Squashed commit of PIPE_CONNECT
[users/heiko/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into 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 "Main configuration settings" "SECTdefconfmain"
5526 The main (global) configuration option settings must always come first in the
5527 file. The first thing you'll see in the file, after some initial comments, is
5528 the line
5529 .code
5530 # primary_hostname =
5531 .endd
5532 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5533 to know the official, fully qualified name of your host, and this is where you
5534 can specify it. However, in most cases you do not need to set this option. When
5535 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5536
5537 The first three non-comment configuration lines are as follows:
5538 .code
5539 domainlist local_domains    = @
5540 domainlist relay_to_domains =
5541 hostlist   relay_from_hosts = 127.0.0.1
5542 .endd
5543 These are not, in fact, option settings. They are definitions of two named
5544 domain lists and one named host list. Exim allows you to give names to lists of
5545 domains, hosts, and email addresses, in order to make it easier to manage the
5546 configuration file (see section &<<SECTnamedlists>>&).
5547
5548 The first line defines a domain list called &'local_domains'&; this is used
5549 later in the configuration to identify domains that are to be delivered
5550 on the local host.
5551
5552 .cindex "@ in a domain list"
5553 There is just one item in this list, the string &"@"&. This is a special form
5554 of entry which means &"the name of the local host"&. Thus, if the local host is
5555 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5556 be delivered locally. Because the local host's name is referenced indirectly,
5557 the same configuration file can be used on different hosts.
5558
5559 The second line defines a domain list called &'relay_to_domains'&, but the
5560 list itself is empty. Later in the configuration we will come to the part that
5561 controls mail relaying through the local host; it allows relaying to any
5562 domains in this list. By default, therefore, no relaying on the basis of a mail
5563 domain is permitted.
5564
5565 The third line defines a host list called &'relay_from_hosts'&. This list is
5566 used later in the configuration to permit relaying from any host or IP address
5567 that matches the list. The default contains just the IP address of the IPv4
5568 loopback interface, which means that processes on the local host are able to
5569 submit mail for relaying by sending it over TCP/IP to that interface. No other
5570 hosts are permitted to submit messages for relaying.
5571
5572 Just to be sure there's no misunderstanding: at this point in the configuration
5573 we aren't actually setting up any controls. We are just defining some domains
5574 and hosts that will be used in the controls that are specified later.
5575
5576 The next two configuration lines are genuine option settings:
5577 .code
5578 acl_smtp_rcpt = acl_check_rcpt
5579 acl_smtp_data = acl_check_data
5580 .endd
5581 These options specify &'Access Control Lists'& (ACLs) that are to be used
5582 during an incoming SMTP session for every recipient of a message (every RCPT
5583 command), and after the contents of the message have been received,
5584 respectively. The names of the lists are &'acl_check_rcpt'& and
5585 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5586 section of the configuration. The RCPT ACL controls which recipients are
5587 accepted for an incoming message &-- if a configuration does not provide an ACL
5588 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5589 contents of a message to be checked.
5590
5591 Two commented-out option settings are next:
5592 .code
5593 # av_scanner = clamd:/tmp/clamd
5594 # spamd_address = 127.0.0.1 783
5595 .endd
5596 These are example settings that can be used when Exim is compiled with the
5597 content-scanning extension. The first specifies the interface to the virus
5598 scanner, and the second specifies the interface to SpamAssassin. Further
5599 details are given in chapter &<<CHAPexiscan>>&.
5600
5601 Three more commented-out option settings follow:
5602 .code
5603 # tls_advertise_hosts = *
5604 # tls_certificate = /etc/ssl/exim.crt
5605 # tls_privatekey = /etc/ssl/exim.pem
5606 .endd
5607 These are example settings that can be used when Exim is compiled with
5608 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5609 first one specifies the list of clients that are allowed to use TLS when
5610 connecting to this server; in this case the wildcard means all clients. The
5611 other options specify where Exim should find its TLS certificate and private
5612 key, which together prove the server's identity to any clients that connect.
5613 More details are given in chapter &<<CHAPTLS>>&.
5614
5615 Another two commented-out option settings follow:
5616 .code
5617 # daemon_smtp_ports = 25 : 465 : 587
5618 # tls_on_connect_ports = 465
5619 .endd
5620 .cindex "port" "465 and 587"
5621 .cindex "port" "for message submission"
5622 .cindex "message" "submission, ports for"
5623 .cindex "submissions protocol"
5624 .cindex "smtps protocol"
5625 .cindex "ssmtp protocol"
5626 .cindex "SMTP" "submissions protocol"
5627 .cindex "SMTP" "ssmtp protocol"
5628 .cindex "SMTP" "smtps protocol"
5629 These options provide better support for roaming users who wish to use this
5630 server for message submission. They are not much use unless you have turned on
5631 TLS (as described in the previous paragraph) and authentication (about which
5632 more in section &<<SECTdefconfauth>>&).
5633 Mail submission from mail clients (MUAs) should be separate from inbound mail
5634 to your domain (MX delivery) for various good reasons (eg, ability to impose
5635 much saner TLS protocol and ciphersuite requirements without unintended
5636 consequences).
5637 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5638 which uses STARTTLS, so this is the &"submission"& port.
5639 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5640 which should be used in preference to 587.
5641 You should also consider deploying SRV records to help clients find
5642 these ports.
5643 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5644
5645 Two more commented-out options settings follow:
5646 .code
5647 # qualify_domain =
5648 # qualify_recipient =
5649 .endd
5650 The first of these specifies a domain that Exim uses when it constructs a
5651 complete email address from a local login name. This is often needed when Exim
5652 receives a message from a local process. If you do not set &%qualify_domain%&,
5653 the value of &%primary_hostname%& is used. If you set both of these options,
5654 you can have different qualification domains for sender and recipient
5655 addresses. If you set only the first one, its value is used in both cases.
5656
5657 .cindex "domain literal" "recognizing format"
5658 The following line must be uncommented if you want Exim to recognize
5659 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5660 (an IP address within square brackets) instead of a named domain.
5661 .code
5662 # allow_domain_literals
5663 .endd
5664 The RFCs still require this form, but many people think that in the modern
5665 Internet it makes little sense to permit mail to be sent to specific hosts by
5666 quoting their IP addresses. This ancient format has been used by people who
5667 try to abuse hosts by using them for unwanted relaying. However, some
5668 people believe there are circumstances (for example, messages addressed to
5669 &'postmaster'&) where domain literals are still useful.
5670
5671 The next configuration line is a kind of trigger guard:
5672 .code
5673 never_users = root
5674 .endd
5675 It specifies that no delivery must ever be run as the root user. The normal
5676 convention is to set up &'root'& as an alias for the system administrator. This
5677 setting is a guard against slips in the configuration.
5678 The list of users specified by &%never_users%& is not, however, the complete
5679 list; the build-time configuration in &_Local/Makefile_& has an option called
5680 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5681 contents of &%never_users%& are added to this list. By default
5682 FIXED_NEVER_USERS also specifies root.
5683
5684 When a remote host connects to Exim in order to send mail, the only information
5685 Exim has about the host's identity is its IP address. The next configuration
5686 line,
5687 .code
5688 host_lookup = *
5689 .endd
5690 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5691 in order to get a host name. This improves the quality of the logging
5692 information, but if you feel it is too expensive, you can remove it entirely,
5693 or restrict the lookup to hosts on &"nearby"& networks.
5694 Note that it is not always possible to find a host name from an IP address,
5695 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5696 unreachable.
5697
5698 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5699 1413 (hence their names):
5700 .code
5701 rfc1413_hosts = *
5702 rfc1413_query_timeout = 0s
5703 .endd
5704 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5705 Few hosts offer RFC1413 service these days; calls have to be
5706 terminated by a timeout and this needlessly delays the startup
5707 of an incoming SMTP connection.
5708 If you have hosts for which you trust RFC1413 and need this
5709 information, you can change this.
5710
5711 This line enables an efficiency SMTP option.  It is negotiated by clients
5712 and not expected to cause problems but can be disabled if needed.
5713 .code
5714 prdr_enable = true
5715 .endd
5716
5717 When Exim receives messages over SMTP connections, it expects all addresses to
5718 be fully qualified with a domain, as required by the SMTP definition. However,
5719 if you are running a server to which simple clients submit messages, you may
5720 find that they send unqualified addresses. The two commented-out options:
5721 .code
5722 # sender_unqualified_hosts =
5723 # recipient_unqualified_hosts =
5724 .endd
5725 show how you can specify hosts that are permitted to send unqualified sender
5726 and recipient addresses, respectively.
5727
5728 The &%log_selector%& option is used to increase the detail of logging
5729 over the default:
5730 .code
5731 log_selector = +smtp_protocol_error +smtp_syntax_error \
5732                +tls_certificate_verified
5733 .endd
5734
5735 The &%percent_hack_domains%& option is also commented out:
5736 .code
5737 # percent_hack_domains =
5738 .endd
5739 It provides a list of domains for which the &"percent hack"& is to operate.
5740 This is an almost obsolete form of explicit email routing. If you do not know
5741 anything about it, you can safely ignore this topic.
5742
5743 The next two settings in the main part of the default configuration are
5744 concerned with messages that have been &"frozen"& on Exim's queue. When a
5745 message is frozen, Exim no longer continues to try to deliver it. Freezing
5746 occurs when a bounce message encounters a permanent failure because the sender
5747 address of the original message that caused the bounce is invalid, so the
5748 bounce cannot be delivered. This is probably the most common case, but there
5749 are also other conditions that cause freezing, and frozen messages are not
5750 always bounce messages.
5751 .code
5752 ignore_bounce_errors_after = 2d
5753 timeout_frozen_after = 7d
5754 .endd
5755 The first of these options specifies that failing bounce messages are to be
5756 discarded after 2 days on the queue. The second specifies that any frozen
5757 message (whether a bounce message or not) is to be timed out (and discarded)
5758 after a week. In this configuration, the first setting ensures that no failing
5759 bounce message ever lasts a week.
5760
5761 Exim queues it's messages in a spool directory. If you expect to have
5762 large queues, you may consider using this option. It splits the spool
5763 directory into subdirectories to avoid file system degradation from
5764 many files in a single directory, resulting in better performance.
5765 Manual manipulation of queued messages becomes more complex (though fortunately
5766 not often needed).
5767 .code
5768 # split_spool_directory = true
5769 .endd
5770
5771 In an ideal world everybody follows the standards. For non-ASCII
5772 messages RFC 2047 is a standard, allowing a maximum line length of 76
5773 characters. Exim adheres that standard and won't process messages which
5774 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5775 In particular, the Exim maintainers have had multiple reports of
5776 problems from Russian administrators of issues until they disable this
5777 check, because of some popular, yet buggy, mail composition software.
5778 .code
5779 # check_rfc2047_length = false
5780 .endd
5781
5782 If you need to be strictly RFC compliant you may wish to disable the
5783 8BITMIME advertisement. Use this, if you exchange mails with systems
5784 that are not 8-bit clean.
5785 .code
5786 # accept_8bitmime = false
5787 .endd
5788
5789 Libraries you use may depend on specific environment settings.  This
5790 imposes a security risk (e.g. PATH). There are two lists:
5791 &%keep_environment%& for the variables to import as they are, and
5792 &%add_environment%& for variables we want to set to a fixed value.
5793 Note that TZ is handled separately, by the $%timezone%$ runtime
5794 option and by the TIMEZONE_DEFAULT buildtime option.
5795 .code
5796 # keep_environment = ^LDAP
5797 # add_environment = PATH=/usr/bin::/bin
5798 .endd
5799
5800
5801 .section "ACL configuration" "SECID54"
5802 .cindex "default" "ACLs"
5803 .cindex "&ACL;" "default configuration"
5804 In the default configuration, the ACL section follows the main configuration.
5805 It starts with the line
5806 .code
5807 begin acl
5808 .endd
5809 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5810 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5811 and &%acl_smtp_data%& above.
5812
5813 .cindex "RCPT" "ACL for"
5814 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5815 RCPT command specifies one of the message's recipients. The ACL statements
5816 are considered in order, until the recipient address is either accepted or
5817 rejected. The RCPT command is then accepted or rejected, according to the
5818 result of the ACL processing.
5819 .code
5820 acl_check_rcpt:
5821 .endd
5822 This line, consisting of a name terminated by a colon, marks the start of the
5823 ACL, and names it.
5824 .code
5825 accept  hosts = :
5826 .endd
5827 This ACL statement accepts the recipient if the sending host matches the list.
5828 But what does that strange list mean? It doesn't actually contain any host
5829 names or IP addresses. The presence of the colon puts an empty item in the
5830 list; Exim matches this only if the incoming message did not come from a remote
5831 host, because in that case, the remote hostname is empty. The colon is
5832 important. Without it, the list itself is empty, and can never match anything.
5833
5834 What this statement is doing is to accept unconditionally all recipients in
5835 messages that are submitted by SMTP from local processes using the standard
5836 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5837 manner.
5838 .code
5839 deny    message       = Restricted characters in address
5840         domains       = +local_domains
5841         local_parts   = ^[.] : ^.*[@%!/|]
5842
5843 deny    message       = Restricted characters in address
5844         domains       = !+local_domains
5845         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5846 .endd
5847 These statements are concerned with local parts that contain any of the
5848 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5849 Although these characters are entirely legal in local parts (in the case of
5850 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5851 in Internet mail addresses.
5852
5853 The first three have in the past been associated with explicitly routed
5854 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5855 option). Addresses containing these characters are regularly tried by spammers
5856 in an attempt to bypass relaying restrictions, and also by open relay testing
5857 programs. Unless you really need them it is safest to reject these characters
5858 at this early stage. This configuration is heavy-handed in rejecting these
5859 characters for all messages it accepts from remote hosts. This is a deliberate
5860 policy of being as safe as possible.
5861
5862 The first rule above is stricter, and is applied to messages that are addressed
5863 to one of the local domains handled by this host. This is implemented by the
5864 first condition, which restricts it to domains that are listed in the
5865 &'local_domains'& domain list. The &"+"& character is used to indicate a
5866 reference to a named list. In this configuration, there is just one domain in
5867 &'local_domains'&, but in general there may be many.
5868
5869 The second condition on the first statement uses two regular expressions to
5870 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5871 or &"|"&. If you have local accounts that include these characters, you will
5872 have to modify this rule.
5873
5874 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5875 allows them because they have been encountered in practice. (Consider the
5876 common convention of local parts constructed as
5877 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5878 the author of Exim, who has no second initial.) However, a local part starting
5879 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5880 file name (for example, for a mailing list). This is also true for local parts
5881 that contain slashes. A pipe symbol can also be troublesome if the local part
5882 is incorporated unthinkingly into a shell command line.
5883
5884 The second rule above applies to all other domains, and is less strict. This
5885 allows your own users to send outgoing messages to sites that use slashes
5886 and vertical bars in their local parts. It blocks local parts that begin
5887 with a dot, slash, or vertical bar, but allows these characters within the
5888 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5889 and &"!"& is blocked, as before. The motivation here is to prevent your users
5890 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5891 .code
5892 accept  local_parts   = postmaster
5893         domains       = +local_domains
5894 .endd
5895 This statement, which has two conditions, accepts an incoming address if the
5896 local part is &'postmaster'& and the domain is one of those listed in the
5897 &'local_domains'& domain list. The &"+"& character is used to indicate a
5898 reference to a named list. In this configuration, there is just one domain in
5899 &'local_domains'&, but in general there may be many.
5900
5901 The presence of this statement means that mail to postmaster is never blocked
5902 by any of the subsequent tests. This can be helpful while sorting out problems
5903 in cases where the subsequent tests are incorrectly denying access.
5904 .code
5905 require verify        = sender
5906 .endd
5907 This statement requires the sender address to be verified before any subsequent
5908 ACL statement can be used. If verification fails, the incoming recipient
5909 address is refused. Verification consists of trying to route the address, to
5910 see if a bounce message could be delivered to it. In the case of remote
5911 addresses, basic verification checks only the domain, but &'callouts'& can be
5912 used for more verification if required. Section &<<SECTaddressverification>>&
5913 discusses the details of address verification.
5914 .code
5915 accept  hosts         = +relay_from_hosts
5916         control       = submission
5917 .endd
5918 This statement accepts the address if the message is coming from one of the
5919 hosts that are defined as being allowed to relay through this host. Recipient
5920 verification is omitted here, because in many cases the clients are dumb MUAs
5921 that do not cope well with SMTP error responses. For the same reason, the
5922 second line specifies &"submission mode"& for messages that are accepted. This
5923 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5924 messages that are deficient in some way, for example, because they lack a
5925 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5926 probably add recipient verification here, and disable submission mode.
5927 .code
5928 accept  authenticated = *
5929         control       = submission
5930 .endd
5931 This statement accepts the address if the client host has authenticated itself.
5932 Submission mode is again specified, on the grounds that such messages are most
5933 likely to come from MUAs. The default configuration does not define any
5934 authenticators, though it does include some nearly complete commented-out
5935 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5936 fact authenticate until you complete the authenticator definitions.
5937 .code
5938 require message = relay not permitted
5939         domains = +local_domains : +relay_to_domains
5940 .endd
5941 This statement rejects the address if its domain is neither a local domain nor
5942 one of the domains for which this host is a relay.
5943 .code
5944 require verify = recipient
5945 .endd
5946 This statement requires the recipient address to be verified; if verification
5947 fails, the address is rejected.
5948 .code
5949 # deny    message     = rejected because $sender_host_address \
5950 #                       is in a black list at $dnslist_domain\n\
5951 #                       $dnslist_text
5952 #         dnslists    = black.list.example
5953 #
5954 # warn    dnslists    = black.list.example
5955 #         add_header  = X-Warning: $sender_host_address is in \
5956 #                       a black list at $dnslist_domain
5957 #         log_message = found in $dnslist_domain
5958 .endd
5959 These commented-out lines are examples of how you could configure Exim to check
5960 sending hosts against a DNS black list. The first statement rejects messages
5961 from blacklisted hosts, whereas the second just inserts a warning header
5962 line.
5963 .code
5964 # require verify = csa
5965 .endd
5966 This commented-out line is an example of how you could turn on client SMTP
5967 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5968 records.
5969 .code
5970 accept
5971 .endd
5972 The final statement in the first ACL unconditionally accepts any recipient
5973 address that has successfully passed all the previous tests.
5974 .code
5975 acl_check_data:
5976 .endd
5977 This line marks the start of the second ACL, and names it. Most of the contents
5978 of this ACL are commented out:
5979 .code
5980 # deny    malware   = *
5981 #         message   = This message contains a virus \
5982 #                     ($malware_name).
5983 .endd
5984 These lines are examples of how to arrange for messages to be scanned for
5985 viruses when Exim has been compiled with the content-scanning extension, and a
5986 suitable virus scanner is installed. If the message is found to contain a
5987 virus, it is rejected with the given custom error message.
5988 .code
5989 # warn    spam      = nobody
5990 #         message   = X-Spam_score: $spam_score\n\
5991 #                     X-Spam_score_int: $spam_score_int\n\
5992 #                     X-Spam_bar: $spam_bar\n\
5993 #                     X-Spam_report: $spam_report
5994 .endd
5995 These lines are an example of how to arrange for messages to be scanned by
5996 SpamAssassin when Exim has been compiled with the content-scanning extension,
5997 and SpamAssassin has been installed. The SpamAssassin check is run with
5998 &`nobody`& as its user parameter, and the results are added to the message as a
5999 series of extra header line. In this case, the message is not rejected,
6000 whatever the spam score.
6001 .code
6002 accept
6003 .endd
6004 This final line in the DATA ACL accepts the message unconditionally.
6005
6006
6007 .section "Router configuration" "SECID55"
6008 .cindex "default" "routers"
6009 .cindex "routers" "default"
6010 The router configuration comes next in the default configuration, introduced
6011 by the line
6012 .code
6013 begin routers
6014 .endd
6015 Routers are the modules in Exim that make decisions about where to send
6016 messages. An address is passed to each router in turn, until it is either
6017 accepted, or failed. This means that the order in which you define the routers
6018 matters. Each router is fully described in its own chapter later in this
6019 manual. Here we give only brief overviews.
6020 .code
6021 # domain_literal:
6022 #   driver = ipliteral
6023 #   domains = !+local_domains
6024 #   transport = remote_smtp
6025 .endd
6026 .cindex "domain literal" "default router"
6027 This router is commented out because the majority of sites do not want to
6028 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6029 you uncomment this router, you also need to uncomment the setting of
6030 &%allow_domain_literals%& in the main part of the configuration.
6031 .code
6032 dnslookup:
6033   driver = dnslookup
6034   domains = ! +local_domains
6035   transport = remote_smtp
6036   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6037   no_more
6038 .endd
6039 The first uncommented router handles addresses that do not involve any local
6040 domains. This is specified by the line
6041 .code
6042 domains = ! +local_domains
6043 .endd
6044 The &%domains%& option lists the domains to which this router applies, but the
6045 exclamation mark is a negation sign, so the router is used only for domains
6046 that are not in the domain list called &'local_domains'& (which was defined at
6047 the start of the configuration). The plus sign before &'local_domains'&
6048 indicates that it is referring to a named list. Addresses in other domains are
6049 passed on to the following routers.
6050
6051 The name of the router driver is &(dnslookup)&,
6052 and is specified by the &%driver%& option. Do not be confused by the fact that
6053 the name of this router instance is the same as the name of the driver. The
6054 instance name is arbitrary, but the name set in the &%driver%& option must be
6055 one of the driver modules that is in the Exim binary.
6056
6057 The &(dnslookup)& router routes addresses by looking up their domains in the
6058 DNS in order to obtain a list of hosts to which the address is routed. If the
6059 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6060 specified by the &%transport%& option. If the router does not find the domain
6061 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6062 the address fails and is bounced.
6063
6064 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6065 be entirely ignored. This option is present because a number of cases have been
6066 encountered where MX records in the DNS point to host names
6067 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6068 Completely ignoring these IP addresses causes Exim to fail to route the
6069 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6070 continue to try to deliver the message periodically until the address timed
6071 out.
6072 .code
6073 system_aliases:
6074   driver = redirect
6075   allow_fail
6076   allow_defer
6077   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6078 # user = exim
6079   file_transport = address_file
6080   pipe_transport = address_pipe
6081 .endd
6082 Control reaches this and subsequent routers only for addresses in the local
6083 domains. This router checks to see whether the local part is defined as an
6084 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6085 data that it looks up from that file. If no data is found for the local part,
6086 the value of the &%data%& option is empty, causing the address to be passed to
6087 the next router.
6088
6089 &_/etc/aliases_& is a conventional name for the system aliases file that is
6090 often used. That is why it is referenced by from the default configuration
6091 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6092 &_Local/Makefile_& before building Exim.
6093 .code
6094 userforward:
6095   driver = redirect
6096   check_local_user
6097 # local_part_suffix = +* : -*
6098 # local_part_suffix_optional
6099   file = $home/.forward
6100 # allow_filter
6101   no_verify
6102   no_expn
6103   check_ancestor
6104   file_transport = address_file
6105   pipe_transport = address_pipe
6106   reply_transport = address_reply
6107 .endd
6108 This is the most complicated router in the default configuration. It is another
6109 redirection router, but this time it is looking for forwarding data set up by
6110 individual users. The &%check_local_user%& setting specifies a check that the
6111 local part of the address is the login name of a local user. If it is not, the
6112 router is skipped. The two commented options that follow &%check_local_user%&,
6113 namely:
6114 .code
6115 # local_part_suffix = +* : -*
6116 # local_part_suffix_optional
6117 .endd
6118 .vindex "&$local_part_suffix$&"
6119 show how you can specify the recognition of local part suffixes. If the first
6120 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6121 by any sequence of characters, is removed from the local part and placed in the
6122 variable &$local_part_suffix$&. The second suffix option specifies that the
6123 presence of a suffix in the local part is optional. When a suffix is present,
6124 the check for a local login uses the local part with the suffix removed.
6125
6126 When a local user account is found, the file called &_.forward_& in the user's
6127 home directory is consulted. If it does not exist, or is empty, the router
6128 declines. Otherwise, the contents of &_.forward_& are interpreted as
6129 redirection data (see chapter &<<CHAPredirect>>& for more details).
6130
6131 .cindex "Sieve filter" "enabling in default router"
6132 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6133 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6134 is commented out by default), the contents of the file are interpreted as a set
6135 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6136 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6137 separate document entitled &'Exim's interfaces to mail filtering'&.
6138
6139 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6140 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6141 There are two reasons for doing this:
6142
6143 .olist
6144 Whether or not a local user has a &_.forward_& file is not really relevant when
6145 checking an address for validity; it makes sense not to waste resources doing
6146 unnecessary work.
6147 .next
6148 More importantly, when Exim is verifying addresses or handling an EXPN
6149 command during an SMTP session, it is running as the Exim user, not as root.
6150 The group is the Exim group, and no additional groups are set up.
6151 It may therefore not be possible for Exim to read users' &_.forward_& files at
6152 this time.
6153 .endlist
6154
6155 The setting of &%check_ancestor%& prevents the router from generating a new
6156 address that is the same as any previous address that was redirected. (This
6157 works round a problem concerning a bad interaction between aliasing and
6158 forwarding &-- see section &<<SECTredlocmai>>&).
6159
6160 The final three option settings specify the transports that are to be used when
6161 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6162 auto-reply, respectively. For example, if a &_.forward_& file contains
6163 .code
6164 a.nother@elsewhere.example, /home/spqr/archive
6165 .endd
6166 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6167 transport.
6168 .code
6169 localuser:
6170   driver = accept
6171   check_local_user
6172 # local_part_suffix = +* : -*
6173 # local_part_suffix_optional
6174   transport = local_delivery
6175 .endd
6176 The final router sets up delivery into local mailboxes, provided that the local
6177 part is the name of a local login, by accepting the address and assigning it to
6178 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6179 routers, so the address is bounced. The commented suffix settings fulfil the
6180 same purpose as they do for the &(userforward)& router.
6181
6182
6183 .section "Transport configuration" "SECID56"
6184 .cindex "default" "transports"
6185 .cindex "transports" "default"
6186 Transports define mechanisms for actually delivering messages. They operate
6187 only when referenced from routers, so the order in which they are defined does
6188 not matter. The transports section of the configuration starts with
6189 .code
6190 begin transports
6191 .endd
6192 One remote transport and four local transports are defined.
6193 .code
6194 remote_smtp:
6195   driver = smtp
6196   hosts_try_prdr = *
6197 .endd
6198 This transport is used for delivering messages over SMTP connections.
6199 The list of remote hosts comes from the router.
6200 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6201 It is negotiated between client and server
6202 and not expected to cause problems but can be disabled if needed.
6203 All other options are defaulted.
6204 .code
6205 local_delivery:
6206   driver = appendfile
6207   file = /var/mail/$local_part
6208   delivery_date_add
6209   envelope_to_add
6210   return_path_add
6211 # group = mail
6212 # mode = 0660
6213 .endd
6214 This &(appendfile)& transport is used for local delivery to user mailboxes in
6215 traditional BSD mailbox format. By default it runs under the uid and gid of the
6216 local user, which requires the sticky bit to be set on the &_/var/mail_&
6217 directory. Some systems use the alternative approach of running mail deliveries
6218 under a particular group instead of using the sticky bit. The commented options
6219 show how this can be done.
6220
6221 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6222 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6223 similarly-named options above.
6224 .code
6225 address_pipe:
6226   driver = pipe
6227   return_output
6228 .endd
6229 This transport is used for handling deliveries to pipes that are generated by
6230 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6231 option specifies that any output on stdout or stderr generated by the pipe is to
6232 be returned to the sender.
6233 .code
6234 address_file:
6235   driver = appendfile
6236   delivery_date_add
6237   envelope_to_add
6238   return_path_add
6239 .endd
6240 This transport is used for handling deliveries to files that are generated by
6241 redirection. The name of the file is not specified in this instance of
6242 &(appendfile)&, because it comes from the &(redirect)& router.
6243 .code
6244 address_reply:
6245   driver = autoreply
6246 .endd
6247 This transport is used for handling automatic replies generated by users'
6248 filter files.
6249
6250
6251
6252 .section "Default retry rule" "SECID57"
6253 .cindex "retry" "default rule"
6254 .cindex "default" "retry rule"
6255 The retry section of the configuration file contains rules which affect the way
6256 Exim retries deliveries that cannot be completed at the first attempt. It is
6257 introduced by the line
6258 .code
6259 begin retry
6260 .endd
6261 In the default configuration, there is just one rule, which applies to all
6262 errors:
6263 .code
6264 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6265 .endd
6266 This causes any temporarily failing address to be retried every 15 minutes for
6267 2 hours, then at intervals starting at one hour and increasing by a factor of
6268 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6269 is not delivered after 4 days of temporary failure, it is bounced. The time is
6270 measured from first failure, not from the time the message was received.
6271
6272 If the retry section is removed from the configuration, or is empty (that is,
6273 if no retry rules are defined), Exim will not retry deliveries. This turns
6274 temporary errors into permanent errors.
6275
6276
6277 .section "Rewriting configuration" "SECID58"
6278 The rewriting section of the configuration, introduced by
6279 .code
6280 begin rewrite
6281 .endd
6282 contains rules for rewriting addresses in messages as they arrive. There are no
6283 rewriting rules in the default configuration file.
6284
6285
6286
6287 .section "Authenticators configuration" "SECTdefconfauth"
6288 .cindex "AUTH" "configuration"
6289 The authenticators section of the configuration, introduced by
6290 .code
6291 begin authenticators
6292 .endd
6293 defines mechanisms for the use of the SMTP AUTH command. The default
6294 configuration file contains two commented-out example authenticators
6295 which support plaintext username/password authentication using the
6296 standard PLAIN mechanism and the traditional but non-standard LOGIN
6297 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6298 to support most MUA software.
6299
6300 The example PLAIN authenticator looks like this:
6301 .code
6302 #PLAIN:
6303 #  driver                  = plaintext
6304 #  server_set_id           = $auth2
6305 #  server_prompts          = :
6306 #  server_condition        = Authentication is not yet configured
6307 #  server_advertise_condition = ${if def:tls_in_cipher }
6308 .endd
6309 And the example LOGIN authenticator looks like this:
6310 .code
6311 #LOGIN:
6312 #  driver                  = plaintext
6313 #  server_set_id           = $auth1
6314 #  server_prompts          = <| Username: | Password:
6315 #  server_condition        = Authentication is not yet configured
6316 #  server_advertise_condition = ${if def:tls_in_cipher }
6317 .endd
6318
6319 The &%server_set_id%& option makes Exim remember the authenticated username
6320 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6321 &%server_prompts%& option configures the &(plaintext)& authenticator so
6322 that it implements the details of the specific authentication mechanism,
6323 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6324 when Exim offers authentication to clients; in the examples, this is only
6325 when TLS or SSL has been started, so to enable the authenticators you also
6326 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6327
6328 The &%server_condition%& setting defines how to verify that the username and
6329 password are correct. In the examples it just produces an error message.
6330 To make the authenticators work, you can use a string expansion
6331 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6332
6333 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6334 usercode and password are in different positions.
6335 Chapter &<<CHAPplaintext>>& covers both.
6336
6337 .ecindex IIDconfiwal
6338
6339
6340
6341 . ////////////////////////////////////////////////////////////////////////////
6342 . ////////////////////////////////////////////////////////////////////////////
6343
6344 .chapter "Regular expressions" "CHAPregexp"
6345
6346 .cindex "regular expressions" "library"
6347 .cindex "PCRE"
6348 Exim supports the use of regular expressions in many of its options. It
6349 uses the PCRE regular expression library; this provides regular expression
6350 matching that is compatible with Perl 5. The syntax and semantics of
6351 regular expressions is discussed in
6352 online Perl manpages, in
6353 many Perl reference books, and also in
6354 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6355 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6356 . --- the http: URL here redirects to another page with the ISBN in the URL
6357 . --- where trying to use https: just redirects back to http:, so sticking
6358 . --- to the old URL for now.  2018-09-07.
6359
6360 The documentation for the syntax and semantics of the regular expressions that
6361 are supported by PCRE is included in the PCRE distribution, and no further
6362 description is included here. The PCRE functions are called from Exim using
6363 the default option settings (that is, with no PCRE options set), except that
6364 the PCRE_CASELESS option is set when the matching is required to be
6365 case-insensitive.
6366
6367 In most cases, when a regular expression is required in an Exim configuration,
6368 it has to start with a circumflex, in order to distinguish it from plain text
6369 or an &"ends with"& wildcard. In this example of a configuration setting, the
6370 second item in the colon-separated list is a regular expression.
6371 .code
6372 domains = a.b.c : ^\\d{3} : *.y.z : ...
6373 .endd
6374 The doubling of the backslash is required because of string expansion that
6375 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6376 of this issue, and a way of avoiding the need for doubling backslashes. The
6377 regular expression that is eventually used in this example contains just one
6378 backslash. The circumflex is included in the regular expression, and has the
6379 normal effect of &"anchoring"& it to the start of the string that is being
6380 matched.
6381
6382 There are, however, two cases where a circumflex is not required for the
6383 recognition of a regular expression: these are the &%match%& condition in a
6384 string expansion, and the &%matches%& condition in an Exim filter file. In
6385 these cases, the relevant string is always treated as a regular expression; if
6386 it does not start with a circumflex, the expression is not anchored, and can
6387 match anywhere in the subject string.
6388
6389 In all cases, if you want a regular expression to match at the end of a string,
6390 you must code the $ metacharacter to indicate this. For example:
6391 .code
6392 domains = ^\\d{3}\\.example
6393 .endd
6394 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6395 You need to use:
6396 .code
6397 domains = ^\\d{3}\\.example\$
6398 .endd
6399 if you want &'example'& to be the top-level domain. The backslash before the
6400 $ is needed because string expansion also interprets dollar characters.
6401
6402
6403
6404 . ////////////////////////////////////////////////////////////////////////////
6405 . ////////////////////////////////////////////////////////////////////////////
6406
6407 .chapter "File and database lookups" "CHAPfdlookup"
6408 .scindex IIDfidalo1 "file" "lookups"
6409 .scindex IIDfidalo2 "database" "lookups"
6410 .cindex "lookup" "description of"
6411 Exim can be configured to look up data in files or databases as it processes
6412 messages. Two different kinds of syntax are used:
6413
6414 .olist
6415 A string that is to be expanded may contain explicit lookup requests. These
6416 cause parts of the string to be replaced by data that is obtained from the
6417 lookup. Lookups of this type are conditional expansion items. Different results
6418 can be defined for the cases of lookup success and failure. See chapter
6419 &<<CHAPexpand>>&, where string expansions are described in detail.
6420 The key for the lookup is specified as part of the string expansion.
6421 .next
6422 Lists of domains, hosts, and email addresses can contain lookup requests as a
6423 way of avoiding excessively long linear lists. In this case, the data that is
6424 returned by the lookup is often (but not always) discarded; whether the lookup
6425 succeeds or fails is what really counts. These kinds of list are described in
6426 chapter &<<CHAPdomhosaddlists>>&.
6427 The key for the lookup is given by the context in which the list is expanded.
6428 .endlist
6429
6430 String expansions, lists, and lookups interact with each other in such a way
6431 that there is no order in which to describe any one of them that does not
6432 involve references to the others. Each of these three chapters makes more sense
6433 if you have read the other two first. If you are reading this for the first
6434 time, be aware that some of it will make a lot more sense after you have read
6435 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6436
6437 .section "Examples of different lookup syntax" "SECID60"
6438 It is easy to confuse the two different kinds of lookup, especially as the
6439 lists that may contain the second kind are always expanded before being
6440 processed as lists. Therefore, they may also contain lookups of the first kind.
6441 Be careful to distinguish between the following two examples:
6442 .code
6443 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6444 domains = lsearch;/some/file
6445 .endd
6446 The first uses a string expansion, the result of which must be a domain list.
6447 No strings have been specified for a successful or a failing lookup; the
6448 defaults in this case are the looked-up data and an empty string, respectively.
6449 The expansion takes place before the string is processed as a list, and the
6450 file that is searched could contain lines like this:
6451 .code
6452 192.168.3.4: domain1:domain2:...
6453 192.168.1.9: domain3:domain4:...
6454 .endd
6455 When the lookup succeeds, the result of the expansion is a list of domains (and
6456 possibly other types of item that are allowed in domain lists).
6457
6458 In the second example, the lookup is a single item in a domain list. It causes
6459 Exim to use a lookup to see if the domain that is being processed can be found
6460 in the file. The file could contains lines like this:
6461 .code
6462 domain1:
6463 domain2:
6464 .endd
6465 Any data that follows the keys is not relevant when checking that the domain
6466 matches the list item.
6467
6468 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6469 Consider a file containing lines like this:
6470 .code
6471 192.168.5.6: lsearch;/another/file
6472 .endd
6473 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6474 first &%domains%& setting above generates the second setting, which therefore
6475 causes a second lookup to occur.
6476
6477 The rest of this chapter describes the different lookup types that are
6478 available. Any of them can be used in any part of the configuration where a
6479 lookup is permitted.
6480
6481
6482 .section "Lookup types" "SECID61"
6483 .cindex "lookup" "types of"
6484 .cindex "single-key lookup" "definition of"
6485 Two different types of data lookup are implemented:
6486
6487 .ilist
6488 The &'single-key'& type requires the specification of a file in which to look,
6489 and a single key to search for. The key must be a non-empty string for the
6490 lookup to succeed. The lookup type determines how the file is searched.
6491 .next
6492 .cindex "query-style lookup" "definition of"
6493 The &'query-style'& type accepts a generalized database query. No particular
6494 key value is assumed by Exim for query-style lookups. You can use whichever
6495 Exim variables you need to construct the database query.
6496 .endlist
6497
6498 The code for each lookup type is in a separate source file that is included in
6499 the binary of Exim only if the corresponding compile-time option is set. The
6500 default settings in &_src/EDITME_& are:
6501 .code
6502 LOOKUP_DBM=yes
6503 LOOKUP_LSEARCH=yes
6504 .endd
6505 which means that only linear searching and DBM lookups are included by default.
6506 For some types of lookup (e.g. SQL databases), you need to install appropriate
6507 libraries and header files before building Exim.
6508
6509
6510
6511
6512 .section "Single-key lookup types" "SECTsinglekeylookups"
6513 .cindex "lookup" "single-key types"
6514 .cindex "single-key lookup" "list of types"
6515 The following single-key lookup types are implemented:
6516
6517 .ilist
6518 .cindex "cdb" "description of"
6519 .cindex "lookup" "cdb"
6520 .cindex "binary zero" "in lookup key"
6521 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6522 string without a terminating binary zero. The cdb format is designed for
6523 indexed files that are read frequently and never updated, except by total
6524 re-creation. As such, it is particularly suitable for large files containing
6525 aliases or other indexed data referenced by an MTA. Information about cdb and
6526 tools for building the files can be found in several places:
6527 .display
6528 &url(https://cr.yp.to/cdb.html)
6529 &url(http://www.corpit.ru/mjt/tinycdb.html)
6530 &url(https://packages.debian.org/stable/utils/freecdb)
6531 &url(https://github.com/philpennock/cdbtools) (in Go)
6532 .endd
6533 . --- 2018-09-07: corpit.ru http:-only
6534 A cdb distribution is not needed in order to build Exim with cdb support,
6535 because the code for reading cdb files is included directly in Exim itself.
6536 However, no means of building or testing cdb files is provided with Exim, so
6537 you need to obtain a cdb distribution in order to do this.
6538 .next
6539 .cindex "DBM" "lookup type"
6540 .cindex "lookup" "dbm"
6541 .cindex "binary zero" "in lookup key"
6542 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6543 DBM file by looking up the record with the given key. A terminating binary
6544 zero is included in the key that is passed to the DBM library. See section
6545 &<<SECTdb>>& for a discussion of DBM libraries.
6546
6547 .cindex "Berkeley DB library" "file format"
6548 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6549 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6550 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6551 the DB_UNKNOWN option. This enables it to handle any of the types of database
6552 that the library supports, and can be useful for accessing DBM files created by
6553 other applications. (For earlier DB versions, DB_HASH is always used.)
6554 .next
6555 .cindex "lookup" "dbmjz"
6556 .cindex "lookup" "dbm &-- embedded NULs"
6557 .cindex "sasldb2"
6558 .cindex "dbmjz lookup type"
6559 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6560 interpreted as an Exim list; the elements of the list are joined together with
6561 ASCII NUL characters to form the lookup key.  An example usage would be to
6562 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6563 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6564 &(cram_md5)& authenticator.
6565 .next
6566 .cindex "lookup" "dbmnz"
6567 .cindex "lookup" "dbm &-- terminating zero"
6568 .cindex "binary zero" "in lookup key"
6569 .cindex "Courier"
6570 .cindex "&_/etc/userdbshadow.dat_&"
6571 .cindex "dbmnz lookup type"
6572 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6573 is not included in the key that is passed to the DBM library. You may need this
6574 if you want to look up data in files that are created by or shared with some
6575 other application that does not use terminating zeros. For example, you need to
6576 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6577 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6578 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6579 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6580 .next
6581 .cindex "lookup" "dsearch"
6582 .cindex "dsearch lookup type"
6583 &(dsearch)&: The given file must be a directory; this is searched for an entry
6584 whose name is the key by calling the &[lstat()]& function. The key may not
6585 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6586 the lookup is the name of the entry, which may be a file, directory,
6587 symbolic link, or any other kind of directory entry. An example of how this
6588 lookup can be used to support virtual domains is given in section
6589 &<<SECTvirtualdomains>>&.
6590 .next
6591 .cindex "lookup" "iplsearch"
6592 .cindex "iplsearch lookup type"
6593 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6594 terminated by a colon or white space or the end of the line. The keys in the
6595 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6596 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6597 being interpreted as a key terminator. For example:
6598 .code
6599 1.2.3.4:           data for 1.2.3.4
6600 192.168.0.0/16:    data for 192.168.0.0/16
6601 "abcd::cdab":      data for abcd::cdab
6602 "abcd:abcd::/32"   data for abcd:abcd::/32
6603 .endd
6604 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6605 file is searched linearly, using the CIDR masks where present, until a matching
6606 key is found. The first key that matches is used; there is no attempt to find a
6607 &"best"& match. Apart from the way the keys are matched, the processing for
6608 &(iplsearch)& is the same as for &(lsearch)&.
6609
6610 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6611 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6612 lookup types support only literal keys.
6613
6614 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6615 the implicit key is the host's IP address rather than its name (see section
6616 &<<SECThoslispatsikey>>&).
6617 .next
6618 .cindex "linear search"
6619 .cindex "lookup" "lsearch"
6620 .cindex "lsearch lookup type"
6621 .cindex "case sensitivity" "in lsearch lookup"
6622 &(lsearch)&: The given file is a text file that is searched linearly for a
6623 line beginning with the search key, terminated by a colon or white space or the
6624 end of the line. The search is case-insensitive; that is, upper and lower case
6625 letters are treated as the same. The first occurrence of the key that is found
6626 in the file is used.
6627
6628 White space between the key and the colon is permitted. The remainder of the
6629 line, with leading and trailing white space removed, is the data. This can be
6630 continued onto subsequent lines by starting them with any amount of white
6631 space, but only a single space character is included in the data at such a
6632 junction. If the data begins with a colon, the key must be terminated by a
6633 colon, for example:
6634 .code
6635 baduser:  :fail:
6636 .endd
6637 Empty lines and lines beginning with # are ignored, even if they occur in the
6638 middle of an item. This is the traditional textual format of alias files. Note
6639 that the keys in an &(lsearch)& file are literal strings. There is no
6640 wildcarding of any kind.
6641
6642 .cindex "lookup" "lsearch &-- colons in keys"
6643 .cindex "white space" "in lsearch key"
6644 In most &(lsearch)& files, keys are not required to contain colons or #
6645 characters, or white space. However, if you need this feature, it is available.
6646 If a key begins with a doublequote character, it is terminated only by a
6647 matching quote (or end of line), and the normal escaping rules apply to its
6648 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6649 quoted keys (exactly as for unquoted keys). There is no special handling of
6650 quotes for the data part of an &(lsearch)& line.
6651
6652 .next
6653 .cindex "NIS lookup type"
6654 .cindex "lookup" "NIS"
6655 .cindex "binary zero" "in lookup key"
6656 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6657 the given key, without a terminating binary zero. There is a variant called
6658 &(nis0)& which does include the terminating binary zero in the key. This is
6659 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6660 aliases; the full map names must be used.
6661
6662 .next
6663 .cindex "wildlsearch lookup type"
6664 .cindex "lookup" "wildlsearch"
6665 .cindex "nwildlsearch lookup type"
6666 .cindex "lookup" "nwildlsearch"
6667 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6668 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6669 the file may be wildcarded. The difference between these two lookup types is
6670 that for &(wildlsearch)&, each key in the file is string-expanded before being
6671 used, whereas for &(nwildlsearch)&, no expansion takes place.
6672
6673 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6674 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6675 file that are regular expressions can be made case-sensitive by the use of
6676 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6677
6678 . ==== As this is a nested list, any displays it contains must be indented
6679 . ==== as otherwise they are too far to the left.
6680
6681 .olist
6682 The string may begin with an asterisk to mean &"ends with"&. For example:
6683 .code
6684     *.a.b.c       data for anything.a.b.c
6685     *fish         data for anythingfish
6686 .endd
6687 .next
6688 The string may begin with a circumflex to indicate a regular expression. For
6689 example, for &(wildlsearch)&:
6690 .code
6691     ^\N\d+\.a\.b\N    data for <digits>.a.b
6692 .endd
6693 Note the use of &`\N`& to disable expansion of the contents of the regular
6694 expression. If you are using &(nwildlsearch)&, where the keys are not
6695 string-expanded, the equivalent entry is:
6696 .code
6697     ^\d+\.a\.b        data for <digits>.a.b
6698 .endd
6699 The case-insensitive flag is set at the start of compiling the regular
6700 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6701 For example, to make the entire pattern case-sensitive:
6702 .code
6703     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6704 .endd
6705
6706 If the regular expression contains white space or colon characters, you must
6707 either quote it (see &(lsearch)& above), or represent these characters in other
6708 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6709 colon. This may be easier than quoting, because if you quote, you have to
6710 escape all the backslashes inside the quotes.
6711
6712 &*Note*&: It is not possible to capture substrings in a regular expression
6713 match for later use, because the results of all lookups are cached. If a lookup
6714 is repeated, the result is taken from the cache, and no actual pattern matching
6715 takes place. The values of all the numeric variables are unset after a
6716 &((n)wildlsearch)& match.
6717
6718 .next
6719 Although I cannot see it being of much use, the general matching function that
6720 is used to implement &((n)wildlsearch)& means that the string may begin with a
6721 lookup name terminated by a semicolon, and followed by lookup data. For
6722 example:
6723 .code
6724     cdb;/some/file  data for keys that match the file
6725 .endd
6726 The data that is obtained from the nested lookup is discarded.
6727 .endlist olist
6728
6729 Keys that do not match any of these patterns are interpreted literally. The
6730 continuation rules for the data are the same as for &(lsearch)&, and keys may
6731 be followed by optional colons.
6732
6733 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6734 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6735 lookup types support only literal keys.
6736 .endlist ilist
6737
6738
6739 .section "Query-style lookup types" "SECTquerystylelookups"
6740 .cindex "lookup" "query-style types"
6741 .cindex "query-style lookup" "list of types"
6742 The supported query-style lookup types are listed below. Further details about
6743 many of them are given in later sections.
6744
6745 .ilist
6746 .cindex "DNS" "as a lookup type"
6747 .cindex "lookup" "DNS"
6748 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6749 are given in the supplied query. The resulting data is the contents of the
6750 records. See section &<<SECTdnsdb>>&.
6751 .next
6752 .cindex "InterBase lookup type"
6753 .cindex "lookup" "InterBase"
6754 &(ibase)&: This does a lookup in an InterBase database.
6755 .next
6756 .cindex "LDAP" "lookup type"
6757 .cindex "lookup" "LDAP"
6758 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6759 returns attributes from a single entry. There is a variant called &(ldapm)&
6760 that permits values from multiple entries to be returned. A third variant
6761 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6762 any attribute values. See section &<<SECTldap>>&.
6763 .next
6764 .cindex "MySQL" "lookup type"
6765 .cindex "lookup" "MySQL"
6766 &(mysql)&: The format of the query is an SQL statement that is passed to a
6767 MySQL database. See section &<<SECTsql>>&.
6768 .next
6769 .cindex "NIS+ lookup type"
6770 .cindex "lookup" "NIS+"
6771 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6772 the field to be returned. See section &<<SECTnisplus>>&.
6773 .next
6774 .cindex "Oracle" "lookup type"
6775 .cindex "lookup" "Oracle"
6776 &(oracle)&: The format of the query is an SQL statement that is passed to an
6777 Oracle database. See section &<<SECTsql>>&.
6778 .next
6779 .cindex "lookup" "passwd"
6780 .cindex "passwd lookup type"
6781 .cindex "&_/etc/passwd_&"
6782 &(passwd)& is a query-style lookup with queries that are just user names. The
6783 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6784 success, the result string is the same as you would get from an &(lsearch)&
6785 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6786 password value. For example:
6787 .code
6788 *:42:42:King Rat:/home/kr:/bin/bash
6789 .endd
6790 .next
6791 .cindex "PostgreSQL lookup type"
6792 .cindex "lookup" "PostgreSQL"
6793 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6794 PostgreSQL database. See section &<<SECTsql>>&.
6795
6796 .next
6797 .cindex "Redis lookup type"
6798 .cindex lookup Redis
6799 &(redis)&: The format of the query is either a simple get or simple set,
6800 passed to a Redis database. See section &<<SECTsql>>&.
6801
6802 .next
6803 .cindex "sqlite lookup type"
6804 .cindex "lookup" "sqlite"
6805 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6806 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6807
6808 .next
6809 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6810 not likely to be useful in normal operation.
6811 .next
6812 .cindex "whoson lookup type"
6813 .cindex "lookup" "whoson"
6814 . --- still http:-only, 2018-09-07
6815 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6816 allows a server to check whether a particular (dynamically allocated) IP
6817 address is currently allocated to a known (trusted) user and, optionally, to
6818 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6819 at one time for &"POP before SMTP"& authentication, but that approach has been
6820 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6821 &"POP before SMTP"& checking using ACL statements such as
6822 .code
6823 require condition = \
6824   ${lookup whoson {$sender_host_address}{yes}{no}}
6825 .endd
6826 The query consists of a single IP address. The value returned is the name of
6827 the authenticated user, which is stored in the variable &$value$&. However, in
6828 this example, the data in &$value$& is not used; the result of the lookup is
6829 one of the fixed strings &"yes"& or &"no"&.
6830 .endlist
6831
6832
6833
6834 .section "Temporary errors in lookups" "SECID63"
6835 .cindex "lookup" "temporary error in"
6836 Lookup functions can return temporary error codes if the lookup cannot be
6837 completed. For example, an SQL or LDAP database might be unavailable. For this
6838 reason, it is not advisable to use a lookup that might do this for critical
6839 options such as a list of local domains.
6840
6841 When a lookup cannot be completed in a router or transport, delivery
6842 of the message (to the relevant address) is deferred, as for any other
6843 temporary error. In other circumstances Exim may assume the lookup has failed,
6844 or may give up altogether.
6845
6846
6847
6848 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6849 .cindex "wildcard lookups"
6850 .cindex "lookup" "default values"
6851 .cindex "lookup" "wildcard"
6852 .cindex "lookup" "* added to type"
6853 .cindex "default" "in single-key lookups"
6854 In this context, a &"default value"& is a value specified by the administrator
6855 that is to be used if a lookup fails.
6856
6857 &*Note:*& This section applies only to single-key lookups. For query-style
6858 lookups, the facilities of the query language must be used. An attempt to
6859 specify a default for a query-style lookup provokes an error.
6860
6861 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6862 and the initial lookup fails, the key &"*"& is looked up in the file to
6863 provide a default value. See also the section on partial matching below.
6864
6865 .cindex "*@ with single-key lookup"
6866 .cindex "lookup" "*@ added to type"
6867 .cindex "alias file" "per-domain default"
6868 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6869 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6870 character, a second lookup is done with everything before the last @ replaced
6871 by *. This makes it possible to provide per-domain defaults in alias files
6872 that include the domains in the keys. If the second lookup fails (or doesn't
6873 take place because there is no @ in the key), &"*"& is looked up.
6874 For example, a &(redirect)& router might contain:
6875 .code
6876 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6877 .endd
6878 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6879 looks up these keys, in this order:
6880 .code
6881 jane@eyre.example
6882 *@eyre.example
6883 *
6884 .endd
6885 The data is taken from whichever key it finds first. &*Note*&: In an
6886 &(lsearch)& file, this does not mean the first of these keys in the file. A
6887 complete scan is done for each key, and only if it is not found at all does
6888 Exim move on to try the next key.
6889
6890
6891
6892 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6893 .cindex "partial matching"
6894 .cindex "wildcard lookups"
6895 .cindex "lookup" "partial matching"
6896 .cindex "lookup" "wildcard"
6897 .cindex "asterisk" "in search type"
6898 The normal operation of a single-key lookup is to search the file for an exact
6899 match with the given key. However, in a number of situations where domains are
6900 being looked up, it is useful to be able to do partial matching. In this case,
6901 information in the file that has a key starting with &"*."& is matched by any
6902 domain that ends with the components that follow the full stop. For example, if
6903 a key in a DBM file is
6904 .code
6905 *.dates.fict.example
6906 .endd
6907 then when partial matching is enabled this is matched by (amongst others)
6908 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6909 by &'dates.fict.example'&, if that does not appear as a separate key in the
6910 file.
6911
6912 &*Note*&: Partial matching is not available for query-style lookups. It is
6913 also not available for any lookup items in address lists (see section
6914 &<<SECTaddresslist>>&).
6915
6916 Partial matching is implemented by doing a series of separate lookups using
6917 keys constructed by modifying the original subject key. This means that it can
6918 be used with any of the single-key lookup types, provided that
6919 partial matching keys
6920 beginning with a special prefix (default &"*."&) are included in the data file.
6921 Keys in the file that do not begin with the prefix are matched only by
6922 unmodified subject keys when partial matching is in use.
6923
6924 Partial matching is requested by adding the string &"partial-"& to the front of
6925 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6926 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6927 is added at the start of the subject key, and it is looked up again. If that
6928 fails, further lookups are tried with dot-separated components removed from the
6929 start of the subject key, one-by-one, and &"*."& added on the front of what
6930 remains.
6931
6932 A minimum number of two non-* components are required. This can be adjusted
6933 by including a number before the hyphen in the search type. For example,
6934 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6935 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6936 subject key is &'2250.dates.fict.example'& then the following keys are looked
6937 up when the minimum number of non-* components is two:
6938 .code
6939 2250.dates.fict.example
6940 *.2250.dates.fict.example
6941 *.dates.fict.example
6942 *.fict.example
6943 .endd
6944 As soon as one key in the sequence is successfully looked up, the lookup
6945 finishes.
6946
6947 .cindex "lookup" "partial matching &-- changing prefix"
6948 .cindex "prefix" "for partial matching"
6949 The use of &"*."& as the partial matching prefix is a default that can be
6950 changed. The motivation for this feature is to allow Exim to operate with file
6951 formats that are used by other MTAs. A different prefix can be supplied in
6952 parentheses instead of the hyphen after &"partial"&. For example:
6953 .code
6954 domains = partial(.)lsearch;/some/file
6955 .endd
6956 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6957 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6958 components is unchanged). The prefix may consist of any punctuation characters
6959 other than a closing parenthesis. It may be empty, for example:
6960 .code
6961 domains = partial1()cdb;/some/file
6962 .endd
6963 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6964 &`a.b.c`&, &`b.c`&, and &`c`&.
6965
6966 If &"partial0"& is specified, what happens at the end (when the lookup with
6967 just one non-wild component has failed, and the original key is shortened right
6968 down to the null string) depends on the prefix:
6969
6970 .ilist
6971 If the prefix has zero length, the whole lookup fails.
6972 .next
6973 If the prefix has length 1, a lookup for just the prefix is done. For
6974 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6975 .next
6976 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6977 remainder is looked up. With the default prefix, therefore, the final lookup is
6978 for &"*"& on its own.
6979 .next
6980 Otherwise, the whole prefix is looked up.
6981 .endlist
6982
6983
6984 If the search type ends in &"*"& or &"*@"& (see section
6985 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6986 this implies happens after all partial lookups have failed. If &"partial0"& is
6987 specified, adding &"*"& to the search type has no effect with the default
6988 prefix, because the &"*"& key is already included in the sequence of partial
6989 lookups. However, there might be a use for lookup types such as
6990 &"partial0(.)lsearch*"&.
6991
6992 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6993 in domain lists and the like. Partial matching works only in terms of
6994 dot-separated components; a key such as &`*fict.example`&
6995 in a database file is useless, because the asterisk in a partial matching
6996 subject key is always followed by a dot.
6997
6998
6999
7000
7001 .section "Lookup caching" "SECID64"
7002 .cindex "lookup" "caching"
7003 .cindex "caching" "lookup data"
7004 Exim caches all lookup results in order to avoid needless repetition of
7005 lookups. However, because (apart from the daemon) Exim operates as a collection
7006 of independent, short-lived processes, this caching applies only within a
7007 single Exim process. There is no inter-process lookup caching facility.
7008
7009 For single-key lookups, Exim keeps the relevant files open in case there is
7010 another lookup that needs them. In some types of configuration this can lead to
7011 many files being kept open for messages with many recipients. To avoid hitting
7012 the operating system limit on the number of simultaneously open files, Exim
7013 closes the least recently used file when it needs to open more files than its
7014 own internal limit, which can be changed via the &%lookup_open_max%& option.
7015
7016 The single-key lookup files are closed and the lookup caches are flushed at
7017 strategic points during delivery &-- for example, after all routing is
7018 complete.
7019
7020
7021
7022
7023 .section "Quoting lookup data" "SECID65"
7024 .cindex "lookup" "quoting"
7025 .cindex "quoting" "in lookups"
7026 When data from an incoming message is included in a query-style lookup, there
7027 is the possibility of special characters in the data messing up the syntax of
7028 the query. For example, a NIS+ query that contains
7029 .code
7030 [name=$local_part]
7031 .endd
7032 will be broken if the local part happens to contain a closing square bracket.
7033 For NIS+, data can be enclosed in double quotes like this:
7034 .code
7035 [name="$local_part"]
7036 .endd
7037 but this still leaves the problem of a double quote in the data. The rule for
7038 NIS+ is that double quotes must be doubled. Other lookup types have different
7039 rules, and to cope with the differing requirements, an expansion operator
7040 of the following form is provided:
7041 .code
7042 ${quote_<lookup-type>:<string>}
7043 .endd
7044 For example, the safest way to write the NIS+ query is
7045 .code
7046 [name="${quote_nisplus:$local_part}"]
7047 .endd
7048 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7049 operator can be used for all lookup types, but has no effect for single-key
7050 lookups, since no quoting is ever needed in their key strings.
7051
7052
7053
7054
7055 .section "More about dnsdb" "SECTdnsdb"
7056 .cindex "dnsdb lookup"
7057 .cindex "lookup" "dnsdb"
7058 .cindex "DNS" "as a lookup type"
7059 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7060 of a record type and a domain name, separated by an equals sign. For example,
7061 an expansion string could contain:
7062 .code
7063 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7064 .endd
7065 If the lookup succeeds, the result is placed in &$value$&, which in this case
7066 is used on its own as the result. If the lookup does not succeed, the
7067 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7068 &<<SECTforexpfai>>& for an explanation of what this means.
7069
7070 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7071 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7072 If no type is given, TXT is assumed.
7073
7074 For any record type, if multiple records are found, the data is returned as a
7075 concatenation, with newline as the default separator. The order, of course,
7076 depends on the DNS resolver. You can specify a different separator character
7077 between multiple records by putting a right angle-bracket followed immediately
7078 by the new separator at the start of the query. For example:
7079 .code
7080 ${lookup dnsdb{>: a=host1.example}}
7081 .endd
7082 It is permitted to specify a space as the separator character. Further
7083 white space is ignored.
7084 For lookup types that return multiple fields per record,
7085 an alternate field separator can be specified using a comma after the main
7086 separator character, followed immediately by the field separator.
7087
7088 .cindex "PTR record" "in &(dnsdb)& lookup"
7089 When the type is PTR,
7090 the data can be an IP address, written as normal; inversion and the addition of
7091 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7092 .code
7093 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7094 .endd
7095 If the data for a PTR record is not a syntactically valid IP address, it is not
7096 altered and nothing is added.
7097
7098 .cindex "MX record" "in &(dnsdb)& lookup"
7099 .cindex "SRV record" "in &(dnsdb)& lookup"
7100 For an MX lookup, both the preference value and the host name are returned for
7101 each record, separated by a space. For an SRV lookup, the priority, weight,
7102 port, and host name are returned for each record, separated by spaces.
7103 The field separator can be modified as above.
7104
7105 .cindex "TXT record" "in &(dnsdb)& lookup"
7106 .cindex "SPF record" "in &(dnsdb)& lookup"
7107 For TXT records with multiple items of data, only the first item is returned,
7108 unless a field separator is specified.
7109 To concatenate items without a separator, use a semicolon instead.
7110 For SPF records the
7111 default behaviour is to concatenate multiple items without using a separator.
7112 .code
7113 ${lookup dnsdb{>\n,: txt=a.b.example}}
7114 ${lookup dnsdb{>\n; txt=a.b.example}}
7115 ${lookup dnsdb{spf=example.org}}
7116 .endd
7117 It is permitted to specify a space as the separator character. Further
7118 white space is ignored.
7119
7120 .cindex "SOA record" "in &(dnsdb)& lookup"
7121 For an SOA lookup, while no result is obtained the lookup is redone with
7122 successively more leading components dropped from the given domain.
7123 Only the primary-nameserver field is returned unless a field separator is
7124 specified.
7125 .code
7126 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7127 .endd
7128
7129 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7130 .cindex "dnsdb modifiers"
7131 .cindex "modifiers" "dnsdb"
7132 .cindex "options" "dnsdb"
7133 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7134 each followed by a comma,
7135 that may appear before the record type.
7136
7137 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7138 temporary DNS error for any of them, the behaviour is controlled by
7139 a defer-option modifier.
7140 The possible keywords are
7141 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7142 With &"strict"& behaviour, any temporary DNS error causes the
7143 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7144 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7145 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7146 error causes the whole lookup to defer only if none of the other lookups
7147 succeed. The default is &"lax"&, so the following lookups are equivalent:
7148 .code
7149 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7150 ${lookup dnsdb{a=one.host.com:two.host.com}}
7151 .endd
7152 Thus, in the default case, as long as at least one of the DNS lookups
7153 yields some data, the lookup succeeds.
7154
7155 .cindex "DNSSEC" "dns lookup"
7156 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7157 The possible keywords are
7158 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7159 With &"strict"& or &"lax"& DNSSEC information is requested
7160 with the lookup.
7161 With &"strict"& a response from the DNS resolver that
7162 is not labelled as authenticated data
7163 is treated as equivalent to a temporary DNS error.
7164 The default is &"never"&.
7165
7166 See also the &$lookup_dnssec_authenticated$& variable.
7167
7168 .cindex timeout "dns lookup"
7169 .cindex "DNS" timeout
7170 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7171 The form is &"retrans_VAL"& where VAL is an Exim time specification
7172 (e.g. &"5s"&).
7173 The default value is set by the main configuration option &%dns_retrans%&.
7174
7175 Retries for the dnsdb lookup can be controlled by a retry modifier.
7176 The form if &"retry_VAL"& where VAL is an integer.
7177 The default count is set by the main configuration option &%dns_retry%&.
7178
7179 .cindex caching "of dns lookup"
7180 .cindex TTL "of dns lookup"
7181 .cindex DNS TTL
7182 Dnsdb lookup results are cached within a single process (and its children).
7183 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7184 value of the set of returned DNS records.
7185
7186
7187 .section "Pseudo dnsdb record types" "SECID66"
7188 .cindex "MX record" "in &(dnsdb)& lookup"
7189 By default, both the preference value and the host name are returned for
7190 each MX record, separated by a space. If you want only host names, you can use
7191 the pseudo-type MXH:
7192 .code
7193 ${lookup dnsdb{mxh=a.b.example}}
7194 .endd
7195 In this case, the preference values are omitted, and just the host names are
7196 returned.
7197
7198 .cindex "name server for enclosing domain"
7199 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7200 records on the given domain, but if none are found, it removes the first
7201 component of the domain name, and tries again. This process continues until NS
7202 records are found or there are no more components left (or there is a DNS
7203 error). In other words, it may return the name servers for a top-level domain,
7204 but it never returns the root name servers. If there are no NS records for the
7205 top-level domain, the lookup fails. Consider these examples:
7206 .code
7207 ${lookup dnsdb{zns=xxx.quercite.com}}
7208 ${lookup dnsdb{zns=xxx.edu}}
7209 .endd
7210 Assuming that in each case there are no NS records for the full domain name,
7211 the first returns the name servers for &%quercite.com%&, and the second returns
7212 the name servers for &%edu%&.
7213
7214 You should be careful about how you use this lookup because, unless the
7215 top-level domain does not exist, the lookup always returns some host names. The
7216 sort of use to which this might be put is for seeing if the name servers for a
7217 given domain are on a blacklist. You can probably assume that the name servers
7218 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7219 such a list.
7220
7221 .cindex "CSA" "in &(dnsdb)& lookup"
7222 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7223 records according to the CSA rules, which are described in section
7224 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7225 not sufficient because of the extra parent domain search behaviour of CSA. The
7226 result of a successful lookup such as:
7227 .code
7228 ${lookup dnsdb {csa=$sender_helo_name}}
7229 .endd
7230 has two space-separated fields: an authorization code and a target host name.
7231 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7232 authorization required but absent, or &"?"& for unknown.
7233
7234 .cindex "A+" "in &(dnsdb)& lookup"
7235 The pseudo-type A+ performs an AAAA
7236 and then an A lookup.  All results are returned; defer processing
7237 (see below) is handled separately for each lookup.  Example:
7238 .code
7239 ${lookup dnsdb {>; a+=$sender_helo_name}}
7240 .endd
7241
7242
7243 .section "Multiple dnsdb lookups" "SECID67"
7244 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7245 However, you can specify a list of domains or IP addresses in a single
7246 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7247 the default separator, but with the ability to change this. For example:
7248 .code
7249 ${lookup dnsdb{one.domain.com:two.domain.com}}
7250 ${lookup dnsdb{a=one.host.com:two.host.com}}
7251 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7252 .endd
7253 In order to retain backwards compatibility, there is one special case: if
7254 the lookup type is PTR and no change of separator is specified, Exim looks
7255 to see if the rest of the string is precisely one IPv6 address. In this
7256 case, it does not treat it as a list.
7257
7258 The data from each lookup is concatenated, with newline separators by default,
7259 in the same way that multiple DNS records for a single item are handled. A
7260 different separator can be specified, as described above.
7261
7262
7263
7264
7265 .section "More about LDAP" "SECTldap"
7266 .cindex "LDAP" "lookup, more about"
7267 .cindex "lookup" "LDAP"
7268 .cindex "Solaris" "LDAP"
7269 The original LDAP implementation came from the University of Michigan; this has
7270 become &"Open LDAP"&, and there are now two different releases. Another
7271 implementation comes from Netscape, and Solaris 7 and subsequent releases
7272 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7273 the lookup function level, their error handling is different. For this reason
7274 it is necessary to set a compile-time variable when building Exim with LDAP, to
7275 indicate which LDAP library is in use. One of the following should appear in
7276 your &_Local/Makefile_&:
7277 .code
7278 LDAP_LIB_TYPE=UMICHIGAN
7279 LDAP_LIB_TYPE=OPENLDAP1
7280 LDAP_LIB_TYPE=OPENLDAP2
7281 LDAP_LIB_TYPE=NETSCAPE
7282 LDAP_LIB_TYPE=SOLARIS
7283 .endd
7284 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7285 same interface as the University of Michigan version.
7286
7287 There are three LDAP lookup types in Exim. These behave slightly differently in
7288 the way they handle the results of a query:
7289
7290 .ilist
7291 &(ldap)& requires the result to contain just one entry; if there are more, it
7292 gives an error.
7293 .next
7294 &(ldapdn)& also requires the result to contain just one entry, but it is the
7295 Distinguished Name that is returned rather than any attribute values.
7296 .next
7297 &(ldapm)& permits the result to contain more than one entry; the attributes
7298 from all of them are returned.
7299 .endlist
7300
7301
7302 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7303 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7304 the data returned by a successful lookup is described in the next section.
7305 First we explain how LDAP queries are coded.
7306
7307
7308 .section "Format of LDAP queries" "SECTforldaque"
7309 .cindex "LDAP" "query format"
7310 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7311 the configuration of a &(redirect)& router one might have this setting:
7312 .code
7313 data = ${lookup ldap \
7314   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7315   c=UK?mailbox?base?}}
7316 .endd
7317 .cindex "LDAP" "with TLS"
7318 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7319 secure (encrypted) LDAP connections. The second of these ensures that an
7320 encrypted TLS connection is used.
7321
7322 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7323 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7324 See the &%ldap_start_tls%& option.
7325
7326 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7327 controlled. Every part of the TLS configuration can be configured by settings in
7328 &_exim.conf_&. Depending on the version of the client libraries installed on
7329 your system, some of the initialization may have required setting options in
7330 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7331 certificates. This revealed a nuance where the current UID that exim was
7332 running as could affect which config files it read. With Exim 4.83, these
7333 methods become optional, only taking effect if not specifically set in
7334 &_exim.conf_&.
7335
7336
7337 .section "LDAP quoting" "SECID68"
7338 .cindex "LDAP" "quoting"
7339 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7340 and the second because the LDAP query is represented as a URL. Furthermore,
7341 within an LDAP query, two different kinds of quoting are required. For this
7342 reason, there are two different LDAP-specific quoting operators.
7343
7344 The &%quote_ldap%& operator is designed for use on strings that are part of
7345 filter specifications. Conceptually, it first does the following conversions on
7346 the string:
7347 .code
7348 *   =>   \2A
7349 (   =>   \28
7350 )   =>   \29
7351 \   =>   \5C
7352 .endd
7353 in accordance with RFC 2254. The resulting string is then quoted according
7354 to the rules for URLs, that is, all non-alphanumeric characters except
7355 .code
7356 ! $ ' - . _ ( ) * +
7357 .endd
7358 are converted to their hex values, preceded by a percent sign. For example:
7359 .code
7360 ${quote_ldap: a(bc)*, a<yz>; }
7361 .endd
7362 yields
7363 .code
7364 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7365 .endd
7366 Removing the URL quoting, this is (with a leading and a trailing space):
7367 .code
7368 a\28bc\29\2A, a<yz>;
7369 .endd
7370 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7371 base DN specifications in queries. Conceptually, it first converts the string
7372 by inserting a backslash in front of any of the following characters:
7373 .code
7374 , + " \ < > ;
7375 .endd
7376 It also inserts a backslash before any leading spaces or # characters, and
7377 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7378 is then quoted according to the rules for URLs. For example:
7379 .code
7380 ${quote_ldap_dn: a(bc)*, a<yz>; }
7381 .endd
7382 yields
7383 .code
7384 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7385 .endd
7386 Removing the URL quoting, this is (with a trailing space):
7387 .code
7388 \ a(bc)*\, a\<yz\>\;\
7389 .endd
7390 There are some further comments about quoting in the section on LDAP
7391 authentication below.
7392
7393
7394 .section "LDAP connections" "SECID69"
7395 .cindex "LDAP" "connections"
7396 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7397 is in use, via a Unix domain socket. The example given above does not specify
7398 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7399 by starting it with
7400 .code
7401 ldap://<hostname>:<port>/...
7402 .endd
7403 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7404 used. When no server is specified in a query, a list of default servers is
7405 taken from the &%ldap_default_servers%& configuration option. This supplies a
7406 colon-separated list of servers which are tried in turn until one successfully
7407 handles a query, or there is a serious error. Successful handling either
7408 returns the requested data, or indicates that it does not exist. Serious errors
7409 are syntactical, or multiple values when only a single value is expected.
7410 Errors which cause the next server to be tried are connection failures, bind
7411 failures, and timeouts.
7412
7413 For each server name in the list, a port number can be given. The standard way
7414 of specifying a host and port is to use a colon separator (RFC 1738). Because
7415 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7416 doubled. For example
7417 .code
7418 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7419 .endd
7420 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7421 to the LDAP library with no server name, and the library's default (normally
7422 the local host) is used.
7423
7424 If you are using the OpenLDAP library, you can connect to an LDAP server using
7425 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7426 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7427 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7428 not available.
7429
7430 For this type of connection, instead of a host name for the server, a pathname
7431 for the socket is required, and the port number is not relevant. The pathname
7432 can be specified either as an item in &%ldap_default_servers%&, or inline in
7433 the query. In the former case, you can have settings such as
7434 .code
7435 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7436 .endd
7437 When the pathname is given in the query, you have to escape the slashes as
7438 &`%2F`& to fit in with the LDAP URL syntax. For example:
7439 .code
7440 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7441 .endd
7442 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7443 a pathname, it uses the Unix domain socket code, even if the query actually
7444 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7445 socket connection. This behaviour means that you can use a setting of
7446 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7447 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7448 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7449 backup host.
7450
7451 If an explicit &`ldapi`& type is given in a query when a host name is
7452 specified, an error is diagnosed. However, if there are more items in
7453 &%ldap_default_servers%&, they are tried. In other words:
7454
7455 .ilist
7456 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7457 interface.
7458 .next
7459 Using &`ldapi`& with a host name causes an error.
7460 .endlist
7461
7462
7463 Using &`ldapi`& with no host or path in the query, and no setting of
7464 &%ldap_default_servers%&, does whatever the library does by default.
7465
7466
7467
7468 .section "LDAP authentication and control information" "SECID70"
7469 .cindex "LDAP" "authentication"
7470 The LDAP URL syntax provides no way of passing authentication and other control
7471 information to the server. To make this possible, the URL in an LDAP query may
7472 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7473 spaces. If a value contains spaces it must be enclosed in double quotes, and
7474 when double quotes are used, backslash is interpreted in the usual way inside
7475 them. The following names are recognized:
7476 .display
7477 &`DEREFERENCE`&  set the dereferencing parameter
7478 &`NETTIME    `&  set a timeout for a network operation
7479 &`USER       `&  set the DN, for authenticating the LDAP bind
7480 &`PASS       `&  set the password, likewise
7481 &`REFERRALS  `&  set the referrals parameter
7482 &`SERVERS    `&  set alternate server list for this query only
7483 &`SIZE       `&  set the limit for the number of entries returned
7484 &`TIME       `&  set the maximum waiting time for a query
7485 .endd
7486 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7487 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7488 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7489 library from trying to follow referrals issued by the LDAP server.
7490
7491 .cindex LDAP timeout
7492 .cindex timeout "LDAP lookup"
7493 The name CONNECT is an obsolete name for NETTIME, retained for
7494 backwards compatibility. This timeout (specified as a number of seconds) is
7495 enforced from the client end for operations that can be carried out over a
7496 network. Specifically, it applies to network connections and calls to the
7497 &'ldap_result()'& function. If the value is greater than zero, it is used if
7498 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7499 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7500 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7501 Netscape SDK; for OpenLDAP no action is taken.
7502
7503 The TIME parameter (also a number of seconds) is passed to the server to
7504 set a server-side limit on the time taken to complete a search.
7505
7506 The SERVERS parameter allows you to specify an alternate list of ldap servers
7507 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7508 default list of ldap servers, and a single lookup can specify a single ldap
7509 server to use.  But when you need to do a lookup with a list of servers that is
7510 different than the default list (maybe different order, maybe a completely
7511 different set of servers), the SERVERS parameter allows you to specify this
7512 alternate list (colon-separated).
7513
7514 Here is an example of an LDAP query in an Exim lookup that uses some of these
7515 values. This is a single line, folded to fit on the page:
7516 .code
7517 ${lookup ldap
7518   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7519   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7520   {$value}fail}
7521 .endd
7522 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7523 any of the auxiliary data. Exim configuration settings that include lookups
7524 which contain password information should be preceded by &"hide"& to prevent
7525 non-admin users from using the &%-bP%& option to see their values.
7526
7527 The auxiliary data items may be given in any order. The default is no
7528 connection timeout (the system timeout is used), no user or password, no limit
7529 on the number of entries returned, and no time limit on queries.
7530
7531 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7532 removes any URL quoting that it may contain before passing it LDAP. Apparently
7533 some libraries do this for themselves, but some do not. Removing the URL
7534 quoting has two advantages:
7535
7536 .ilist
7537 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7538 DNs as with DNs inside actual queries.
7539 .next
7540 It permits spaces inside USER= DNs.
7541 .endlist
7542
7543 For example, a setting such as
7544 .code
7545 USER=cn=${quote_ldap_dn:$1}
7546 .endd
7547 should work even if &$1$& contains spaces.
7548
7549 Expanded data for the PASS= value should be quoted using the &%quote%&
7550 expansion operator, rather than the LDAP quote operators. The only reason this
7551 field needs quoting is to ensure that it conforms to the Exim syntax, which
7552 does not allow unquoted spaces. For example:
7553 .code
7554 PASS=${quote:$3}
7555 .endd
7556 The LDAP authentication mechanism can be used to check passwords as part of
7557 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7558 &<<CHAPexpand>>&.
7559
7560
7561
7562 .section "Format of data returned by LDAP" "SECID71"
7563 .cindex "LDAP" "returned data formats"
7564 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7565 as a sequence of values, for example
7566 .code
7567 cn=manager,o=University of Cambridge,c=UK
7568 .endd
7569 The &(ldap)& lookup type generates an error if more than one entry matches the
7570 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7571 the result between the data from different entries. It is possible for multiple
7572 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7573 you know that whatever values are returned all came from a single entry in the
7574 directory.
7575
7576 In the common case where you specify a single attribute in your LDAP query, the
7577 result is not quoted, and does not contain the attribute name. If the attribute
7578 has multiple values, they are separated by commas. Any comma that is
7579 part of an attribute's value is doubled.
7580
7581 If you specify multiple attributes, the result contains space-separated, quoted
7582 strings, each preceded by the attribute name and an equals sign. Within the
7583 quotes, the quote character, backslash, and newline are escaped with
7584 backslashes, and commas are used to separate multiple values for the attribute.
7585 Any commas in attribute values are doubled
7586 (permitting treatment of the values as a comma-separated list).
7587 Apart from the escaping, the string within quotes takes the same form as the
7588 output when a single attribute is requested. Specifying no attributes is the
7589 same as specifying all of an entry's attributes.
7590
7591 Here are some examples of the output format. The first line of each pair is an
7592 LDAP query, and the second is the data that is returned. The attribute called
7593 &%attr1%& has two values, one of them with an embedded comma, whereas
7594 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7595 (they have SUP &%attr%& in their schema definitions).
7596
7597 .code
7598 ldap:///o=base?attr1?sub?(uid=fred)
7599 value1.1,value1,,2
7600
7601 ldap:///o=base?attr2?sub?(uid=fred)
7602 value two
7603
7604 ldap:///o=base?attr?sub?(uid=fred)
7605 value1.1,value1,,2,value two
7606
7607 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7608 attr1="value1.1,value1,,2" attr2="value two"
7609
7610 ldap:///o=base??sub?(uid=fred)
7611 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7612 .endd
7613 You can
7614 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7615 results of LDAP lookups.
7616 The &%extract%& operator in string expansions can be used to pick out
7617 individual fields from data that consists of &'key'&=&'value'& pairs.
7618 The &%listextract%& operator should be used to pick out individual values
7619 of attributes, even when only a single value is expected.
7620 The doubling of embedded commas allows you to use the returned data as a
7621 comma separated list (using the "<," syntax for changing the input list separator).
7622
7623
7624
7625
7626 .section "More about NIS+" "SECTnisplus"
7627 .cindex "NIS+ lookup type"
7628 .cindex "lookup" "NIS+"
7629 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7630 and field name. If this is given, the result of a successful query is the
7631 contents of the named field; otherwise the result consists of a concatenation
7632 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7633 values containing spaces are quoted. For example, the query
7634 .code
7635 [name=mg1456],passwd.org_dir
7636 .endd
7637 might return the string
7638 .code
7639 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7640 home=/home/mg1456 shell=/bin/bash shadow=""
7641 .endd
7642 (split over two lines here to fit on the page), whereas
7643 .code
7644 [name=mg1456],passwd.org_dir:gcos
7645 .endd
7646 would just return
7647 .code
7648 Martin Guerre
7649 .endd
7650 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7651 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7652 operator is to double any quote characters within the text.
7653
7654
7655
7656 .section "SQL lookups" "SECTsql"
7657 .cindex "SQL lookup types"
7658 .cindex "MySQL" "lookup type"
7659 .cindex "PostgreSQL lookup type"
7660 .cindex "lookup" "MySQL"
7661 .cindex "lookup" "PostgreSQL"
7662 .cindex "Oracle" "lookup type"
7663 .cindex "lookup" "Oracle"
7664 .cindex "InterBase lookup type"
7665 .cindex "lookup" "InterBase"
7666 .cindex "Redis lookup type"
7667 .cindex lookup Redis
7668 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7669 and SQLite
7670 databases. Queries for these databases contain SQL statements, so an example
7671 might be
7672 .code
7673 ${lookup mysql{select mailbox from users where id='userx'}\
7674   {$value}fail}
7675 .endd
7676 If the result of the query contains more than one field, the data for each
7677 field in the row is returned, preceded by its name, so the result of
7678 .code
7679 ${lookup pgsql{select home,name from users where id='userx'}\
7680   {$value}}
7681 .endd
7682 might be
7683 .code
7684 home=/home/userx name="Mister X"
7685 .endd
7686 Empty values and values containing spaces are double quoted, with embedded
7687 quotes escaped by a backslash. If the result of the query contains just one
7688 field, the value is passed back verbatim, without a field name, for example:
7689 .code
7690 Mister X
7691 .endd
7692 If the result of the query yields more than one row, it is all concatenated,
7693 with a newline between the data for each row.
7694
7695
7696 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7697 .cindex "MySQL" "lookup type"
7698 .cindex "PostgreSQL lookup type"
7699 .cindex "lookup" "MySQL"
7700 .cindex "lookup" "PostgreSQL"
7701 .cindex "Oracle" "lookup type"
7702 .cindex "lookup" "Oracle"
7703 .cindex "InterBase lookup type"
7704 .cindex "lookup" "InterBase"
7705 .cindex "Redis lookup type"
7706 .cindex lookup Redis
7707 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7708 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7709 or &%redis_servers%&
7710 option (as appropriate) must be set to a colon-separated list of server
7711 information.
7712 (For MySQL and PostgreSQL, the global option need not be set if all
7713 queries contain their own server information &-- see section
7714 &<<SECTspeserque>>&.)
7715 For all but Redis
7716 each item in the list is a slash-separated list of four
7717 items: host name, database name, user name, and password. In the case of
7718 Oracle, the host name field is used for the &"service name"&, and the database
7719 name field is not used and should be empty. For example:
7720 .code
7721 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7722 .endd
7723 Because password data is sensitive, you should always precede the setting with
7724 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7725 option. Here is an example where two MySQL servers are listed:
7726 .code
7727 hide mysql_servers = localhost/users/root/secret:\
7728                      otherhost/users/root/othersecret
7729 .endd
7730 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7731 because this is a colon-separated list, the colon has to be doubled. For each
7732 query, these parameter groups are tried in order until a connection is made and
7733 a query is successfully processed. The result of a query may be that no data is
7734 found, but that is still a successful query. In other words, the list of
7735 servers provides a backup facility, not a list of different places to look.
7736
7737 For Redis the global option need not be specified if all queries contain their
7738 own server information &-- see section &<<SECTspeserque>>&.
7739 If specified, the option must be set to a colon-separated list of server
7740 information.
7741 Each item in the list is a slash-separated list of three items:
7742 host, database number, and password.
7743 .olist
7744 The host is required and may be either an IPv4 address and optional
7745 port number (separated by a colon, which needs doubling due to the
7746 higher-level list), or a Unix socket pathname enclosed in parentheses
7747 .next
7748 The database number is optional; if present that number is selected in the backend
7749 .next
7750 The password is optional; if present it is used to authenticate to the backend
7751 .endlist
7752
7753 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7754 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7755 respectively, and the characters single-quote, double-quote, and backslash
7756 itself are escaped with backslashes.
7757
7758 The &%quote_redis%& expansion operator
7759 escapes whitespace and backslash characters with a backslash.
7760
7761 .section "Specifying the server in the query" "SECTspeserque"
7762 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7763 it is possible to specify a list of servers with an individual query. This is
7764 done by starting the query with
7765 .display
7766 &`servers=`&&'server1:server2:server3:...'&&`;`&
7767 .endd
7768 Each item in the list may take one of two forms:
7769 .olist
7770 If it contains no slashes it is assumed to be just a host name. The appropriate
7771 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7772 of the same name, and the remaining parameters (database, user, password) are
7773 taken from there.
7774 .next
7775 If it contains any slashes, it is taken as a complete parameter set.
7776 .endlist
7777 The list of servers is used in exactly the same way as the global list.
7778 Once a connection to a server has happened and a query has been
7779 successfully executed, processing of the lookup ceases.
7780
7781 This feature is intended for use in master/slave situations where updates
7782 are occurring and you want to update the master rather than a slave. If the
7783 master is in the list as a backup for reading, you might have a global setting
7784 like this:
7785 .code
7786 mysql_servers = slave1/db/name/pw:\
7787                 slave2/db/name/pw:\
7788                 master/db/name/pw
7789 .endd
7790 In an updating lookup, you could then write:
7791 .code
7792 ${lookup mysql{servers=master; UPDATE ...} }
7793 .endd
7794 That query would then be sent only to the master server. If, on the other hand,
7795 the master is not to be used for reading, and so is not present in the global
7796 option, you can still update it by a query of this form:
7797 .code
7798 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7799 .endd
7800
7801
7802 .section "Special MySQL features" "SECID73"
7803 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7804 causes a connection to the server on the local host by means of a Unix domain
7805 socket. An alternate socket can be specified in parentheses.
7806 An option group name for MySQL option files can be specified in square brackets;
7807 the default value is &"exim"&.
7808 The full syntax of each item in &%mysql_servers%& is:
7809 .display
7810 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7811   <&'database'&>/<&'user'&>/<&'password'&>
7812 .endd
7813 Any of the four sub-parts of the first field can be omitted. For normal use on
7814 the local host it can be left blank or set to just &"localhost"&.
7815
7816 No database need be supplied &-- but if it is absent here, it must be given in
7817 the queries.
7818
7819 If a MySQL query is issued that does not request any data (an insert, update,
7820 or delete command), the result of the lookup is the number of rows affected.
7821
7822 &*Warning*&: This can be misleading. If an update does not actually change
7823 anything (for example, setting a field to the value it already has), the result
7824 is zero because no rows are affected.
7825
7826
7827 .section "Special PostgreSQL features" "SECID74"
7828 PostgreSQL lookups can also use Unix domain socket connections to the database.
7829 This is usually faster and costs less CPU time than a TCP/IP connection.
7830 However it can be used only if the mail server runs on the same machine as the
7831 database server. A configuration line for PostgreSQL via Unix domain sockets
7832 looks like this:
7833 .code
7834 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7835 .endd
7836 In other words, instead of supplying a host name, a path to the socket is
7837 given. The path name is enclosed in parentheses so that its slashes aren't
7838 visually confused with the delimiters for the other server parameters.
7839
7840 If a PostgreSQL query is issued that does not request any data (an insert,
7841 update, or delete command), the result of the lookup is the number of rows
7842 affected.
7843
7844 .section "More about SQLite" "SECTsqlite"
7845 .cindex "lookup" "SQLite"
7846 .cindex "sqlite lookup type"
7847 SQLite is different to the other SQL lookups because a file name is required in
7848 addition to the SQL query. An SQLite database is a single file, and there is no
7849 daemon as in the other SQL databases. The interface to Exim requires the name
7850 of the file, as an absolute path, to be given at the start of the query. It is
7851 separated from the query by white space. This means that the path name cannot
7852 contain white space. Here is a lookup expansion example:
7853 .code
7854 ${lookup sqlite {/some/thing/sqlitedb \
7855   select name from aliases where id='userx';}}
7856 .endd
7857 In a list, the syntax is similar. For example:
7858 .code
7859 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7860    select * from relays where ip='$sender_host_address';
7861 .endd
7862 The only character affected by the &%quote_sqlite%& operator is a single
7863 quote, which it doubles.
7864
7865 .cindex timeout SQLite
7866 .cindex sqlite "lookup timeout"
7867 The SQLite library handles multiple simultaneous accesses to the database
7868 internally. Multiple readers are permitted, but only one process can
7869 update at once. Attempts to access the database while it is being updated
7870 are rejected after a timeout period, during which the SQLite library
7871 waits for the lock to be released. In Exim, the default timeout is set
7872 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7873 option.
7874
7875 .section "More about Redis" "SECTredis"
7876 .cindex "lookup" "Redis"
7877 .cindex "redis lookup type"
7878 Redis is a non-SQL database. Commands are simple get and set.
7879 Examples:
7880 .code
7881 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
7882 ${lookup redis{get keyname}}
7883 .endd
7884
7885 As of release 4.91, "lightweight" support for Redis Cluster is available.
7886 Requires &%redis_servers%& list to contain all the servers in the cluster, all
7887 of which must be reachable from the running exim instance. If the cluster has
7888 master/slave replication, the list must contain all the master and slave
7889 servers.
7890
7891 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
7892 immediately follow the redirection but treats the response as a DEFER, moving on
7893 to the next server in the &%redis_servers%& list until the correct server is
7894 reached.
7895
7896 .ecindex IIDfidalo1
7897 .ecindex IIDfidalo2
7898
7899
7900 . ////////////////////////////////////////////////////////////////////////////
7901 . ////////////////////////////////////////////////////////////////////////////
7902
7903 .chapter "Domain, host, address, and local part lists" &&&
7904          "CHAPdomhosaddlists" &&&
7905          "Domain, host, and address lists"
7906 .scindex IIDdohoadli "lists of domains; hosts; etc."
7907 A number of Exim configuration options contain lists of domains, hosts,
7908 email addresses, or local parts. For example, the &%hold_domains%& option
7909 contains a list of domains whose delivery is currently suspended. These lists
7910 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7911 arguments to expansion conditions such as &%match_domain%&.
7912
7913 Each item in one of these lists is a pattern to be matched against a domain,
7914 host, email address, or local part, respectively. In the sections below, the
7915 different types of pattern for each case are described, but first we cover some
7916 general facilities that apply to all four kinds of list.
7917
7918 Note that other parts of Exim use a &'string list'& which does not
7919 support all the complexity available in
7920 domain, host, address and local part lists.
7921
7922
7923
7924 .section "Expansion of lists" "SECTlistexpand"
7925 .cindex "expansion" "of lists"
7926 Each list is expanded as a single string before it is used.
7927
7928 &'Exception: the router headers_remove option, where list-item
7929 splitting is done before string-expansion.'&
7930
7931 The result of
7932 expansion must be a list, possibly containing empty items, which is split up
7933 into separate items for matching. By default, colon is the separator character,
7934 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7935 &<<SECTempitelis>>& for details of the list syntax; the second of these
7936 discusses the way to specify empty list items.
7937
7938
7939 If the string expansion is forced to fail, Exim behaves as if the item it is
7940 testing (domain, host, address, or local part) is not in the list. Other
7941 expansion failures cause temporary errors.
7942
7943 If an item in a list is a regular expression, backslashes, dollars and possibly
7944 other special characters in the expression must be protected against
7945 misinterpretation by the string expander. The easiest way to do this is to use
7946 the &`\N`& expansion feature to indicate that the contents of the regular
7947 expression should not be expanded. For example, in an ACL you might have:
7948 .code
7949 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7950                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7951 .endd
7952 The first item is a regular expression that is protected from expansion by
7953 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7954 senders based on the receiving domain.
7955
7956
7957
7958
7959 .section "Negated items in lists" "SECID76"
7960 .cindex "list" "negation"
7961 .cindex "negation" "in lists"
7962 Items in a list may be positive or negative. Negative items are indicated by a
7963 leading exclamation mark, which may be followed by optional white space. A list
7964 defines a set of items (domains, etc). When Exim processes one of these lists,
7965 it is trying to find out whether a domain, host, address, or local part
7966 (respectively) is in the set that is defined by the list. It works like this:
7967
7968 The list is scanned from left to right. If a positive item is matched, the
7969 subject that is being checked is in the set; if a negative item is matched, the
7970 subject is not in the set. If the end of the list is reached without the
7971 subject having matched any of the patterns, it is in the set if the last item
7972 was a negative one, but not if it was a positive one. For example, the list in
7973 .code
7974 domainlist relay_to_domains = !a.b.c : *.b.c
7975 .endd
7976 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7977 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7978 list is positive. However, if the setting were
7979 .code
7980 domainlist relay_to_domains = !a.b.c
7981 .endd
7982 then all domains other than &'a.b.c'& would match because the last item in the
7983 list is negative. In other words, a list that ends with a negative item behaves
7984 as if it had an extra item &`:*`& on the end.
7985
7986 Another way of thinking about positive and negative items in lists is to read
7987 the connector as &"or"& after a positive item and as &"and"& after a negative
7988 item.
7989
7990
7991
7992 .section "File names in lists" "SECTfilnamlis"
7993 .cindex "list" "file name in"
7994 If an item in a domain, host, address, or local part list is an absolute file
7995 name (beginning with a slash character), each line of the file is read and
7996 processed as if it were an independent item in the list, except that further
7997 file names are not allowed,
7998 and no expansion of the data from the file takes place.
7999 Empty lines in the file are ignored, and the file may also contain comment
8000 lines:
8001
8002 .ilist
8003 For domain and host lists, if a # character appears anywhere in a line of the
8004 file, it and all following characters are ignored.
8005 .next
8006 Because local parts may legitimately contain # characters, a comment in an
8007 address list or local part list file is recognized only if # is preceded by
8008 white space or the start of the line. For example:
8009 .code
8010 not#comment@x.y.z   # but this is a comment
8011 .endd
8012 .endlist
8013
8014 Putting a file name in a list has the same effect as inserting each line of the
8015 file as an item in the list (blank lines and comments excepted). However, there
8016 is one important difference: the file is read each time the list is processed,
8017 so if its contents vary over time, Exim's behaviour changes.
8018
8019 If a file name is preceded by an exclamation mark, the sense of any match
8020 within the file is inverted. For example, if
8021 .code
8022 hold_domains = !/etc/nohold-domains
8023 .endd
8024 and the file contains the lines
8025 .code
8026 !a.b.c
8027 *.b.c
8028 .endd
8029 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8030 any domain matching &`*.b.c`& is not.
8031
8032
8033
8034 .section "An lsearch file is not an out-of-line list" "SECID77"
8035 As will be described in the sections that follow, lookups can be used in lists
8036 to provide indexed methods of checking list membership. There has been some
8037 confusion about the way &(lsearch)& lookups work in lists. Because
8038 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8039 sometimes thought that it is allowed to contain wild cards and other kinds of
8040 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8041 always fixed strings, just as for any other single-key lookup type.
8042
8043 If you want to use a file to contain wild-card patterns that form part of a
8044 list, just give the file name on its own, without a search type, as described
8045 in the previous section. You could also use the &(wildlsearch)& or
8046 &(nwildlsearch)&, but there is no advantage in doing this.
8047
8048
8049
8050
8051 .section "Named lists" "SECTnamedlists"
8052 .cindex "named lists"
8053 .cindex "list" "named"
8054 A list of domains, hosts, email addresses, or local parts can be given a name
8055 which is then used to refer to the list elsewhere in the configuration. This is
8056 particularly convenient if the same list is required in several different
8057 places. It also allows lists to be given meaningful names, which can improve
8058 the readability of the configuration. For example, it is conventional to define
8059 a domain list called &'local_domains'& for all the domains that are handled
8060 locally on a host, using a configuration line such as
8061 .code
8062 domainlist local_domains = localhost:my.dom.example
8063 .endd
8064 Named lists are referenced by giving their name preceded by a plus sign, so,
8065 for example, a router that is intended to handle local domains would be
8066 configured with the line
8067 .code
8068 domains = +local_domains
8069 .endd
8070 The first router in a configuration is often one that handles all domains
8071 except the local ones, using a configuration with a negated item like this:
8072 .code
8073 dnslookup:
8074   driver = dnslookup
8075   domains = ! +local_domains
8076   transport = remote_smtp
8077   no_more
8078 .endd
8079 The four kinds of named list are created by configuration lines starting with
8080 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8081 respectively. Then there follows the name that you are defining, followed by an
8082 equals sign and the list itself. For example:
8083 .code
8084 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8085 addresslist bad_senders = cdb;/etc/badsenders
8086 .endd
8087 A named list may refer to other named lists:
8088 .code
8089 domainlist  dom1 = first.example : second.example
8090 domainlist  dom2 = +dom1 : third.example
8091 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8092 .endd
8093 &*Warning*&: If the last item in a referenced list is a negative one, the
8094 effect may not be what you intended, because the negation does not propagate
8095 out to the higher level. For example, consider:
8096 .code
8097 domainlist  dom1 = !a.b
8098 domainlist  dom2 = +dom1 : *.b
8099 .endd
8100 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8101 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8102 means it matches the second list as well. The effect is not the same as
8103 .code
8104 domainlist  dom2 = !a.b : *.b
8105 .endd
8106 where &'x.y'& does not match. It's best to avoid negation altogether in
8107 referenced lists if you can.
8108
8109 Named lists may have a performance advantage. When Exim is routing an
8110 address or checking an incoming message, it caches the result of tests on named
8111 lists. So, if you have a setting such as
8112 .code
8113 domains = +local_domains
8114 .endd
8115 on several of your routers
8116 or in several ACL statements,
8117 the actual test is done only for the first one. However, the caching works only
8118 if there are no expansions within the list itself or any sublists that it
8119 references. In other words, caching happens only for lists that are known to be
8120 the same each time they are referenced.
8121
8122 By default, there may be up to 16 named lists of each type. This limit can be
8123 extended by changing a compile-time variable. The use of domain and host lists
8124 is recommended for concepts such as local domains, relay domains, and relay
8125 hosts. The default configuration is set up like this.
8126
8127
8128
8129 .section "Named lists compared with macros" "SECID78"
8130 .cindex "list" "named compared with macro"
8131 .cindex "macro" "compared with named list"
8132 At first sight, named lists might seem to be no different from macros in the
8133 configuration file. However, macros are just textual substitutions. If you
8134 write
8135 .code
8136 ALIST = host1 : host2
8137 auth_advertise_hosts = !ALIST
8138 .endd
8139 it probably won't do what you want, because that is exactly the same as
8140 .code
8141 auth_advertise_hosts = !host1 : host2
8142 .endd
8143 Notice that the second host name is not negated. However, if you use a host
8144 list, and write
8145 .code
8146 hostlist alist = host1 : host2
8147 auth_advertise_hosts = ! +alist
8148 .endd
8149 the negation applies to the whole list, and so that is equivalent to
8150 .code
8151 auth_advertise_hosts = !host1 : !host2
8152 .endd
8153
8154
8155 .section "Named list caching" "SECID79"
8156 .cindex "list" "caching of named"
8157 .cindex "caching" "named lists"
8158 While processing a message, Exim caches the result of checking a named list if
8159 it is sure that the list is the same each time. In practice, this means that
8160 the cache operates only if the list contains no $ characters, which guarantees
8161 that it will not change when it is expanded. Sometimes, however, you may have
8162 an expanded list that you know will be the same each time within a given
8163 message. For example:
8164 .code
8165 domainlist special_domains = \
8166            ${lookup{$sender_host_address}cdb{/some/file}}
8167 .endd
8168 This provides a list of domains that depends only on the sending host's IP
8169 address. If this domain list is referenced a number of times (for example,
8170 in several ACL lines, or in several routers) the result of the check is not
8171 cached by default, because Exim does not know that it is going to be the
8172 same list each time.
8173
8174 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8175 cache the result anyway. For example:
8176 .code
8177 domainlist_cache special_domains = ${lookup{...
8178 .endd
8179 If you do this, you should be absolutely sure that caching is going to do
8180 the right thing in all cases. When in doubt, leave it out.
8181
8182
8183
8184 .section "Domain lists" "SECTdomainlist"
8185 .cindex "domain list" "patterns for"
8186 .cindex "list" "domain list"
8187 Domain lists contain patterns that are to be matched against a mail domain.
8188 The following types of item may appear in domain lists:
8189
8190 .ilist
8191 .cindex "primary host name"
8192 .cindex "host name" "matched in domain list"
8193 .oindex "&%primary_hostname%&"
8194 .cindex "domain list" "matching primary host name"
8195 .cindex "@ in a domain list"
8196 If a pattern consists of a single @ character, it matches the local host name,
8197 as set by the &%primary_hostname%& option (or defaulted). This makes it
8198 possible to use the same configuration file on several different hosts that
8199 differ only in their names.
8200 .next
8201 .cindex "@[] in a domain list"
8202 .cindex "domain list" "matching local IP interfaces"
8203 .cindex "domain literal"
8204 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8205 in square brackets (as in an email address that contains a domain literal), but
8206 only if that IP address is recognized as local for email routing purposes. The
8207 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8208 control which of a host's several IP addresses are treated as local.
8209 In today's Internet, the use of domain literals is controversial.
8210 .next
8211 .cindex "@mx_any"
8212 .cindex "@mx_primary"
8213 .cindex "@mx_secondary"
8214 .cindex "domain list" "matching MX pointers to local host"
8215 If a pattern consists of the string &`@mx_any`& it matches any domain that
8216 has an MX record pointing to the local host or to any host that is listed in
8217 .oindex "&%hosts_treat_as_local%&"
8218 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8219 are similar, except that the first matches only when a primary MX target is the
8220 local host, and the second only when no primary MX target is the local host,
8221 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8222 preference value &-- there may of course be more than one of them.
8223
8224 The MX lookup that takes place when matching a pattern of this type is
8225 performed with the resolver options for widening names turned off. Thus, for
8226 example, a single-component domain will &'not'& be expanded by adding the
8227 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8228 options of the &(dnslookup)& router for a discussion of domain widening.
8229
8230 Sometimes you may want to ignore certain IP addresses when using one of these
8231 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8232 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8233 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8234 on a router). For example:
8235 .code
8236 domains = @mx_any/ignore=127.0.0.1
8237 .endd
8238 This example matches any domain that has an MX record pointing to one of
8239 the local host's IP addresses other than 127.0.0.1.
8240
8241 The list of IP addresses is in fact processed by the same code that processes
8242 host lists, so it may contain CIDR-coded network specifications and it may also
8243 contain negative items.
8244
8245 Because the list of IP addresses is a sublist within a domain list, you have to
8246 be careful about delimiters if there is more than one address. Like any other
8247 list, the default delimiter can be changed. Thus, you might have:
8248 .code
8249 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8250           an.other.domain : ...
8251 .endd
8252 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8253 involved, it is easiest to change the delimiter for the main list as well:
8254 .code
8255 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8256           an.other.domain ? ...
8257 .endd
8258 .next
8259 .cindex "asterisk" "in domain list"
8260 .cindex "domain list" "asterisk in"
8261 .cindex "domain list" "matching &""ends with""&"
8262 If a pattern starts with an asterisk, the remaining characters of the pattern
8263 are compared with the terminating characters of the domain. The use of &"*"& in
8264 domain lists differs from its use in partial matching lookups. In a domain
8265 list, the character following the asterisk need not be a dot, whereas partial
8266 matching works only in terms of dot-separated components. For example, a domain
8267 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8268 &'cipher.key.ex'&.
8269
8270 .next
8271 .cindex "regular expressions" "in domain list"
8272 .cindex "domain list" "matching regular expression"
8273 If a pattern starts with a circumflex character, it is treated as a regular
8274 expression, and matched against the domain using a regular expression matching
8275 function. The circumflex is treated as part of the regular expression.
8276 Email domains are case-independent, so this regular expression match is by
8277 default case-independent, but you can make it case-dependent by starting it
8278 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8279 are given in chapter &<<CHAPregexp>>&.
8280
8281 &*Warning*&: Because domain lists are expanded before being processed, you
8282 must escape any backslash and dollar characters in the regular expression, or
8283 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8284 it is not to be expanded (unless you really do want to build a regular
8285 expression by expansion, of course).
8286 .next
8287 .cindex "lookup" "in domain list"
8288 .cindex "domain list" "matching by lookup"
8289 If a pattern starts with the name of a single-key lookup type followed by a
8290 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8291 must be a file name in a suitable format for the lookup type. For example, for
8292 &"cdb;"& it must be an absolute path:
8293 .code
8294 domains = cdb;/etc/mail/local_domains.cdb
8295 .endd
8296 The appropriate type of lookup is done on the file using the domain name as the
8297 key. In most cases, the data that is looked up is not used; Exim is interested
8298 only in whether or not the key is present in the file. However, when a lookup
8299 is used for the &%domains%& option on a router
8300 or a &%domains%& condition in an ACL statement, the data is preserved in the
8301 &$domain_data$& variable and can be referred to in other router options or
8302 other statements in the same ACL.
8303
8304 .next
8305 Any of the single-key lookup type names may be preceded by
8306 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8307 .code
8308 domains = partial-dbm;/partial/domains
8309 .endd
8310 This causes partial matching logic to be invoked; a description of how this
8311 works is given in section &<<SECTpartiallookup>>&.
8312
8313 .next
8314 .cindex "asterisk" "in lookup type"
8315 Any of the single-key lookup types may be followed by an asterisk. This causes
8316 a default lookup for a key consisting of a single asterisk to be done if the
8317 original lookup fails. This is not a useful feature when using a domain list to
8318 select particular domains (because any domain would match), but it might have
8319 value if the result of the lookup is being used via the &$domain_data$&
8320 expansion variable.
8321 .next
8322 If the pattern starts with the name of a query-style lookup type followed by a
8323 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8324 pattern must be an appropriate query for the lookup type, as described in
8325 chapter &<<CHAPfdlookup>>&. For example:
8326 .code
8327 hold_domains = mysql;select domain from holdlist \
8328   where domain = '${quote_mysql:$domain}';
8329 .endd
8330 In most cases, the data that is looked up is not used (so for an SQL query, for
8331 example, it doesn't matter what field you select). Exim is interested only in
8332 whether or not the query succeeds. However, when a lookup is used for the
8333 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8334 variable and can be referred to in other options.
8335 .next
8336 .cindex "domain list" "matching literal domain name"
8337 If none of the above cases apply, a caseless textual comparison is made
8338 between the pattern and the domain.
8339 .endlist
8340
8341 Here is an example that uses several different kinds of pattern:
8342 .code
8343 domainlist funny_domains = \
8344   @ : \
8345   lib.unseen.edu : \
8346   *.foundation.fict.example : \
8347   \N^[1-2]\d{3}\.fict\.example$\N : \
8348   partial-dbm;/opt/data/penguin/book : \
8349   nis;domains.byname : \
8350   nisplus;[name=$domain,status=local],domains.org_dir
8351 .endd
8352 There are obvious processing trade-offs among the various matching modes. Using
8353 an asterisk is faster than a regular expression, and listing a few names
8354 explicitly probably is too. The use of a file or database lookup is expensive,
8355 but may be the only option if hundreds of names are required. Because the
8356 patterns are tested in order, it makes sense to put the most commonly matched
8357 patterns earlier.
8358
8359
8360
8361 .section "Host lists" "SECThostlist"
8362 .cindex "host list" "patterns in"
8363 .cindex "list" "host list"
8364 Host lists are used to control what remote hosts are allowed to do. For
8365 example, some hosts may be allowed to use the local host as a relay, and some
8366 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8367 two different ways, by name or by IP address. In a host list, some types of
8368 pattern are matched to a host name, and some are matched to an IP address.
8369 You need to be particularly careful with this when single-key lookups are
8370 involved, to ensure that the right value is being used as the key.
8371
8372
8373 .section "Special host list patterns" "SECID80"
8374 .cindex "empty item in hosts list"
8375 .cindex "host list" "empty string in"
8376 If a host list item is the empty string, it matches only when no remote host is
8377 involved. This is the case when a message is being received from a local
8378 process using SMTP on the standard input, that is, when a TCP/IP connection is
8379 not used.
8380
8381 .cindex "asterisk" "in host list"
8382 The special pattern &"*"& in a host list matches any host or no host. Neither
8383 the IP address nor the name is actually inspected.
8384
8385
8386
8387 .section "Host list patterns that match by IP address" "SECThoslispatip"
8388 .cindex "host list" "matching IP addresses"
8389 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8390 the incoming address actually appears in the IPv6 host as
8391 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8392 list, it is converted into a traditional IPv4 address first. (Not all operating
8393 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8394 concerns.)
8395
8396 The following types of pattern in a host list check the remote host by
8397 inspecting its IP address:
8398
8399 .ilist
8400 If the pattern is a plain domain name (not a regular expression, not starting
8401 with *, not a lookup of any kind), Exim calls the operating system function
8402 to find the associated IP address(es). Exim uses the newer
8403 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8404 This typically causes a forward DNS lookup of the name. The result is compared
8405 with the IP address of the subject host.
8406
8407 If there is a temporary problem (such as a DNS timeout) with the host name
8408 lookup, a temporary error occurs. For example, if the list is being used in an
8409 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8410 temporary SMTP error code. If no IP address can be found for the host name,
8411 what happens is described in section &<<SECTbehipnot>>& below.
8412
8413 .next
8414 .cindex "@ in a host list"
8415 If the pattern is &"@"&, the primary host name is substituted and used as a
8416 domain name, as just described.
8417
8418 .next
8419 If the pattern is an IP address, it is matched against the IP address of the
8420 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8421 IPv6 addresses can be given in colon-separated format, but the colons have to
8422 be doubled so as not to be taken as item separators when the default list
8423 separator is used. IPv6 addresses are recognized even when Exim is compiled
8424 without IPv6 support. This means that if they appear in a host list on an
8425 IPv4-only host, Exim will not treat them as host names. They are just addresses
8426 that can never match a client host.
8427
8428 .next
8429 .cindex "@[] in a host list"
8430 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8431 the local host. For example, if the local host is an IPv4 host with one
8432 interface address 10.45.23.56, these two ACL statements have the same effect:
8433 .code
8434 accept hosts = 127.0.0.1 : 10.45.23.56
8435 accept hosts = @[]
8436 .endd
8437 .next
8438 .cindex "CIDR notation"
8439 If the pattern is an IP address followed by a slash and a mask length (for
8440 example 10.11.42.0/24), it is matched against the IP address of the subject
8441 host under the given mask. This allows, an entire network of hosts to be
8442 included (or excluded) by a single item. The mask uses CIDR notation; it
8443 specifies the number of address bits that must match, starting from the most
8444 significant end of the address.
8445
8446 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8447 of a range of addresses. It is the number of bits in the network portion of the
8448 address. The above example specifies a 24-bit netmask, so it matches all 256
8449 addresses in the 10.11.42.0 network. An item such as
8450 .code
8451 192.168.23.236/31
8452 .endd
8453 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8454 32 for an IPv4 address is the same as no mask at all; just a single address
8455 matches.
8456
8457 Here is another example which shows an IPv4 and an IPv6 network:
8458 .code
8459 recipient_unqualified_hosts = 192.168.0.0/16: \
8460                               3ffe::ffff::836f::::/48
8461 .endd
8462 The doubling of list separator characters applies only when these items
8463 appear inline in a host list. It is not required when indirecting via a file.
8464 For example:
8465 .code
8466 recipient_unqualified_hosts = /opt/exim/unqualnets
8467 .endd
8468 could make use of a file containing
8469 .code
8470 172.16.0.0/12
8471 3ffe:ffff:836f::/48
8472 .endd
8473 to have exactly the same effect as the previous example. When listing IPv6
8474 addresses inline, it is usually more convenient to use the facility for
8475 changing separator characters. This list contains the same two networks:
8476 .code
8477 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8478                                  3ffe:ffff:836f::/48
8479 .endd
8480 The separator is changed to semicolon by the leading &"<;"& at the start of the
8481 list.
8482 .endlist
8483
8484
8485
8486 .section "Host list patterns for single-key lookups by host address" &&&
8487          "SECThoslispatsikey"
8488 .cindex "host list" "lookup of IP address"
8489 When a host is to be identified by a single-key lookup of its complete IP
8490 address, the pattern takes this form:
8491 .display
8492 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8493 .endd
8494 For example:
8495 .code
8496 hosts_lookup = net-cdb;/hosts-by-ip.db
8497 .endd
8498 The text form of the IP address of the subject host is used as the lookup key.
8499 IPv6 addresses are converted to an unabbreviated form, using lower case
8500 letters, with dots as separators because colon is the key terminator in
8501 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8502 quoting the keys, but this is a facility that was added later.] The data
8503 returned by the lookup is not used.
8504
8505 .cindex "IP address" "masking"
8506 .cindex "host list" "masked IP address"
8507 Single-key lookups can also be performed using masked IP addresses, using
8508 patterns of this form:
8509 .display
8510 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8511 .endd
8512 For example:
8513 .code
8514 net24-dbm;/networks.db
8515 .endd
8516 The IP address of the subject host is masked using <&'number'&> as the mask
8517 length. A textual string is constructed from the masked value, followed by the
8518 mask, and this is used as the lookup key. For example, if the host's IP address
8519 is 192.168.34.6, the key that is looked up for the above example is
8520 &"192.168.34.0/24"&.
8521
8522 When an IPv6 address is converted to a string, dots are normally used instead
8523 of colons, so that keys in &(lsearch)& files need not contain colons (which
8524 terminate &(lsearch)& keys). This was implemented some time before the ability
8525 to quote keys was made available in &(lsearch)& files. However, the more
8526 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8527 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8528 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8529 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8530 addresses are always used.
8531
8532 Ideally, it would be nice to tidy up this anomalous situation by changing to
8533 colons in all cases, given that quoting is now available for &(lsearch)&.
8534 However, this would be an incompatible change that might break some existing
8535 configurations.
8536
8537 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8538 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8539 the former case the key strings include the mask value, whereas in the latter
8540 case the IP address is used on its own.
8541
8542
8543
8544 .section "Host list patterns that match by host name" "SECThoslispatnam"
8545 .cindex "host" "lookup failures"
8546 .cindex "unknown host name"
8547 .cindex "host list" "matching host name"
8548 There are several types of pattern that require Exim to know the name of the
8549 remote host. These are either wildcard patterns or lookups by name. (If a
8550 complete hostname is given without any wildcarding, it is used to find an IP
8551 address to match against, as described in section &<<SECThoslispatip>>&
8552 above.)
8553
8554 If the remote host name is not already known when Exim encounters one of these
8555 patterns, it has to be found from the IP address.
8556 Although many sites on the Internet are conscientious about maintaining reverse
8557 DNS data for their hosts, there are also many that do not do this.
8558 Consequently, a name cannot always be found, and this may lead to unwanted
8559 effects. Take care when configuring host lists with wildcarded name patterns.
8560 Consider what will happen if a name cannot be found.
8561
8562 Because of the problems of determining host names from IP addresses, matching
8563 against host names is not as common as matching against IP addresses.
8564
8565 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8566 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8567 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8568 are done can be changed by setting the &%host_lookup_order%& option. For
8569 security, once Exim has found one or more names, it looks up the IP addresses
8570 for these names and compares them with the IP address that it started with.
8571 Only those names whose IP addresses match are accepted. Any other names are
8572 discarded. If no names are left, Exim behaves as if the host name cannot be
8573 found. In the most common case there is only one name and one IP address.
8574
8575 There are some options that control what happens if a host name cannot be
8576 found. These are described in section &<<SECTbehipnot>>& below.
8577
8578 .cindex "host" "alias for"
8579 .cindex "alias for host"
8580 As a result of aliasing, hosts may have more than one name. When processing any
8581 of the following types of pattern, all the host's names are checked:
8582
8583 .ilist
8584 .cindex "asterisk" "in host list"
8585 If a pattern starts with &"*"& the remainder of the item must match the end of
8586 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8587 &'.b.c'&. This special simple form is provided because this is a very common
8588 requirement. Other kinds of wildcarding require the use of a regular
8589 expression.
8590 .next
8591 .cindex "regular expressions" "in host list"
8592 .cindex "host list" "regular expression in"
8593 If the item starts with &"^"& it is taken to be a regular expression which is
8594 matched against the host name. Host names are case-independent, so this regular
8595 expression match is by default case-independent, but you can make it
8596 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8597 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8598 example,
8599 .code
8600 ^(a|b)\.c\.d$
8601 .endd
8602 is a regular expression that matches either of the two hosts &'a.c.d'& or
8603 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8604 that backslash and dollar characters are not misinterpreted as part of the
8605 string expansion. The simplest way to do this is to use &`\N`& to mark that
8606 part of the string as non-expandable. For example:
8607 .code
8608 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8609 .endd
8610 &*Warning*&: If you want to match a complete host name, you must include the
8611 &`$`& terminating metacharacter in the regular expression, as in the above
8612 example. Without it, a match at the start of the host name is all that is
8613 required.
8614 .endlist
8615
8616
8617
8618
8619 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8620 .cindex "host" "lookup failures, permanent"
8621 While processing a host list, Exim may need to look up an IP address from a
8622 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8623 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8624 behaviour when it fails to find the information it is seeking is the same.
8625
8626 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8627 apply to temporary DNS errors, whose handling is described in the next section.
8628
8629 .cindex "&`+include_unknown`&"
8630 .cindex "&`+ignore_unknown`&"
8631 Exim parses a host list from left to right. If it encounters a permanent
8632 lookup failure in any item in the host list before it has found a match,
8633 Exim treats it as a failure and the default behavior is as if the host
8634 does not match the list. This may not always be what you want to happen.
8635 To change Exim's behaviour, the special items &`+include_unknown`& or
8636 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8637 not recognized in an indirected file).
8638
8639 .ilist
8640 If any item that follows &`+include_unknown`& requires information that
8641 cannot found, Exim behaves as if the host does match the list. For example,
8642 .code
8643 host_reject_connection = +include_unknown:*.enemy.ex
8644 .endd
8645 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8646 any hosts whose name it cannot find.
8647
8648 .next
8649 If any item that follows &`+ignore_unknown`& requires information that cannot
8650 be found, Exim ignores that item and proceeds to the rest of the list. For
8651 example:
8652 .code
8653 accept hosts = +ignore_unknown : friend.example : \
8654                192.168.4.5
8655 .endd
8656 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8657 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8658 name can be found for 192.168.4.5, it is rejected.
8659 .endlist
8660
8661 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8662 list. The effect of each one lasts until the next, or until the end of the
8663 list.
8664
8665 .section "Mixing wildcarded host names and addresses in host lists" &&&
8666          "SECTmixwilhos"
8667 .cindex "host list" "mixing names and addresses in"
8668
8669 This section explains the host/ip processing logic with the same concepts
8670 as the previous section, but specifically addresses what happens when a
8671 wildcarded hostname is one of the items in the hostlist.
8672
8673 .ilist
8674 If you have name lookups or wildcarded host names and
8675 IP addresses in the same host list, you should normally put the IP
8676 addresses first. For example, in an ACL you could have:
8677 .code
8678 accept hosts = 10.9.8.7 : *.friend.example
8679 .endd
8680 The reason you normally would order it this way lies in the
8681 left-to-right way that Exim processes lists.  It can test IP addresses
8682 without doing any DNS lookups, but when it reaches an item that requires
8683 a host name, it fails if it cannot find a host name to compare with the
8684 pattern. If the above list is given in the opposite order, the
8685 &%accept%& statement fails for a host whose name cannot be found, even
8686 if its IP address is 10.9.8.7.
8687
8688 .next
8689 If you really do want to do the name check first, and still recognize the IP
8690 address, you can rewrite the ACL like this:
8691 .code
8692 accept hosts = *.friend.example
8693 accept hosts = 10.9.8.7
8694 .endd
8695 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8696 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8697 &`+ignore_unknown`&, which was discussed in depth in the first example in
8698 this section.
8699 .endlist
8700
8701
8702 .section "Temporary DNS errors when looking up host information" &&&
8703          "SECTtemdnserr"
8704 .cindex "host" "lookup failures, temporary"
8705 .cindex "&`+include_defer`&"
8706 .cindex "&`+ignore_defer`&"
8707 A temporary DNS lookup failure normally causes a defer action (except when
8708 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8709 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8710 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8711 section. These options should be used with care, probably only in non-critical
8712 host lists such as whitelists.
8713
8714
8715
8716 .section "Host list patterns for single-key lookups by host name" &&&
8717          "SECThoslispatnamsk"
8718 .cindex "unknown host name"
8719 .cindex "host list" "matching host name"
8720 If a pattern is of the form
8721 .display
8722 <&'single-key-search-type'&>;<&'search-data'&>
8723 .endd
8724 for example
8725 .code
8726 dbm;/host/accept/list
8727 .endd
8728 a single-key lookup is performed, using the host name as its key. If the
8729 lookup succeeds, the host matches the item. The actual data that is looked up
8730 is not used.
8731
8732 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8733 keys in the file, not IP addresses. If you want to do lookups based on IP
8734 addresses, you must precede the search type with &"net-"& (see section
8735 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8736 two items in the same list, one doing an address lookup and one doing a name
8737 lookup, both using the same file.
8738
8739
8740
8741 .section "Host list patterns for query-style lookups" "SECID81"
8742 If a pattern is of the form
8743 .display
8744 <&'query-style-search-type'&>;<&'query'&>
8745 .endd
8746 the query is obeyed, and if it succeeds, the host matches the item. The actual
8747 data that is looked up is not used. The variables &$sender_host_address$& and
8748 &$sender_host_name$& can be used in the query. For example:
8749 .code
8750 hosts_lookup = pgsql;\
8751   select ip from hostlist where ip='$sender_host_address'
8752 .endd
8753 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8754 can use the &%sg%& expansion item to change this if you need to. If you want to
8755 use masked IP addresses in database queries, you can use the &%mask%& expansion
8756 operator.
8757
8758 If the query contains a reference to &$sender_host_name$&, Exim automatically
8759 looks up the host name if it has not already done so. (See section
8760 &<<SECThoslispatnam>>& for comments on finding host names.)
8761
8762 Historical note: prior to release 4.30, Exim would always attempt to find a
8763 host name before running the query, unless the search type was preceded by
8764 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8765 still recognized for query-style lookups, but its presence or absence has no
8766 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8767 See section &<<SECThoslispatsikey>>&.)
8768
8769
8770
8771
8772
8773 .section "Address lists" "SECTaddresslist"
8774 .cindex "list" "address list"
8775 .cindex "address list" "empty item"
8776 .cindex "address list" "patterns"
8777 Address lists contain patterns that are matched against mail addresses. There
8778 is one special case to be considered: the sender address of a bounce message is
8779 always empty. You can test for this by providing an empty item in an address
8780 list. For example, you can set up a router to process bounce messages by
8781 using this option setting:
8782 .code
8783 senders = :
8784 .endd
8785 The presence of the colon creates an empty item. If you do not provide any
8786 data, the list is empty and matches nothing. The empty sender can also be
8787 detected by a regular expression that matches an empty string,
8788 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8789
8790 Non-empty items in an address list can be straightforward email addresses. For
8791 example:
8792 .code
8793 senders = jbc@askone.example : hs@anacreon.example
8794 .endd
8795 A certain amount of wildcarding is permitted. If a pattern contains an @
8796 character, but is not a regular expression and does not begin with a
8797 semicolon-terminated lookup type (described below), the local part of the
8798 subject address is compared with the local part of the pattern, which may start
8799 with an asterisk. If the local parts match, the domain is checked in exactly
8800 the same way as for a pattern in a domain list. For example, the domain can be
8801 wildcarded, refer to a named list, or be a lookup:
8802 .code
8803 deny senders = *@*.spamming.site:\
8804                *@+hostile_domains:\
8805                bozo@partial-lsearch;/list/of/dodgy/sites:\
8806                *@dbm;/bad/domains.db
8807 .endd
8808 .cindex "local part" "starting with !"
8809 .cindex "address list" "local part starting with !"
8810 If a local part that begins with an exclamation mark is required, it has to be
8811 specified using a regular expression, because otherwise the exclamation mark is
8812 treated as a sign of negation, as is standard in lists.
8813
8814 If a non-empty pattern that is not a regular expression or a lookup does not
8815 contain an @ character, it is matched against the domain part of the subject
8816 address. The only two formats that are recognized this way are a literal
8817 domain, or a domain pattern that starts with *. In both these cases, the effect
8818 is the same as if &`*@`& preceded the pattern. For example:
8819 .code
8820 deny senders = enemy.domain : *.enemy.domain
8821 .endd
8822
8823 The following kinds of more complicated address list pattern can match any
8824 address, including the empty address that is characteristic of bounce message
8825 senders:
8826
8827 .ilist
8828 .cindex "regular expressions" "in address list"
8829 .cindex "address list" "regular expression in"
8830 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8831 done against the complete address, with the pattern as the regular expression.
8832 You must take care that backslash and dollar characters are not misinterpreted
8833 as part of the string expansion. The simplest way to do this is to use &`\N`&
8834 to mark that part of the string as non-expandable. For example:
8835 .code
8836 deny senders = \N^.*this.*@example\.com$\N : \
8837                \N^\d{8}.+@spamhaus.example$\N : ...
8838 .endd
8839 The &`\N`& sequences are removed by the expansion, so these items do indeed
8840 start with &"^"& by the time they are being interpreted as address patterns.
8841
8842 .next
8843 .cindex "address list" "lookup for complete address"
8844 Complete addresses can be looked up by using a pattern that starts with a
8845 lookup type terminated by a semicolon, followed by the data for the lookup. For
8846 example:
8847 .code
8848 deny senders = cdb;/etc/blocked.senders : \
8849   mysql;select address from blocked where \
8850   address='${quote_mysql:$sender_address}'
8851 .endd
8852 Both query-style and single-key lookup types can be used. For a single-key
8853 lookup type, Exim uses the complete address as the key. However, empty keys are
8854 not supported for single-key lookups, so a match against the empty address
8855 always fails. This restriction does not apply to query-style lookups.
8856
8857 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8858 cannot be used, and is ignored if specified, with an entry being written to the
8859 panic log.
8860 .cindex "*@ with single-key lookup"
8861 However, you can configure lookup defaults, as described in section
8862 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8863 default. For example, with this lookup:
8864 .code
8865 accept senders = lsearch*@;/some/file
8866 .endd
8867 the file could contains lines like this:
8868 .code
8869 user1@domain1.example
8870 *@domain2.example
8871 .endd
8872 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8873 that are tried is:
8874 .code
8875 nimrod@jaeger.example
8876 *@jaeger.example
8877 *
8878 .endd
8879 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8880 would mean that every address matches, thus rendering the test useless.
8881
8882 &*Warning 2*&: Do not confuse these two kinds of item:
8883 .code
8884 deny recipients = dbm*@;/some/file
8885 deny recipients = *@dbm;/some/file
8886 .endd
8887 The first does a whole address lookup, with defaulting, as just described,
8888 because it starts with a lookup type. The second matches the local part and
8889 domain independently, as described in a bullet point below.
8890 .endlist
8891
8892
8893 The following kinds of address list pattern can match only non-empty addresses.
8894 If the subject address is empty, a match against any of these pattern types
8895 always fails.
8896
8897
8898 .ilist
8899 .cindex "@@ with single-key lookup"
8900 .cindex "address list" "@@ lookup type"
8901 .cindex "address list" "split local part and domain"
8902 If a pattern starts with &"@@"& followed by a single-key lookup item
8903 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8904 split into a local part and a domain. The domain is looked up in the file. If
8905 it is not found, there is no match. If it is found, the data that is looked up
8906 from the file is treated as a colon-separated list of local part patterns, each
8907 of which is matched against the subject local part in turn.
8908
8909 .cindex "asterisk" "in address list"
8910 The lookup may be a partial one, and/or one involving a search for a default
8911 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8912 patterns that are looked up can be regular expressions or begin with &"*"&, or
8913 even be further lookups. They may also be independently negated. For example,
8914 with
8915 .code
8916 deny senders = @@dbm;/etc/reject-by-domain
8917 .endd
8918 the data from which the DBM file is built could contain lines like
8919 .code
8920 baddomain.com:  !postmaster : *
8921 .endd
8922 to reject all senders except &%postmaster%& from that domain.
8923
8924 .cindex "local part" "starting with !"
8925 If a local part that actually begins with an exclamation mark is required, it
8926 has to be specified using a regular expression. In &(lsearch)& files, an entry
8927 may be split over several lines by indenting the second and subsequent lines,
8928 but the separating colon must still be included at line breaks. White space
8929 surrounding the colons is ignored. For example:
8930 .code
8931 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8932   spammer3 : spammer4
8933 .endd
8934 As in all colon-separated lists in Exim, a colon can be included in an item by
8935 doubling.
8936
8937 If the last item in the list starts with a right angle-bracket, the remainder
8938 of the item is taken as a new key to look up in order to obtain a continuation
8939 list of local parts. The new key can be any sequence of characters. Thus one
8940 might have entries like
8941 .code
8942 aol.com: spammer1 : spammer 2 : >*
8943 xyz.com: spammer3 : >*
8944 *:       ^\d{8}$
8945 .endd
8946 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8947 local parts for all domains, in addition to the specific local parts listed for
8948 each domain. Of course, using this feature costs another lookup each time a
8949 chain is followed, but the effort needed to maintain the data is reduced.
8950
8951 .cindex "loop" "in lookups"
8952 It is possible to construct loops using this facility, and in order to catch
8953 them, the chains may be no more than fifty items long.
8954
8955 .next
8956 The @@<&'lookup'&> style of item can also be used with a query-style
8957 lookup, but in this case, the chaining facility is not available. The lookup
8958 can only return a single list of local parts.
8959 .endlist
8960
8961 &*Warning*&: There is an important difference between the address list items
8962 in these two examples:
8963 .code
8964 senders = +my_list
8965 senders = *@+my_list
8966 .endd
8967 In the first one, &`my_list`& is a named address list, whereas in the second
8968 example it is a named domain list.
8969
8970
8971
8972
8973 .section "Case of letters in address lists" "SECTcasletadd"
8974 .cindex "case of local parts"
8975 .cindex "address list" "case forcing"
8976 .cindex "case forcing in address lists"
8977 Domains in email addresses are always handled caselessly, but for local parts
8978 case may be significant on some systems (see &%caseful_local_part%& for how
8979 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8980 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8981 blocking lists should be done in a case-independent manner. Since most address
8982 lists in Exim are used for this kind of control, Exim attempts to do this by
8983 default.
8984
8985 The domain portion of an address is always lowercased before matching it to an
8986 address list. The local part is lowercased by default, and any string
8987 comparisons that take place are done caselessly. This means that the data in
8988 the address list itself, in files included as plain file names, and in any file
8989 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8990 keys in files that are looked up by a search type other than &(lsearch)& (which
8991 works caselessly) must be in lower case, because these lookups are not
8992 case-independent.
8993
8994 .cindex "&`+caseful`&"
8995 To allow for the possibility of caseful address list matching, if an item in
8996 an address list is the string &"+caseful"&, the original case of the local
8997 part is restored for any comparisons that follow, and string comparisons are no
8998 longer case-independent. This does not affect the domain, which remains in
8999 lower case. However, although independent matches on the domain alone are still
9000 performed caselessly, regular expressions that match against an entire address
9001 become case-sensitive after &"+caseful"& has been seen.
9002
9003
9004
9005 .section "Local part lists" "SECTlocparlis"
9006 .cindex "list" "local part list"
9007 .cindex "local part" "list"
9008 Case-sensitivity in local part lists is handled in the same way as for address
9009 lists, as just described. The &"+caseful"& item can be used if required. In a
9010 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9011 set false, the subject is lowercased and the matching is initially
9012 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9013 matching in the local part list, but not elsewhere in the router. If
9014 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9015 option is case-sensitive from the start.
9016
9017 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9018 comments are handled in the same way as address lists &-- they are recognized
9019 only if the # is preceded by white space or the start of the line.
9020 Otherwise, local part lists are matched in the same way as domain lists, except
9021 that the special items that refer to the local host (&`@`&, &`@[]`&,
9022 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9023 Refer to section &<<SECTdomainlist>>& for details of the other available item
9024 types.
9025 .ecindex IIDdohoadli
9026
9027
9028
9029
9030 . ////////////////////////////////////////////////////////////////////////////
9031 . ////////////////////////////////////////////////////////////////////////////
9032
9033 .chapter "String expansions" "CHAPexpand"
9034 .scindex IIDstrexp "expansion" "of strings"
9035 Many strings in Exim's run time configuration are expanded before use. Some of
9036 them are expanded every time they are used; others are expanded only once.
9037
9038 When a string is being expanded it is copied verbatim from left to right except
9039 when a dollar or backslash character is encountered. A dollar specifies the
9040 start of a portion of the string that is interpreted and replaced as described
9041 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9042 escape character, as described in the following section.
9043
9044 Whether a string is expanded depends upon the context.  Usually this is solely
9045 dependent upon the option for which a value is sought; in this documentation,
9046 options for which string expansion is performed are marked with &dagger; after
9047 the data type.  ACL rules always expand strings.  A couple of expansion
9048 conditions do not expand some of the brace-delimited branches, for security
9049 reasons.
9050
9051
9052
9053 .section "Literal text in expanded strings" "SECTlittext"
9054 .cindex "expansion" "including literal text"
9055 An uninterpreted dollar can be included in an expanded string by putting a
9056 backslash in front of it. A backslash can be used to prevent any special
9057 character being treated specially in an expansion, including backslash itself.
9058 If the string appears in quotes in the configuration file, two backslashes are
9059 required because the quotes themselves cause interpretation of backslashes when
9060 the string is read in (see section &<<SECTstrings>>&).
9061
9062 .cindex "expansion" "non-expandable substrings"
9063 A portion of the string can specified as non-expandable by placing it between
9064 two occurrences of &`\N`&. This is particularly useful for protecting regular
9065 expressions, which often contain backslashes and dollar signs. For example:
9066 .code
9067 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9068 .endd
9069 On encountering the first &`\N`&, the expander copies subsequent characters
9070 without interpretation until it reaches the next &`\N`& or the end of the
9071 string.
9072
9073
9074
9075 .section "Character escape sequences in expanded strings" "SECID82"
9076 .cindex "expansion" "escape sequences"
9077 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9078 expanded string is recognized as an escape sequence for the character newline,
9079 carriage return, or tab, respectively. A backslash followed by up to three
9080 octal digits is recognized as an octal encoding for a single character, and a
9081 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9082 encoding.
9083
9084 These escape sequences are also recognized in quoted strings when they are read
9085 in. Their interpretation in expansions as well is useful for unquoted strings,
9086 and for other cases such as looked-up strings that are then expanded.
9087
9088
9089 .section "Testing string expansions" "SECID83"
9090 .cindex "expansion" "testing"
9091 .cindex "testing" "string expansion"
9092 .oindex "&%-be%&"
9093 Many expansions can be tested by calling Exim with the &%-be%& option. This
9094 takes the command arguments, or lines from the standard input if there are no
9095 arguments, runs them through the string expansion code, and writes the results
9096 to the standard output. Variables based on configuration values are set up, but
9097 since no message is being processed, variables such as &$local_part$& have no
9098 value. Nevertheless the &%-be%& option can be useful for checking out file and
9099 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9100 and &%nhash%&.
9101
9102 Exim gives up its root privilege when it is called with the &%-be%& option, and
9103 instead runs under the uid and gid it was called with, to prevent users from
9104 using &%-be%& for reading files to which they do not have access.
9105
9106 .oindex "&%-bem%&"
9107 If you want to test expansions that include variables whose values are taken
9108 from a message, there are two other options that can be used. The &%-bem%&
9109 option is like &%-be%& except that it is followed by a file name. The file is
9110 read as a message before doing the test expansions. For example:
9111 .code
9112 exim -bem /tmp/test.message '$h_subject:'
9113 .endd
9114 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9115 Exim message identifier. For example:
9116 .code
9117 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9118 .endd
9119 This loads the message from Exim's spool before doing the test expansions, and
9120 is therefore restricted to admin users.
9121
9122
9123 .section "Forced expansion failure" "SECTforexpfai"
9124 .cindex "expansion" "forced failure"
9125 A number of expansions that are described in the following section have
9126 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9127 (which are sometimes called &"curly brackets"&). Which of the two strings is
9128 used depends on some condition that is evaluated as part of the expansion. If,
9129 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9130 the entire string expansion fails in a way that can be detected by the code
9131 that requested the expansion. This is called &"forced expansion failure"&, and
9132 its consequences depend on the circumstances. In some cases it is no different
9133 from any other expansion failure, but in others a different action may be
9134 taken. Such variations are mentioned in the documentation of the option that is
9135 being expanded.
9136
9137
9138
9139
9140 .section "Expansion items" "SECTexpansionitems"
9141 The following items are recognized in expanded strings. White space may be used
9142 between sub-items that are keywords or substrings enclosed in braces inside an
9143 outer set of braces, to improve readability. &*Warning*&: Within braces,
9144 white space is significant.
9145
9146 .vlist
9147 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9148 .cindex "expansion" "variables"
9149 Substitute the contents of the named variable, for example:
9150 .code
9151 $local_part
9152 ${domain}
9153 .endd
9154 The second form can be used to separate the name from subsequent alphanumeric
9155 characters. This form (using braces) is available only for variables; it does
9156 &'not'& apply to message headers. The names of the variables are given in
9157 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9158 given, the expansion fails.
9159
9160 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9161 .cindex "expansion" "operators"
9162 The string is first itself expanded, and then the operation specified by
9163 <&'op'&> is applied to it. For example:
9164 .code
9165 ${lc:$local_part}
9166 .endd
9167 The string starts with the first character after the colon, which may be
9168 leading white space. A list of operators is given in section &<<SECTexpop>>&
9169 below. The operator notation is used for simple expansion items that have just
9170 one argument, because it reduces the number of braces and therefore makes the
9171 string easier to understand.
9172
9173 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9174 This item inserts &"basic"& header lines. It is described with the &%header%&
9175 expansion item below.
9176
9177
9178 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9179 .cindex "expansion" "calling an acl"
9180 .cindex "&%acl%&" "call from expansion"
9181 The name and zero to nine argument strings are first expanded separately.  The expanded
9182 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9183 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9184 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9185 and may use the variables; if another acl expansion is used the values
9186 are restored after it returns.  If the ACL sets
9187 a value using a "message =" modifier and returns accept or deny, the value becomes
9188 the result of the expansion.
9189 If no message is set and the ACL returns accept or deny
9190 the expansion result is an empty string.
9191 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9192
9193
9194 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9195 .cindex authentication "results header"
9196 .cindex headers "authentication-results:"
9197 .cindex authentication "expansion item"
9198 This item returns a string suitable for insertion as an
9199 &'Authentication-Results"'&
9200 header line.
9201 The given <&'authserv-id'&> is included in the result; typically this
9202 will be a domain name identifying the system performing the authentications.
9203 Methods that might be present in the result include:
9204 .code
9205 none
9206 iprev
9207 auth
9208 spf
9209 dkim
9210 .endd
9211
9212 Example use (as an ACL modifier):
9213 .code
9214       add_header = :at_start:${authresults {$primary_hostname}}
9215 .endd
9216 This is safe even if no authentication results are available.
9217
9218
9219 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9220        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9221 .cindex "expansion" "extracting certificate fields"
9222 .cindex "&%certextract%&" "certificate fields"
9223 .cindex "certificate" "extracting fields"
9224 The <&'certificate'&> must be a variable of type certificate.
9225 The field name is expanded and used to retrieve the relevant field from
9226 the certificate.  Supported fields are:
9227 .display
9228 &`version        `&
9229 &`serial_number  `&
9230 &`subject        `& RFC4514 DN
9231 &`issuer         `& RFC4514 DN
9232 &`notbefore      `& time
9233 &`notafter       `& time
9234 &`sig_algorithm  `&
9235 &`signature      `&
9236 &`subj_altname   `& tagged list
9237 &`ocsp_uri       `& list
9238 &`crl_uri        `& list
9239 .endd
9240 If the field is found,
9241 <&'string2'&> is expanded, and replaces the whole item;
9242 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9243 variable &$value$& contains the value that has been extracted. Afterwards, it
9244 is restored to any previous value it might have had.
9245
9246 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9247 key is not found. If {<&'string2'&>} is also omitted, the value that was
9248 extracted is used.
9249
9250 Some field names take optional modifiers, appended and separated by commas.
9251
9252 The field selectors marked as "RFC4514" above
9253 output a Distinguished Name string which is
9254 not quite
9255 parseable by Exim as a comma-separated tagged list
9256 (the exceptions being elements containing commas).
9257 RDN elements of a single type may be selected by
9258 a modifier of the type label; if so the expansion
9259 result is a list (newline-separated by default).
9260 The separator may be changed by another modifier of
9261 a right angle-bracket followed immediately by the new separator.
9262 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9263
9264 The field selectors marked as "time" above
9265 take an optional modifier of "int"
9266 for which the result is the number of seconds since epoch.
9267 Otherwise the result is a human-readable string
9268 in the timezone selected by the main "timezone" option.
9269
9270 The field selectors marked as "list" above return a list,
9271 newline-separated by default,
9272 (embedded separator characters in elements are doubled).
9273 The separator may be changed by a modifier of
9274 a right angle-bracket followed immediately by the new separator.
9275
9276 The field selectors marked as "tagged" above
9277 prefix each list element with a type string and an equals sign.
9278 Elements of only one type may be selected by a modifier
9279 which is one of "dns", "uri" or "mail";
9280 if so the element tags are omitted.
9281
9282 If not otherwise noted field values are presented in human-readable form.
9283
9284 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9285        {*&<&'arg'&>&*}...}*&"
9286 .cindex &%dlfunc%&
9287 This expansion dynamically loads and then calls a locally-written C function.
9288 This functionality is available only if Exim is compiled with
9289 .code
9290 EXPAND_DLFUNC=yes
9291 .endd
9292 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9293 object so that it doesn't reload the same object file in the same Exim process
9294 (but of course Exim does start new processes frequently).
9295
9296 There may be from zero to eight arguments to the function. When compiling
9297 a local function that is to be called in this way, &_local_scan.h_& should be
9298 included. The Exim variables and functions that are defined by that API
9299 are also available for dynamically loaded functions. The function itself
9300 must have the following type:
9301 .code
9302 int dlfunction(uschar **yield, int argc, uschar *argv[])
9303 .endd
9304 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9305 function should return one of the following values:
9306
9307 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9308 into the expanded string that is being built.
9309
9310 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9311 from &'yield'&, if it is set.
9312
9313 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9314 taken from &'yield'& if it is set.
9315
9316 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9317
9318 When compiling a function that is to be used in this way with gcc,
9319 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9320 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9321
9322
9323 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9324 .cindex "expansion" "extracting value from environment"
9325 .cindex "environment" "values from"
9326 The key is first expanded separately, and leading and trailing white space
9327 removed.
9328 This is then searched for as a name in the environment.
9329 If a variable is found then its value is placed in &$value$&
9330 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9331
9332 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9333 appear, for example:
9334 .code
9335 ${env{USER}{$value} fail }
9336 .endd
9337 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9338 {<&'string1'&>} must be present for &"fail"& to be recognized.
9339
9340 If {<&'string2'&>} is omitted an empty string is substituted on
9341 search failure.
9342 If {<&'string1'&>} is omitted the search result is substituted on
9343 search success.
9344
9345 The environment is adjusted by the &%keep_environment%& and
9346 &%add_environment%& main section options.
9347
9348
9349 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9350        {*&<&'string3'&>&*}}*&"
9351 .cindex "expansion" "extracting substrings by key"
9352 .cindex "&%extract%&" "substrings by key"
9353 The key and <&'string1'&> are first expanded separately. Leading and trailing
9354 white space is removed from the key (but not from any of the strings). The key
9355 must not be empty and must not consist entirely of digits.
9356 The expanded <&'string1'&> must be of the form:
9357 .display
9358 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9359 .endd
9360 .vindex "&$value$&"
9361 where the equals signs and spaces (but not both) are optional. If any of the
9362 values contain white space, they must be enclosed in double quotes, and any
9363 values that are enclosed in double quotes are subject to escape processing as
9364 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9365 for the value that corresponds to the key. The search is case-insensitive. If
9366 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9367 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9368 variable &$value$& contains the value that has been extracted. Afterwards, it
9369 is restored to any previous value it might have had.
9370
9371 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9372 key is not found. If {<&'string2'&>} is also omitted, the value that was
9373 extracted is used. Thus, for example, these two expansions are identical, and
9374 yield &"2001"&:
9375 .code
9376 ${extract{gid}{uid=1984 gid=2001}}
9377 ${extract{gid}{uid=1984 gid=2001}{$value}}
9378 .endd
9379 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9380 appear, for example:
9381 .code
9382 ${extract{Z}{A=... B=...}{$value} fail }
9383 .endd
9384 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9385 {<&'string2'&>} must be present for &"fail"& to be recognized.
9386
9387 .new
9388 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9389        {*&<&'string3'&>&*}}*&"
9390 .cindex "expansion" "extracting from JSON object"
9391 .cindex JSON expansions
9392 The key and <&'string1'&> are first expanded separately. Leading and trailing
9393 white space is removed from the key (but not from any of the strings). The key
9394 must not be empty and must not consist entirely of digits.
9395 The expanded <&'string1'&> must be of the form:
9396 .display
9397 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9398 .endd
9399 .vindex "&$value$&"
9400 The braces, commas and colons, and the quoting of the member name are required;
9401 the spaces are optional.
9402 Matching of the key against the member names is done case-sensitively.
9403 . XXX should be a UTF-8 compare
9404
9405 The results of matching are handled as above.
9406 .wen
9407
9408
9409 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9410         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9411 .cindex "expansion" "extracting substrings by number"
9412 .cindex "&%extract%&" "substrings by number"
9413 The <&'number'&> argument must consist entirely of decimal digits,
9414 apart from leading and trailing white space, which is ignored.
9415 This is what distinguishes this form of &%extract%& from the previous kind. It
9416 behaves in the same way, except that, instead of extracting a named field, it
9417 extracts from <&'string1'&> the field whose number is given as the first
9418 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9419 <&'string3'&> as before.
9420
9421 The fields in the string are separated by any one of the characters in the
9422 separator string. These may include space or tab characters.
9423 The first field is numbered one. If the number is negative, the fields are
9424 counted from the end of the string, with the rightmost one numbered -1. If the
9425 number given is zero, the entire string is returned. If the modulus of the
9426 number is greater than the number of fields in the string, the result is the
9427 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9428 provided. For example:
9429 .code
9430 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9431 .endd
9432 yields &"42"&, and
9433 .code
9434 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9435 .endd
9436 yields &"99"&. Two successive separators mean that the field between them is
9437 empty (for example, the fifth field above).
9438
9439
9440 .new
9441 .vitem "&*${extract json{*&<&'number'&>&*}}&&&
9442         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9443 .cindex "expansion" "extracting from JSON array"
9444 .cindex JSON expansions
9445 The <&'number'&> argument must consist entirely of decimal digits,
9446 apart from leading and trailing white space, which is ignored.
9447
9448 Field selection and result handling is as above;
9449 there is no choice of field separator.
9450 .wen
9451
9452
9453 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9454 .cindex "list" "selecting by condition"
9455 .cindex "expansion" "selecting from list by condition"
9456 .vindex "&$item$&"
9457 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9458 default, but the separator can be changed in the usual way. For each item
9459 in this list, its value is place in &$item$&, and then the condition is
9460 evaluated. If the condition is true, &$item$& is added to the output as an
9461 item in a new list; if the condition is false, the item is discarded. The
9462 separator used for the output list is the same as the one used for the
9463 input, but a separator setting is not included in the output. For example:
9464 .code
9465 ${filter{a:b:c}{!eq{$item}{b}}}
9466 .endd
9467 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9468 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9469
9470
9471 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9472 .cindex "hash function" "textual"
9473 .cindex "expansion" "textual hash"
9474 This is a textual hashing function, and was the first to be implemented in
9475 early versions of Exim. In current releases, there are other hashing functions
9476 (numeric, MD5, and SHA-1), which are described below.
9477
9478 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9479 <&'n'&>. If you are using fixed values for these numbers, that is, if
9480 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9481 use the simpler operator notation that avoids some of the braces:
9482 .code
9483 ${hash_<n>_<m>:<string>}
9484 .endd
9485 The second number is optional (in both notations). If <&'n'&> is greater than
9486 or equal to the length of the string, the expansion item returns the string.
9487 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9488 function to the string. The new string consists of characters taken from the
9489 first <&'m'&> characters of the string
9490 .code
9491 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9492 .endd
9493 If <&'m'&> is not present the value 26 is used, so that only lower case
9494 letters appear. For example:
9495 .display
9496 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9497 &`$hash{5}{monty}}           `&   yields  &`monty`&
9498 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9499 .endd
9500
9501 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9502         &*$h_*&<&'header&~name'&>&*:*&" &&&
9503        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9504         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9505        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9506         &*$lh_*&<&'header&~name'&>&*:*&"
9507        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9508         &*$rh_*&<&'header&~name'&>&*:*&"
9509 .cindex "expansion" "header insertion"
9510 .vindex "&$header_$&"
9511 .vindex "&$bheader_$&"
9512 .vindex "&$lheader_$&"
9513 .vindex "&$rheader_$&"
9514 .cindex "header lines" "in expansion strings"
9515 .cindex "header lines" "character sets"
9516 .cindex "header lines" "decoding"
9517 Substitute the contents of the named message header line, for example
9518 .code
9519 $header_reply-to:
9520 .endd
9521 The newline that terminates a header line is not included in the expansion, but
9522 internal newlines (caused by splitting the header line over several physical
9523 lines) may be present.
9524
9525 The difference between the four pairs of expansions is in the way
9526 the data in the header line is interpreted.
9527
9528 .ilist
9529 .cindex "white space" "in header lines"
9530 &%rheader%& gives the original &"raw"& content of the header line, with no
9531 processing at all, and without the removal of leading and trailing white space.
9532
9533 .next
9534 .cindex "list" "of header lines"
9535 &%lheader%& gives a colon-separated list, one element per header when there
9536 are multiple headers with a given name.
9537 Any embedded colon characters within an element are doubled, so normal Exim
9538 list-processing facilities can be used.
9539 The terminating newline of each element is removed; in other respects
9540 the content is &"raw"&.
9541
9542 .next
9543 .cindex "base64 encoding" "in header lines"
9544 &%bheader%& removes leading and trailing white space, and then decodes base64
9545 or quoted-printable MIME &"words"& within the header text, but does no
9546 character set translation. If decoding of what looks superficially like a MIME
9547 &"word"& fails, the raw string is returned. If decoding
9548 .cindex "binary zero" "in header line"
9549 produces a binary zero character, it is replaced by a question mark &-- this is
9550 what Exim does for binary zeros that are actually received in header lines.
9551
9552 .next
9553 &%header%& tries to translate the string as decoded by &%bheader%& to a
9554 standard character set. This is an attempt to produce the same string as would
9555 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9556 returned. Translation is attempted only on operating systems that support the
9557 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9558 a system Makefile or in &_Local/Makefile_&.
9559 .endlist ilist
9560
9561 In a filter file, the target character set for &%header%& can be specified by a
9562 command of the following form:
9563 .code
9564 headers charset "UTF-8"
9565 .endd
9566 This command affects all references to &$h_$& (or &$header_$&) expansions in
9567 subsequently obeyed filter commands. In the absence of this command, the target
9568 character set in a filter is taken from the setting of the &%headers_charset%&
9569 option in the runtime configuration. The value of this option defaults to the
9570 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9571 ISO-8859-1.
9572
9573 Header names follow the syntax of RFC 2822, which states that they may contain
9574 any printing characters except space and colon. Consequently, curly brackets
9575 &'do not'& terminate header names, and should not be used to enclose them as
9576 if they were variables. Attempting to do so causes a syntax error.
9577
9578 Only header lines that are common to all copies of a message are visible to
9579 this mechanism. These are the original header lines that are received with the
9580 message, and any that are added by an ACL statement or by a system
9581 filter. Header lines that are added to a particular copy of a message by a
9582 router or transport are not accessible.
9583
9584 For incoming SMTP messages, no header lines are visible in
9585 ACLs that are obeyed before the data phase completes,
9586 because the header structure is not set up until the message is received.
9587 They are visible in DKIM, PRDR and DATA ACLs.
9588 Header lines that are added in a RCPT ACL (for example)
9589 are saved until the message's incoming header lines are available, at which
9590 point they are added.
9591 When any of the above ACLs ar
9592 running, however, header lines added by earlier ACLs are visible.
9593
9594 Upper case and lower case letters are synonymous in header names. If the
9595 following character is white space, the terminating colon may be omitted, but
9596 this is not recommended, because you may then forget it when it is needed. When
9597 white space terminates the header name, this white space is included in the
9598 expanded string.  If the message does not contain the given header, the
9599 expansion item is replaced by an empty string. (See the &%def%& condition in
9600 section &<<SECTexpcond>>& for a means of testing for the existence of a
9601 header.)
9602
9603 If there is more than one header with the same name, they are all concatenated
9604 to form the substitution string, up to a maximum length of 64K. Unless
9605 &%rheader%& is being used, leading and trailing white space is removed from
9606 each header before concatenation, and a completely empty header is ignored. A
9607 newline character is then inserted between non-empty headers, but there is no
9608 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9609 those headers that contain lists of addresses, a comma is also inserted at the
9610 junctions between headers. This does not happen for the &%rheader%& expansion.
9611
9612
9613 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9614 .cindex "expansion" "hmac hashing"
9615 .cindex &%hmac%&
9616 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9617 shared secret and some text into a message authentication code, as specified in
9618 RFC 2104. This differs from &`${md5:secret_text...}`& or
9619 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9620 cryptographic hash, allowing for authentication that is not possible with MD5
9621 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9622 present. For example:
9623 .code
9624 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9625 .endd
9626 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9627 produces:
9628 .code
9629 dd97e3ba5d1a61b5006108f8c8252953
9630 .endd
9631 As an example of how this might be used, you might put in the main part of
9632 an Exim configuration:
9633 .code
9634 SPAMSCAN_SECRET=cohgheeLei2thahw
9635 .endd
9636 In a router or a transport you could then have:
9637 .code
9638 headers_add = \
9639   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9640   ${hmac{md5}{SPAMSCAN_SECRET}\
9641   {${primary_hostname},${message_exim_id},$h_message-id:}}
9642 .endd
9643 Then given a message, you can check where it was scanned by looking at the
9644 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9645 this header line is authentic by recomputing the authentication code from the
9646 host name, message ID and the &'Message-id:'& header line. This can be done
9647 using Exim's &%-be%& option, or by other means, for example by using the
9648 &'hmac_md5_hex()'& function in Perl.
9649
9650
9651 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9652 .cindex "expansion" "conditional"
9653 .cindex "&%if%&, expansion item"
9654 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9655 item; otherwise <&'string2'&> is used. The available conditions are described
9656 in section &<<SECTexpcond>>& below. For example:
9657 .code
9658 ${if eq {$local_part}{postmaster} {yes}{no} }
9659 .endd
9660 The second string need not be present; if it is not and the condition is not
9661 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9662 be present instead of the second string (without any curly brackets). In this
9663 case, the expansion is forced to fail if the condition is not true (see section
9664 &<<SECTforexpfai>>&).
9665
9666 If both strings are omitted, the result is the string &`true`& if the condition
9667 is true, and the empty string if the condition is false. This makes it less
9668 cumbersome to write custom ACL and router conditions. For example, instead of
9669 .code
9670 condition = ${if >{$acl_m4}{3}{true}{false}}
9671 .endd
9672 you can use
9673 .code
9674 condition = ${if >{$acl_m4}{3}}
9675 .endd
9676
9677
9678
9679 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9680 .cindex expansion "imap folder"
9681 .cindex "&%imapfolder%& expansion item"
9682 This item converts a (possibly multilevel, or with non-ASCII characters)
9683 folder specification to a Maildir name for filesystem use.
9684 For information on internationalisation support see &<<SECTi18nMDA>>&.
9685
9686
9687
9688 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9689 .cindex "expansion" "string truncation"
9690 .cindex "&%length%& expansion item"
9691 The &%length%& item is used to extract the initial portion of a string. Both
9692 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9693 you are using a fixed value for the number, that is, if <&'string1'&> does not
9694 change when expanded, you can use the simpler operator notation that avoids
9695 some of the braces:
9696 .code
9697 ${length_<n>:<string>}
9698 .endd
9699 The result of this item is either the first <&'n'&> bytes or the whole
9700 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9701 &%strlen%&, which gives the length of a string.
9702 All measurement is done in bytes and is not UTF-8 aware.
9703
9704
9705 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9706         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9707 .cindex "expansion" "extracting list elements by number"
9708 .cindex "&%listextract%&" "extract list elements by number"
9709 .cindex "list" "extracting elements by number"
9710 The <&'number'&> argument must consist entirely of decimal digits,
9711 apart from an optional leading minus,
9712 and leading and trailing white space (which is ignored).
9713
9714 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9715 default, but the separator can be changed in the usual way.
9716
9717 The first field of the list is numbered one.
9718 If the number is negative, the fields are
9719 counted from the end of the list, with the rightmost one numbered -1.
9720 The numbered element of the list is extracted and placed in &$value$&,
9721 then <&'string2'&> is expanded as the result.
9722
9723 If the modulus of the
9724 number is zero or greater than the number of fields in the string,
9725 the result is the expansion of <&'string3'&>.
9726
9727 For example:
9728 .code
9729 ${listextract{2}{x:42:99}}
9730 .endd
9731 yields &"42"&, and
9732 .code
9733 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9734 .endd
9735 yields &"result: 42"&.
9736
9737 If {<&'string3'&>} is omitted, an empty string is used for string3.
9738 If {<&'string2'&>} is also omitted, the value that was
9739 extracted is used.
9740 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9741
9742
9743 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9744         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9745 This is the first of one of two different types of lookup item, which are both
9746 described in the next item.
9747
9748 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9749         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9750 .cindex "expansion" "lookup in"
9751 .cindex "file" "lookups"
9752 .cindex "lookup" "in expanded string"
9753 The two forms of lookup item specify data lookups in files and databases, as
9754 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9755 lookups, and the second is used for query-style lookups. The <&'key'&>,
9756 <&'file'&>, and <&'query'&> strings are expanded before use.
9757
9758 If there is any white space in a lookup item which is part of a filter command,
9759 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9760 other place where white space is significant, the lookup item must be enclosed
9761 in double quotes. The use of data lookups in users' filter files may be locked
9762 out by the system administrator.
9763
9764 .vindex "&$value$&"
9765 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9766 During its expansion, the variable &$value$& contains the data returned by the
9767 lookup. Afterwards it reverts to the value it had previously (at the outer
9768 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9769 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9770 string on failure. If <&'string2'&> is provided, it can itself be a nested
9771 lookup, thus providing a mechanism for looking up a default value when the
9772 original lookup fails.
9773
9774 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9775 data for the outer lookup while the parameters of the second lookup are
9776 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9777 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9778 appear, and in this case, if the lookup fails, the entire expansion is forced
9779 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9780 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9781 successful lookup, and nothing in the case of failure.
9782
9783 For single-key lookups, the string &"partial"& is permitted to precede the
9784 search type in order to do partial matching, and * or *@ may follow a search
9785 type to request default lookups if the key does not match (see sections
9786 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9787
9788 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9789 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9790 and non-wild parts of the key during the expansion of the replacement text.
9791 They return to their previous values at the end of the lookup item.
9792
9793 This example looks up the postmaster alias in the conventional alias file:
9794 .code
9795 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9796 .endd
9797 This example uses NIS+ to look up the full name of the user corresponding to
9798 the local part of an address, forcing the expansion to fail if it is not found:
9799 .code
9800 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9801   {$value}fail}
9802 .endd
9803
9804
9805 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9806 .cindex "expansion" "list creation"
9807 .vindex "&$item$&"
9808 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9809 default, but the separator can be changed in the usual way. For each item
9810 in this list, its value is place in &$item$&, and then <&'string2'&> is
9811 expanded and added to the output as an item in a new list. The separator used
9812 for the output list is the same as the one used for the input, but a separator
9813 setting is not included in the output. For example:
9814 .code
9815 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9816 .endd
9817 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9818 value of &$item$& is restored to what it was before. See also the &*filter*&
9819 and &*reduce*& expansion items.
9820
9821 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9822 .cindex "expansion" "numeric hash"
9823 .cindex "hash function" "numeric"
9824 The three strings are expanded; the first two must yield numbers. Call them
9825 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9826 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9827 can use the simpler operator notation that avoids some of the braces:
9828 .code
9829 ${nhash_<n>_<m>:<string>}
9830 .endd
9831 The second number is optional (in both notations). If there is only one number,
9832 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9833 processed by a div/mod hash function that returns two numbers, separated by a
9834 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9835 example,
9836 .code
9837 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9838 .endd
9839 returns the string &"6/33"&.
9840
9841
9842
9843 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9844 .cindex "Perl" "use in expanded string"
9845 .cindex "expansion" "calling Perl from"
9846 This item is available only if Exim has been built to include an embedded Perl
9847 interpreter. The subroutine name and the arguments are first separately
9848 expanded, and then the Perl subroutine is called with those arguments. No
9849 additional arguments need be given; the maximum number permitted, including the
9850 name of the subroutine, is nine.
9851
9852 The return value of the subroutine is inserted into the expanded string, unless
9853 the return value is &%undef%&. In that case, the expansion fails in the same
9854 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9855 Whatever you return is evaluated in a scalar context. For example, if you
9856 return the name of a Perl vector, the return value is the size of the vector,
9857 not its contents.
9858
9859 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9860 with the error message that was passed to &%die%&. More details of the embedded
9861 Perl facility are given in chapter &<<CHAPperl>>&.
9862
9863 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9864 out the use of this expansion item in filter files.
9865
9866
9867 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9868 .cindex "&%prvs%& expansion item"
9869 The first argument is a complete email address and the second is secret
9870 keystring. The third argument, specifying a key number, is optional. If absent,
9871 it defaults to 0. The result of the expansion is a prvs-signed email address,
9872 to be typically used with the &%return_path%& option on an &(smtp)& transport
9873 as part of a bounce address tag validation (BATV) scheme. For more discussion
9874 and an example, see section &<<SECTverifyPRVS>>&.
9875
9876 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9877         {*&<&'string'&>&*}}*&"
9878 .cindex "&%prvscheck%& expansion item"
9879 This expansion item is the complement of the &%prvs%& item. It is used for
9880 checking prvs-signed addresses. If the expansion of the first argument does not
9881 yield a syntactically valid prvs-signed address, the whole item expands to the
9882 empty string. When the first argument does expand to a syntactically valid
9883 prvs-signed address, the second argument is expanded, with the prvs-decoded
9884 version of the address and the key number extracted from the address in the
9885 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9886
9887 These two variables can be used in the expansion of the second argument to
9888 retrieve the secret. The validity of the prvs-signed address is then checked
9889 against the secret. The result is stored in the variable &$prvscheck_result$&,
9890 which is empty for failure or &"1"& for success.
9891
9892 The third argument is optional; if it is missing, it defaults to an empty
9893 string. This argument is now expanded. If the result is an empty string, the
9894 result of the expansion is the decoded version of the address. This is the case
9895 whether or not the signature was valid. Otherwise, the result of the expansion
9896 is the expansion of the third argument.
9897
9898 All three variables can be used in the expansion of the third argument.
9899 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9900 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9901
9902 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9903 .cindex "expansion" "inserting an entire file"
9904 .cindex "file" "inserting into expansion"
9905 .cindex "&%readfile%& expansion item"
9906 The file name and end-of-line string are first expanded separately. The file is
9907 then read, and its contents replace the entire item. All newline characters in
9908 the file are replaced by the end-of-line string if it is present. Otherwise,
9909 newlines are left in the string.
9910 String expansion is not applied to the contents of the file. If you want this,
9911 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9912 the string expansion fails.
9913
9914 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9915 locks out the use of this expansion item in filter files.
9916
9917
9918
9919 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9920         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9921 .cindex "expansion" "inserting from a socket"
9922 .cindex "socket, use of in expansion"
9923 .cindex "&%readsocket%& expansion item"
9924 This item inserts data from a Unix domain or TCP socket into the expanded
9925 string. The minimal way of using it uses just two arguments, as in these
9926 examples:
9927 .code
9928 ${readsocket{/socket/name}{request string}}
9929 ${readsocket{inet:some.host:1234}{request string}}
9930 .endd
9931 For a Unix domain socket, the first substring must be the path to the socket.
9932 For an Internet socket, the first substring must contain &`inet:`& followed by
9933 a host name or IP address, followed by a colon and a port, which can be a
9934 number or the name of a TCP port in &_/etc/services_&. An IP address may
9935 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9936 example:
9937 .code
9938 ${readsocket{inet:[::1]:1234}{request string}}
9939 .endd
9940 Only a single host name may be given, but if looking it up yields more than
9941 one IP address, they are each tried in turn until a connection is made. For
9942 both kinds of socket, Exim makes a connection, writes the request string
9943 unless it is an empty string; and no terminating NUL is ever sent)
9944 and reads from the socket until an end-of-file
9945 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9946 extend what can be done. Firstly, you can vary the timeout. For example:
9947 .code
9948 ${readsocket{/socket/name}{request string}{3s}}
9949 .endd
9950
9951 The third argument is a list of options, of which the first element is the timeout
9952 and must be present if the argument is given.
9953 Further elements are options of form &'name=value'&.
9954 Two option types is currently recognised: shutdown and tls.
9955 The first defines whether (the default)
9956 or not a shutdown is done on the connection after sending the request.
9957 Example, to not do so (preferred, eg. by some webservers):
9958 .code
9959 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
9960 .endd
9961 .new
9962 The second, tls, controls the use of TLS on the connection.  Example:
9963 .code
9964 ${readsocket{/socket/name}{request string}{3s:tls=yes}}
9965 .endd
9966 The default is to not use TLS.
9967 If it is enabled, a shutdown as descripbed above is never done.
9968 .wen
9969
9970 A fourth argument allows you to change any newlines that are in the data
9971 that is read, in the same way as for &%readfile%& (see above). This example
9972 turns them into spaces:
9973 .code
9974 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9975 .endd
9976 As with all expansions, the substrings are expanded before the processing
9977 happens. Errors in these sub-expansions cause the expansion to fail. In
9978 addition, the following errors can occur:
9979
9980 .ilist
9981 Failure to create a socket file descriptor;
9982 .next
9983 Failure to connect the socket;
9984 .next
9985 Failure to write the request string;
9986 .next
9987 Timeout on reading from the socket.
9988 .endlist
9989
9990 By default, any of these errors causes the expansion to fail. However, if
9991 you supply a fifth substring, it is expanded and used when any of the above
9992 errors occurs. For example:
9993 .code
9994 ${readsocket{/socket/name}{request string}{3s}{\n}\
9995   {socket failure}}
9996 .endd
9997 You can test for the existence of a Unix domain socket by wrapping this
9998 expansion in &`${if exists`&, but there is a race condition between that test
9999 and the actual opening of the socket, so it is safer to use the fifth argument
10000 if you want to be absolutely sure of avoiding an expansion error for a
10001 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10002
10003 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10004 locks out the use of this expansion item in filter files.
10005
10006
10007 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10008 .cindex "expansion" "reducing a list to a scalar"
10009 .cindex "list" "reducing to a scalar"
10010 .vindex "&$value$&"
10011 .vindex "&$item$&"
10012 This operation reduces a list to a single, scalar string. After expansion,
10013 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10014 separator can be changed in the usual way. Then <&'string2'&> is expanded and
10015 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10016 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
10017 them. The result of that expansion is assigned to &$value$& before the next
10018 iteration. When the end of the list is reached, the final value of &$value$& is
10019 added to the expansion output. The &*reduce*& expansion item can be used in a
10020 number of ways. For example, to add up a list of numbers:
10021 .code
10022 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10023 .endd
10024 The result of that expansion would be &`6`&. The maximum of a list of numbers
10025 can be found:
10026 .code
10027 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10028 .endd
10029 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10030 restored to what they were before. See also the &*filter*& and &*map*&
10031 expansion items.
10032
10033 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10034 This item inserts &"raw"& header lines. It is described with the &%header%&
10035 expansion item above.
10036
10037 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10038         {*&<&'string2'&>&*}}*&"
10039 .cindex "expansion" "running a command"
10040 .cindex "&%run%& expansion item"
10041 The command and its arguments are first expanded as one string. The string is
10042 split apart into individual arguments by spaces, and then the command is run
10043 in a separate process, but under the same uid and gid.  As in other command
10044 executions from Exim, a shell is not used by default. If the command requires
10045 a shell, you must explicitly code it.
10046
10047 Since the arguments are split by spaces, when there is a variable expansion
10048 which has an empty result, it will cause the situation that the argument will
10049 simply be omitted when the program is actually executed by Exim. If the
10050 script/program requires a specific number of arguments and the expanded
10051 variable could possibly result in this empty expansion, the variable must be
10052 quoted. This is more difficult if the expanded variable itself could result
10053 in a string containing quotes, because it would interfere with the quotes
10054 around the command arguments. A possible guard against this is to wrap the
10055 variable in the &%sg%& operator to change any quote marks to some other
10056 character.
10057
10058 The standard input for the command exists, but is empty. The standard output
10059 and standard error are set to the same file descriptor.
10060 .cindex "return code" "from &%run%& expansion"
10061 .vindex "&$value$&"
10062 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10063 and replaces the entire item; during this expansion, the standard output/error
10064 from the command is in the variable &$value$&. If the command fails,
10065 <&'string2'&>, if present, is expanded and used. Once again, during the
10066 expansion, the standard output/error from the command is in the variable
10067 &$value$&.
10068
10069 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10070 can be the word &"fail"& (not in braces) to force expansion failure if the
10071 command does not succeed. If both strings are omitted, the result is contents
10072 of the standard output/error on success, and nothing on failure.
10073
10074 .vindex "&$run_in_acl$&"
10075 The standard output/error of the command is put in the variable &$value$&.
10076 In this ACL example, the output of a command is logged for the admin to
10077 troubleshoot:
10078 .code
10079 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10080       log_message  = Output of id: $value
10081 .endd
10082 If the command requires shell idioms, such as the > redirect operator, the
10083 shell must be invoked directly, such as with:
10084 .code
10085 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10086 .endd
10087
10088 .vindex "&$runrc$&"
10089 The return code from the command is put in the variable &$runrc$&, and this
10090 remains set afterwards, so in a filter file you can do things like this:
10091 .code
10092 if "${run{x y z}{}}$runrc" is 1 then ...
10093   elif $runrc is 2 then ...
10094   ...
10095 endif
10096 .endd
10097 If execution of the command fails (for example, the command does not exist),
10098 the return code is 127 &-- the same code that shells use for non-existent
10099 commands.
10100
10101 &*Warning*&: In a router or transport, you cannot assume the order in which
10102 option values are expanded, except for those preconditions whose order of
10103 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10104 by the expansion of one option, and use it in another.
10105
10106 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10107 out the use of this expansion item in filter files.
10108
10109
10110 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10111 .cindex "expansion" "string substitution"
10112 .cindex "&%sg%& expansion item"
10113 This item works like Perl's substitution operator (s) with the global (/g)
10114 option; hence its name. However, unlike the Perl equivalent, Exim does not
10115 modify the subject string; instead it returns the modified string for insertion
10116 into the overall expansion. The item takes three arguments: the subject string,
10117 a regular expression, and a substitution string. For example:
10118 .code
10119 ${sg{abcdefabcdef}{abc}{xyz}}
10120 .endd
10121 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10122 if any $, } or \ characters are required in the regular expression or in the
10123 substitution string, they have to be escaped. For example:
10124 .code
10125 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10126 .endd
10127 yields &"defabc"&, and
10128 .code
10129 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10130 .endd
10131 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10132 the regular expression from string expansion.
10133
10134 The regular expression is compiled in 8-bit mode, working against bytes
10135 rather than any Unicode-aware character handling.
10136
10137
10138 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10139 .cindex sorting "a list"
10140 .cindex list sorting
10141 .cindex expansion "list sorting"
10142 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10143 default, but the separator can be changed in the usual way.
10144 The <&'comparator'&> argument is interpreted as the operator
10145 of a two-argument expansion condition.
10146 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10147 The comparison should return true when applied to two values
10148 if the first value should sort before the second value.
10149 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10150 the element being placed in &$item$&,
10151 to give values for comparison.
10152
10153 The item result is a sorted list,
10154 with the original list separator,
10155 of the list elements (in full) of the original.
10156
10157 Examples:
10158 .code
10159 ${sort{3:2:1:4}{<}{$item}}
10160 .endd
10161 sorts a list of numbers, and
10162 .code
10163 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10164 .endd
10165 will sort an MX lookup into priority order.
10166
10167
10168 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10169 .cindex "&%substr%& expansion item"
10170 .cindex "substring extraction"
10171 .cindex "expansion" "substring extraction"
10172 The three strings are expanded; the first two must yield numbers. Call them
10173 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10174 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10175 can use the simpler operator notation that avoids some of the braces:
10176 .code
10177 ${substr_<n>_<m>:<string>}
10178 .endd
10179 The second number is optional (in both notations).
10180 If it is absent in the simpler format, the preceding underscore must also be
10181 omitted.
10182
10183 The &%substr%& item can be used to extract more general substrings than
10184 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10185 length required. For example
10186 .code
10187 ${substr{3}{2}{$local_part}}
10188 .endd
10189 If the starting offset is greater than the string length the result is the
10190 null string; if the length plus starting offset is greater than the string
10191 length, the result is the right-hand part of the string, starting from the
10192 given offset. The first byte (character) in the string has offset zero.
10193
10194 The &%substr%& expansion item can take negative offset values to count
10195 from the right-hand end of its operand. The last byte (character) is offset -1,
10196 the second-last is offset -2, and so on. Thus, for example,
10197 .code
10198 ${substr{-5}{2}{1234567}}
10199 .endd
10200 yields &"34"&. If the absolute value of a negative offset is greater than the
10201 length of the string, the substring starts at the beginning of the string, and
10202 the length is reduced by the amount of overshoot. Thus, for example,
10203 .code
10204 ${substr{-5}{2}{12}}
10205 .endd
10206 yields an empty string, but
10207 .code
10208 ${substr{-3}{2}{12}}
10209 .endd
10210 yields &"1"&.
10211
10212 When the second number is omitted from &%substr%&, the remainder of the string
10213 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10214 string preceding the offset point are taken. For example, an offset of -1 and
10215 no length, as in these semantically identical examples:
10216 .code
10217 ${substr_-1:abcde}
10218 ${substr{-1}{abcde}}
10219 .endd
10220 yields all but the last character of the string, that is, &"abcd"&.
10221
10222 All measurement is done in bytes and is not UTF-8 aware.
10223
10224
10225
10226 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10227         {*&<&'replacements'&>&*}}*&"
10228 .cindex "expansion" "character translation"
10229 .cindex "&%tr%& expansion item"
10230 This item does single-character (in bytes) translation on its subject string. The second
10231 argument is a list of characters to be translated in the subject string. Each
10232 matching character is replaced by the corresponding character from the
10233 replacement list. For example
10234 .code
10235 ${tr{abcdea}{ac}{13}}
10236 .endd
10237 yields &`1b3de1`&. If there are duplicates in the second character string, the
10238 last occurrence is used. If the third string is shorter than the second, its
10239 last character is replicated. However, if it is empty, no translation takes
10240 place.
10241
10242 All character handling is done in bytes and is not UTF-8 aware.
10243
10244 .endlist
10245
10246
10247
10248 .section "Expansion operators" "SECTexpop"
10249 .cindex "expansion" "operators"
10250 For expansion items that perform transformations on a single argument string,
10251 the &"operator"& notation is used because it is simpler and uses fewer braces.
10252 The substring is first expanded before the operation is applied to it. The
10253 following operations can be performed:
10254
10255 .vlist
10256 .vitem &*${address:*&<&'string'&>&*}*&
10257 .cindex "expansion" "RFC 2822 address handling"
10258 .cindex "&%address%& expansion item"
10259 The string is interpreted as an RFC 2822 address, as it might appear in a
10260 header line, and the effective address is extracted from it. If the string does
10261 not parse successfully, the result is empty.
10262
10263 The parsing correctly handles SMTPUTF8 Unicode in the string.
10264
10265
10266 .vitem &*${addresses:*&<&'string'&>&*}*&
10267 .cindex "expansion" "RFC 2822 address handling"
10268 .cindex "&%addresses%& expansion item"
10269 The string (after expansion) is interpreted as a list of addresses in RFC
10270 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10271 operative address (&'local-part@domain'&) is extracted from each item, and the
10272 result of the expansion is a colon-separated list, with appropriate
10273 doubling of colons should any happen to be present in the email addresses.
10274 Syntactically invalid RFC2822 address items are omitted from the output.
10275
10276 It is possible to specify a character other than colon for the output
10277 separator by starting the string with > followed by the new separator
10278 character. For example:
10279 .code
10280 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10281 .endd
10282 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10283 first, so if the expanded string starts with >, it may change the output
10284 separator unintentionally. This can be avoided by setting the output
10285 separator explicitly:
10286 .code
10287 ${addresses:>:$h_from:}
10288 .endd
10289
10290 Compare the &*address*& (singular)
10291 expansion item, which extracts the working address from a single RFC2822
10292 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10293 processing lists.
10294
10295 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10296 a strict interpretation of header line formatting.  Exim parses the bare,
10297 unquoted portion of an email address and if it finds a comma, treats it as an
10298 email address separator. For the example header line:
10299 .code
10300 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10301 .endd
10302 The first example below demonstrates that Q-encoded email addresses are parsed
10303 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10304 It does not see the comma because it's still encoded as "=2C".  The second
10305 example below is passed the contents of &`$header_from:`&, meaning it gets
10306 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10307 The third example shows that the presence of a comma is skipped when it is
10308 quoted.  The fourth example shows SMTPUTF8 handling.
10309 .code
10310 # exim -be '${addresses:From: \
10311 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10312 user@example.com
10313 # exim -be '${addresses:From: Last, First <user@example.com>}'
10314 Last:user@example.com
10315 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10316 user@example.com
10317 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10318 フィリップ@example.jp
10319 .endd
10320
10321 .vitem &*${base32:*&<&'digits'&>&*}*&
10322 .cindex "&%base32%& expansion item"
10323 .cindex "expansion" "conversion to base 32"
10324 The string must consist entirely of decimal digits. The number is converted to
10325 base 32 and output as a (empty, for zero) string of characters.
10326 Only lowercase letters are used.
10327
10328 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10329 .cindex "&%base32d%& expansion item"
10330 .cindex "expansion" "conversion to base 32"
10331 The string must consist entirely of base-32 digits.
10332 The number is converted to decimal and output as a string.
10333
10334 .vitem &*${base62:*&<&'digits'&>&*}*&
10335 .cindex "&%base62%& expansion item"
10336 .cindex "expansion" "conversion to base 62"
10337 The string must consist entirely of decimal digits. The number is converted to
10338 base 62 and output as a string of six characters, including leading zeros. In
10339 the few operating environments where Exim uses base 36 instead of base 62 for
10340 its message identifiers (because those systems do not have case-sensitive file
10341 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
10342 be absolutely clear: this is &'not'& base64 encoding.
10343
10344 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10345 .cindex "&%base62d%& expansion item"
10346 .cindex "expansion" "conversion to base 62"
10347 The string must consist entirely of base-62 digits, or, in operating
10348 environments where Exim uses base 36 instead of base 62 for its message
10349 identifiers, base-36 digits. The number is converted to decimal and output as a
10350 string.
10351
10352 .vitem &*${base64:*&<&'string'&>&*}*&
10353 .cindex "expansion" "base64 encoding"
10354 .cindex "base64 encoding" "in string expansion"
10355 .cindex "&%base64%& expansion item"
10356 .cindex certificate "base64 of DER"
10357 This operator converts a string into one that is base64 encoded.
10358
10359 If the string is a single variable of type certificate,
10360 returns the base64 encoding of the DER form of the certificate.
10361
10362
10363 .vitem &*${base64d:*&<&'string'&>&*}*&
10364 .cindex "expansion" "base64 decoding"
10365 .cindex "base64 decoding" "in string expansion"
10366 .cindex "&%base64d%& expansion item"
10367 This operator converts a base64-encoded string into the un-coded form.
10368
10369
10370 .vitem &*${domain:*&<&'string'&>&*}*&
10371 .cindex "domain" "extraction"
10372 .cindex "expansion" "domain extraction"
10373 The string is interpreted as an RFC 2822 address and the domain is extracted
10374 from it. If the string does not parse successfully, the result is empty.
10375
10376
10377 .vitem &*${escape:*&<&'string'&>&*}*&
10378 .cindex "expansion" "escaping non-printing characters"
10379 .cindex "&%escape%& expansion item"
10380 If the string contains any non-printing characters, they are converted to
10381 escape sequences starting with a backslash. Whether characters with the most
10382 significant bit set (so-called &"8-bit characters"&) count as printing or not
10383 is controlled by the &%print_topbitchars%& option.
10384
10385 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10386 .cindex "expansion" "escaping 8-bit characters"
10387 .cindex "&%escape8bit%& expansion item"
10388 If the string contains and characters with the most significant bit set,
10389 they are converted to escape sequences starting with a backslash.
10390 Backslashes and DEL characters are also converted.
10391
10392
10393 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10394 .cindex "expansion" "expression evaluation"
10395 .cindex "expansion" "arithmetic expression"
10396 .cindex "&%eval%& expansion item"
10397 These items supports simple arithmetic and bitwise logical operations in
10398 expansion strings. The string (after expansion) must be a conventional
10399 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10400 logical operators, and parentheses. All operations are carried out using
10401 integer arithmetic. The operator priorities are as follows (the same as in the
10402 C programming language):
10403 .table2 70pt 300pt
10404 .irow &'highest:'& "not (~), negate (-)"
10405 .irow ""   "multiply (*), divide (/), remainder (%)"
10406 .irow ""   "plus (+), minus (-)"
10407 .irow ""   "shift-left (<<), shift-right (>>)"
10408 .irow ""   "and (&&)"
10409 .irow ""   "xor (^)"
10410 .irow &'lowest:'&  "or (|)"
10411 .endtable
10412 Binary operators with the same priority are evaluated from left to right. White
10413 space is permitted before or after operators.
10414
10415 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10416 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10417 decimal, even if they start with a leading zero; hexadecimal numbers are not
10418 permitted. This can be useful when processing numbers extracted from dates or
10419 times, which often do have leading zeros.
10420
10421 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10422 or 1024*1024*1024,
10423 respectively. Negative numbers are supported. The result of the computation is
10424 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10425
10426 .display
10427 &`${eval:1+1}            `&  yields 2
10428 &`${eval:1+2*3}          `&  yields 7
10429 &`${eval:(1+2)*3}        `&  yields 9
10430 &`${eval:2+42%5}         `&  yields 4
10431 &`${eval:0xc&amp;5}          `&  yields 4
10432 &`${eval:0xc|5}          `&  yields 13
10433 &`${eval:0xc^5}          `&  yields 9
10434 &`${eval:0xc>>1}         `&  yields 6
10435 &`${eval:0xc<<1}         `&  yields 24
10436 &`${eval:~255&amp;0x1234}    `&  yields 4608
10437 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10438 .endd
10439
10440 As a more realistic example, in an ACL you might have
10441 .code
10442 deny   message = Too many bad recipients
10443        condition =                    \
10444          ${if and {                   \
10445            {>{$rcpt_count}{10}}       \
10446            {                          \
10447            <                          \
10448              {$recipients_count}      \
10449              {${eval:$rcpt_count/2}}  \
10450            }                          \
10451          }{yes}{no}}
10452 .endd
10453 The condition is true if there have been more than 10 RCPT commands and
10454 fewer than half of them have resulted in a valid recipient.
10455
10456
10457 .vitem &*${expand:*&<&'string'&>&*}*&
10458 .cindex "expansion" "re-expansion of substring"
10459 The &%expand%& operator causes a string to be expanded for a second time. For
10460 example,
10461 .code
10462 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10463 .endd
10464 first looks up a string in a file while expanding the operand for &%expand%&,
10465 and then re-expands what it has found.
10466
10467
10468 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10469 .cindex "Unicode"
10470 .cindex "UTF-8" "conversion from"
10471 .cindex "expansion" "UTF-8 conversion"
10472 .cindex "&%from_utf8%& expansion item"
10473 The world is slowly moving towards Unicode, although there are no standards for
10474 email yet. However, other applications (including some databases) are starting
10475 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10476 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10477 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10478 the result is an undefined sequence of bytes.
10479
10480 Unicode code points with values less than 256 are compatible with ASCII and
10481 ISO-8859-1 (also known as Latin-1).
10482 For example, character 169 is the copyright symbol in both cases, though the
10483 way it is encoded is different. In UTF-8, more than one byte is needed for
10484 characters with code values greater than 127, whereas ISO-8859-1 is a
10485 single-byte encoding (but thereby limited to 256 characters). This makes
10486 translation from UTF-8 to ISO-8859-1 straightforward.
10487
10488
10489 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10490 .cindex "hash function" "textual"
10491 .cindex "expansion" "textual hash"
10492 The &%hash%& operator is a simpler interface to the hashing function that can
10493 be used when the two parameters are fixed numbers (as opposed to strings that
10494 change when expanded). The effect is the same as
10495 .code
10496 ${hash{<n>}{<m>}{<string>}}
10497 .endd
10498 See the description of the general &%hash%& item above for details. The
10499 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10500
10501
10502
10503 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10504 .cindex "base64 encoding" "conversion from hex"
10505 .cindex "expansion" "hex to base64"
10506 .cindex "&%hex2b64%& expansion item"
10507 This operator converts a hex string into one that is base64 encoded. This can
10508 be useful for processing the output of the various hashing functions.
10509
10510
10511
10512 .vitem &*${hexquote:*&<&'string'&>&*}*&
10513 .cindex "quoting" "hex-encoded unprintable characters"
10514 .cindex "&%hexquote%& expansion item"
10515 This operator converts non-printable characters in a string into a hex
10516 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10517 as is, and other byte values are converted to &`\xNN`&, for example a
10518 byte value 127 is converted to &`\x7f`&.
10519
10520
10521 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10522 .cindex "&%ipv6denorm%& expansion item"
10523 .cindex "IP address" normalisation
10524 This expands an IPv6 address to a full eight-element colon-separated set
10525 of hex digits including leading zeroes.
10526 A trailing ipv4-style dotted-decimal set is converted to hex.
10527 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10528
10529 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10530 .cindex "&%ipv6norm%& expansion item"
10531 .cindex "IP address" normalisation
10532 .cindex "IP address" "canonical form"
10533 This converts an IPv6 address to canonical form.
10534 Leading zeroes of groups are omitted, and the longest
10535 set of zero-valued groups is replaced with a double colon.
10536 A trailing ipv4-style dotted-decimal set is converted to hex.
10537 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10538
10539
10540 .vitem &*${lc:*&<&'string'&>&*}*&
10541 .cindex "case forcing in strings"
10542 .cindex "string" "case forcing"
10543 .cindex "lower casing"
10544 .cindex "expansion" "case forcing"
10545 .cindex "&%lc%& expansion item"
10546 This forces the letters in the string into lower-case, for example:
10547 .code
10548 ${lc:$local_part}
10549 .endd
10550 Case is defined per the system C locale.
10551
10552 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10553 .cindex "expansion" "string truncation"
10554 .cindex "&%length%& expansion item"
10555 The &%length%& operator is a simpler interface to the &%length%& function that
10556 can be used when the parameter is a fixed number (as opposed to a string that
10557 changes when expanded). The effect is the same as
10558 .code
10559 ${length{<number>}{<string>}}
10560 .endd
10561 See the description of the general &%length%& item above for details. Note that
10562 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10563 when &%length%& is used as an operator.
10564 All measurement is done in bytes and is not UTF-8 aware.
10565
10566
10567 .vitem &*${listcount:*&<&'string'&>&*}*&
10568 .cindex "expansion" "list item count"
10569 .cindex "list" "item count"
10570 .cindex "list" "count of items"
10571 .cindex "&%listcount%& expansion item"
10572 The string is interpreted as a list and the number of items is returned.
10573
10574
10575 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10576 .cindex "expansion" "named list"
10577 .cindex "&%listnamed%& expansion item"
10578 The name is interpreted as a named list and the content of the list is returned,
10579 expanding any referenced lists, re-quoting as needed for colon-separation.
10580 If the optional type is given it must be one of "a", "d", "h" or "l"
10581 and selects address-, domain-, host- or localpart- lists to search among respectively.
10582 Otherwise all types are searched in an undefined order and the first
10583 matching list is returned.
10584
10585
10586 .vitem &*${local_part:*&<&'string'&>&*}*&
10587 .cindex "expansion" "local part extraction"
10588 .cindex "&%local_part%& expansion item"
10589 The string is interpreted as an RFC 2822 address and the local part is
10590 extracted from it. If the string does not parse successfully, the result is
10591 empty.
10592 The parsing correctly handles SMTPUTF8 Unicode in the string.
10593
10594
10595 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10596 .cindex "masked IP address"
10597 .cindex "IP address" "masking"
10598 .cindex "CIDR notation"
10599 .cindex "expansion" "IP address masking"
10600 .cindex "&%mask%& expansion item"
10601 If the form of the string to be operated on is not an IP address followed by a
10602 slash and an integer (that is, a network address in CIDR notation), the
10603 expansion fails. Otherwise, this operator converts the IP address to binary,
10604 masks off the least significant bits according to the bit count, and converts
10605 the result back to text, with mask appended. For example,
10606 .code
10607 ${mask:10.111.131.206/28}
10608 .endd
10609 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10610 be mostly used for looking up masked addresses in files, the result for an IPv6
10611 address uses dots to separate components instead of colons, because colon
10612 terminates a key string in lsearch files. So, for example,
10613 .code
10614 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10615 .endd
10616 returns the string
10617 .code
10618 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10619 .endd
10620 Letters in IPv6 addresses are always output in lower case.
10621
10622
10623 .vitem &*${md5:*&<&'string'&>&*}*&
10624 .cindex "MD5 hash"
10625 .cindex "expansion" "MD5 hash"
10626 .cindex certificate fingerprint
10627 .cindex "&%md5%& expansion item"
10628 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10629 as a 32-digit hexadecimal number, in which any letters are in lower case.
10630
10631 If the string is a single variable of type certificate,
10632 returns the MD5 hash fingerprint of the certificate.
10633
10634
10635 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10636 .cindex "expansion" "numeric hash"
10637 .cindex "hash function" "numeric"
10638 The &%nhash%& operator is a simpler interface to the numeric hashing function
10639 that can be used when the two parameters are fixed numbers (as opposed to
10640 strings that change when expanded). The effect is the same as
10641 .code
10642 ${nhash{<n>}{<m>}{<string>}}
10643 .endd
10644 See the description of the general &%nhash%& item above for details.
10645
10646
10647 .vitem &*${quote:*&<&'string'&>&*}*&
10648 .cindex "quoting" "in string expansions"
10649 .cindex "expansion" "quoting"
10650 .cindex "&%quote%& expansion item"
10651 The &%quote%& operator puts its argument into double quotes if it
10652 is an empty string or
10653 contains anything other than letters, digits, underscores, dots, and hyphens.
10654 Any occurrences of double quotes and backslashes are escaped with a backslash.
10655 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10656 respectively For example,
10657 .code
10658 ${quote:ab"*"cd}
10659 .endd
10660 becomes
10661 .code
10662 "ab\"*\"cd"
10663 .endd
10664 The place where this is useful is when the argument is a substitution from a
10665 variable or a message header.
10666
10667 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10668 .cindex "&%quote_local_part%& expansion item"
10669 This operator is like &%quote%&, except that it quotes the string only if
10670 required to do so by the rules of RFC 2822 for quoting local parts. For
10671 example, a plus sign would not cause quoting (but it would for &%quote%&).
10672 If you are creating a new email address from the contents of &$local_part$&
10673 (or any other unknown data), you should always use this operator.
10674
10675 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
10676 will likely use the quoting form.
10677 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
10678
10679
10680 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10681 .cindex "quoting" "lookup-specific"
10682 This operator applies lookup-specific quoting rules to the string. Each
10683 query-style lookup type has its own quoting rules which are described with
10684 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10685 .code
10686 ${quote_ldap:two * two}
10687 .endd
10688 returns
10689 .code
10690 two%20%5C2A%20two
10691 .endd
10692 For single-key lookup types, no quoting is ever necessary and this operator
10693 yields an unchanged string.
10694
10695
10696 .vitem &*${randint:*&<&'n'&>&*}*&
10697 .cindex "random number"
10698 This operator returns a somewhat random number which is less than the
10699 supplied number and is at least 0.  The quality of this randomness depends
10700 on how Exim was built; the values are not suitable for keying material.
10701 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10702 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10703 for versions of GnuTLS with that function.
10704 Otherwise, the implementation may be arc4random(), random() seeded by
10705 srandomdev() or srandom(), or a custom implementation even weaker than
10706 random().
10707
10708
10709 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10710 .cindex "expansion" "IP address"
10711 This operator reverses an IP address; for IPv4 addresses, the result is in
10712 dotted-quad decimal form, while for IPv6 addresses the result is in
10713 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10714 for DNS.  For example,
10715 .code
10716 ${reverse_ip:192.0.2.4}
10717 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10718 .endd
10719 returns
10720 .code
10721 4.2.0.192
10722 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
10723 .endd
10724
10725
10726 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10727 .cindex "expansion" "RFC 2047"
10728 .cindex "RFC 2047" "expansion operator"
10729 .cindex "&%rfc2047%& expansion item"
10730 This operator encodes text according to the rules of RFC 2047. This is an
10731 encoding that is used in header lines to encode non-ASCII characters. It is
10732 assumed that the input string is in the encoding specified by the
10733 &%headers_charset%& option, which gets its default at build time. If the string
10734 contains only characters in the range 33&--126, and no instances of the
10735 characters
10736 .code
10737 ? = ( ) < > @ , ; : \ " . [ ] _
10738 .endd
10739 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10740 string, using as many &"encoded words"& as necessary to encode all the
10741 characters.
10742
10743
10744 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10745 .cindex "expansion" "RFC 2047"
10746 .cindex "RFC 2047" "decoding"
10747 .cindex "&%rfc2047d%& expansion item"
10748 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10749 bytes are replaced by question marks. Characters are converted into the
10750 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10751 not recognized unless &%check_rfc2047_length%& is set false.
10752
10753 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10754 access a header line, RFC 2047 decoding is done automatically. You do not need
10755 to use this operator as well.
10756
10757
10758
10759 .vitem &*${rxquote:*&<&'string'&>&*}*&
10760 .cindex "quoting" "in regular expressions"
10761 .cindex "regular expressions" "quoting"
10762 .cindex "&%rxquote%& expansion item"
10763 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10764 characters in its argument. This is useful when substituting the values of
10765 variables or headers inside regular expressions.
10766
10767
10768 .vitem &*${sha1:*&<&'string'&>&*}*&
10769 .cindex "SHA-1 hash"
10770 .cindex "expansion" "SHA-1 hashing"
10771 .cindex certificate fingerprint
10772 .cindex "&%sha1%& expansion item"
10773 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10774 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10775
10776 If the string is a single variable of type certificate,
10777 returns the SHA-1 hash fingerprint of the certificate.
10778
10779
10780 .vitem &*${sha256:*&<&'string'&>&*}*&
10781 .cindex "SHA-256 hash"
10782 .cindex certificate fingerprint
10783 .cindex "expansion" "SHA-256 hashing"
10784 .cindex "&%sha256%& expansion item"
10785 The &%sha256%& operator computes the SHA-256 hash value of the string
10786 and returns
10787 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10788
10789 If the string is a single variable of type certificate,
10790 returns the SHA-256 hash fingerprint of the certificate.
10791
10792
10793 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
10794        &*${sha3_<n>:*&<&'string'&>&*}*&
10795 .cindex "SHA3 hash"
10796 .cindex "expansion" "SHA3 hashing"
10797 .cindex "&%sha3%& expansion item"
10798 The &%sha3%& operator computes the SHA3-256 hash value of the string
10799 and returns
10800 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10801
10802 If a number is appended, separated by an underbar, it specifies
10803 the output length.  Values of 224, 256, 384 and 512 are accepted;
10804 with 256 being the default.
10805
10806 The &%sha3%& expansion item is only supported if Exim has been
10807 compiled with GnuTLS 3.5.0 or later,
10808 or OpenSSL 1.1.1 or later.
10809 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
10810
10811
10812 .vitem &*${stat:*&<&'string'&>&*}*&
10813 .cindex "expansion" "statting a file"
10814 .cindex "file" "extracting characteristics"
10815 .cindex "&%stat%& expansion item"
10816 The string, after expansion, must be a file path. A call to the &[stat()]&
10817 function is made for this path. If &[stat()]& fails, an error occurs and the
10818 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10819 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10820 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10821 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10822 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10823 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10824 can extract individual fields using the &%extract%& expansion item.
10825
10826 The use of the &%stat%& expansion in users' filter files can be locked out by
10827 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10828 systems for files larger than 2GB.
10829
10830 .vitem &*${str2b64:*&<&'string'&>&*}*&
10831 .cindex "&%str2b64%& expansion item"
10832 Now deprecated, a synonym for the &%base64%& expansion operator.
10833
10834
10835
10836 .vitem &*${strlen:*&<&'string'&>&*}*&
10837 .cindex "expansion" "string length"
10838 .cindex "string" "length in expansion"
10839 .cindex "&%strlen%& expansion item"
10840 The item is replace by the length of the expanded string, expressed as a
10841 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10842 All measurement is done in bytes and is not UTF-8 aware.
10843
10844
10845 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10846 .cindex "&%substr%& expansion item"
10847 .cindex "substring extraction"
10848 .cindex "expansion" "substring expansion"
10849 The &%substr%& operator is a simpler interface to the &%substr%& function that
10850 can be used when the two parameters are fixed numbers (as opposed to strings
10851 that change when expanded). The effect is the same as
10852 .code
10853 ${substr{<start>}{<length>}{<string>}}
10854 .endd
10855 See the description of the general &%substr%& item above for details. The
10856 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10857 All measurement is done in bytes and is not UTF-8 aware.
10858
10859 .vitem &*${time_eval:*&<&'string'&>&*}*&
10860 .cindex "&%time_eval%& expansion item"
10861 .cindex "time interval" "decoding"
10862 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10863 seconds.
10864
10865 .vitem &*${time_interval:*&<&'string'&>&*}*&
10866 .cindex "&%time_interval%& expansion item"
10867 .cindex "time interval" "formatting"
10868 The argument (after sub-expansion) must be a sequence of decimal digits that
10869 represents an interval of time as a number of seconds. It is converted into a
10870 number of larger units and output in Exim's normal time format, for example,
10871 &`1w3d4h2m6s`&.
10872
10873 .vitem &*${uc:*&<&'string'&>&*}*&
10874 .cindex "case forcing in strings"
10875 .cindex "string" "case forcing"
10876 .cindex "upper casing"
10877 .cindex "expansion" "case forcing"
10878 .cindex "&%uc%& expansion item"
10879 This forces the letters in the string into upper-case.
10880 Case is defined per the system C locale.
10881
10882 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10883 .cindex "correction of invalid utf-8 sequences in strings"
10884 .cindex "utf-8" "utf-8 sequences"
10885 .cindex "incorrect utf-8"
10886 .cindex "expansion" "utf-8 forcing"
10887 .cindex "&%utf8clean%& expansion item"
10888 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10889 .new
10890 In versions of Exim before 4.92, this did not correctly do so for a truncated
10891 final codepoint's encoding, and the character would be silently dropped.
10892 If you must handle detection of this scenario across both sets of Exim behavior,
10893 the complexity will depend upon the task.
10894 For instance, to detect if the first character is multibyte and a 1-byte
10895 extraction can be successfully used as a path component (as is common for
10896 dividing up delivery folders), you might use:
10897 .code
10898 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
10899 .endd
10900 (which will false-positive if the first character of the local part is a
10901 literal question mark).
10902 .wen
10903
10904 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
10905        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
10906        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
10907        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
10908 .cindex expansion UTF-8
10909 .cindex UTF-8 expansion
10910 .cindex EAI
10911 .cindex internationalisation
10912 .cindex "&%utf8_domain_to_alabel%& expansion item"
10913 .cindex "&%utf8_domain_from_alabel%& expansion item"
10914 .cindex "&%utf8_localpart_to_alabel%& expansion item"
10915 .cindex "&%utf8_localpart_from_alabel%& expansion item"
10916 These convert EAI mail name components between UTF-8 and a-label forms.
10917 For information on internationalisation support see &<<SECTi18nMTA>>&.
10918 .endlist
10919
10920
10921
10922
10923
10924
10925 .section "Expansion conditions" "SECTexpcond"
10926 .scindex IIDexpcond "expansion" "conditions"
10927 The following conditions are available for testing by the &%${if%& construct
10928 while expanding strings:
10929
10930 .vlist
10931 .vitem &*!*&<&'condition'&>
10932 .cindex "expansion" "negating a condition"
10933 .cindex "negation" "in expansion condition"
10934 Preceding any condition with an exclamation mark negates the result of the
10935 condition.
10936
10937 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10938 .cindex "numeric comparison"
10939 .cindex "expansion" "numeric comparison"
10940 There are a number of symbolic operators for doing numeric comparisons. They
10941 are:
10942 .display
10943 &`=   `&   equal
10944 &`==  `&   equal
10945 &`>   `&   greater
10946 &`>=  `&   greater or equal
10947 &`<   `&   less
10948 &`<=  `&   less or equal
10949 .endd
10950 For example:
10951 .code
10952 ${if >{$message_size}{10M} ...
10953 .endd
10954 Note that the general negation operator provides for inequality testing. The
10955 two strings must take the form of optionally signed decimal integers,
10956 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10957 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10958 As a special case, the numerical value of an empty string is taken as
10959 zero.
10960
10961 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10962 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10963 10M, not if 10M is larger than &$message_size$&.
10964
10965
10966 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10967         {*&<&'arg2'&>&*}...}*&
10968 .cindex "expansion" "calling an acl"
10969 .cindex "&%acl%&" "expansion condition"
10970 The name and zero to nine argument strings are first expanded separately.  The expanded
10971 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10972 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10973 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10974 and may use the variables; if another acl expansion is used the values
10975 are restored after it returns.  If the ACL sets
10976 a value using a "message =" modifier the variable $value becomes
10977 the result of the expansion, otherwise it is empty.
10978 If the ACL returns accept the condition is true; if deny, false.
10979 If the ACL returns defer the result is a forced-fail.
10980
10981 .vitem &*bool&~{*&<&'string'&>&*}*&
10982 .cindex "expansion" "boolean parsing"
10983 .cindex "&%bool%& expansion condition"
10984 This condition turns a string holding a true or false representation into
10985 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10986 (case-insensitively); also integer numbers map to true if non-zero,
10987 false if zero.
10988 An empty string is treated as false.
10989 Leading and trailing whitespace is ignored;
10990 thus a string consisting only of whitespace is false.
10991 All other string values will result in expansion failure.
10992
10993 When combined with ACL variables, this expansion condition will let you
10994 make decisions in one place and act on those decisions in another place.
10995 For example:
10996 .code
10997 ${if bool{$acl_m_privileged_sender} ...
10998 .endd
10999
11000
11001 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11002 .cindex "expansion" "boolean parsing"
11003 .cindex "&%bool_lax%& expansion condition"
11004 Like &%bool%&, this condition turns a string into a boolean state.  But
11005 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11006 loose definition that the Router &%condition%& option uses.  The empty string
11007 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11008 true.  Leading and trailing whitespace is ignored.
11009
11010 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11011
11012 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11013 .cindex "expansion" "encrypted comparison"
11014 .cindex "encrypted strings, comparing"
11015 .cindex "&%crypteq%& expansion condition"
11016 This condition is included in the Exim binary if it is built to support any
11017 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11018 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11019 included in the binary.
11020
11021 The &%crypteq%& condition has two arguments. The first is encrypted and
11022 compared against the second, which is already encrypted. The second string may
11023 be in the LDAP form for storing encrypted strings, which starts with the
11024 encryption type in curly brackets, followed by the data. If the second string
11025 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11026 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11027 Typically this will be a field from a password file. An example of an encrypted
11028 string in LDAP form is:
11029 .code
11030 {md5}CY9rzUYh03PK3k6DJie09g==
11031 .endd
11032 If such a string appears directly in an expansion, the curly brackets have to
11033 be quoted, because they are part of the expansion syntax. For example:
11034 .code
11035 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11036 .endd
11037 The following encryption types (whose names are matched case-independently) are
11038 supported:
11039
11040 .ilist
11041 .cindex "MD5 hash"
11042 .cindex "base64 encoding" "in encrypted password"
11043 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11044 printable characters to compare with the remainder of the second string. If the
11045 length of the comparison string is 24, Exim assumes that it is base64 encoded
11046 (as in the above example). If the length is 32, Exim assumes that it is a
11047 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11048 comparison fails.
11049
11050 .next
11051 .cindex "SHA-1 hash"
11052 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11053 printable characters to compare with the remainder of the second string. If the
11054 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11055 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11056 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11057
11058 .next
11059 .cindex "&[crypt()]&"
11060 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11061 only the first eight characters of the password. However, in modern operating
11062 systems this is no longer true, and in many cases the entire password is used,
11063 whatever its length.
11064
11065 .next
11066 .cindex "&[crypt16()]&"
11067 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11068 use up to 16 characters of the password in some operating systems. Again, in
11069 modern operating systems, more characters may be used.
11070 .endlist
11071 Exim has its own version of &[crypt16()]&, which is just a double call to
11072 &[crypt()]&. For operating systems that have their own version, setting
11073 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11074 operating system version instead of its own. This option is set by default in
11075 the OS-dependent &_Makefile_& for those operating systems that are known to
11076 support &[crypt16()]&.
11077
11078 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11079 it was not using the same algorithm as some operating systems' versions. It
11080 turns out that as well as &[crypt16()]& there is a function called
11081 &[bigcrypt()]& in some operating systems. This may or may not use the same
11082 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11083
11084 However, since there is now a move away from the traditional &[crypt()]&
11085 functions towards using SHA1 and other algorithms, tidying up this area of
11086 Exim is seen as very low priority.
11087
11088 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11089 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11090 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11091 default is &`{crypt}`&. Whatever the default, you can always use either
11092 function by specifying it explicitly in curly brackets.
11093
11094 .vitem &*def:*&<&'variable&~name'&>
11095 .cindex "expansion" "checking for empty variable"
11096 .cindex "&%def%& expansion condition"
11097 The &%def%& condition must be followed by the name of one of the expansion
11098 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11099 variable does not contain the empty string. For example:
11100 .code
11101 ${if def:sender_ident {from $sender_ident}}
11102 .endd
11103 Note that the variable name is given without a leading &%$%& character. If the
11104 variable does not exist, the expansion fails.
11105
11106 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11107         &~&*def:h_*&<&'header&~name'&>&*:*&"
11108 .cindex "expansion" "checking header line existence"
11109 This condition is true if a message is being processed and the named header
11110 exists in the message. For example,
11111 .code
11112 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11113 .endd
11114 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11115 the header name must be terminated by a colon if white space does not follow.
11116
11117 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11118        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11119 .cindex "string" "comparison"
11120 .cindex "expansion" "string comparison"
11121 .cindex "&%eq%& expansion condition"
11122 .cindex "&%eqi%& expansion condition"
11123 The two substrings are first expanded. The condition is true if the two
11124 resulting strings are identical. For &%eq%& the comparison includes the case of
11125 letters, whereas for &%eqi%& the comparison is case-independent, where
11126 case is defined per the system C locale.
11127
11128 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11129 .cindex "expansion" "file existence test"
11130 .cindex "file" "existence test"
11131 .cindex "&%exists%&, expansion condition"
11132 The substring is first expanded and then interpreted as an absolute path. The
11133 condition is true if the named file (or directory) exists. The existence test
11134 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11135 users' filter files may be locked out by the system administrator.
11136
11137 .vitem &*first_delivery*&
11138 .cindex "delivery" "first"
11139 .cindex "first delivery"
11140 .cindex "expansion" "first delivery test"
11141 .cindex "&%first_delivery%& expansion condition"
11142 This condition, which has no data, is true during a message's first delivery
11143 attempt. It is false during any subsequent delivery attempts.
11144
11145
11146 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11147        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11148 .cindex "list" "iterative conditions"
11149 .cindex "expansion" "&*forall*& condition"
11150 .cindex "expansion" "&*forany*& condition"
11151 .vindex "&$item$&"
11152 These conditions iterate over a list. The first argument is expanded to form
11153 the list. By default, the list separator is a colon, but it can be changed by
11154 the normal method. The second argument is interpreted as a condition that is to
11155 be applied to each item in the list in turn. During the interpretation of the
11156 condition, the current list item is placed in a variable called &$item$&.
11157 .ilist
11158 For &*forany*&, interpretation stops if the condition is true for any item, and
11159 the result of the whole condition is true. If the condition is false for all
11160 items in the list, the overall condition is false.
11161 .next
11162 For &*forall*&, interpretation stops if the condition is false for any item,
11163 and the result of the whole condition is false. If the condition is true for
11164 all items in the list, the overall condition is true.
11165 .endlist
11166 Note that negation of &*forany*& means that the condition must be false for all
11167 items for the overall condition to succeed, and negation of &*forall*& means
11168 that the condition must be false for at least one item. In this example, the
11169 list separator is changed to a comma:
11170 .code
11171 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11172 .endd
11173 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
11174 being processed, to enable these expansion items to be nested.
11175
11176 To scan a named list, expand it with the &*listnamed*& operator.
11177
11178
11179 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11180        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11181 .cindex "string" "comparison"
11182 .cindex "expansion" "string comparison"
11183 .cindex "&%ge%& expansion condition"
11184 .cindex "&%gei%& expansion condition"
11185 The two substrings are first expanded. The condition is true if the first
11186 string is lexically greater than or equal to the second string. For &%ge%& the
11187 comparison includes the case of letters, whereas for &%gei%& the comparison is
11188 case-independent.
11189 Case and collation order are defined per the system C locale.
11190
11191 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11192        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11193 .cindex "string" "comparison"
11194 .cindex "expansion" "string comparison"
11195 .cindex "&%gt%& expansion condition"
11196 .cindex "&%gti%& expansion condition"
11197 The two substrings are first expanded. The condition is true if the first
11198 string is lexically greater than the second string. For &%gt%& the comparison
11199 includes the case of letters, whereas for &%gti%& the comparison is
11200 case-independent.
11201 Case and collation order are defined per the system C locale.
11202
11203 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11204        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11205 .cindex "string" "comparison"
11206 .cindex "list" "iterative conditions"
11207 Both strings are expanded; the second string is treated as a list of simple
11208 strings; if the first string is a member of the second, then the condition
11209 is true.
11210 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11211
11212 These are simpler to use versions of the more powerful &*forany*& condition.
11213 Examples, and the &*forany*& equivalents:
11214 .code
11215 ${if inlist{needle}{foo:needle:bar}}
11216   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11217 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11218   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11219 .endd
11220
11221 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11222        &*isip4&~{*&<&'string'&>&*}*& &&&
11223        &*isip6&~{*&<&'string'&>&*}*&
11224 .cindex "IP address" "testing string format"
11225 .cindex "string" "testing for IP address"
11226 .cindex "&%isip%& expansion condition"
11227 .cindex "&%isip4%& expansion condition"
11228 .cindex "&%isip6%& expansion condition"
11229 The substring is first expanded, and then tested to see if it has the form of
11230 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11231 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11232
11233 For an IPv4 address, the test is for four dot-separated components, each of
11234 which consists of from one to three digits. For an IPv6 address, up to eight
11235 colon-separated components are permitted, each containing from one to four
11236 hexadecimal digits. There may be fewer than eight components if an empty
11237 component (adjacent colons) is present. Only one empty component is permitted.
11238
11239 &*Note*&: The checks used to be just on the form of the address; actual numerical
11240 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11241 check.
11242 This is no longer the case.
11243
11244 The main use of these tests is to distinguish between IP addresses and
11245 host names, or between IPv4 and IPv6 addresses. For example, you could use
11246 .code
11247 ${if isip4{$sender_host_address}...
11248 .endd
11249 to test which IP version an incoming SMTP connection is using.
11250
11251 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11252 .cindex "LDAP" "use for authentication"
11253 .cindex "expansion" "LDAP authentication test"
11254 .cindex "&%ldapauth%& expansion condition"
11255 This condition supports user authentication using LDAP. See section
11256 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11257 queries. For this use, the query must contain a user name and password. The
11258 query itself is not used, and can be empty. The condition is true if the
11259 password is not empty, and the user name and password are accepted by the LDAP
11260 server. An empty password is rejected without calling LDAP because LDAP binds
11261 with an empty password are considered anonymous regardless of the username, and
11262 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11263 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11264 this can be used.
11265
11266
11267 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11268        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11269 .cindex "string" "comparison"
11270 .cindex "expansion" "string comparison"
11271 .cindex "&%le%& expansion condition"
11272 .cindex "&%lei%& expansion condition"
11273 The two substrings are first expanded. The condition is true if the first
11274 string is lexically less than or equal to the second string. For &%le%& the
11275 comparison includes the case of letters, whereas for &%lei%& the comparison is
11276 case-independent.
11277 Case and collation order are defined per the system C locale.
11278
11279 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11280        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11281 .cindex "string" "comparison"
11282 .cindex "expansion" "string comparison"
11283 .cindex "&%lt%& expansion condition"
11284 .cindex "&%lti%& expansion condition"
11285 The two substrings are first expanded. The condition is true if the first
11286 string is lexically less than the second string. For &%lt%& the comparison
11287 includes the case of letters, whereas for &%lti%& the comparison is
11288 case-independent.
11289 Case and collation order are defined per the system C locale.
11290
11291
11292 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11293 .cindex "expansion" "regular expression comparison"
11294 .cindex "regular expressions" "match in expanded string"
11295 .cindex "&%match%& expansion condition"
11296 The two substrings are first expanded. The second is then treated as a regular
11297 expression and applied to the first. Because of the pre-expansion, if the
11298 regular expression contains dollar, or backslash characters, they must be
11299 escaped. Care must also be taken if the regular expression contains braces
11300 (curly brackets). A closing brace must be escaped so that it is not taken as a
11301 premature termination of <&'string2'&>. The easiest approach is to use the
11302 &`\N`& feature to disable expansion of the regular expression.
11303 For example,
11304 .code
11305 ${if match {$local_part}{\N^\d{3}\N} ...
11306 .endd
11307 If the whole expansion string is in double quotes, further escaping of
11308 backslashes is also required.
11309
11310 The condition is true if the regular expression match succeeds.
11311 The regular expression is not required to begin with a circumflex
11312 metacharacter, but if there is no circumflex, the expression is not anchored,
11313 and it may match anywhere in the subject, not just at the start. If you want
11314 the pattern to match at the end of the subject, you must include the &`$`&
11315 metacharacter at an appropriate point.
11316 All character handling is done in bytes and is not UTF-8 aware,
11317 but we might change this in a future Exim release.
11318
11319 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11320 At the start of an &%if%& expansion the values of the numeric variable
11321 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11322 succeeds causes them to be reset to the substrings of that condition and they
11323 will have these values during the expansion of the success string. At the end
11324 of the &%if%& expansion, the previous values are restored. After testing a
11325 combination of conditions using &%or%&, the subsequent values of the numeric
11326 variables are those of the condition that succeeded.
11327
11328 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11329 .cindex "&%match_address%& expansion condition"
11330 See &*match_local_part*&.
11331
11332 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11333 .cindex "&%match_domain%& expansion condition"
11334 See &*match_local_part*&.
11335
11336 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11337 .cindex "&%match_ip%& expansion condition"
11338 This condition matches an IP address to a list of IP address patterns. It must
11339 be followed by two argument strings. The first (after expansion) must be an IP
11340 address or an empty string. The second (not expanded) is a restricted host
11341 list that can match only an IP address, not a host name. For example:
11342 .code
11343 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11344 .endd
11345 The specific types of host list item that are permitted in the list are:
11346
11347 .ilist
11348 An IP address, optionally with a CIDR mask.
11349 .next
11350 A single asterisk, which matches any IP address.
11351 .next
11352 An empty item, which matches only if the IP address is empty. This could be
11353 useful for testing for a locally submitted message or one from specific hosts
11354 in a single test such as
11355 . ==== As this is a nested list, any displays it contains must be indented
11356 . ==== as otherwise they are too far to the left. This comment applies to
11357 . ==== the use of xmlto plus fop. There's no problem when formatting with
11358 . ==== sdop, with or without the extra indent.
11359 .code
11360   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11361 .endd
11362 where the first item in the list is the empty string.
11363 .next
11364 The item @[] matches any of the local host's interface addresses.
11365 .next
11366 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11367 even if &`net-`& is not specified. There is never any attempt to turn the IP
11368 address into a host name. The most common type of linear search for
11369 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11370 masks. For example:
11371 .code
11372   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11373 .endd
11374 It is of course possible to use other kinds of lookup, and in such a case, you
11375 do need to specify the &`net-`& prefix if you want to specify a specific
11376 address mask, for example:
11377 .code
11378   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11379 .endd
11380 However, unless you are combining a &%match_ip%& condition with others, it is
11381 just as easy to use the fact that a lookup is itself a condition, and write:
11382 .code
11383   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11384 .endd
11385 .endlist ilist
11386
11387 Note that <&'string2'&> is not itself subject to string expansion, unless
11388 Exim was built with the EXPAND_LISTMATCH_RHS option.
11389
11390 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11391
11392 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11393 .cindex "domain list" "in expansion condition"
11394 .cindex "address list" "in expansion condition"
11395 .cindex "local part" "list, in expansion condition"
11396 .cindex "&%match_local_part%& expansion condition"
11397 This condition, together with &%match_address%& and &%match_domain%&, make it
11398 possible to test domain, address, and local part lists within expansions. Each
11399 condition requires two arguments: an item and a list to match. A trivial
11400 example is:
11401 .code
11402 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11403 .endd
11404 In each case, the second argument may contain any of the allowable items for a
11405 list of the appropriate type. Also, because the second argument
11406 is a standard form of list, it is possible to refer to a named list.
11407 Thus, you can use conditions like this:
11408 .code
11409 ${if match_domain{$domain}{+local_domains}{...
11410 .endd
11411 .cindex "&`+caseful`&"
11412 For address lists, the matching starts off caselessly, but the &`+caseful`&
11413 item can be used, as in all address lists, to cause subsequent items to
11414 have their local parts matched casefully. Domains are always matched
11415 caselessly.
11416
11417 Note that <&'string2'&> is not itself subject to string expansion, unless
11418 Exim was built with the EXPAND_LISTMATCH_RHS option.
11419
11420 &*Note*&: Host lists are &'not'& supported in this way. This is because
11421 hosts have two identities: a name and an IP address, and it is not clear
11422 how to specify cleanly how such a test would work. However, IP addresses can be
11423 matched using &%match_ip%&.
11424
11425 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11426 .cindex "PAM authentication"
11427 .cindex "AUTH" "with PAM"
11428 .cindex "Solaris" "PAM support"
11429 .cindex "expansion" "PAM authentication test"
11430 .cindex "&%pam%& expansion condition"
11431 &'Pluggable Authentication Modules'&
11432 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11433 available in the latest releases of Solaris and in some GNU/Linux
11434 distributions. The Exim support, which is intended for use in conjunction with
11435 the SMTP AUTH command, is available only if Exim is compiled with
11436 .code
11437 SUPPORT_PAM=yes
11438 .endd
11439 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11440 in some releases of GNU/Linux &%-ldl%& is also needed.
11441
11442 The argument string is first expanded, and the result must be a
11443 colon-separated list of strings. Leading and trailing white space is ignored.
11444 The PAM module is initialized with the service name &"exim"& and the user name
11445 taken from the first item in the colon-separated data string (<&'string1'&>).
11446 The remaining items in the data string are passed over in response to requests
11447 from the authentication function. In the simple case there will only be one
11448 request, for a password, so the data consists of just two strings.
11449
11450 There can be problems if any of the strings are permitted to contain colon
11451 characters. In the usual way, these have to be doubled to avoid being taken as
11452 separators. If the data is being inserted from a variable, the &%sg%& expansion
11453 item can be used to double any existing colons. For example, the configuration
11454 of a LOGIN authenticator might contain this setting:
11455 .code
11456 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11457 .endd
11458 For a PLAIN authenticator you could use:
11459 .code
11460 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11461 .endd
11462 In some operating systems, PAM authentication can be done only from a process
11463 running as root. Since Exim is running as the Exim user when receiving
11464 messages, this means that PAM cannot be used directly in those systems.
11465 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11466
11467
11468 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11469 .cindex "&'pwcheck'& daemon"
11470 .cindex "Cyrus"
11471 .cindex "expansion" "&'pwcheck'& authentication test"
11472 .cindex "&%pwcheck%& expansion condition"
11473 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11474 This is one way of making it possible for passwords to be checked by a process
11475 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11476 deprecated. Its replacement is &'saslauthd'& (see below).
11477
11478 The pwcheck support is not included in Exim by default. You need to specify
11479 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11480 building Exim. For example:
11481 .code
11482 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11483 .endd
11484 You do not need to install the full Cyrus software suite in order to use
11485 the pwcheck daemon. You can compile and install just the daemon alone
11486 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11487 access to the &_/var/pwcheck_& directory.
11488
11489 The &%pwcheck%& condition takes one argument, which must be the user name and
11490 password, separated by a colon. For example, in a LOGIN authenticator
11491 configuration, you might have this:
11492 .code
11493 server_condition = ${if pwcheck{$auth1:$auth2}}
11494 .endd
11495 Again, for a PLAIN authenticator configuration, this would be:
11496 .code
11497 server_condition = ${if pwcheck{$auth2:$auth3}}
11498 .endd
11499 .vitem &*queue_running*&
11500 .cindex "queue runner" "detecting when delivering from"
11501 .cindex "expansion" "queue runner test"
11502 .cindex "&%queue_running%& expansion condition"
11503 This condition, which has no data, is true during delivery attempts that are
11504 initiated by queue runner processes, and false otherwise.
11505
11506
11507 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11508 .cindex "Radius"
11509 .cindex "expansion" "Radius authentication"
11510 .cindex "&%radius%& expansion condition"
11511 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11512 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11513 the Radius client configuration file in order to build Exim with Radius
11514 support.
11515
11516 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11517 library, using the original API. If you are using release 0.4.0 or later of
11518 this library, you need to set
11519 .code
11520 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11521 .endd
11522 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11523 &%libradius%& library that comes with FreeBSD. To do this, set
11524 .code
11525 RADIUS_LIB_TYPE=RADLIB
11526 .endd
11527 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11528 You may also have to supply a suitable setting in EXTRALIBS so that the
11529 Radius library can be found when Exim is linked.
11530
11531 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11532 Radius client library, which calls the Radius server. The condition is true if
11533 the authentication is successful. For example:
11534 .code
11535 server_condition = ${if radius{<arguments>}}
11536 .endd
11537
11538
11539 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11540         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11541 .cindex "&'saslauthd'& daemon"
11542 .cindex "Cyrus"
11543 .cindex "expansion" "&'saslauthd'& authentication test"
11544 .cindex "&%saslauthd%& expansion condition"
11545 This condition supports user authentication using the Cyrus &'saslauthd'&
11546 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11547 Using this daemon is one way of making it possible for passwords to be checked
11548 by a process that is not running as root.
11549
11550 The saslauthd support is not included in Exim by default. You need to specify
11551 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11552 building Exim. For example:
11553 .code
11554 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11555 .endd
11556 You do not need to install the full Cyrus software suite in order to use
11557 the saslauthd daemon. You can compile and install just the daemon alone
11558 from the Cyrus SASL library.
11559
11560 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11561 two are mandatory. For example:
11562 .code
11563 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11564 .endd
11565 The service and the realm are optional (which is why the arguments are enclosed
11566 in their own set of braces). For details of the meaning of the service and
11567 realm, and how to run the daemon, consult the Cyrus documentation.
11568 .endlist vlist
11569
11570
11571
11572 .section "Combining expansion conditions" "SECID84"
11573 .cindex "expansion" "combining conditions"
11574 Several conditions can be tested at once by combining them using the &%and%&
11575 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11576 conditions on their own, and precede their lists of sub-conditions. Each
11577 sub-condition must be enclosed in braces within the overall braces that contain
11578 the list. No repetition of &%if%& is used.
11579
11580
11581 .vlist
11582 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11583 .cindex "&""or""& expansion condition"
11584 .cindex "expansion" "&""or""& of conditions"
11585 The sub-conditions are evaluated from left to right. The condition is true if
11586 any one of the sub-conditions is true.
11587 For example,
11588 .code
11589 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11590 .endd
11591 When a true sub-condition is found, the following ones are parsed but not
11592 evaluated. If there are several &"match"& sub-conditions the values of the
11593 numeric variables afterwards are taken from the first one that succeeds.
11594
11595 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11596 .cindex "&""and""& expansion condition"
11597 .cindex "expansion" "&""and""& of conditions"
11598 The sub-conditions are evaluated from left to right. The condition is true if
11599 all of the sub-conditions are true. If there are several &"match"&
11600 sub-conditions, the values of the numeric variables afterwards are taken from
11601 the last one. When a false sub-condition is found, the following ones are
11602 parsed but not evaluated.
11603 .endlist
11604 .ecindex IIDexpcond
11605
11606
11607
11608
11609 .section "Expansion variables" "SECTexpvar"
11610 .cindex "expansion" "variables, list of"
11611 This section contains an alphabetical list of all the expansion variables. Some
11612 of them are available only when Exim is compiled with specific options such as
11613 support for TLS or the content scanning extension.
11614
11615 .vlist
11616 .vitem "&$0$&, &$1$&, etc"
11617 .cindex "numerical variables (&$1$& &$2$& etc)"
11618 When a &%match%& expansion condition succeeds, these variables contain the
11619 captured substrings identified by the regular expression during subsequent
11620 processing of the success string of the containing &%if%& expansion item.
11621 In the expansion condition case
11622 they do not retain their values afterwards; in fact, their previous
11623 values are restored at the end of processing an &%if%& item. The numerical
11624 variables may also be set externally by some other matching process which
11625 precedes the expansion of the string. For example, the commands available in
11626 Exim filter files include an &%if%& command with its own regular expression
11627 matching condition.
11628
11629 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11630 Within an acl condition, expansion condition or expansion item
11631 any arguments are copied to these variables,
11632 any unused variables being made empty.
11633
11634 .vitem "&$acl_c...$&"
11635 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11636 can be given any name that starts with &$acl_c$& and is at least six characters
11637 long, but the sixth character must be either a digit or an underscore. For
11638 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11639 variables persist throughout the lifetime of an SMTP connection. They can be
11640 used to pass information between ACLs and between different invocations of the
11641 same ACL. When a message is received, the values of these variables are saved
11642 with the message, and can be accessed by filters, routers, and transports
11643 during subsequent delivery.
11644
11645 .vitem "&$acl_m...$&"
11646 These variables are like the &$acl_c...$& variables, except that their values
11647 are reset after a message has been received. Thus, if several messages are
11648 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11649 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11650 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11651 message is received, the values of these variables are saved with the message,
11652 and can be accessed by filters, routers, and transports during subsequent
11653 delivery.
11654
11655 .vitem &$acl_narg$&
11656 Within an acl condition, expansion condition or expansion item
11657 this variable has the number of arguments.
11658
11659 .vitem &$acl_verify_message$&
11660 .vindex "&$acl_verify_message$&"
11661 After an address verification has failed, this variable contains the failure
11662 message. It retains its value for use in subsequent modifiers. The message can
11663 be preserved by coding like this:
11664 .code
11665 warn !verify = sender
11666      set acl_m0 = $acl_verify_message
11667 .endd
11668 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11669 &%log_message%& modifiers, to include information about the verification
11670 failure.
11671
11672 .vitem &$address_data$&
11673 .vindex "&$address_data$&"
11674 This variable is set by means of the &%address_data%& option in routers. The
11675 value then remains with the address while it is processed by subsequent routers
11676 and eventually a transport. If the transport is handling multiple addresses,
11677 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11678 for more details. &*Note*&: The contents of &$address_data$& are visible in
11679 user filter files.
11680
11681 If &$address_data$& is set when the routers are called from an ACL to verify
11682 a recipient address, the final value is still in the variable for subsequent
11683 conditions and modifiers of the ACL statement. If routing the address caused it
11684 to be redirected to just one address, the child address is also routed as part
11685 of the verification, and in this case the final value of &$address_data$& is
11686 from the child's routing.
11687
11688 If &$address_data$& is set when the routers are called from an ACL to verify a
11689 sender address, the final value is also preserved, but this time in
11690 &$sender_address_data$&, to distinguish it from data from a recipient
11691 address.
11692
11693 In both cases (recipient and sender verification), the value does not persist
11694 after the end of the current ACL statement. If you want to preserve
11695 these values for longer, you can save them in ACL variables.
11696
11697 .vitem &$address_file$&
11698 .vindex "&$address_file$&"
11699 When, as a result of aliasing, forwarding, or filtering, a message is directed
11700 to a specific file, this variable holds the name of the file when the transport
11701 is running. At other times, the variable is empty. For example, using the
11702 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11703 .code
11704 /home/r2d2/savemail
11705 .endd
11706 then when the &(address_file)& transport is running, &$address_file$&
11707 contains the text string &`/home/r2d2/savemail`&.
11708 .cindex "Sieve filter" "value of &$address_file$&"
11709 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11710 then up to the transport configuration to generate an appropriate absolute path
11711 to the relevant file.
11712
11713 .vitem &$address_pipe$&
11714 .vindex "&$address_pipe$&"
11715 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11716 this variable holds the pipe command when the transport is running.
11717
11718 .vitem "&$auth1$& &-- &$auth3$&"
11719 .vindex "&$auth1$&, &$auth2$&, etc"
11720 These variables are used in SMTP authenticators (see chapters
11721 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11722
11723 .vitem &$authenticated_id$&
11724 .cindex "authentication" "id"
11725 .vindex "&$authenticated_id$&"
11726 When a server successfully authenticates a client it may be configured to
11727 preserve some of the authentication information in the variable
11728 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11729 user/password authenticator configuration might preserve the user name for use
11730 in the routers. Note that this is not the same information that is saved in
11731 &$sender_host_authenticated$&.
11732
11733 When a message is submitted locally (that is, not over a TCP connection)
11734 the value of &$authenticated_id$& is normally the login name of the calling
11735 process. However, a trusted user can override this by means of the &%-oMai%&
11736 command line option.
11737 This second case also sets up inforamtion used by the
11738 &$authresults$& expansion item.
11739
11740 .vitem &$authenticated_fail_id$&
11741 .cindex "authentication" "fail" "id"
11742 .vindex "&$authenticated_fail_id$&"
11743 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11744 will contain the failed authentication id. If more than one authentication
11745 id is attempted, it will contain only the last one. The variable is
11746 available for processing in the ACL's, generally the quit or notquit ACL.
11747 A message to a local recipient could still be accepted without requiring
11748 authentication, which means this variable could also be visible in all of
11749 the ACL's as well.
11750
11751
11752 .vitem &$authenticated_sender$&
11753 .cindex "sender" "authenticated"
11754 .cindex "authentication" "sender"
11755 .cindex "AUTH" "on MAIL command"
11756 .vindex "&$authenticated_sender$&"
11757 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11758 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11759 described in section &<<SECTauthparamail>>&. Unless the data is the string
11760 &"<>"&, it is set as the authenticated sender of the message, and the value is
11761 available during delivery in the &$authenticated_sender$& variable. If the
11762 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11763
11764 .vindex "&$qualify_domain$&"
11765 When a message is submitted locally (that is, not over a TCP connection), the
11766 value of &$authenticated_sender$& is an address constructed from the login
11767 name of the calling process and &$qualify_domain$&, except that a trusted user
11768 can override this by means of the &%-oMas%& command line option.
11769
11770
11771 .vitem &$authentication_failed$&
11772 .cindex "authentication" "failure"
11773 .vindex "&$authentication_failed$&"
11774 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11775 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11776 possible to distinguish between &"did not try to authenticate"&
11777 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11778 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11779 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11780 negative response to an AUTH command, including (for example) an attempt to use
11781 an undefined mechanism.
11782
11783 .vitem &$av_failed$&
11784 .cindex "content scanning" "AV scanner failure"
11785 This variable is available when Exim is compiled with the content-scanning
11786 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11787 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11788 the ACL malware condition.
11789
11790 .vitem &$body_linecount$&
11791 .cindex "message body" "line count"
11792 .cindex "body of message" "line count"
11793 .vindex "&$body_linecount$&"
11794 When a message is being received or delivered, this variable contains the
11795 number of lines in the message's body. See also &$message_linecount$&.
11796
11797 .vitem &$body_zerocount$&
11798 .cindex "message body" "binary zero count"
11799 .cindex "body of message" "binary zero count"
11800 .cindex "binary zero" "in message body"
11801 .vindex "&$body_zerocount$&"
11802 When a message is being received or delivered, this variable contains the
11803 number of binary zero bytes (ASCII NULs) in the message's body.
11804
11805 .vitem &$bounce_recipient$&
11806 .vindex "&$bounce_recipient$&"
11807 This is set to the recipient address of a bounce message while Exim is creating
11808 it. It is useful if a customized bounce message text file is in use (see
11809 chapter &<<CHAPemsgcust>>&).
11810
11811 .vitem &$bounce_return_size_limit$&
11812 .vindex "&$bounce_return_size_limit$&"
11813 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11814 up to a multiple of 1000. It is useful when a customized error message text
11815 file is in use (see chapter &<<CHAPemsgcust>>&).
11816
11817 .vitem &$caller_gid$&
11818 .cindex "gid (group id)" "caller"
11819 .vindex "&$caller_gid$&"
11820 The real group id under which the process that called Exim was running. This is
11821 not the same as the group id of the originator of a message (see
11822 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11823 incarnation normally contains the Exim gid.
11824
11825 .vitem &$caller_uid$&
11826 .cindex "uid (user id)" "caller"
11827 .vindex "&$caller_uid$&"
11828 The real user id under which the process that called Exim was running. This is
11829 not the same as the user id of the originator of a message (see
11830 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11831 incarnation normally contains the Exim uid.
11832
11833 .vitem &$callout_address$&
11834 .vindex "&$callout_address$&"
11835 After a callout for verification, spamd or malware daemon service, the
11836 address that was connected to.
11837
11838 .vitem &$compile_number$&
11839 .vindex "&$compile_number$&"
11840 The building process for Exim keeps a count of the number
11841 of times it has been compiled. This serves to distinguish different
11842 compilations of the same version of the program.
11843
11844 .vitem &$config_dir$&
11845 .vindex "&$config_dir$&"
11846 The directory name of the main configuration file. That is, the content of
11847 &$config_file$& with the last component stripped. The value does not
11848 contain the trailing slash. If &$config_file$& does not contain a slash,
11849 &$config_dir$& is ".".
11850
11851 .vitem &$config_file$&
11852 .vindex "&$config_file$&"
11853 The name of the main configuration file Exim is using.
11854
11855 .vitem &$dkim_verify_status$&
11856 Results of DKIM verification.
11857 For details see section &<<SECDKIMVFY>>&.
11858
11859 .vitem &$dkim_cur_signer$& &&&
11860        &$dkim_verify_reason$& &&&
11861        &$dkim_domain$& &&&
11862        &$dkim_identity$& &&&
11863        &$dkim_selector$& &&&
11864        &$dkim_algo$& &&&
11865        &$dkim_canon_body$& &&&
11866        &$dkim_canon_headers$& &&&
11867        &$dkim_copiedheaders$& &&&
11868        &$dkim_bodylength$& &&&
11869        &$dkim_created$& &&&
11870        &$dkim_expires$& &&&
11871        &$dkim_headernames$& &&&
11872        &$dkim_key_testing$& &&&
11873        &$dkim_key_nosubdomains$& &&&
11874        &$dkim_key_srvtype$& &&&
11875        &$dkim_key_granularity$& &&&
11876        &$dkim_key_notes$& &&&
11877        &$dkim_key_length$&
11878 These variables are only available within the DKIM ACL.
11879 For details see section &<<SECDKIMVFY>>&.
11880
11881 .vitem &$dkim_signers$&
11882 .vindex &$dkim_signers$&
11883 When a message has been received this variable contains
11884 a colon-separated list of signer domains and identities for the message.
11885 For details see section &<<SECDKIMVFY>>&.
11886
11887 .vitem &$dnslist_domain$& &&&
11888        &$dnslist_matched$& &&&
11889        &$dnslist_text$& &&&
11890        &$dnslist_value$&
11891 .vindex "&$dnslist_domain$&"
11892 .vindex "&$dnslist_matched$&"
11893 .vindex "&$dnslist_text$&"
11894 .vindex "&$dnslist_value$&"
11895 .cindex "black list (DNS)"
11896 When a DNS (black) list lookup succeeds, these variables are set to contain
11897 the following data from the lookup: the list's domain name, the key that was
11898 looked up, the contents of any associated TXT record, and the value from the
11899 main A record. See section &<<SECID204>>& for more details.
11900
11901 .vitem &$domain$&
11902 .vindex "&$domain$&"
11903 When an address is being routed, or delivered on its own, this variable
11904 contains the domain. Uppercase letters in the domain are converted into lower
11905 case for &$domain$&.
11906
11907 Global address rewriting happens when a message is received, so the value of
11908 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11909 is set during user filtering, but not during system filtering, because a
11910 message may have many recipients and the system filter is called just once.
11911
11912 When more than one address is being delivered at once (for example, several
11913 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11914 have the same domain. Transports can be restricted to handling only one domain
11915 at a time if the value of &$domain$& is required at transport time &-- this is
11916 the default for local transports. For further details of the environment in
11917 which local transports are run, see chapter &<<CHAPenvironment>>&.
11918
11919 .oindex "&%delay_warning_condition%&"
11920 At the end of a delivery, if all deferred addresses have the same domain, it is
11921 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11922
11923 The &$domain$& variable is also used in some other circumstances:
11924
11925 .ilist
11926 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11927 the recipient address. The domain of the &'sender'& address is in
11928 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11929 normally set during the running of the MAIL ACL. However, if the sender address
11930 is verified with a callout during the MAIL ACL, the sender domain is placed in
11931 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11932 the &(smtp)& transport.
11933
11934 .next
11935 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11936 &$domain$& contains the domain portion of the address that is being rewritten;
11937 it can be used in the expansion of the replacement address, for example, to
11938 rewrite domains by file lookup.
11939
11940 .next
11941 With one important exception, whenever a domain list is being scanned,
11942 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11943 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11944 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11945 that, in a RCPT ACL, the sender domain list can be dependent on the
11946 recipient domain (which is what is in &$domain$& at this time).
11947
11948 .next
11949 .cindex "ETRN" "value of &$domain$&"
11950 .oindex "&%smtp_etrn_command%&"
11951 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11952 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11953 .endlist
11954
11955
11956 .vitem &$domain_data$&
11957 .vindex "&$domain_data$&"
11958 When the &%domains%& option on a router matches a domain by
11959 means of a lookup, the data read by the lookup is available during the running
11960 of the router as &$domain_data$&. In addition, if the driver routes the
11961 address to a transport, the value is available in that transport. If the
11962 transport is handling multiple addresses, the value from the first address is
11963 used.
11964
11965 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11966 domain by means of a lookup. The data read by the lookup is available during
11967 the rest of the ACL statement. In all other situations, this variable expands
11968 to nothing.
11969
11970 .vitem &$exim_gid$&
11971 .vindex "&$exim_gid$&"
11972 This variable contains the numerical value of the Exim group id.
11973
11974 .vitem &$exim_path$&
11975 .vindex "&$exim_path$&"
11976 This variable contains the path to the Exim binary.
11977
11978 .vitem &$exim_uid$&
11979 .vindex "&$exim_uid$&"
11980 This variable contains the numerical value of the Exim user id.
11981
11982 .vitem &$exim_version$&
11983 .vindex "&$exim_version$&"
11984 This variable contains the version string of the Exim build.
11985 The first character is a major version number, currently 4.
11986 Then after a dot, the next group of digits is a minor version number.
11987 There may be other characters following the minor version.
11988
11989 .vitem &$header_$&<&'name'&>
11990 This is not strictly an expansion variable. It is expansion syntax for
11991 inserting the message header line with the given name. Note that the name must
11992 be terminated by colon or white space, because it may contain a wide variety of
11993 characters. Note also that braces must &'not'& be used.
11994
11995 .vitem &$headers_added$&
11996 .vindex "&$headers_added$&"
11997 Within an ACL this variable contains the headers added so far by
11998 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11999 The headers are a newline-separated list.
12000
12001 .vitem &$home$&
12002 .vindex "&$home$&"
12003 When the &%check_local_user%& option is set for a router, the user's home
12004 directory is placed in &$home$& when the check succeeds. In particular, this
12005 means it is set during the running of users' filter files. A router may also
12006 explicitly set a home directory for use by a transport; this can be overridden
12007 by a setting on the transport itself.
12008
12009 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12010 of the environment variable HOME, which is subject to the
12011 &%keep_environment%& and &%add_environment%& main config options.
12012
12013 .vitem &$host$&
12014 .vindex "&$host$&"
12015 If a router assigns an address to a transport (any transport), and passes a
12016 list of hosts with the address, the value of &$host$& when the transport starts
12017 to run is the name of the first host on the list. Note that this applies both
12018 to local and remote transports.
12019
12020 .cindex "transport" "filter"
12021 .cindex "filter" "transport filter"
12022 For the &(smtp)& transport, if there is more than one host, the value of
12023 &$host$& changes as the transport works its way through the list. In
12024 particular, when the &(smtp)& transport is expanding its options for encryption
12025 using TLS, or for specifying a transport filter (see chapter
12026 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12027 is connected.
12028
12029 When used in the client part of an authenticator configuration (see chapter
12030 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12031 client is connected.
12032
12033
12034 .vitem &$host_address$&
12035 .vindex "&$host_address$&"
12036 This variable is set to the remote host's IP address whenever &$host$& is set
12037 for a remote connection. It is also set to the IP address that is being checked
12038 when the &%ignore_target_hosts%& option is being processed.
12039
12040 .vitem &$host_data$&
12041 .vindex "&$host_data$&"
12042 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12043 result of the lookup is made available in the &$host_data$& variable. This
12044 allows you, for example, to do things like this:
12045 .code
12046 deny  hosts = net-lsearch;/some/file
12047 message = $host_data
12048 .endd
12049 .vitem &$host_lookup_deferred$&
12050 .cindex "host name" "lookup, failure of"
12051 .vindex "&$host_lookup_deferred$&"
12052 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12053 message comes from a remote host and there is an attempt to look up the host's
12054 name from its IP address, and the attempt is not successful, one of these
12055 variables is set to &"1"&.
12056
12057 .ilist
12058 If the lookup receives a definite negative response (for example, a DNS lookup
12059 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12060
12061 .next
12062 If there is any kind of problem during the lookup, such that Exim cannot
12063 tell whether or not the host name is defined (for example, a timeout for a DNS
12064 lookup), &$host_lookup_deferred$& is set to &"1"&.
12065 .endlist ilist
12066
12067 Looking up a host's name from its IP address consists of more than just a
12068 single reverse lookup. Exim checks that a forward lookup of at least one of the
12069 names it receives from a reverse lookup yields the original IP address. If this
12070 is not the case, Exim does not accept the looked up name(s), and
12071 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12072 IP address (for example, the existence of a PTR record in the DNS) is not
12073 sufficient on its own for the success of a host name lookup. If the reverse
12074 lookup succeeds, but there is a lookup problem such as a timeout when checking
12075 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12076 &"1"&. See also &$sender_host_name$&.
12077
12078 .cindex authentication "expansion item"
12079 Performing these checks sets up information used by the
12080 &$authresults$& expansion item.
12081
12082
12083 .vitem &$host_lookup_failed$&
12084 .vindex "&$host_lookup_failed$&"
12085 See &$host_lookup_deferred$&.
12086
12087 .vitem &$host_port$&
12088 .vindex "&$host_port$&"
12089 This variable is set to the remote host's TCP port whenever &$host$& is set
12090 for an outbound connection.
12091
12092 .vitem &$initial_cwd$&
12093 .vindex "&$initial_cwd$&
12094 This variable contains the full path name of the initial working
12095 directory of the current Exim process. This may differ from the current
12096 working directory, as Exim changes this to "/" during early startup, and
12097 to &$spool_directory$& later.
12098
12099 .vitem &$inode$&
12100 .vindex "&$inode$&"
12101 The only time this variable is set is while expanding the &%directory_file%&
12102 option in the &(appendfile)& transport. The variable contains the inode number
12103 of the temporary file which is about to be renamed. It can be used to construct
12104 a unique name for the file.
12105
12106 .vitem &$interface_address$&
12107 .vindex "&$interface_address$&"
12108 This is an obsolete name for &$received_ip_address$&.
12109
12110 .vitem &$interface_port$&
12111 .vindex "&$interface_port$&"
12112 This is an obsolete name for &$received_port$&.
12113
12114 .vitem &$item$&
12115 .vindex "&$item$&"
12116 This variable is used during the expansion of &*forall*& and &*forany*&
12117 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12118 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12119 empty.
12120
12121 .vitem &$ldap_dn$&
12122 .vindex "&$ldap_dn$&"
12123 This variable, which is available only when Exim is compiled with LDAP support,
12124 contains the DN from the last entry in the most recently successful LDAP
12125 lookup.
12126
12127 .vitem &$load_average$&
12128 .vindex "&$load_average$&"
12129 This variable contains the system load average, multiplied by 1000 so that it
12130 is an integer. For example, if the load average is 0.21, the value of the
12131 variable is 210. The value is recomputed every time the variable is referenced.
12132
12133 .vitem &$local_part$&
12134 .vindex "&$local_part$&"
12135 When an address is being routed, or delivered on its own, this
12136 variable contains the local part. When a number of addresses are being
12137 delivered together (for example, multiple RCPT commands in an SMTP
12138 session), &$local_part$& is not set.
12139
12140 Global address rewriting happens when a message is received, so the value of
12141 &$local_part$& during routing and delivery is the value after rewriting.
12142 &$local_part$& is set during user filtering, but not during system filtering,
12143 because a message may have many recipients and the system filter is called just
12144 once.
12145
12146 .vindex "&$local_part_prefix$&"
12147 .vindex "&$local_part_suffix$&"
12148 .cindex affix variables
12149 If a local part prefix or suffix has been recognized, it is not included in the
12150 value of &$local_part$& during routing and subsequent delivery. The values of
12151 any prefix or suffix are in &$local_part_prefix$& and
12152 &$local_part_suffix$&, respectively.
12153
12154 When a message is being delivered to a file, pipe, or autoreply transport as a
12155 result of aliasing or forwarding, &$local_part$& is set to the local part of
12156 the parent address, not to the file name or command (see &$address_file$& and
12157 &$address_pipe$&).
12158
12159 When an ACL is running for a RCPT command, &$local_part$& contains the
12160 local part of the recipient address.
12161
12162 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12163 &$local_part$& contains the local part of the address that is being rewritten;
12164 it can be used in the expansion of the replacement address, for example.
12165
12166 In all cases, all quoting is removed from the local part. For example, for both
12167 the addresses
12168 .code
12169 "abc:xyz"@test.example
12170 abc\:xyz@test.example
12171 .endd
12172 the value of &$local_part$& is
12173 .code
12174 abc:xyz
12175 .endd
12176 If you use &$local_part$& to create another address, you should always wrap it
12177 inside a quoting operator. For example, in a &(redirect)& router you could
12178 have:
12179 .code
12180 data = ${quote_local_part:$local_part}@new.domain.example
12181 .endd
12182 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12183 to process local parts in a case-dependent manner in a router, you can set the
12184 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12185
12186 .vitem &$local_part_data$&
12187 .vindex "&$local_part_data$&"
12188 When the &%local_parts%& option on a router matches a local part by means of a
12189 lookup, the data read by the lookup is available during the running of the
12190 router as &$local_part_data$&. In addition, if the driver routes the address
12191 to a transport, the value is available in that transport. If the transport is
12192 handling multiple addresses, the value from the first address is used.
12193
12194 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12195 matches a local part by means of a lookup. The data read by the lookup is
12196 available during the rest of the ACL statement. In all other situations, this
12197 variable expands to nothing.
12198
12199 .vitem &$local_part_prefix$&
12200 .vindex "&$local_part_prefix$&"
12201 .cindex affix variables
12202 When an address is being routed or delivered, and a
12203 specific prefix for the local part was recognized, it is available in this
12204 variable, having been removed from &$local_part$&.
12205
12206 .vitem &$local_part_suffix$&
12207 .vindex "&$local_part_suffix$&"
12208 When an address is being routed or delivered, and a
12209 specific suffix for the local part was recognized, it is available in this
12210 variable, having been removed from &$local_part$&.
12211
12212 .vitem &$local_scan_data$&
12213 .vindex "&$local_scan_data$&"
12214 This variable contains the text returned by the &[local_scan()]& function when
12215 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12216
12217 .vitem &$local_user_gid$&
12218 .vindex "&$local_user_gid$&"
12219 See &$local_user_uid$&.
12220
12221 .vitem &$local_user_uid$&
12222 .vindex "&$local_user_uid$&"
12223 This variable and &$local_user_gid$& are set to the uid and gid after the
12224 &%check_local_user%& router precondition succeeds. This means that their values
12225 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12226 and &%condition%&), for the &%address_data%& expansion, and for any
12227 router-specific expansions. At all other times, the values in these variables
12228 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12229
12230 .vitem &$localhost_number$&
12231 .vindex "&$localhost_number$&"
12232 This contains the expanded value of the
12233 &%localhost_number%& option. The expansion happens after the main options have
12234 been read.
12235
12236 .vitem &$log_inodes$&
12237 .vindex "&$log_inodes$&"
12238 The number of free inodes in the disk partition where Exim's
12239 log files are being written. The value is recalculated whenever the variable is
12240 referenced. If the relevant file system does not have the concept of inodes,
12241 the value of is -1. See also the &%check_log_inodes%& option.
12242
12243 .vitem &$log_space$&
12244 .vindex "&$log_space$&"
12245 The amount of free space (as a number of kilobytes) in the disk
12246 partition where Exim's log files are being written. The value is recalculated
12247 whenever the variable is referenced. If the operating system does not have the
12248 ability to find the amount of free space (only true for experimental systems),
12249 the space value is -1. See also the &%check_log_space%& option.
12250
12251
12252 .vitem &$lookup_dnssec_authenticated$&
12253 .vindex "&$lookup_dnssec_authenticated$&"
12254 This variable is set after a DNS lookup done by
12255 a dnsdb lookup expansion, dnslookup router or smtp transport.
12256 .cindex "DNS" "DNSSEC"
12257 It will be empty if &(DNSSEC)& was not requested,
12258 &"no"& if the result was not labelled as authenticated data
12259 and &"yes"& if it was.
12260 Results that are labelled as authoritative answer that match
12261 the &%dns_trust_aa%& configuration variable count also
12262 as authenticated data.
12263
12264 .vitem &$mailstore_basename$&
12265 .vindex "&$mailstore_basename$&"
12266 This variable is set only when doing deliveries in &"mailstore"& format in the
12267 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12268 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12269 contains the basename of the files that are being written, that is, the name
12270 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12271 variable is empty.
12272
12273 .vitem &$malware_name$&
12274 .vindex "&$malware_name$&"
12275 This variable is available when Exim is compiled with the
12276 content-scanning extension. It is set to the name of the virus that was found
12277 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12278
12279 .vitem &$max_received_linelength$&
12280 .vindex "&$max_received_linelength$&"
12281 .cindex "maximum" "line length"
12282 .cindex "line length" "maximum"
12283 This variable contains the number of bytes in the longest line that was
12284 received as part of the message, not counting the line termination
12285 character(s).
12286 It is not valid if the &%spool_files_wireformat%& option is used.
12287
12288 .vitem &$message_age$&
12289 .cindex "message" "age of"
12290 .vindex "&$message_age$&"
12291 This variable is set at the start of a delivery attempt to contain the number
12292 of seconds since the message was received. It does not change during a single
12293 delivery attempt.
12294
12295 .vitem &$message_body$&
12296 .cindex "body of message" "expansion variable"
12297 .cindex "message body" "in expansion"
12298 .cindex "binary zero" "in message body"
12299 .vindex "&$message_body$&"
12300 .oindex "&%message_body_visible%&"
12301 This variable contains the initial portion of a message's body while it is
12302 being delivered, and is intended mainly for use in filter files. The maximum
12303 number of characters of the body that are put into the variable is set by the
12304 &%message_body_visible%& configuration option; the default is 500.
12305
12306 .oindex "&%message_body_newlines%&"
12307 By default, newlines are converted into spaces in &$message_body$&, to make it
12308 easier to search for phrases that might be split over a line break. However,
12309 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12310 zeros are always converted into spaces.
12311
12312 .vitem &$message_body_end$&
12313 .cindex "body of message" "expansion variable"
12314 .cindex "message body" "in expansion"
12315 .vindex "&$message_body_end$&"
12316 This variable contains the final portion of a message's
12317 body while it is being delivered. The format and maximum size are as for
12318 &$message_body$&.
12319
12320 .vitem &$message_body_size$&
12321 .cindex "body of message" "size"
12322 .cindex "message body" "size"
12323 .vindex "&$message_body_size$&"
12324 When a message is being delivered, this variable contains the size of the body
12325 in bytes. The count starts from the character after the blank line that
12326 separates the body from the header. Newlines are included in the count. See
12327 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12328
12329 If the spool file is wireformat
12330 (see the &%spool_files_wireformat%& main option)
12331 the CRLF line-terminators are included in the count.
12332
12333 .vitem &$message_exim_id$&
12334 .vindex "&$message_exim_id$&"
12335 When a message is being received or delivered, this variable contains the
12336 unique message id that is generated and used by Exim to identify the message.
12337 An id is not created for a message until after its header has been successfully
12338 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12339 line; it is the local id that Exim assigns to the message, for example:
12340 &`1BXTIK-0001yO-VA`&.
12341
12342 .vitem &$message_headers$&
12343 .vindex &$message_headers$&
12344 This variable contains a concatenation of all the header lines when a message
12345 is being processed, except for lines added by routers or transports. The header
12346 lines are separated by newline characters. Their contents are decoded in the
12347 same way as a header line that is inserted by &%bheader%&.
12348
12349 .vitem &$message_headers_raw$&
12350 .vindex &$message_headers_raw$&
12351 This variable is like &$message_headers$& except that no processing of the
12352 contents of header lines is done.
12353
12354 .vitem &$message_id$&
12355 This is an old name for &$message_exim_id$&. It is now deprecated.
12356
12357 .vitem &$message_linecount$&
12358 .vindex "&$message_linecount$&"
12359 This variable contains the total number of lines in the header and body of the
12360 message. Compare &$body_linecount$&, which is the count for the body only.
12361 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12362 number of lines received. Before delivery happens (that is, before filters,
12363 routers, and transports run) the count is increased to include the
12364 &'Received:'& header line that Exim standardly adds, and also any other header
12365 lines that are added by ACLs. The blank line that separates the message header
12366 from the body is not counted.
12367
12368 As with the special case of &$message_size$&, during the expansion of the
12369 appendfile transport's maildir_tag option in maildir format, the value of
12370 &$message_linecount$& is the precise size of the number of newlines in the
12371 file that has been written (minus one for the blank line between the
12372 header and the body).
12373
12374 Here is an example of the use of this variable in a DATA ACL:
12375 .code
12376 deny message   = Too many lines in message header
12377      condition = \
12378       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12379 .endd
12380 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12381 message has not yet been received.
12382
12383 This variable is not valid if the &%spool_files_wireformat%& option is used.
12384
12385 .vitem &$message_size$&
12386 .cindex "size" "of message"
12387 .cindex "message" "size"
12388 .vindex "&$message_size$&"
12389 When a message is being processed, this variable contains its size in bytes. In
12390 most cases, the size includes those headers that were received with the
12391 message, but not those (such as &'Envelope-to:'&) that are added to individual
12392 deliveries as they are written. However, there is one special case: during the
12393 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12394 doing a delivery in maildir format, the value of &$message_size$& is the
12395 precise size of the file that has been written. See also
12396 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12397
12398 .cindex "RCPT" "value of &$message_size$&"
12399 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12400 contains the size supplied on the MAIL command, or -1 if no size was given. The
12401 value may not, of course, be truthful.
12402
12403 .vitem &$mime_$&&'xxx'&
12404 A number of variables whose names start with &$mime$& are
12405 available when Exim is compiled with the content-scanning extension. For
12406 details, see section &<<SECTscanmimepart>>&.
12407
12408 .vitem "&$n0$& &-- &$n9$&"
12409 These variables are counters that can be incremented by means
12410 of the &%add%& command in filter files.
12411
12412 .vitem &$original_domain$&
12413 .vindex "&$domain$&"
12414 .vindex "&$original_domain$&"
12415 When a top-level address is being processed for delivery, this contains the
12416 same value as &$domain$&. However, if a &"child"& address (for example,
12417 generated by an alias, forward, or filter file) is being processed, this
12418 variable contains the domain of the original address (lower cased). This
12419 differs from &$parent_domain$& only when there is more than one level of
12420 aliasing or forwarding. When more than one address is being delivered in a
12421 single transport run, &$original_domain$& is not set.
12422
12423 If a new address is created by means of a &%deliver%& command in a system
12424 filter, it is set up with an artificial &"parent"& address. This has the local
12425 part &'system-filter'& and the default qualify domain.
12426
12427 .vitem &$original_local_part$&
12428 .vindex "&$local_part$&"
12429 .vindex "&$original_local_part$&"
12430 When a top-level address is being processed for delivery, this contains the
12431 same value as &$local_part$&, unless a prefix or suffix was removed from the
12432 local part, because &$original_local_part$& always contains the full local
12433 part. When a &"child"& address (for example, generated by an alias, forward, or
12434 filter file) is being processed, this variable contains the full local part of
12435 the original address.
12436
12437 If the router that did the redirection processed the local part
12438 case-insensitively, the value in &$original_local_part$& is in lower case.
12439 This variable differs from &$parent_local_part$& only when there is more than
12440 one level of aliasing or forwarding. When more than one address is being
12441 delivered in a single transport run, &$original_local_part$& is not set.
12442
12443 If a new address is created by means of a &%deliver%& command in a system
12444 filter, it is set up with an artificial &"parent"& address. This has the local
12445 part &'system-filter'& and the default qualify domain.
12446
12447 .vitem &$originator_gid$&
12448 .cindex "gid (group id)" "of originating user"
12449 .cindex "sender" "gid"
12450 .vindex "&$caller_gid$&"
12451 .vindex "&$originator_gid$&"
12452 This variable contains the value of &$caller_gid$& that was set when the
12453 message was received. For messages received via the command line, this is the
12454 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12455 normally the gid of the Exim user.
12456
12457 .vitem &$originator_uid$&
12458 .cindex "uid (user id)" "of originating user"
12459 .cindex "sender" "uid"
12460 .vindex "&$caller_uid$&"
12461 .vindex "&$originator_uid$&"
12462 The value of &$caller_uid$& that was set when the message was received. For
12463 messages received via the command line, this is the uid of the sending user.
12464 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12465 user.
12466
12467 .vitem &$parent_domain$&
12468 .vindex "&$parent_domain$&"
12469 This variable is similar to &$original_domain$& (see
12470 above), except that it refers to the immediately preceding parent address.
12471
12472 .vitem &$parent_local_part$&
12473 .vindex "&$parent_local_part$&"
12474 This variable is similar to &$original_local_part$&
12475 (see above), except that it refers to the immediately preceding parent address.
12476
12477 .vitem &$pid$&
12478 .cindex "pid (process id)" "of current process"
12479 .vindex "&$pid$&"
12480 This variable contains the current process id.
12481
12482 .vitem &$pipe_addresses$&
12483 .cindex "filter" "transport filter"
12484 .cindex "transport" "filter"
12485 .vindex "&$pipe_addresses$&"
12486 This is not an expansion variable, but is mentioned here because the string
12487 &`$pipe_addresses`& is handled specially in the command specification for the
12488 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12489 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12490 It cannot be used in general expansion strings, and provokes an &"unknown
12491 variable"& error if encountered.
12492
12493 .vitem &$primary_hostname$&
12494 .vindex "&$primary_hostname$&"
12495 This variable contains the value set by &%primary_hostname%& in the
12496 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12497 a single-component name, Exim calls &[gethostbyname()]& (or
12498 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12499 qualified host name. See also &$smtp_active_hostname$&.
12500
12501
12502 .vitem &$proxy_external_address$& &&&
12503        &$proxy_external_port$& &&&
12504        &$proxy_local_address$& &&&
12505        &$proxy_local_port$& &&&
12506        &$proxy_session$&
12507 These variables are only available when built with Proxy Protocol
12508 or SOCKS5 support.
12509 For details see chapter &<<SECTproxyInbound>>&.
12510
12511 .vitem &$prdr_requested$&
12512 .cindex "PRDR" "variable for"
12513 This variable is set to &"yes"& if PRDR was requested by the client for the
12514 current message, otherwise &"no"&.
12515
12516 .vitem &$prvscheck_address$&
12517 This variable is used in conjunction with the &%prvscheck%& expansion item,
12518 which is described in sections &<<SECTexpansionitems>>& and
12519 &<<SECTverifyPRVS>>&.
12520
12521 .vitem &$prvscheck_keynum$&
12522 This variable is used in conjunction with the &%prvscheck%& expansion item,
12523 which is described in sections &<<SECTexpansionitems>>& and
12524 &<<SECTverifyPRVS>>&.
12525
12526 .vitem &$prvscheck_result$&
12527 This variable is used in conjunction with the &%prvscheck%& expansion item,
12528 which is described in sections &<<SECTexpansionitems>>& and
12529 &<<SECTverifyPRVS>>&.
12530
12531 .vitem &$qualify_domain$&
12532 .vindex "&$qualify_domain$&"
12533 The value set for the &%qualify_domain%& option in the configuration file.
12534
12535 .vitem &$qualify_recipient$&
12536 .vindex "&$qualify_recipient$&"
12537 The value set for the &%qualify_recipient%& option in the configuration file,
12538 or if not set, the value of &$qualify_domain$&.
12539
12540 .vitem &$queue_name$&
12541 .vindex &$queue_name$&
12542 .cindex "named queues"
12543 .cindex queues named
12544 The name of the spool queue in use; empty for the default queue.
12545
12546 .vitem &$rcpt_count$&
12547 .vindex "&$rcpt_count$&"
12548 When a message is being received by SMTP, this variable contains the number of
12549 RCPT commands received for the current message. If this variable is used in a
12550 RCPT ACL, its value includes the current command.
12551
12552 .vitem &$rcpt_defer_count$&
12553 .vindex "&$rcpt_defer_count$&"
12554 .cindex "4&'xx'& responses" "count of"
12555 When a message is being received by SMTP, this variable contains the number of
12556 RCPT commands in the current message that have previously been rejected with a
12557 temporary (4&'xx'&) response.
12558
12559 .vitem &$rcpt_fail_count$&
12560 .vindex "&$rcpt_fail_count$&"
12561 When a message is being received by SMTP, this variable contains the number of
12562 RCPT commands in the current message that have previously been rejected with a
12563 permanent (5&'xx'&) response.
12564
12565 .vitem &$received_count$&
12566 .vindex "&$received_count$&"
12567 This variable contains the number of &'Received:'& header lines in the message,
12568 including the one added by Exim (so its value is always greater than zero). It
12569 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12570 delivering.
12571
12572 .vitem &$received_for$&
12573 .vindex "&$received_for$&"
12574 If there is only a single recipient address in an incoming message, this
12575 variable contains that address when the &'Received:'& header line is being
12576 built. The value is copied after recipient rewriting has happened, but before
12577 the &[local_scan()]& function is run.
12578
12579 .vitem &$received_ip_address$&
12580 .vindex "&$received_ip_address$&"
12581 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12582 variable is set to the address of the local IP interface, and &$received_port$&
12583 is set to the local port number. (The remote IP address and port are in
12584 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12585 the port value is -1 unless it has been set using the &%-oMi%& command line
12586 option.
12587
12588 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12589 could be used, for example, to make the file name for a TLS certificate depend
12590 on which interface and/or port is being used for the incoming connection. The
12591 values of &$received_ip_address$& and &$received_port$& are saved with any
12592 messages that are received, thus making these variables available at delivery
12593 time.
12594 For outbound connections see &$sending_ip_address$&.
12595
12596 .vitem &$received_port$&
12597 .vindex "&$received_port$&"
12598 See &$received_ip_address$&.
12599
12600 .vitem &$received_protocol$&
12601 .vindex "&$received_protocol$&"
12602 When a message is being processed, this variable contains the name of the
12603 protocol by which it was received. Most of the names used by Exim are defined
12604 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12605 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12606 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12607 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12608 connection and the client was successfully authenticated.
12609
12610 Exim uses the protocol name &"smtps"& for the case when encryption is
12611 automatically set up on connection without the use of STARTTLS (see
12612 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12613 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12614 where the client initially uses EHLO, sets up an encrypted connection using
12615 STARTTLS, and then uses HELO afterwards.
12616
12617 The &%-oMr%& option provides a way of specifying a custom protocol name for
12618 messages that are injected locally by trusted callers. This is commonly used to
12619 identify messages that are being re-injected after some kind of scanning.
12620
12621 .vitem &$received_time$&
12622 .vindex "&$received_time$&"
12623 This variable contains the date and time when the current message was received,
12624 as a number of seconds since the start of the Unix epoch.
12625
12626 .vitem &$recipient_data$&
12627 .vindex "&$recipient_data$&"
12628 This variable is set after an indexing lookup success in an ACL &%recipients%&
12629 condition. It contains the data from the lookup, and the value remains set
12630 until the next &%recipients%& test. Thus, you can do things like this:
12631 .display
12632 &`require recipients  = cdb*@;/some/file`&
12633 &`deny    `&&'some further test involving'& &`$recipient_data`&
12634 .endd
12635 &*Warning*&: This variable is set only when a lookup is used as an indexing
12636 method in the address list, using the semicolon syntax as in the example above.
12637 The variable is not set for a lookup that is used as part of the string
12638 expansion that all such lists undergo before being interpreted.
12639
12640 .vitem &$recipient_verify_failure$&
12641 .vindex "&$recipient_verify_failure$&"
12642 In an ACL, when a recipient verification fails, this variable contains
12643 information about the failure. It is set to one of the following words:
12644
12645 .ilist
12646 &"qualify"&: The address was unqualified (no domain), and the message
12647 was neither local nor came from an exempted host.
12648
12649 .next
12650 &"route"&: Routing failed.
12651
12652 .next
12653 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12654 or before the MAIL command (that is, on initial connection, HELO, or
12655 MAIL).
12656
12657 .next
12658 &"recipient"&: The RCPT command in a callout was rejected.
12659 .next
12660
12661 &"postmaster"&: The postmaster check in a callout was rejected.
12662 .endlist
12663
12664 The main use of this variable is expected to be to distinguish between
12665 rejections of MAIL and rejections of RCPT.
12666
12667 .vitem &$recipients$&
12668 .vindex "&$recipients$&"
12669 This variable contains a list of envelope recipients for a message. A comma and
12670 a space separate the addresses in the replacement text. However, the variable
12671 is not generally available, to prevent exposure of Bcc recipients in
12672 unprivileged users' filter files. You can use &$recipients$& only in these
12673 cases:
12674
12675 .olist
12676 In a system filter file.
12677 .next
12678 In the ACLs associated with the DATA command and with non-SMTP messages, that
12679 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12680 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12681 &%acl_not_smtp_mime%&.
12682 .next
12683 From within a &[local_scan()]& function.
12684 .endlist
12685
12686
12687 .vitem &$recipients_count$&
12688 .vindex "&$recipients_count$&"
12689 When a message is being processed, this variable contains the number of
12690 envelope recipients that came with the message. Duplicates are not excluded
12691 from the count. While a message is being received over SMTP, the number
12692 increases for each accepted recipient. It can be referenced in an ACL.
12693
12694
12695 .vitem &$regex_match_string$&
12696 .vindex "&$regex_match_string$&"
12697 This variable is set to contain the matching regular expression after a
12698 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12699
12700 .vitem "&$regex1$&, &$regex2$&, etc"
12701 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12702 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12703 these variables contain the
12704 captured substrings identified by the regular expression.
12705
12706
12707 .vitem &$reply_address$&
12708 .vindex "&$reply_address$&"
12709 When a message is being processed, this variable contains the contents of the
12710 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12711 contents of the &'From:'& header line. Apart from the removal of leading
12712 white space, the value is not processed in any way. In particular, no RFC 2047
12713 decoding or character code translation takes place.
12714
12715 .vitem &$return_path$&
12716 .vindex "&$return_path$&"
12717 When a message is being delivered, this variable contains the return path &--
12718 the sender field that will be sent as part of the envelope. It is not enclosed
12719 in <> characters. At the start of routing an address, &$return_path$& has the
12720 same value as &$sender_address$&, but if, for example, an incoming message to a
12721 mailing list has been expanded by a router which specifies a different address
12722 for bounce messages, &$return_path$& subsequently contains the new bounce
12723 address, whereas &$sender_address$& always contains the original sender address
12724 that was received with the message. In other words, &$sender_address$& contains
12725 the incoming envelope sender, and &$return_path$& contains the outgoing
12726 envelope sender.
12727
12728 .vitem &$return_size_limit$&
12729 .vindex "&$return_size_limit$&"
12730 This is an obsolete name for &$bounce_return_size_limit$&.
12731
12732 .vitem &$router_name$&
12733 .cindex "router" "name"
12734 .cindex "name" "of router"
12735 .vindex "&$router_name$&"
12736 During the running of a router this variable contains its name.
12737
12738 .vitem &$runrc$&
12739 .cindex "return code" "from &%run%& expansion"
12740 .vindex "&$runrc$&"
12741 This variable contains the return code from a command that is run by the
12742 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12743 assume the order in which option values are expanded, except for those
12744 preconditions whose order of testing is documented. Therefore, you cannot
12745 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12746 another.
12747
12748 .vitem &$self_hostname$&
12749 .oindex "&%self%&" "value of host name"
12750 .vindex "&$self_hostname$&"
12751 When an address is routed to a supposedly remote host that turns out to be the
12752 local host, what happens is controlled by the &%self%& generic router option.
12753 One of its values causes the address to be passed to another router. When this
12754 happens, &$self_hostname$& is set to the name of the local host that the
12755 original router encountered. In other circumstances its contents are null.
12756
12757 .vitem &$sender_address$&
12758 .vindex "&$sender_address$&"
12759 When a message is being processed, this variable contains the sender's address
12760 that was received in the message's envelope. The case of letters in the address
12761 is retained, in both the local part and the domain. For bounce messages, the
12762 value of this variable is the empty string. See also &$return_path$&.
12763
12764 .vitem &$sender_address_data$&
12765 .vindex "&$address_data$&"
12766 .vindex "&$sender_address_data$&"
12767 If &$address_data$& is set when the routers are called from an ACL to verify a
12768 sender address, the final value is preserved in &$sender_address_data$&, to
12769 distinguish it from data from a recipient address. The value does not persist
12770 after the end of the current ACL statement. If you want to preserve it for
12771 longer, you can save it in an ACL variable.
12772
12773 .vitem &$sender_address_domain$&
12774 .vindex "&$sender_address_domain$&"
12775 The domain portion of &$sender_address$&.
12776
12777 .vitem &$sender_address_local_part$&
12778 .vindex "&$sender_address_local_part$&"
12779 The local part portion of &$sender_address$&.
12780
12781 .vitem &$sender_data$&
12782 .vindex "&$sender_data$&"
12783 This variable is set after a lookup success in an ACL &%senders%& condition or
12784 in a router &%senders%& option. It contains the data from the lookup, and the
12785 value remains set until the next &%senders%& test. Thus, you can do things like
12786 this:
12787 .display
12788 &`require senders      = cdb*@;/some/file`&
12789 &`deny    `&&'some further test involving'& &`$sender_data`&
12790 .endd
12791 &*Warning*&: This variable is set only when a lookup is used as an indexing
12792 method in the address list, using the semicolon syntax as in the example above.
12793 The variable is not set for a lookup that is used as part of the string
12794 expansion that all such lists undergo before being interpreted.
12795
12796 .vitem &$sender_fullhost$&
12797 .vindex "&$sender_fullhost$&"
12798 When a message is received from a remote host, this variable contains the host
12799 name and IP address in a single string. It ends with the IP address in square
12800 brackets, followed by a colon and a port number if the logging of ports is
12801 enabled. The format of the rest of the string depends on whether the host
12802 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12803 looking up its IP address. (Looking up the IP address can be forced by the
12804 &%host_lookup%& option, independent of verification.) A plain host name at the
12805 start of the string is a verified host name; if this is not present,
12806 verification either failed or was not requested. A host name in parentheses is
12807 the argument of a HELO or EHLO command. This is omitted if it is identical to
12808 the verified host name or to the host's IP address in square brackets.
12809
12810 .vitem &$sender_helo_dnssec$&
12811 .vindex "&$sender_helo_dnssec$&"
12812 This boolean variable is true if a successful HELO verification was
12813 .cindex "DNS" "DNSSEC"
12814 done using DNS information the resolver library stated was authenticated data.
12815
12816 .vitem &$sender_helo_name$&
12817 .vindex "&$sender_helo_name$&"
12818 When a message is received from a remote host that has issued a HELO or EHLO
12819 command, the argument of that command is placed in this variable. It is also
12820 set if HELO or EHLO is used when a message is received using SMTP locally via
12821 the &%-bs%& or &%-bS%& options.
12822
12823 .vitem &$sender_host_address$&
12824 .vindex "&$sender_host_address$&"
12825 When a message is received from a remote host using SMTP,
12826 this variable contains that
12827 host's IP address. For locally non-SMTP submitted messages, it is empty.
12828
12829 .vitem &$sender_host_authenticated$&
12830 .vindex "&$sender_host_authenticated$&"
12831 This variable contains the name (not the public name) of the authenticator
12832 driver that successfully authenticated the client from which the message was
12833 received. It is empty if there was no successful authentication. See also
12834 &$authenticated_id$&.
12835
12836 .vitem &$sender_host_dnssec$&
12837 .vindex "&$sender_host_dnssec$&"
12838 If an attempt to populate &$sender_host_name$& has been made
12839 (by reference, &%hosts_lookup%& or
12840 otherwise) then this boolean will have been set true if, and only if, the
12841 resolver library states that both
12842 the reverse and forward DNS were authenticated data.  At all
12843 other times, this variable is false.
12844
12845 .cindex "DNS" "DNSSEC"
12846 It is likely that you will need to coerce DNSSEC support on in the resolver
12847 library, by setting:
12848 .code
12849 dns_dnssec_ok = 1
12850 .endd
12851
12852 Exim does not perform DNSSEC validation itself, instead leaving that to a
12853 validating resolver (e.g. unbound, or bind with suitable configuration).
12854
12855 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12856 mechanism in the list, then this variable will be false.
12857
12858 This requires that your system resolver library support EDNS0 (and that
12859 DNSSEC flags exist in the system headers).  If the resolver silently drops
12860 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
12861 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
12862
12863
12864 .vitem &$sender_host_name$&
12865 .vindex "&$sender_host_name$&"
12866 When a message is received from a remote host, this variable contains the
12867 host's name as obtained by looking up its IP address. For messages received by
12868 other means, this variable is empty.
12869
12870 .vindex "&$host_lookup_failed$&"
12871 If the host name has not previously been looked up, a reference to
12872 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12873 A looked up name is accepted only if it leads back to the original IP address
12874 via a forward lookup. If either the reverse or the forward lookup fails to find
12875 any data, or if the forward lookup does not yield the original IP address,
12876 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12877
12878 .vindex "&$host_lookup_deferred$&"
12879 However, if either of the lookups cannot be completed (for example, there is a
12880 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12881 &$host_lookup_failed$& remains set to &"0"&.
12882
12883 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12884 host name again if there is a subsequent reference to &$sender_host_name$&
12885 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12886 is set to &"1"&.
12887
12888 Exim does not automatically look up every calling host's name. If you want
12889 maximum efficiency, you should arrange your configuration so that it avoids
12890 these lookups altogether. The lookup happens only if one or more of the
12891 following are true:
12892
12893 .ilist
12894 A string containing &$sender_host_name$& is expanded.
12895 .next
12896 The calling host matches the list in &%host_lookup%&. In the default
12897 configuration, this option is set to *, so it must be changed if lookups are
12898 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12899 .next
12900 Exim needs the host name in order to test an item in a host list. The items
12901 that require this are described in sections &<<SECThoslispatnam>>& and
12902 &<<SECThoslispatnamsk>>&.
12903 .next
12904 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12905 In this case, the host name is required to compare with the name quoted in any
12906 EHLO or HELO commands that the client issues.
12907 .next
12908 The remote host issues a EHLO or HELO command that quotes one of the
12909 domains in &%helo_lookup_domains%&. The default value of this option is
12910 . ==== As this is a nested list, any displays it contains must be indented
12911 . ==== as otherwise they are too far to the left.
12912 .code
12913   helo_lookup_domains = @ : @[]
12914 .endd
12915 which causes a lookup if a remote host (incorrectly) gives the server's name or
12916 IP address in an EHLO or HELO command.
12917 .endlist
12918
12919
12920 .vitem &$sender_host_port$&
12921 .vindex "&$sender_host_port$&"
12922 When a message is received from a remote host, this variable contains the port
12923 number that was used on the remote host.
12924
12925 .vitem &$sender_ident$&
12926 .vindex "&$sender_ident$&"
12927 When a message is received from a remote host, this variable contains the
12928 identification received in response to an RFC 1413 request. When a message has
12929 been received locally, this variable contains the login name of the user that
12930 called Exim.
12931
12932 .vitem &$sender_rate_$&&'xxx'&
12933 A number of variables whose names begin &$sender_rate_$& are set as part of the
12934 &%ratelimit%& ACL condition. Details are given in section
12935 &<<SECTratelimiting>>&.
12936
12937 .vitem &$sender_rcvhost$&
12938 .cindex "DNS" "reverse lookup"
12939 .cindex "reverse DNS lookup"
12940 .vindex "&$sender_rcvhost$&"
12941 This is provided specifically for use in &'Received:'& headers. It starts with
12942 either the verified host name (as obtained from a reverse DNS lookup) or, if
12943 there is no verified host name, the IP address in square brackets. After that
12944 there may be text in parentheses. When the first item is a verified host name,
12945 the first thing in the parentheses is the IP address in square brackets,
12946 followed by a colon and a port number if port logging is enabled. When the
12947 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12948 the parentheses.
12949
12950 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12951 was used and its argument was not identical to the real host name or IP
12952 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12953 all three items are present in the parentheses, a newline and tab are inserted
12954 into the string, to improve the formatting of the &'Received:'& header.
12955
12956 .vitem &$sender_verify_failure$&
12957 .vindex "&$sender_verify_failure$&"
12958 In an ACL, when a sender verification fails, this variable contains information
12959 about the failure. The details are the same as for
12960 &$recipient_verify_failure$&.
12961
12962 .vitem &$sending_ip_address$&
12963 .vindex "&$sending_ip_address$&"
12964 This variable is set whenever an outgoing SMTP connection to another host has
12965 been set up. It contains the IP address of the local interface that is being
12966 used. This is useful if a host that has more than one IP address wants to take
12967 on different personalities depending on which one is being used. For incoming
12968 connections, see &$received_ip_address$&.
12969
12970 .vitem &$sending_port$&
12971 .vindex "&$sending_port$&"
12972 This variable is set whenever an outgoing SMTP connection to another host has
12973 been set up. It contains the local port that is being used. For incoming
12974 connections, see &$received_port$&.
12975
12976 .vitem &$smtp_active_hostname$&
12977 .vindex "&$smtp_active_hostname$&"
12978 During an incoming SMTP session, this variable contains the value of the active
12979 host name, as specified by the &%smtp_active_hostname%& option. The value of
12980 &$smtp_active_hostname$& is saved with any message that is received, so its
12981 value can be consulted during routing and delivery.
12982
12983 .vitem &$smtp_command$&
12984 .vindex "&$smtp_command$&"
12985 During the processing of an incoming SMTP command, this variable contains the
12986 entire command. This makes it possible to distinguish between HELO and EHLO in
12987 the HELO ACL, and also to distinguish between commands such as these:
12988 .code
12989 MAIL FROM:<>
12990 MAIL FROM: <>
12991 .endd
12992 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12993 command, the address in &$smtp_command$& is the original address before any
12994 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12995 the address after SMTP-time rewriting.
12996
12997 .vitem &$smtp_command_argument$&
12998 .cindex "SMTP" "command, argument for"
12999 .vindex "&$smtp_command_argument$&"
13000 While an ACL is running to check an SMTP command, this variable contains the
13001 argument, that is, the text that follows the command name, with leading white
13002 space removed. Following the introduction of &$smtp_command$&, this variable is
13003 somewhat redundant, but is retained for backwards compatibility.
13004
13005 .vitem &$smtp_command_history$&
13006 .cindex SMTP "command history"
13007 .vindex "&$smtp_command_history$&"
13008 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13009 received, in time-order left to right.  Only a limited number of commands
13010 are remembered.
13011
13012 .vitem &$smtp_count_at_connection_start$&
13013 .vindex "&$smtp_count_at_connection_start$&"
13014 This variable is set greater than zero only in processes spawned by the Exim
13015 daemon for handling incoming SMTP connections. The name is deliberately long,
13016 in order to emphasize what the contents are. When the daemon accepts a new
13017 connection, it increments this variable. A copy of the variable is passed to
13018 the child process that handles the connection, but its value is fixed, and
13019 never changes. It is only an approximation of how many incoming connections
13020 there actually are, because many other connections may come and go while a
13021 single connection is being processed. When a child process terminates, the
13022 daemon decrements its copy of the variable.
13023
13024 .vitem "&$sn0$& &-- &$sn9$&"
13025 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13026 that were current at the end of the system filter file. This allows a system
13027 filter file to set values that can be tested in users' filter files. For
13028 example, a system filter could set a value indicating how likely it is that a
13029 message is junk mail.
13030
13031 .vitem &$spam_$&&'xxx'&
13032 A number of variables whose names start with &$spam$& are available when Exim
13033 is compiled with the content-scanning extension. For details, see section
13034 &<<SECTscanspamass>>&.
13035
13036 .vitem &$spf_header_comment$& &&&
13037        &$spf_received$& &&&
13038        &$spf_result$& &&&
13039        &$spf_result_guessed$& &&&
13040        &$spf_smtp_comment$&
13041 These variables are only available if Exim is built with SPF support.
13042 For details see section &<<SECSPF>>&.
13043
13044 .vitem &$spool_directory$&
13045 .vindex "&$spool_directory$&"
13046 The name of Exim's spool directory.
13047
13048 .vitem &$spool_inodes$&
13049 .vindex "&$spool_inodes$&"
13050 The number of free inodes in the disk partition where Exim's spool files are
13051 being written. The value is recalculated whenever the variable is referenced.
13052 If the relevant file system does not have the concept of inodes, the value of
13053 is -1. See also the &%check_spool_inodes%& option.
13054
13055 .vitem &$spool_space$&
13056 .vindex "&$spool_space$&"
13057 The amount of free space (as a number of kilobytes) in the disk partition where
13058 Exim's spool files are being written. The value is recalculated whenever the
13059 variable is referenced. If the operating system does not have the ability to
13060 find the amount of free space (only true for experimental systems), the space
13061 value is -1. For example, to check in an ACL that there is at least 50
13062 megabytes free on the spool, you could write:
13063 .code
13064 condition = ${if > {$spool_space}{50000}}
13065 .endd
13066 See also the &%check_spool_space%& option.
13067
13068
13069 .vitem &$thisaddress$&
13070 .vindex "&$thisaddress$&"
13071 This variable is set only during the processing of the &%foranyaddress%&
13072 command in a filter file. Its use is explained in the description of that
13073 command, which can be found in the separate document entitled &'Exim's
13074 interfaces to mail filtering'&.
13075
13076 .vitem &$tls_in_bits$&
13077 .vindex "&$tls_in_bits$&"
13078 Contains an approximation of the TLS cipher's bit-strength
13079 on the inbound connection; the meaning of
13080 this depends upon the TLS implementation used.
13081 If TLS has not been negotiated, the value will be 0.
13082 The value of this is automatically fed into the Cyrus SASL authenticator
13083 when acting as a server, to specify the "external SSF" (a SASL term).
13084
13085 The deprecated &$tls_bits$& variable refers to the inbound side
13086 except when used in the context of an outbound SMTP delivery, when it refers to
13087 the outbound.
13088
13089 .vitem &$tls_out_bits$&
13090 .vindex "&$tls_out_bits$&"
13091 Contains an approximation of the TLS cipher's bit-strength
13092 on an outbound SMTP connection; the meaning of
13093 this depends upon the TLS implementation used.
13094 If TLS has not been negotiated, the value will be 0.
13095
13096 .vitem &$tls_in_ourcert$&
13097 .vindex "&$tls_in_ourcert$&"
13098 .cindex certificate variables
13099 This variable refers to the certificate presented to the peer of an
13100 inbound connection when the message was received.
13101 It is only useful as the argument of a
13102 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13103 or a &%def%& condition.
13104
13105 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13106 when a list of more than one
13107 file is used for &%tls_certificate%&, this variable is not reliable.
13108
13109 .vitem &$tls_in_peercert$&
13110 .vindex "&$tls_in_peercert$&"
13111 This variable refers to the certificate presented by the peer of an
13112 inbound connection when the message was received.
13113 It is only useful as the argument of a
13114 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13115 or a &%def%& condition.
13116 If certificate verification fails it may refer to a failing chain element
13117 which is not the leaf.
13118
13119 .vitem &$tls_out_ourcert$&
13120 .vindex "&$tls_out_ourcert$&"
13121 This variable refers to the certificate presented to the peer of an
13122 outbound connection.  It is only useful as the argument of a
13123 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13124 or a &%def%& condition.
13125
13126 .vitem &$tls_out_peercert$&
13127 .vindex "&$tls_out_peercert$&"
13128 This variable refers to the certificate presented by the peer of an
13129 outbound connection.  It is only useful as the argument of a
13130 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13131 or a &%def%& condition.
13132 If certificate verification fails it may refer to a failing chain element
13133 which is not the leaf.
13134
13135 .vitem &$tls_in_certificate_verified$&
13136 .vindex "&$tls_in_certificate_verified$&"
13137 This variable is set to &"1"& if a TLS certificate was verified when the
13138 message was received, and &"0"& otherwise.
13139
13140 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13141 except when used in the context of an outbound SMTP delivery, when it refers to
13142 the outbound.
13143
13144 .vitem &$tls_out_certificate_verified$&
13145 .vindex "&$tls_out_certificate_verified$&"
13146 This variable is set to &"1"& if a TLS certificate was verified when an
13147 outbound SMTP connection was made,
13148 and &"0"& otherwise.
13149
13150 .vitem &$tls_in_cipher$&
13151 .vindex "&$tls_in_cipher$&"
13152 .vindex "&$tls_cipher$&"
13153 When a message is received from a remote host over an encrypted SMTP
13154 connection, this variable is set to the cipher suite that was negotiated, for
13155 example DES-CBC3-SHA. In other circumstances, in particular, for message
13156 received over unencrypted connections, the variable is empty. Testing
13157 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13158 non-encrypted connections during ACL processing.
13159
13160 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13161 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13162 becomes the same as &$tls_out_cipher$&.
13163
13164 .vitem &$tls_out_cipher$&
13165 .vindex "&$tls_out_cipher$&"
13166 This variable is
13167 cleared before any outgoing SMTP connection is made,
13168 and then set to the outgoing cipher suite if one is negotiated. See chapter
13169 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13170 details of the &(smtp)& transport.
13171
13172 .vitem &$tls_out_dane$&
13173 .vindex &$tls_out_dane$&
13174 DANE active status.  See section &<<SECDANE>>&.
13175
13176 .vitem &$tls_in_ocsp$&
13177 .vindex "&$tls_in_ocsp$&"
13178 When a message is received from a remote client connection
13179 the result of any OCSP request from the client is encoded in this variable:
13180 .code
13181 0 OCSP proof was not requested (default value)
13182 1 No response to request
13183 2 Response not verified
13184 3 Verification failed
13185 4 Verification succeeded
13186 .endd
13187
13188 .vitem &$tls_out_ocsp$&
13189 .vindex "&$tls_out_ocsp$&"
13190 When a message is sent to a remote host connection
13191 the result of any OCSP request made is encoded in this variable.
13192 See &$tls_in_ocsp$& for values.
13193
13194 .vitem &$tls_in_peerdn$&
13195 .vindex "&$tls_in_peerdn$&"
13196 .vindex "&$tls_peerdn$&"
13197 .cindex certificate "extracting fields"
13198 When a message is received from a remote host over an encrypted SMTP
13199 connection, and Exim is configured to request a certificate from the client,
13200 the value of the Distinguished Name of the certificate is made available in the
13201 &$tls_in_peerdn$& during subsequent processing.
13202 If certificate verification fails it may refer to a failing chain element
13203 which is not the leaf.
13204
13205 The deprecated &$tls_peerdn$& variable refers to the inbound side
13206 except when used in the context of an outbound SMTP delivery, when it refers to
13207 the outbound.
13208
13209 .vitem &$tls_out_peerdn$&
13210 .vindex "&$tls_out_peerdn$&"
13211 When a message is being delivered to a remote host over an encrypted SMTP
13212 connection, and Exim is configured to request a certificate from the server,
13213 the value of the Distinguished Name of the certificate is made available in the
13214 &$tls_out_peerdn$& during subsequent processing.
13215 If certificate verification fails it may refer to a failing chain element
13216 which is not the leaf.
13217
13218 .vitem &$tls_in_sni$&
13219 .vindex "&$tls_in_sni$&"
13220 .vindex "&$tls_sni$&"
13221 .cindex "TLS" "Server Name Indication"
13222 When a TLS session is being established, if the client sends the Server
13223 Name Indication extension, the value will be placed in this variable.
13224 If the variable appears in &%tls_certificate%& then this option and
13225 some others, described in &<<SECTtlssni>>&,
13226 will be re-expanded early in the TLS session, to permit
13227 a different certificate to be presented (and optionally a different key to be
13228 used) to the client, based upon the value of the SNI extension.
13229
13230 The deprecated &$tls_sni$& variable refers to the inbound side
13231 except when used in the context of an outbound SMTP delivery, when it refers to
13232 the outbound.
13233
13234 .vitem &$tls_out_sni$&
13235 .vindex "&$tls_out_sni$&"
13236 .cindex "TLS" "Server Name Indication"
13237 During outbound
13238 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13239 the transport.
13240
13241 .vitem &$tls_out_tlsa_usage$&
13242 .vindex &$tls_out_tlsa_usage$&
13243 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13244
13245 .vitem &$tod_bsdinbox$&
13246 .vindex "&$tod_bsdinbox$&"
13247 The time of day and the date, in the format required for BSD-style mailbox
13248 files, for example: Thu Oct 17 17:14:09 1995.
13249
13250 .vitem &$tod_epoch$&
13251 .vindex "&$tod_epoch$&"
13252 The time and date as a number of seconds since the start of the Unix epoch.
13253
13254 .vitem &$tod_epoch_l$&
13255 .vindex "&$tod_epoch_l$&"
13256 The time and date as a number of microseconds since the start of the Unix epoch.
13257
13258 .vitem &$tod_full$&
13259 .vindex "&$tod_full$&"
13260 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13261 +0100. The timezone is always given as a numerical offset from UTC, with
13262 positive values used for timezones that are ahead (east) of UTC, and negative
13263 values for those that are behind (west).
13264
13265 .vitem &$tod_log$&
13266 .vindex "&$tod_log$&"
13267 The time and date in the format used for writing Exim's log files, for example:
13268 1995-10-12 15:32:29, but without a timezone.
13269
13270 .vitem &$tod_logfile$&
13271 .vindex "&$tod_logfile$&"
13272 This variable contains the date in the format yyyymmdd. This is the format that
13273 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13274 flag.
13275
13276 .vitem &$tod_zone$&
13277 .vindex "&$tod_zone$&"
13278 This variable contains the numerical value of the local timezone, for example:
13279 -0500.
13280
13281 .vitem &$tod_zulu$&
13282 .vindex "&$tod_zulu$&"
13283 This variable contains the UTC date and time in &"Zulu"& format, as specified
13284 by ISO 8601, for example: 20030221154023Z.
13285
13286 .vitem &$transport_name$&
13287 .cindex "transport" "name"
13288 .cindex "name" "of transport"
13289 .vindex "&$transport_name$&"
13290 During the running of a transport, this variable contains its name.
13291
13292 .vitem &$value$&
13293 .vindex "&$value$&"
13294 This variable contains the result of an expansion lookup, extraction operation,
13295 or external command, as described above. It is also used during a
13296 &*reduce*& expansion.
13297
13298 .vitem &$verify_mode$&
13299 .vindex "&$verify_mode$&"
13300 While a router or transport is being run in verify mode or for cutthrough delivery,
13301 contains "S" for sender-verification or "R" for recipient-verification.
13302 Otherwise, empty.
13303
13304 .vitem &$version_number$&
13305 .vindex "&$version_number$&"
13306 The version number of Exim.
13307
13308 .vitem &$warn_message_delay$&
13309 .vindex "&$warn_message_delay$&"
13310 This variable is set only during the creation of a message warning about a
13311 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13312
13313 .vitem &$warn_message_recipients$&
13314 .vindex "&$warn_message_recipients$&"
13315 This variable is set only during the creation of a message warning about a
13316 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13317 .endlist
13318 .ecindex IIDstrexp
13319
13320
13321
13322 . ////////////////////////////////////////////////////////////////////////////
13323 . ////////////////////////////////////////////////////////////////////////////
13324
13325 .chapter "Embedded Perl" "CHAPperl"
13326 .scindex IIDperl "Perl" "calling from Exim"
13327 Exim can be built to include an embedded Perl interpreter. When this is done,
13328 Perl subroutines can be called as part of the string expansion process. To make
13329 use of the Perl support, you need version 5.004 or later of Perl installed on
13330 your system. To include the embedded interpreter in the Exim binary, include
13331 the line
13332 .code
13333 EXIM_PERL = perl.o
13334 .endd
13335 in your &_Local/Makefile_& and then build Exim in the normal way.
13336
13337
13338 .section "Setting up so Perl can be used" "SECID85"
13339 .oindex "&%perl_startup%&"
13340 Access to Perl subroutines is via a global configuration option called
13341 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13342 no &%perl_startup%& option in the Exim configuration file then no Perl
13343 interpreter is started and there is almost no overhead for Exim (since none of
13344 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13345 option then the associated value is taken to be Perl code which is executed in
13346 a newly created Perl interpreter.
13347
13348 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13349 need backslashes before any characters to escape special meanings. The option
13350 should usually be something like
13351 .code
13352 perl_startup = do '/etc/exim.pl'
13353 .endd
13354 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13355 use from Exim. Exim can be configured either to start up a Perl interpreter as
13356 soon as it is entered, or to wait until the first time it is needed. Starting
13357 the interpreter at the beginning ensures that it is done while Exim still has
13358 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13359 fact used in a particular run. Also, note that this does not mean that Exim is
13360 necessarily running as root when Perl is called at a later time. By default,
13361 the interpreter is started only when it is needed, but this can be changed in
13362 two ways:
13363
13364 .ilist
13365 .oindex "&%perl_at_start%&"
13366 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13367 a startup when Exim is entered.
13368 .next
13369 The command line option &%-ps%& also requests a startup when Exim is entered,
13370 overriding the setting of &%perl_at_start%&.
13371 .endlist
13372
13373 There is also a command line option &%-pd%& (for delay) which suppresses the
13374 initial startup, even if &%perl_at_start%& is set.
13375
13376 .ilist
13377 .oindex "&%perl_taintmode%&"
13378 .cindex "Perl" "taintmode"
13379 To provide more security executing Perl code via the embedded Perl
13380 interpreter, the &%perl_taintmode%& option can be set. This enables the
13381 taint mode of the Perl interpreter. You are encouraged to set this
13382 option to a true value. To avoid breaking existing installations, it
13383 defaults to false.
13384
13385
13386 .section "Calling Perl subroutines" "SECID86"
13387 When the configuration file includes a &%perl_startup%& option you can make use
13388 of the string expansion item to call the Perl subroutines that are defined
13389 by the &%perl_startup%& code. The operator is used in any of the following
13390 forms:
13391 .code
13392 ${perl{foo}}
13393 ${perl{foo}{argument}}
13394 ${perl{foo}{argument1}{argument2} ... }
13395 .endd
13396 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13397 arguments may be passed. Passing more than this results in an expansion failure
13398 with an error message of the form
13399 .code
13400 Too many arguments passed to Perl subroutine "foo" (max is 8)
13401 .endd
13402 The return value of the Perl subroutine is evaluated in a scalar context before
13403 it is passed back to Exim to be inserted into the expanded string. If the
13404 return value is &'undef'&, the expansion is forced to fail in the same way as
13405 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13406 by obeying Perl's &%die%& function, the expansion fails with the error message
13407 that was passed to &%die%&.
13408
13409
13410 .section "Calling Exim functions from Perl" "SECID87"
13411 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13412 is available to call back into Exim's string expansion function. For example,
13413 the Perl code
13414 .code
13415 my $lp = Exim::expand_string('$local_part');
13416 .endd
13417 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13418 Note those are single quotes and not double quotes to protect against
13419 &$local_part$& being interpolated as a Perl variable.
13420
13421 If the string expansion is forced to fail by a &"fail"& item, the result of
13422 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13423 expansion string, the Perl call from the original expansion string fails with
13424 an appropriate error message, in the same way as if &%die%& were used.
13425
13426 .cindex "debugging" "from embedded Perl"
13427 .cindex "log" "writing from embedded Perl"
13428 Two other Exim functions are available for use from within Perl code.
13429 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13430 debugging is enabled. If you want a newline at the end, you must supply it.
13431 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13432 timestamp. In this case, you should not supply a terminating newline.
13433
13434
13435 .section "Use of standard output and error by Perl" "SECID88"
13436 .cindex "Perl" "standard output and error"
13437 You should not write to the standard error or output streams from within your
13438 Perl code, as it is not defined how these are set up. In versions of Exim
13439 before 4.50, it is possible for the standard output or error to refer to the
13440 SMTP connection during message reception via the daemon. Writing to this stream
13441 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13442 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13443 avoided, but the output is lost.
13444
13445 .cindex "Perl" "use of &%warn%&"
13446 The Perl &%warn%& statement writes to the standard error stream by default.
13447 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13448 you have no control. When Exim starts up the Perl interpreter, it arranges for
13449 output from the &%warn%& statement to be written to the Exim main log. You can
13450 change this by including appropriate Perl magic somewhere in your Perl code.
13451 For example, to discard &%warn%& output completely, you need this:
13452 .code
13453 $SIG{__WARN__} = sub { };
13454 .endd
13455 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13456 example, the code for the subroutine is empty, so it does nothing, but you can
13457 include any Perl code that you like. The text of the &%warn%& message is passed
13458 as the first subroutine argument.
13459 .ecindex IIDperl
13460
13461
13462 . ////////////////////////////////////////////////////////////////////////////
13463 . ////////////////////////////////////////////////////////////////////////////
13464
13465 .chapter "Starting the daemon and the use of network interfaces" &&&
13466          "CHAPinterfaces" &&&
13467          "Starting the daemon"
13468 .cindex "daemon" "starting"
13469 .cindex "interface" "listening"
13470 .cindex "network interface"
13471 .cindex "interface" "network"
13472 .cindex "IP address" "for listening"
13473 .cindex "daemon" "listening IP addresses"
13474 .cindex "TCP/IP" "setting listening interfaces"
13475 .cindex "TCP/IP" "setting listening ports"
13476 A host that is connected to a TCP/IP network may have one or more physical
13477 hardware network interfaces. Each of these interfaces may be configured as one
13478 or more &"logical"& interfaces, which are the entities that a program actually
13479 works with. Each of these logical interfaces is associated with an IP address.
13480 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13481 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13482 knowledge about the host's interfaces for use in three different circumstances:
13483
13484 .olist
13485 When a listening daemon is started, Exim needs to know which interfaces
13486 and ports to listen on.
13487 .next
13488 When Exim is routing an address, it needs to know which IP addresses
13489 are associated with local interfaces. This is required for the correct
13490 processing of MX lists by removing the local host and others with the
13491 same or higher priority values. Also, Exim needs to detect cases
13492 when an address is routed to an IP address that in fact belongs to the
13493 local host. Unless the &%self%& router option or the &%allow_localhost%&
13494 option of the smtp transport is set (as appropriate), this is treated
13495 as an error situation.
13496 .next
13497 When Exim connects to a remote host, it may need to know which interface to use
13498 for the outgoing connection.
13499 .endlist
13500
13501
13502 Exim's default behaviour is likely to be appropriate in the vast majority
13503 of cases. If your host has only one interface, and you want all its IP
13504 addresses to be treated in the same way, and you are using only the
13505 standard SMTP port, you should not need to take any special action. The
13506 rest of this chapter does not apply to you.
13507
13508 In a more complicated situation you may want to listen only on certain
13509 interfaces, or on different ports, and for this reason there are a number of
13510 options that can be used to influence Exim's behaviour. The rest of this
13511 chapter describes how they operate.
13512
13513 When a message is received over TCP/IP, the interface and port that were
13514 actually used are set in &$received_ip_address$& and &$received_port$&.
13515
13516
13517
13518 .section "Starting a listening daemon" "SECID89"
13519 When a listening daemon is started (by means of the &%-bd%& command line
13520 option), the interfaces and ports on which it listens are controlled by the
13521 following options:
13522
13523 .ilist
13524 &%daemon_smtp_ports%& contains a list of default ports
13525 or service names.
13526 (For backward compatibility, this option can also be specified in the singular.)
13527 .next
13528 &%local_interfaces%& contains list of interface IP addresses on which to
13529 listen. Each item may optionally also specify a port.
13530 .endlist
13531
13532 The default list separator in both cases is a colon, but this can be changed as
13533 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
13534 it is usually best to change the separator to avoid having to double all the
13535 colons. For example:
13536 .code
13537 local_interfaces = <; 127.0.0.1 ; \
13538                       192.168.23.65 ; \
13539                       ::1 ; \
13540                       3ffe:ffff:836f::fe86:a061
13541 .endd
13542 There are two different formats for specifying a port along with an IP address
13543 in &%local_interfaces%&:
13544
13545 .olist
13546 The port is added onto the address with a dot separator. For example, to listen
13547 on port 1234 on two different IP addresses:
13548 .code
13549 local_interfaces = <; 192.168.23.65.1234 ; \
13550                       3ffe:ffff:836f::fe86:a061.1234
13551 .endd
13552 .next
13553 The IP address is enclosed in square brackets, and the port is added
13554 with a colon separator, for example:
13555 .code
13556 local_interfaces = <; [192.168.23.65]:1234 ; \
13557                       [3ffe:ffff:836f::fe86:a061]:1234
13558 .endd
13559 .endlist
13560
13561 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13562 default setting contains just one port:
13563 .code
13564 daemon_smtp_ports = smtp
13565 .endd
13566 If more than one port is listed, each interface that does not have its own port
13567 specified listens on all of them. Ports that are listed in
13568 &%daemon_smtp_ports%& can be identified either by name (defined in
13569 &_/etc/services_&) or by number. However, when ports are given with individual
13570 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13571
13572
13573
13574 .section "Special IP listening addresses" "SECID90"
13575 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13576 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13577 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13578 instead of setting up separate listening sockets for each interface. The
13579 default value of &%local_interfaces%& is
13580 .code
13581 local_interfaces = 0.0.0.0
13582 .endd
13583 when Exim is built without IPv6 support; otherwise it is:
13584 .code
13585 local_interfaces = <; ::0 ; 0.0.0.0
13586 .endd
13587 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13588
13589
13590
13591 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13592 The &%-oX%& command line option can be used to override the values of
13593 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13594 instance. Another way of doing this would be to use macros and the &%-D%&
13595 option. However, &%-oX%& can be used by any admin user, whereas modification of
13596 the runtime configuration by &%-D%& is allowed only when the caller is root or
13597 exim.
13598
13599 The value of &%-oX%& is a list of items. The default colon separator can be
13600 changed in the usual way if required. If there are any items that do not
13601 contain dots or colons (that is, are not IP addresses), the value of
13602 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13603 items that do contain dots or colons, the value of &%local_interfaces%& is
13604 replaced by those items. Thus, for example,
13605 .code
13606 -oX 1225
13607 .endd
13608 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13609 whereas
13610 .code
13611 -oX 192.168.34.5.1125
13612 .endd
13613 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13614 (However, since &%local_interfaces%& now contains no items without ports, the
13615 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13616
13617
13618
13619 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
13620 .cindex "submissions protocol"
13621 .cindex "ssmtp protocol"
13622 .cindex "smtps protocol"
13623 .cindex "SMTP" "ssmtp protocol"
13624 .cindex "SMTP" "smtps protocol"
13625 Exim supports the use of TLS-on-connect, used by mail clients in the
13626 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
13627 For some years, IETF Standards Track documents only blessed the
13628 STARTTLS-based Submission service (port 587) while common practice was to support
13629 the same feature set on port 465, but using TLS-on-connect.
13630 If your installation needs to provide service to mail clients
13631 (Mail User Agents, MUAs) then you should provide service on both the 587 and
13632 the 465 TCP ports.
13633
13634 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
13635 service names, connections to those ports must first establish TLS, before
13636 proceeding to the application layer use of the SMTP protocol.
13637
13638 The common use of this option is expected to be
13639 .code
13640 tls_on_connect_ports = 465
13641 .endd
13642 per RFC 8314.
13643 There is also a command line option &%-tls-on-connect%&, which forces all ports
13644 to behave in this way when a daemon is started.
13645
13646 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13647 daemon to listen on those ports. You must still specify them in
13648 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13649 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13650 connections via the daemon.)
13651
13652
13653
13654
13655 .section "IPv6 address scopes" "SECID92"
13656 .cindex "IPv6" "address scopes"
13657 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13658 can, in principle, have the same link-local IPv6 address on different
13659 interfaces. Thus, additional information is needed, over and above the IP
13660 address, to distinguish individual interfaces. A convention of using a
13661 percent sign followed by something (often the interface name) has been
13662 adopted in some cases, leading to addresses like this:
13663 .code
13664 fe80::202:b3ff:fe03:45c1%eth0
13665 .endd
13666 To accommodate this usage, a percent sign followed by an arbitrary string is
13667 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13668 to convert a textual IPv6 address for actual use. This function recognizes the
13669 percent convention in operating systems that support it, and it processes the
13670 address appropriately. Unfortunately, some older libraries have problems with
13671 &[getaddrinfo()]&. If
13672 .code
13673 IPV6_USE_INET_PTON=yes
13674 .endd
13675 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13676 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13677 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13678 function.) Of course, this means that the additional functionality of
13679 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13680
13681 .section "Disabling IPv6" "SECID93"
13682 .cindex "IPv6" "disabling"
13683 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13684 run on a host whose kernel does not support IPv6. The binary will fall back to
13685 using IPv4, but it may waste resources looking up AAAA records, and trying to
13686 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13687 .oindex "&%disable_ipv6%&"
13688 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13689 activities take place. AAAA records are never looked up, and any IPv6 addresses
13690 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13691 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13692 to handle IPv6 literal addresses.
13693
13694 On the other hand, when IPv6 is in use, there may be times when you want to
13695 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13696 option to globally suppress the lookup of AAAA records for specified domains,
13697 and you can use the &%ignore_target_hosts%& generic router option to ignore
13698 IPv6 addresses in an individual router.
13699
13700
13701
13702 .section "Examples of starting a listening daemon" "SECID94"
13703 The default case in an IPv6 environment is
13704 .code
13705 daemon_smtp_ports = smtp
13706 local_interfaces = <; ::0 ; 0.0.0.0
13707 .endd
13708 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13709 Either one or two sockets may be used, depending on the characteristics of
13710 the TCP/IP stack. (This is complicated and messy; for more information,
13711 read the comments in the &_daemon.c_& source file.)
13712
13713 To specify listening on ports 25 and 26 on all interfaces:
13714 .code
13715 daemon_smtp_ports = 25 : 26
13716 .endd
13717 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13718 .code
13719 local_interfaces = <; ::0.25     ; ::0.26 \
13720                       0.0.0.0.25 ; 0.0.0.0.26
13721 .endd
13722 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13723 IPv4 loopback address only:
13724 .code
13725 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13726 .endd
13727 To specify listening on the default port on specific interfaces only:
13728 .code
13729 local_interfaces = 10.0.0.67 : 192.168.34.67
13730 .endd
13731 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13732
13733
13734
13735 .section "Recognizing the local host" "SECTreclocipadd"
13736 The &%local_interfaces%& option is also used when Exim needs to determine
13737 whether or not an IP address refers to the local host. That is, the IP
13738 addresses of all the interfaces on which a daemon is listening are always
13739 treated as local.
13740
13741 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13742 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13743 available interfaces from the operating system, and extracts the relevant
13744 (that is, IPv4 or IPv6) addresses to use for checking.
13745
13746 Some systems set up large numbers of virtual interfaces in order to provide
13747 many virtual web servers. In this situation, you may want to listen for
13748 email on only a few of the available interfaces, but nevertheless treat all
13749 interfaces as local when routing. You can do this by setting
13750 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13751 &"all"& wildcard values. These addresses are recognized as local, but are not
13752 used for listening. Consider this example:
13753 .code
13754 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13755                       192.168.53.235 ; \
13756                       3ffe:2101:12:1:a00:20ff:fe86:a061
13757
13758 extra_local_interfaces = <; ::0 ; 0.0.0.0
13759 .endd
13760 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13761 address, but all available interface addresses are treated as local when
13762 Exim is routing.
13763
13764 In some environments the local host name may be in an MX list, but with an IP
13765 address that is not assigned to any local interface. In other cases it may be
13766 desirable to treat other host names as if they referred to the local host. Both
13767 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13768 This contains host names rather than IP addresses. When a host is referenced
13769 during routing, either via an MX record or directly, it is treated as the local
13770 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13771 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13772
13773
13774
13775 .section "Delivering to a remote host" "SECID95"
13776 Delivery to a remote host is handled by the smtp transport. By default, it
13777 allows the system's TCP/IP functions to choose which interface to use (if
13778 there is more than one) when connecting to a remote host. However, the
13779 &%interface%& option can be set to specify which interface is used. See the
13780 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13781 details.
13782
13783
13784
13785
13786 . ////////////////////////////////////////////////////////////////////////////
13787 . ////////////////////////////////////////////////////////////////////////////
13788
13789 .chapter "Main configuration" "CHAPmainconfig"
13790 .scindex IIDconfima "configuration file" "main section"
13791 .scindex IIDmaiconf "main configuration"
13792 The first part of the run time configuration file contains three types of item:
13793
13794 .ilist
13795 Macro definitions: These lines start with an upper case letter. See section
13796 &<<SECTmacrodefs>>& for details of macro processing.
13797 .next
13798 Named list definitions: These lines start with one of the words &"domainlist"&,
13799 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13800 section &<<SECTnamedlists>>&.
13801 .next
13802 Main configuration settings: Each setting occupies one line of the file
13803 (with possible continuations). If any setting is preceded by the word
13804 &"hide"&, the &%-bP%& command line option displays its value to admin users
13805 only. See section &<<SECTcos>>& for a description of the syntax of these option
13806 settings.
13807 .endlist
13808
13809 This chapter specifies all the main configuration options, along with their
13810 types and default values. For ease of finding a particular option, they appear
13811 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13812 are now so many options, they are first listed briefly in functional groups, as
13813 an aid to finding the name of the option you are looking for. Some options are
13814 listed in more than one group.
13815
13816 .section "Miscellaneous" "SECID96"
13817 .table2
13818 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13819 .row &%debug_store%&                 "do extra internal checks"
13820 .row &%disable_ipv6%&                "do no IPv6 processing"
13821 .row &%keep_malformed%&              "for broken files &-- should not happen"
13822 .row &%localhost_number%&            "for unique message ids in clusters"
13823 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13824 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13825 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13826 .row &%print_topbitchars%&           "top-bit characters are printing"
13827 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
13828 .row &%timezone%&                    "force time zone"
13829 .endtable
13830
13831
13832 .section "Exim parameters" "SECID97"
13833 .table2
13834 .row &%exim_group%&                  "override compiled-in value"
13835 .row &%exim_path%&                   "override compiled-in value"
13836 .row &%exim_user%&                   "override compiled-in value"
13837 .row &%primary_hostname%&            "default from &[uname()]&"
13838 .row &%split_spool_directory%&       "use multiple directories"
13839 .row &%spool_directory%&             "override compiled-in value"
13840 .endtable
13841
13842
13843
13844 .section "Privilege controls" "SECID98"
13845 .table2
13846 .row &%admin_groups%&                "groups that are Exim admin users"
13847 .row &%commandline_checks_require_admin%& "require admin for various checks"
13848 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13849 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13850 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13851 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13852 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13853 .row &%never_users%&                 "do not run deliveries as these"
13854 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13855 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13856 .row &%trusted_groups%&              "groups that are trusted"
13857 .row &%trusted_users%&               "users that are trusted"
13858 .endtable
13859
13860
13861
13862 .section "Logging" "SECID99"
13863 .table2
13864 .row &%event_action%&                "custom logging"
13865 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13866 .row &%log_file_path%&               "override compiled-in value"
13867 .row &%log_selector%&                "set/unset optional logging"
13868 .row &%log_timezone%&                "add timezone to log lines"
13869 .row &%message_logs%&                "create per-message logs"
13870 .row &%preserve_message_logs%&       "after message completion"
13871 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13872 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13873 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13874 .row &%syslog_facility%&             "set syslog &""facility""& field"
13875 .row &%syslog_pid%&                  "pid in syslog lines"
13876 .row &%syslog_processname%&          "set syslog &""ident""& field"
13877 .row &%syslog_timestamp%&            "timestamp syslog lines"
13878 .row &%write_rejectlog%&             "control use of message log"
13879 .endtable
13880
13881
13882
13883 .section "Frozen messages" "SECID100"
13884 .table2
13885 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13886 .row &%freeze_tell%&                 "send message when freezing"
13887 .row &%move_frozen_messages%&        "to another directory"
13888 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13889 .endtable
13890
13891
13892
13893 .section "Data lookups" "SECID101"
13894 .table2
13895 .row &%ibase_servers%&               "InterBase servers"
13896 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13897 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13898 .row &%ldap_cert_file%&              "client cert file for LDAP"
13899 .row &%ldap_cert_key%&               "client key file for LDAP"
13900 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13901 .row &%ldap_default_servers%&        "used if no server in query"
13902 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13903 .row &%ldap_start_tls%&              "require TLS within LDAP"
13904 .row &%ldap_version%&                "set protocol version"
13905 .row &%lookup_open_max%&             "lookup files held open"
13906 .row &%mysql_servers%&               "default MySQL servers"
13907 .row &%oracle_servers%&              "Oracle servers"
13908 .row &%pgsql_servers%&               "default PostgreSQL servers"
13909 .row &%sqlite_lock_timeout%&         "as it says"
13910 .endtable
13911
13912
13913
13914 .section "Message ids" "SECID102"
13915 .table2
13916 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13917 .row &%message_id_header_text%&      "ditto"
13918 .endtable
13919
13920
13921
13922 .section "Embedded Perl Startup" "SECID103"
13923 .table2
13924 .row &%perl_at_start%&               "always start the interpreter"
13925 .row &%perl_startup%&                "code to obey when starting Perl"
13926 .row &%perl_taintmode%&              "enable taint mode in Perl"
13927 .endtable
13928
13929
13930
13931 .section "Daemon" "SECID104"
13932 .table2
13933 .row &%daemon_smtp_ports%&           "default ports"
13934 .row &%daemon_startup_retries%&      "number of times to retry"
13935 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13936 .row &%extra_local_interfaces%&      "not necessarily listened on"
13937 .row &%local_interfaces%&            "on which to listen, with optional ports"
13938 .row &%pid_file_path%&               "override compiled-in value"
13939 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13940 .endtable
13941
13942
13943
13944 .section "Resource control" "SECID105"
13945 .table2
13946 .row &%check_log_inodes%&            "before accepting a message"
13947 .row &%check_log_space%&             "before accepting a message"
13948 .row &%check_spool_inodes%&          "before accepting a message"
13949 .row &%check_spool_space%&           "before accepting a message"
13950 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13951 .row &%queue_only_load%&             "queue incoming if load high"
13952 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13953 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13954 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13955 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13956 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13957 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13958 .row &%smtp_accept_max_per_connection%& "messages per connection"
13959 .row &%smtp_accept_max_per_host%&    "connections from one host"
13960 .row &%smtp_accept_queue%&           "queue mail if more connections"
13961 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13962                                            connection"
13963 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13964 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13965 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13966 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13967 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13968 .endtable
13969
13970
13971
13972 .section "Policy controls" "SECID106"
13973 .table2
13974 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13975 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13976 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13977 .row &%acl_smtp_auth%&               "ACL for AUTH"
13978 .row &%acl_smtp_connect%&            "ACL for connection"
13979 .row &%acl_smtp_data%&               "ACL for DATA"
13980 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13981 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13982 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13983 .row &%acl_smtp_expn%&               "ACL for EXPN"
13984 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13985 .row &%acl_smtp_mail%&               "ACL for MAIL"
13986 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13987 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13988 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13989 .row &%acl_smtp_predata%&            "ACL for start of data"
13990 .row &%acl_smtp_quit%&               "ACL for QUIT"
13991 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13992 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13993 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13994 .row &%av_scanner%&                  "specify virus scanner"
13995 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13996                                       words""&"
13997 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
13998 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13999 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14000 .row &%header_maxsize%&              "total size of message header"
14001 .row &%header_line_maxsize%&         "individual header line limit"
14002 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14003 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14004 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14005 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14006 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14007 .row &%host_lookup%&                 "host name looked up for these hosts"
14008 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14009 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14010 .row &%host_reject_connection%&      "reject connection from these hosts"
14011 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14012 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14013 .row &%message_size_limit%&          "for all messages"
14014 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14015 .row &%spamd_address%&               "set interface to SpamAssassin"
14016 .row &%strict_acl_vars%&             "object to unset ACL variables"
14017 .endtable
14018
14019
14020
14021 .section "Callout cache" "SECID107"
14022 .table2
14023 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14024                                          item"
14025 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14026                                          item"
14027 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14028 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14029 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14030 .endtable
14031
14032
14033
14034 .section "TLS" "SECID108"
14035 .table2
14036 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14037 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14038 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14039 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14040 .row &%tls_certificate%&             "location of server certificate"
14041 .row &%tls_crl%&                     "certificate revocation list"
14042 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14043 .row &%tls_dhparam%&                 "DH parameters for server"
14044 .row &%tls_eccurve%&                 "EC curve selection for server"
14045 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14046 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14047 .row &%tls_privatekey%&              "location of server private key"
14048 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14049 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14050 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14051 .row &%tls_verify_certificates%&     "expected client certificates"
14052 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14053 .endtable
14054
14055
14056
14057 .section "Local user handling" "SECID109"
14058 .table2
14059 .row &%finduser_retries%&            "useful in NIS environments"
14060 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14061 .row &%gecos_pattern%&               "ditto"
14062 .row &%max_username_length%&         "for systems that truncate"
14063 .row &%unknown_login%&               "used when no login name found"
14064 .row &%unknown_username%&            "ditto"
14065 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14066 .row &%uucp_from_sender%&            "ditto"
14067 .endtable
14068
14069
14070
14071 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14072 .table2
14073 .row &%header_maxsize%&              "total size of message header"
14074 .row &%header_line_maxsize%&         "individual header line limit"
14075 .row &%message_size_limit%&          "applies to all messages"
14076 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14077 .row &%received_header_text%&        "expanded to make &'Received:'&"
14078 .row &%received_headers_max%&        "for mail loop detection"
14079 .row &%recipients_max%&              "limit per message"
14080 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14081 .endtable
14082
14083
14084
14085
14086 .section "Non-SMTP incoming messages" "SECID111"
14087 .table2
14088 .row &%receive_timeout%&             "for non-SMTP messages"
14089 .endtable
14090
14091
14092
14093
14094
14095 .section "Incoming SMTP messages" "SECID112"
14096 See also the &'Policy controls'& section above.
14097
14098 .table2
14099 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
14100 .row &%host_lookup%&                 "host name looked up for these hosts"
14101 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14102 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14103 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14104 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14105 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14106 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14107 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14108 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14109 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14110 .row &%smtp_accept_max_per_connection%& "messages per connection"
14111 .row &%smtp_accept_max_per_host%&    "connections from one host"
14112 .row &%smtp_accept_queue%&           "queue mail if more connections"
14113 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14114                                            connection"
14115 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14116 .row &%smtp_active_hostname%&        "host name to use in messages"
14117 .row &%smtp_banner%&                 "text for welcome banner"
14118 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14119 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14120 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14121 .row &%smtp_etrn_command%&           "what to run for ETRN"
14122 .row &%smtp_etrn_serialize%&         "only one at once"
14123 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14124 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14125 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14126 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14127 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14128 .row &%smtp_receive_timeout%&        "per command or data line"
14129 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14130 .row &%smtp_return_error_details%&   "give detail on rejections"
14131 .endtable
14132
14133
14134
14135 .section "SMTP extensions" "SECID113"
14136 .table2
14137 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14138 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14139 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14140 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14141 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14142 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14143 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14144 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14145 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14146 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14147 .endtable
14148
14149
14150
14151 .section "Processing messages" "SECID114"
14152 .table2
14153 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14154 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14155 .row &%allow_utf8_domains%&          "in addresses"
14156 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14157                                       words""&"
14158 .row &%delivery_date_remove%&        "from incoming messages"
14159 .row &%envelope_to_remove%&          "from incoming messages"
14160 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14161 .row &%headers_charset%&             "default for translations"
14162 .row &%qualify_domain%&              "default for senders"
14163 .row &%qualify_recipient%&           "default for recipients"
14164 .row &%return_path_remove%&          "from incoming messages"
14165 .row &%strip_excess_angle_brackets%& "in addresses"
14166 .row &%strip_trailing_dot%&          "at end of addresses"
14167 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14168 .endtable
14169
14170
14171
14172 .section "System filter" "SECID115"
14173 .table2
14174 .row &%system_filter%&               "locate system filter"
14175 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14176                                             directory"
14177 .row &%system_filter_file_transport%& "transport for delivery to a file"
14178 .row &%system_filter_group%&         "group for filter running"
14179 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14180 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14181 .row &%system_filter_user%&          "user for filter running"
14182 .endtable
14183
14184
14185
14186 .section "Routing and delivery" "SECID116"
14187 .table2
14188 .row &%disable_ipv6%&                "do no IPv6 processing"
14189 .row &%dns_again_means_nonexist%&    "for broken domains"
14190 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14191 .row &%dns_dnssec_ok%&               "parameter for resolver"
14192 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14193 .row &%dns_retrans%&                 "parameter for resolver"
14194 .row &%dns_retry%&                   "parameter for resolver"
14195 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14196 .row &%dns_use_edns0%&               "parameter for resolver"
14197 .row &%hold_domains%&                "hold delivery for these domains"
14198 .row &%local_interfaces%&            "for routing checks"
14199 .row &%queue_domains%&               "no immediate delivery for these"
14200 .row &%queue_only%&                  "no immediate delivery at all"
14201 .row &%queue_only_file%&             "no immediate delivery if file exists"
14202 .row &%queue_only_load%&             "no immediate delivery if load is high"
14203 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14204 .row &%queue_only_override%&         "allow command line to override"
14205 .row &%queue_run_in_order%&          "order of arrival"
14206 .row &%queue_run_max%&               "of simultaneous queue runners"
14207 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14208 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14209 .row &%remote_sort_domains%&         "order of remote deliveries"
14210 .row &%retry_data_expire%&           "timeout for retry data"
14211 .row &%retry_interval_max%&          "safety net for retry rules"
14212 .endtable
14213
14214
14215
14216 .section "Bounce and warning messages" "SECID117"
14217 .table2
14218 .row &%bounce_message_file%&         "content of bounce"
14219 .row &%bounce_message_text%&         "content of bounce"
14220 .row &%bounce_return_body%&          "include body if returning message"
14221 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14222 .row &%bounce_return_message%&       "include original message in bounce"
14223 .row &%bounce_return_size_limit%&    "limit on returned message"
14224 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14225 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14226 .row &%errors_copy%&                 "copy bounce messages"
14227 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14228 .row &%delay_warning%&               "time schedule"
14229 .row &%delay_warning_condition%&     "condition for warning messages"
14230 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14231 .row &%smtp_return_error_details%&   "give detail on rejections"
14232 .row &%warn_message_file%&           "content of warning message"
14233 .endtable
14234
14235
14236
14237 .section "Alphabetical list of main options" "SECTalomo"
14238 Those options that undergo string expansion before use are marked with
14239 &dagger;.
14240
14241 .option accept_8bitmime main boolean true
14242 .cindex "8BITMIME"
14243 .cindex "8-bit characters"
14244 .cindex "log" "selectors"
14245 .cindex "log" "8BITMIME"
14246 This option causes Exim to send 8BITMIME in its response to an SMTP
14247 EHLO command, and to accept the BODY= parameter on MAIL commands.
14248 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14249 takes no steps to do anything special with messages received by this route.
14250
14251 Historically Exim kept this option off by default, but the maintainers
14252 feel that in today's Internet, this causes more problems than it solves.
14253 It now defaults to true.
14254 A more detailed analysis of the issues is provided by Dan Bernstein:
14255 .display
14256 &url(https://cr.yp.to/smtp/8bitmime.html)
14257 .endd
14258
14259 To log received 8BITMIME status use
14260 .code
14261 log_selector = +8bitmime
14262 .endd
14263
14264 .option acl_not_smtp main string&!! unset
14265 .cindex "&ACL;" "for non-SMTP messages"
14266 .cindex "non-SMTP messages" "ACLs for"
14267 This option defines the ACL that is run when a non-SMTP message has been
14268 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14269 further details.
14270
14271 .option acl_not_smtp_mime main string&!! unset
14272 This option defines the ACL that is run for individual MIME parts of non-SMTP
14273 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14274 SMTP messages.
14275
14276 .option acl_not_smtp_start main string&!! unset
14277 .cindex "&ACL;" "at start of non-SMTP message"
14278 .cindex "non-SMTP messages" "ACLs for"
14279 This option defines the ACL that is run before Exim starts reading a
14280 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14281
14282 .option acl_smtp_auth main string&!! unset
14283 .cindex "&ACL;" "setting up for SMTP commands"
14284 .cindex "AUTH" "ACL for"
14285 This option defines the ACL that is run when an SMTP AUTH command is
14286 received. See chapter &<<CHAPACL>>& for further details.
14287
14288 .option acl_smtp_connect main string&!! unset
14289 .cindex "&ACL;" "on SMTP connection"
14290 This option defines the ACL that is run when an SMTP connection is received.
14291 See chapter &<<CHAPACL>>& for further details.
14292
14293 .option acl_smtp_data main string&!! unset
14294 .cindex "DATA" "ACL for"
14295 This option defines the ACL that is run after an SMTP DATA command has been
14296 processed and the message itself has been received, but before the final
14297 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14298
14299 .option acl_smtp_data_prdr main string&!! accept
14300 .cindex "PRDR" "ACL for"
14301 .cindex "DATA" "PRDR ACL for"
14302 .cindex "&ACL;" "PRDR-related"
14303 .cindex "&ACL;" "per-user data processing"
14304 This option defines the ACL that,
14305 if the PRDR feature has been negotiated,
14306 is run for each recipient after an SMTP DATA command has been
14307 processed and the message itself has been received, but before the
14308 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14309
14310 .option acl_smtp_dkim main string&!! unset
14311 .cindex DKIM "ACL for"
14312 This option defines the ACL that is run for each DKIM signature
14313 (by default, or as specified in the dkim_verify_signers option)
14314 of a received message.
14315 See section &<<SECDKIMVFY>>& for further details.
14316
14317 .option acl_smtp_etrn main string&!! unset
14318 .cindex "ETRN" "ACL for"
14319 This option defines the ACL that is run when an SMTP ETRN command is
14320 received. See chapter &<<CHAPACL>>& for further details.
14321
14322 .option acl_smtp_expn main string&!! unset
14323 .cindex "EXPN" "ACL for"
14324 This option defines the ACL that is run when an SMTP EXPN command is
14325 received. See chapter &<<CHAPACL>>& for further details.
14326
14327 .option acl_smtp_helo main string&!! unset
14328 .cindex "EHLO" "ACL for"
14329 .cindex "HELO" "ACL for"
14330 This option defines the ACL that is run when an SMTP EHLO or HELO
14331 command is received. See chapter &<<CHAPACL>>& for further details.
14332
14333
14334 .option acl_smtp_mail main string&!! unset
14335 .cindex "MAIL" "ACL for"
14336 This option defines the ACL that is run when an SMTP MAIL command is
14337 received. See chapter &<<CHAPACL>>& for further details.
14338
14339 .option acl_smtp_mailauth main string&!! unset
14340 .cindex "AUTH" "on MAIL command"
14341 This option defines the ACL that is run when there is an AUTH parameter on
14342 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14343 &<<CHAPSMTPAUTH>>& for details of authentication.
14344
14345 .option acl_smtp_mime main string&!! unset
14346 .cindex "MIME content scanning" "ACL for"
14347 This option is available when Exim is built with the content-scanning
14348 extension. It defines the ACL that is run for each MIME part in a message. See
14349 section &<<SECTscanmimepart>>& for details.
14350
14351 .option acl_smtp_notquit main string&!! unset
14352 .cindex "not-QUIT, ACL for"
14353 This option defines the ACL that is run when an SMTP session
14354 ends without a QUIT command being received.
14355 See chapter &<<CHAPACL>>& for further details.
14356
14357 .option acl_smtp_predata main string&!! unset
14358 This option defines the ACL that is run when an SMTP DATA command is
14359 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14360 further details.
14361
14362 .option acl_smtp_quit main string&!! unset
14363 .cindex "QUIT, ACL for"
14364 This option defines the ACL that is run when an SMTP QUIT command is
14365 received. See chapter &<<CHAPACL>>& for further details.
14366
14367 .option acl_smtp_rcpt main string&!! unset
14368 .cindex "RCPT" "ACL for"
14369 This option defines the ACL that is run when an SMTP RCPT command is
14370 received. See chapter &<<CHAPACL>>& for further details.
14371
14372 .option acl_smtp_starttls main string&!! unset
14373 .cindex "STARTTLS, ACL for"
14374 This option defines the ACL that is run when an SMTP STARTTLS command is
14375 received. See chapter &<<CHAPACL>>& for further details.
14376
14377 .option acl_smtp_vrfy main string&!! unset
14378 .cindex "VRFY" "ACL for"
14379 This option defines the ACL that is run when an SMTP VRFY command is
14380 received. See chapter &<<CHAPACL>>& for further details.
14381
14382 .option add_environment main "string list" empty
14383 .cindex "environment" "set values"
14384 This option allows to set individual environment variables that the
14385 currently linked libraries and programs in child processes use.
14386 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14387
14388 .option admin_groups main "string list&!!" unset
14389 .cindex "admin user"
14390 This option is expanded just once, at the start of Exim's processing. If the
14391 current group or any of the supplementary groups of an Exim caller is in this
14392 colon-separated list, the caller has admin privileges. If all your system
14393 programmers are in a specific group, for example, you can give them all Exim
14394 admin privileges by putting that group in &%admin_groups%&. However, this does
14395 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14396 To permit this, you have to add individuals to the Exim group.
14397
14398 .option allow_domain_literals main boolean false
14399 .cindex "domain literal"
14400 If this option is set, the RFC 2822 domain literal format is permitted in
14401 email addresses. The option is not set by default, because the domain literal
14402 format is not normally required these days, and few people know about it. It
14403 has, however, been exploited by mail abusers.
14404
14405 Unfortunately, it seems that some DNS black list maintainers are using this
14406 format to report black listing to postmasters. If you want to accept messages
14407 addressed to your hosts by IP address, you need to set
14408 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14409 domains (defined in the named domain list &%local_domains%& in the default
14410 configuration). This &"magic string"& matches the domain literal form of all
14411 the local host's IP addresses.
14412
14413
14414 .option allow_mx_to_ip main boolean false
14415 .cindex "MX record" "pointing to IP address"
14416 It appears that more and more DNS zone administrators are breaking the rules
14417 and putting domain names that look like IP addresses on the right hand side of
14418 MX records. Exim follows the rules and rejects this, giving an error message
14419 that explains the misconfiguration. However, some other MTAs support this
14420 practice, so to avoid &"Why can't Exim do this?"& complaints,
14421 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14422 recommended, except when you have no other choice.
14423
14424 .option allow_utf8_domains main boolean false
14425 .cindex "domain" "UTF-8 characters in"
14426 .cindex "UTF-8" "in domain name"
14427 Lots of discussion is going on about internationalized domain names. One
14428 camp is strongly in favour of just using UTF-8 characters, and it seems
14429 that at least two other MTAs permit this. This option allows Exim users to
14430 experiment if they wish.
14431
14432 If it is set true, Exim's domain parsing function allows valid
14433 UTF-8 multicharacters to appear in domain name components, in addition to
14434 letters, digits, and hyphens. However, just setting this option is not
14435 enough; if you want to look up these domain names in the DNS, you must also
14436 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14437 suitable setting is:
14438 .code
14439 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14440   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14441 .endd
14442 Alternatively, you can just disable this feature by setting
14443 .code
14444 dns_check_names_pattern =
14445 .endd
14446 That is, set the option to an empty string so that no check is done.
14447
14448
14449 .option auth_advertise_hosts main "host list&!!" *
14450 .cindex "authentication" "advertising"
14451 .cindex "AUTH" "advertising"
14452 If any server authentication mechanisms are configured, Exim advertises them in
14453 response to an EHLO command only if the calling host matches this list.
14454 Otherwise, Exim does not advertise AUTH.
14455 Exim does not accept AUTH commands from clients to which it has not
14456 advertised the availability of AUTH. The advertising of individual
14457 authentication mechanisms can be controlled by the use of the
14458 &%server_advertise_condition%& generic authenticator option on the individual
14459 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14460
14461 Certain mail clients (for example, Netscape) require the user to provide a name
14462 and password for authentication if AUTH is advertised, even though it may
14463 not be needed (the host may accept messages from hosts on its local LAN without
14464 authentication, for example). The &%auth_advertise_hosts%& option can be used
14465 to make these clients more friendly by excluding them from the set of hosts to
14466 which Exim advertises AUTH.
14467
14468 .cindex "AUTH" "advertising when encrypted"
14469 If you want to advertise the availability of AUTH only when the connection
14470 is encrypted using TLS, you can make use of the fact that the value of this
14471 option is expanded, with a setting like this:
14472 .code
14473 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14474 .endd
14475 .vindex "&$tls_in_cipher$&"
14476 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14477 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14478 expansion is *, which matches all hosts.
14479
14480
14481 .option auto_thaw main time 0s
14482 .cindex "thawing messages"
14483 .cindex "unfreezing messages"
14484 If this option is set to a time greater than zero, a queue runner will try a
14485 new delivery attempt on any frozen message, other than a bounce message, if
14486 this much time has passed since it was frozen. This may result in the message
14487 being re-frozen if nothing has changed since the last attempt. It is a way of
14488 saying &"keep on trying, even though there are big problems"&.
14489
14490 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14491 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14492 thought to be very useful any more, and its use should probably be avoided.
14493
14494
14495 .option av_scanner main string "see below"
14496 This option is available if Exim is built with the content-scanning extension.
14497 It specifies which anti-virus scanner to use. The default value is:
14498 .code
14499 sophie:/var/run/sophie
14500 .endd
14501 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14502 before use. See section &<<SECTscanvirus>>& for further details.
14503
14504
14505 .option bi_command main string unset
14506 .oindex "&%-bi%&"
14507 This option supplies the name of a command that is run when Exim is called with
14508 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14509 just the command name, it is not a complete command line. If an argument is
14510 required, it must come from the &%-oA%& command line option.
14511
14512
14513 .option bounce_message_file main string unset
14514 .cindex "bounce message" "customizing"
14515 .cindex "customizing" "bounce message"
14516 This option defines a template file containing paragraphs of text to be used
14517 for constructing bounce messages.  Details of the file's contents are given in
14518 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14519
14520
14521 .option bounce_message_text main string unset
14522 When this option is set, its contents are included in the default bounce
14523 message immediately after &"This message was created automatically by mail
14524 delivery software."& It is not used if &%bounce_message_file%& is set.
14525
14526 .option bounce_return_body main boolean true
14527 .cindex "bounce message" "including body"
14528 This option controls whether the body of an incoming message is included in a
14529 bounce message when &%bounce_return_message%& is true. The default setting
14530 causes the entire message, both header and body, to be returned (subject to the
14531 value of &%bounce_return_size_limit%&). If this option is false, only the
14532 message header is included. In the case of a non-SMTP message containing an
14533 error that is detected during reception, only those header lines preceding the
14534 point at which the error was detected are returned.
14535 .cindex "bounce message" "including original"
14536
14537 .option bounce_return_linesize_limit main integer 998
14538 .cindex "size" "of bounce lines, limit"
14539 .cindex "bounce message" "line length limit"
14540 .cindex "limit" "bounce message line length"
14541 This option sets a limit in bytes on the line length of messages
14542 that are returned to senders due to delivery problems,
14543 when &%bounce_return_message%& is true.
14544 The default value corresponds to RFC limits.
14545 If the message being returned has lines longer than this value it is
14546 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14547
14548 The option also applies to bounces returned when an error is detected
14549 during reception of a message.
14550 In this case lines from the original are truncated.
14551
14552 The option does not apply to messages generated by an &(autoreply)& transport.
14553
14554
14555 .option bounce_return_message main boolean true
14556 If this option is set false, none of the original message is included in
14557 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14558 &%bounce_return_body%&.
14559
14560
14561 .option bounce_return_size_limit main integer 100K
14562 .cindex "size" "of bounce, limit"
14563 .cindex "bounce message" "size limit"
14564 .cindex "limit" "bounce message size"
14565 This option sets a limit in bytes on the size of messages that are returned to
14566 senders as part of bounce messages when &%bounce_return_message%& is true. The
14567 limit should be less than the value of the global &%message_size_limit%& and of
14568 any &%message_size_limit%& settings on transports, to allow for the bounce text
14569 that Exim generates. If this option is set to zero there is no limit.
14570
14571 When the body of any message that is to be included in a bounce message is
14572 greater than the limit, it is truncated, and a comment pointing this out is
14573 added at the top. The actual cutoff may be greater than the value given, owing
14574 to the use of buffering for transferring the message in chunks (typically 8K in
14575 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14576 messages.
14577
14578 .option bounce_sender_authentication main string unset
14579 .cindex "bounce message" "sender authentication"
14580 .cindex "authentication" "bounce message"
14581 .cindex "AUTH" "on bounce message"
14582 This option provides an authenticated sender address that is sent with any
14583 bounce messages generated by Exim that are sent over an authenticated SMTP
14584 connection. A typical setting might be:
14585 .code
14586 bounce_sender_authentication = mailer-daemon@my.domain.example
14587 .endd
14588 which would cause bounce messages to be sent using the SMTP command:
14589 .code
14590 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14591 .endd
14592 The value of &%bounce_sender_authentication%& must always be a complete email
14593 address.
14594
14595 .option callout_domain_negative_expire main time 3h
14596 .cindex "caching" "callout timeouts"
14597 .cindex "callout" "caching timeouts"
14598 This option specifies the expiry time for negative callout cache data for a
14599 domain. See section &<<SECTcallver>>& for details of callout verification, and
14600 section &<<SECTcallvercache>>& for details of the caching.
14601
14602
14603 .option callout_domain_positive_expire main time 7d
14604 This option specifies the expiry time for positive callout cache data for a
14605 domain. See section &<<SECTcallver>>& for details of callout verification, and
14606 section &<<SECTcallvercache>>& for details of the caching.
14607
14608
14609 .option callout_negative_expire main time 2h
14610 This option specifies the expiry time for negative callout cache data for an
14611 address. See section &<<SECTcallver>>& for details of callout verification, and
14612 section &<<SECTcallvercache>>& for details of the caching.
14613
14614
14615 .option callout_positive_expire main time 24h
14616 This option specifies the expiry time for positive callout cache data for an
14617 address. See section &<<SECTcallver>>& for details of callout verification, and
14618 section &<<SECTcallvercache>>& for details of the caching.
14619
14620
14621 .option callout_random_local_part main string&!! "see below"
14622 This option defines the &"random"& local part that can be used as part of
14623 callout verification. The default value is
14624 .code
14625 $primary_hostname-$tod_epoch-testing
14626 .endd
14627 See section &<<CALLaddparcall>>& for details of how this value is used.
14628
14629
14630 .option check_log_inodes main integer 100
14631 See &%check_spool_space%& below.
14632
14633
14634 .option check_log_space main integer 10M
14635 See &%check_spool_space%& below.
14636
14637 .oindex "&%check_rfc2047_length%&"
14638 .cindex "RFC 2047" "disabling length check"
14639 .option check_rfc2047_length main boolean true
14640 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14641 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14642 word; strings to be encoded that exceed this length are supposed to use
14643 multiple encoded words. By default, Exim does not recognize encoded words that
14644 exceed the maximum length. However, it seems that some software, in violation
14645 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14646 set false, Exim recognizes encoded words of any length.
14647
14648
14649 .option check_spool_inodes main integer 100
14650 See &%check_spool_space%& below.
14651
14652
14653 .option check_spool_space main integer 10M
14654 .cindex "checking disk space"
14655 .cindex "disk space, checking"
14656 .cindex "spool directory" "checking space"
14657 The four &%check_...%& options allow for checking of disk resources before a
14658 message is accepted.
14659
14660 .vindex "&$log_inodes$&"
14661 .vindex "&$log_space$&"
14662 .vindex "&$spool_inodes$&"
14663 .vindex "&$spool_space$&"
14664 When any of these options are nonzero, they apply to all incoming messages. If you
14665 want to apply different checks to different kinds of message, you can do so by
14666 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14667 &$spool_space$& in an ACL with appropriate additional conditions.
14668
14669
14670 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14671 either value is greater than zero, for example:
14672 .code
14673 check_spool_space = 100M
14674 check_spool_inodes = 100
14675 .endd
14676 The spool partition is the one that contains the directory defined by
14677 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14678 transit.
14679
14680 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14681 files are written if either is greater than zero. These should be set only if
14682 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14683
14684 If there is less space or fewer inodes than requested, Exim refuses to accept
14685 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14686 error response to the MAIL command. If ESMTP is in use and there was a
14687 SIZE parameter on the MAIL command, its value is added to the
14688 &%check_spool_space%& value, and the check is performed even if
14689 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14690
14691 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14692 number of kilobytes (though specified in bytes).
14693 If a non-multiple of 1024 is specified, it is rounded up.
14694
14695 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14696 failure a message is written to stderr and Exim exits with a non-zero code, as
14697 it obviously cannot send an error message of any kind.
14698
14699 There is a slight performance penalty for these checks.
14700 Versions of Exim preceding 4.88 had these disabled by default;
14701 high-rate installations confident they will never run out of resources
14702 may wish to deliberately disable them.
14703
14704 .option chunking_advertise_hosts main "host list&!!" *
14705 .cindex CHUNKING advertisement
14706 .cindex "RFC 3030" "CHUNKING"
14707 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
14708 these hosts.
14709 Hosts may use the BDAT command as an alternate to DATA.
14710
14711 .option commandline_checks_require_admin main boolean &`false`&
14712 .cindex "restricting access to features"
14713 This option restricts various basic checking features to require an
14714 administrative user.
14715 This affects most of the &%-b*%& options, such as &%-be%&.
14716
14717 .option debug_store main boolean &`false`&
14718 .cindex debugging "memory corruption"
14719 .cindex memory debugging
14720 This option, when true, enables extra checking in Exim's internal memory
14721 management.  For use when a memory corruption issue is being investigated,
14722 it should normally be left as default.
14723
14724 .option daemon_smtp_ports main string &`smtp`&
14725 .cindex "port" "for daemon"
14726 .cindex "TCP/IP" "setting listening ports"
14727 This option specifies one or more default SMTP ports on which the Exim daemon
14728 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14729 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14730
14731 .option daemon_startup_retries main integer 9
14732 .cindex "daemon startup, retrying"
14733 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14734 the daemon at startup when it cannot immediately bind a listening socket
14735 (typically because the socket is already in use): &%daemon_startup_retries%&
14736 defines the number of retries after the first failure, and
14737 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14738
14739 .option daemon_startup_sleep main time 30s
14740 See &%daemon_startup_retries%&.
14741
14742 .option delay_warning main "time list" 24h
14743 .cindex "warning of delay"
14744 .cindex "delay warning, specifying"
14745 .cindex "queue" "delay warning"
14746 When a message is delayed, Exim sends a warning message to the sender at
14747 intervals specified by this option. The data is a colon-separated list of times
14748 after which to send warning messages. If the value of the option is an empty
14749 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14750 message has been on the queue for longer than the last time, the last interval
14751 between the times is used to compute subsequent warning times. For example,
14752 with
14753 .code
14754 delay_warning = 4h:8h:24h
14755 .endd
14756 the first message is sent after 4 hours, the second after 8 hours, and
14757 the third one after 24 hours. After that, messages are sent every 16 hours,
14758 because that is the interval between the last two times on the list. If you set
14759 just one time, it specifies the repeat interval. For example, with:
14760 .code
14761 delay_warning = 6h
14762 .endd
14763 messages are repeated every six hours. To stop warnings after a given time, set
14764 a very large time at the end of the list. For example:
14765 .code
14766 delay_warning = 2h:12h:99d
14767 .endd
14768 Note that the option is only evaluated at the time a delivery attempt fails,
14769 which depends on retry and queue-runner configuration.
14770 Typically retries will be configured more frequently than warning messages.
14771
14772 .option delay_warning_condition main string&!! "see below"
14773 .vindex "&$domain$&"
14774 The string is expanded at the time a warning message might be sent. If all the
14775 deferred addresses have the same domain, it is set in &$domain$& during the
14776 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14777 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14778 &"false"& (the comparison being done caselessly) then the warning message is
14779 not sent. The default is:
14780 .code
14781 delay_warning_condition = ${if or {\
14782   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14783   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14784   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14785   } {no}{yes}}
14786 .endd
14787 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14788 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14789 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14790 &"auto-replied"& in an &'Auto-Submitted:'& header.
14791
14792 .option deliver_drop_privilege main boolean false
14793 .cindex "unprivileged delivery"
14794 .cindex "delivery" "unprivileged"
14795 If this option is set true, Exim drops its root privilege at the start of a
14796 delivery process, and runs as the Exim user throughout. This severely restricts
14797 the kinds of local delivery that are possible, but is viable in certain types
14798 of configuration. There is a discussion about the use of root privilege in
14799 chapter &<<CHAPsecurity>>&.
14800
14801 .option deliver_queue_load_max main fixed-point unset
14802 .cindex "load average"
14803 .cindex "queue runner" "abandoning"
14804 When this option is set, a queue run is abandoned if the system load average
14805 becomes greater than the value of the option. The option has no effect on
14806 ancient operating systems on which Exim cannot determine the load average.
14807 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14808
14809
14810 .option delivery_date_remove main boolean true
14811 .cindex "&'Delivery-date:'& header line"
14812 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14813 message when it is delivered, in exactly the same way as &'Return-path:'& is
14814 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14815 should not be present in incoming messages, and this option causes them to be
14816 removed at the time the message is received, to avoid any problems that might
14817 occur when a delivered message is subsequently sent on to some other recipient.
14818
14819 .option disable_fsync main boolean false
14820 .cindex "&[fsync()]&, disabling"
14821 This option is available only if Exim was built with the compile-time option
14822 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14823 a runtime configuration generates an &"unknown option"& error. You should not
14824 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14825 really, really, really understand what you are doing. &'No pre-compiled
14826 distributions of Exim should ever make this option available.'&
14827
14828 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14829 updated files' data to be written to disc before continuing. Unexpected events
14830 such as crashes and power outages may cause data to be lost or scrambled.
14831 Here be Dragons. &*Beware.*&
14832
14833
14834 .option disable_ipv6 main boolean false
14835 .cindex "IPv6" "disabling"
14836 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14837 activities take place. AAAA records are never looked up, and any IPv6 addresses
14838 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14839 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14840 to handle IPv6 literal addresses.
14841
14842
14843 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14844 .cindex DKIM "controlling calls to the ACL"
14845 This option gives a list of DKIM domains for which the DKIM ACL is run.
14846 It is expanded after the message is received; by default it runs
14847 the ACL once for each signature in the message.
14848 See section &<<SECDKIMVFY>>&.
14849
14850
14851 .option dns_again_means_nonexist main "domain list&!!" unset
14852 .cindex "DNS" "&""try again""& response; overriding"
14853 DNS lookups give a &"try again"& response for the DNS errors
14854 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14855 keep trying to deliver a message, or to give repeated temporary errors to
14856 incoming mail. Sometimes the effect is caused by a badly set up name server and
14857 may persist for a long time. If a domain which exhibits this problem matches
14858 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14859 This option should be used with care. You can make it apply to reverse lookups
14860 by a setting such as this:
14861 .code
14862 dns_again_means_nonexist = *.in-addr.arpa
14863 .endd
14864 This option applies to all DNS lookups that Exim does. It also applies when the
14865 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14866 since these are most likely to be caused by DNS lookup problems. The
14867 &(dnslookup)& router has some options of its own for controlling what happens
14868 when lookups for MX or SRV records give temporary errors. These more specific
14869 options are applied after this global option.
14870
14871 .option dns_check_names_pattern main string "see below"
14872 .cindex "DNS" "pre-check of name syntax"
14873 When this option is set to a non-empty string, it causes Exim to check domain
14874 names for characters that are not allowed in host names before handing them to
14875 the DNS resolver, because some resolvers give temporary errors for names that
14876 contain unusual characters. If a domain name contains any unwanted characters,
14877 a &"not found"& result is forced, and the resolver is not called. The check is
14878 done by matching the domain name against a regular expression, which is the
14879 value of this option. The default pattern is
14880 .code
14881 dns_check_names_pattern = \
14882   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14883 .endd
14884 which permits only letters, digits, slashes, and hyphens in components, but
14885 they must start and end with a letter or digit. Slashes are not, in fact,
14886 permitted in host names, but they are found in certain NS records (which can be
14887 accessed in Exim by using a &%dnsdb%& lookup). If you set
14888 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14889 empty string.
14890
14891 .option dns_csa_search_limit main integer 5
14892 This option controls the depth of parental searching for CSA SRV records in the
14893 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14894
14895 .option dns_csa_use_reverse main boolean true
14896 This option controls whether or not an IP address, given as a CSA domain, is
14897 reversed and looked up in the reverse DNS, as described in more detail in
14898 section &<<SECTverifyCSA>>&.
14899
14900 .new
14901 .option dns_cname_loops main integer 1
14902 .cindex DNS "CNAME following"
14903 This option controls the following of CNAME chains, needed if the resolver does
14904 not do it internally.
14905 As of 2018 most should, and the default can be left.
14906 If you have an ancient one, a value of 10 is likely needed.
14907
14908 The default value of one CNAME-follow is needed
14909 thanks to the observed return for an MX request,
14910 given no MX presence but a CNAME to an A, of the CNAME.
14911 .wen
14912
14913
14914 .option dns_dnssec_ok main integer -1
14915 .cindex "DNS" "resolver options"
14916 .cindex "DNS" "DNSSEC"
14917 If this option is set to a non-negative number then Exim will initialise the
14918 DNS resolver library to either use or not use DNSSEC, overriding the system
14919 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14920
14921 If the resolver library does not support DNSSEC then this option has no effect.
14922
14923
14924 .option dns_ipv4_lookup main "domain list&!!" unset
14925 .cindex "IPv6" "DNS lookup for AAAA records"
14926 .cindex "DNS" "IPv6 lookup for AAAA records"
14927 .cindex DNS "IPv6 disabling"
14928 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14929 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14930 (A records) when trying to find IP addresses for hosts, unless the host's
14931 domain matches this list.
14932
14933 This is a fudge to help with name servers that give big delays or otherwise do
14934 not work for the AAAA record type. In due course, when the world's name
14935 servers have all been upgraded, there should be no need for this option.
14936
14937
14938 .option dns_retrans main time 0s
14939 .cindex "DNS" "resolver options"
14940 .cindex timeout "dns lookup"
14941 .cindex "DNS" timeout
14942 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14943 retransmission and retry parameters for DNS lookups. Values of zero (the
14944 defaults) leave the system default settings unchanged. The first value is the
14945 time between retries, and the second is the number of retries. It isn't
14946 totally clear exactly how these settings affect the total time a DNS lookup may
14947 take. I haven't found any documentation about timeouts on DNS lookups; these
14948 parameter values are available in the external resolver interface structure,
14949 but nowhere does it seem to describe how they are used or what you might want
14950 to set in them.
14951 See also the &%slow_lookup_log%& option.
14952
14953
14954 .option dns_retry main integer 0
14955 See &%dns_retrans%& above.
14956
14957
14958 .option dns_trust_aa main "domain list&!!" unset
14959 .cindex "DNS" "resolver options"
14960 .cindex "DNS" "DNSSEC"
14961 If this option is set then lookup results marked with the AA bit
14962 (Authoritative Answer) are trusted the same way as if they were
14963 DNSSEC-verified. The authority section's name of the answer must
14964 match with this expanded domain list.
14965
14966 Use this option only if you talk directly to a resolver that is
14967 authoritative for some zones and does not set the AD (Authentic Data)
14968 bit in the answer. Some DNS servers may have an configuration option to
14969 mark the answers from their own zones as verified (they set the AD bit).
14970 Others do not have this option. It is considered as poor practice using
14971 a resolver that is an authoritative server for some zones.
14972
14973 Use this option only if you really have to (e.g. if you want
14974 to use DANE for remote delivery to a server that is listed in the DNS
14975 zones that your resolver is authoritative for).
14976
14977 If the DNS answer packet has the AA bit set and contains resource record
14978 in the answer section, the name of the first NS record appearing in the
14979 authority section is compared against the list. If the answer packet is
14980 authoritative but the answer section is empty, the name of the first SOA
14981 record in the authoritative section is used instead.
14982
14983 .cindex "DNS" "resolver options"
14984 .option dns_use_edns0 main integer -1
14985 .cindex "DNS" "resolver options"
14986 .cindex "DNS" "EDNS0"
14987 .cindex "DNS" "OpenBSD
14988 If this option is set to a non-negative number then Exim will initialise the
14989 DNS resolver library to either use or not use EDNS0 extensions, overriding
14990 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14991 on.
14992
14993 If the resolver library does not support EDNS0 then this option has no effect.
14994
14995 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
14996 means that DNSSEC will not work with Exim on that platform either, unless Exim
14997 is linked against an alternative DNS client library.
14998
14999
15000 .option drop_cr main boolean false
15001 This is an obsolete option that is now a no-op. It used to affect the way Exim
15002 handled CR and LF characters in incoming messages. What happens now is
15003 described in section &<<SECTlineendings>>&.
15004
15005 .option dsn_advertise_hosts main "host list&!!" unset
15006 .cindex "bounce messages" "success"
15007 .cindex "DSN" "success"
15008 .cindex "Delivery Status Notification" "success"
15009 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15010 and accepted from, these hosts.
15011 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15012 and RET and ORCPT options on MAIL FROM commands.
15013 A NOTIFY=SUCCESS option requests success-DSN messages.
15014 A NOTIFY= option with no argument requests that no delay or failure DSNs
15015 are sent.
15016
15017 .option dsn_from main "string&!!" "see below"
15018 .cindex "&'From:'& header line" "in bounces"
15019 .cindex "bounce messages" "&'From:'& line, specifying"
15020 This option can be used to vary the contents of &'From:'& header lines in
15021 bounces and other automatically generated messages (&"Delivery Status
15022 Notifications"& &-- hence the name of the option). The default setting is:
15023 .code
15024 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15025 .endd
15026 The value is expanded every time it is needed. If the expansion fails, a
15027 panic is logged, and the default value is used.
15028
15029 .option envelope_to_remove main boolean true
15030 .cindex "&'Envelope-to:'& header line"
15031 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15032 message when it is delivered, in exactly the same way as &'Return-path:'& is
15033 handled. &'Envelope-to:'& records the original recipient address from the
15034 message's envelope that caused the delivery to happen. Such headers should not
15035 be present in incoming messages, and this option causes them to be removed at
15036 the time the message is received, to avoid any problems that might occur when a
15037 delivered message is subsequently sent on to some other recipient.
15038
15039
15040 .option errors_copy main "string list&!!" unset
15041 .cindex "bounce message" "copy to other address"
15042 .cindex "copy of bounce message"
15043 Setting this option causes Exim to send bcc copies of bounce messages that it
15044 generates to other addresses. &*Note*&: This does not apply to bounce messages
15045 coming from elsewhere. The value of the option is a colon-separated list of
15046 items. Each item consists of a pattern, terminated by white space, followed by
15047 a comma-separated list of email addresses. If a pattern contains spaces, it
15048 must be enclosed in double quotes.
15049
15050 Each pattern is processed in the same way as a single item in an address list
15051 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15052 the bounce message, the message is copied to the addresses on the list. The
15053 items are scanned in order, and once a matching one is found, no further items
15054 are examined. For example:
15055 .code
15056 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15057               rqps@mydomain   hostmaster@mydomain.example,\
15058                               postmaster@mydomain.example
15059 .endd
15060 .vindex "&$domain$&"
15061 .vindex "&$local_part$&"
15062 The address list is expanded before use. The expansion variables &$local_part$&
15063 and &$domain$& are set from the original recipient of the error message, and if
15064 there was any wildcard matching in the pattern, the expansion
15065 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15066 variables &$0$&, &$1$&, etc. are set in the normal way.
15067
15068
15069 .option errors_reply_to main string unset
15070 .cindex "bounce message" "&'Reply-to:'& in"
15071 By default, Exim's bounce and delivery warning messages contain the header line
15072 .display
15073 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15074 .endd
15075 .oindex &%quota_warn_message%&
15076 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15077 A warning message that is generated by the &%quota_warn_message%& option in an
15078 &(appendfile)& transport may contain its own &'From:'& header line that
15079 overrides the default.
15080
15081 Experience shows that people reply to bounce messages. If the
15082 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15083 and warning messages. For example:
15084 .code
15085 errors_reply_to = postmaster@my.domain.example
15086 .endd
15087 The value of the option is not expanded. It must specify a valid RFC 2822
15088 address. However, if a warning message that is generated by the
15089 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15090 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15091 not used.
15092
15093
15094 .option event_action main string&!! unset
15095 .cindex events
15096 This option declares a string to be expanded for Exim's events mechanism.
15097 For details see chapter &<<CHAPevents>>&.
15098
15099
15100 .option exim_group main string "compile-time configured"
15101 .cindex "gid (group id)" "Exim's own"
15102 .cindex "Exim group"
15103 This option changes the gid under which Exim runs when it gives up root
15104 privilege. The default value is compiled into the binary. The value of this
15105 option is used only when &%exim_user%& is also set. Unless it consists entirely
15106 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15107 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15108 security issues.
15109
15110
15111 .option exim_path main string "see below"
15112 .cindex "Exim binary, path name"
15113 This option specifies the path name of the Exim binary, which is used when Exim
15114 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15115 the directory configured at compile time by the BIN_DIRECTORY setting. It
15116 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15117 other place.
15118 &*Warning*&: Do not use a macro to define the value of this option, because
15119 you will break those Exim utilities that scan the configuration file to find
15120 where the binary is. (They then use the &%-bP%& option to extract option
15121 settings such as the value of &%spool_directory%&.)
15122
15123
15124 .option exim_user main string "compile-time configured"
15125 .cindex "uid (user id)" "Exim's own"
15126 .cindex "Exim user"
15127 This option changes the uid under which Exim runs when it gives up root
15128 privilege. The default value is compiled into the binary. Ownership of the run
15129 time configuration file and the use of the &%-C%& and &%-D%& command line
15130 options is checked against the values in the binary, not what is set here.
15131
15132 Unless it consists entirely of digits, the string is looked up using
15133 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15134 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15135 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15136
15137
15138 .option extra_local_interfaces main "string list" unset
15139 This option defines network interfaces that are to be considered local when
15140 routing, but which are not used for listening by the daemon. See section
15141 &<<SECTreclocipadd>>& for details.
15142
15143
15144 . Allow this long option name to split; give it unsplit as a fifth argument
15145 . for the automatic .oindex that is generated by .option.
15146
15147 .option "extract_addresses_remove_arguments" main boolean true &&&
15148          extract_addresses_remove_arguments
15149 .oindex "&%-t%&"
15150 .cindex "command line" "addresses with &%-t%&"
15151 .cindex "Sendmail compatibility" "&%-t%& option"
15152 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15153 are present on the command line when the &%-t%& option is used to build an
15154 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15155 line addresses are removed from the recipients list. This is also how Smail
15156 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15157 command line addresses are added to those obtained from the header lines. When
15158 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15159 argument headers. If it is set false, Exim adds rather than removes argument
15160 addresses.
15161
15162
15163 .option finduser_retries main integer 0
15164 .cindex "NIS, retrying user lookups"
15165 On systems running NIS or other schemes in which user and group information is
15166 distributed from a remote system, there can be times when &[getpwnam()]& and
15167 related functions fail, even when given valid data, because things time out.
15168 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15169 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15170 many extra times to find a user or a group, waiting for one second between
15171 retries.
15172
15173 .cindex "&_/etc/passwd_&" "multiple reading of"
15174 You should not set this option greater than zero if your user information is in
15175 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15176 search the file multiple times for non-existent users, and also cause delay.
15177
15178
15179
15180 .option freeze_tell main "string list, comma separated" unset
15181 .cindex "freezing messages" "sending a message when freezing"
15182 On encountering certain errors, or when configured to do so in a system filter,
15183 ACL, or special router, Exim freezes a message. This means that no further
15184 delivery attempts take place until an administrator thaws the message, or the
15185 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15186 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15187 warning message whenever it freezes something, unless the message it is
15188 freezing is a locally-generated bounce message. (Without this exception there
15189 is the possibility of looping.) The warning message is sent to the addresses
15190 supplied as the comma-separated value of this option. If several of the
15191 message's addresses cause freezing, only a single message is sent. If the
15192 freezing was automatic, the reason(s) for freezing can be found in the message
15193 log. If you configure freezing in a filter or ACL, you must arrange for any
15194 logging that you require.
15195
15196
15197 .option gecos_name main string&!! unset
15198 .cindex "HP-UX"
15199 .cindex "&""gecos""& field, parsing"
15200 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15201 password file to hold other information in addition to users' real names. Exim
15202 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15203 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15204 of the field are used unchanged, except that, if an ampersand is encountered,
15205 it is replaced by the user's login name with the first character forced to
15206 upper case, since this is a convention that is observed on many systems.
15207
15208 When these options are set, &%gecos_pattern%& is treated as a regular
15209 expression that is to be applied to the field (again with && replaced by the
15210 login name), and if it matches, &%gecos_name%& is expanded and used as the
15211 user's name.
15212
15213 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15214 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15215 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15216 name terminates at the first comma, the following can be used:
15217 .code
15218 gecos_pattern = ([^,]*)
15219 gecos_name = $1
15220 .endd
15221
15222 .option gecos_pattern main string unset
15223 See &%gecos_name%& above.
15224
15225
15226 .option gnutls_compat_mode main boolean unset
15227 This option controls whether GnuTLS is used in compatibility mode in an Exim
15228 server. This reduces security slightly, but improves interworking with older
15229 implementations of TLS.
15230
15231
15232 .option gnutls_allow_auto_pkcs11 main boolean unset
15233 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15234 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15235
15236 See
15237 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15238 for documentation.
15239
15240
15241
15242 .option headers_charset main string "see below"
15243 This option sets a default character set for translating from encoded MIME
15244 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15245 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15246 ultimate default is ISO-8859-1. For more details see the description of header
15247 insertions in section &<<SECTexpansionitems>>&.
15248
15249
15250
15251 .option header_maxsize main integer "see below"
15252 .cindex "header section" "maximum size of"
15253 .cindex "limit" "size of message header section"
15254 This option controls the overall maximum size of a message's header
15255 section. The default is the value of HEADER_MAXSIZE in
15256 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15257 sections are rejected.
15258
15259
15260 .option header_line_maxsize main integer 0
15261 .cindex "header lines" "maximum size of"
15262 .cindex "limit" "size of one header line"
15263 This option limits the length of any individual header line in a message, after
15264 all the continuations have been joined together. Messages with individual
15265 header lines that are longer than the limit are rejected. The default value of
15266 zero means &"no limit"&.
15267
15268
15269
15270
15271 .option helo_accept_junk_hosts main "host list&!!" unset
15272 .cindex "HELO" "accepting junk data"
15273 .cindex "EHLO" "accepting junk data"
15274 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15275 mail, and gives an error response for invalid data. Unfortunately, there are
15276 some SMTP clients that send syntactic junk. They can be accommodated by setting
15277 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15278 if you want to do semantic checking.
15279 See also &%helo_allow_chars%& for a way of extending the permitted character
15280 set.
15281
15282
15283 .option helo_allow_chars main string unset
15284 .cindex "HELO" "underscores in"
15285 .cindex "EHLO" "underscores in"
15286 .cindex "underscore in EHLO/HELO"
15287 This option can be set to a string of rogue characters that are permitted in
15288 all EHLO and HELO names in addition to the standard letters, digits,
15289 hyphens, and dots. If you really must allow underscores, you can set
15290 .code
15291 helo_allow_chars = _
15292 .endd
15293 Note that the value is one string, not a list.
15294
15295
15296 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15297 .cindex "HELO" "forcing reverse lookup"
15298 .cindex "EHLO" "forcing reverse lookup"
15299 If the domain given by a client in a HELO or EHLO command matches this
15300 list, a reverse lookup is done in order to establish the host's true name. The
15301 default forces a lookup if the client host gives the server's name or any of
15302 its IP addresses (in brackets), something that broken clients have been seen to
15303 do.
15304
15305
15306 .option helo_try_verify_hosts main "host list&!!" unset
15307 .cindex "HELO verifying" "optional"
15308 .cindex "EHLO" "verifying, optional"
15309 By default, Exim just checks the syntax of HELO and EHLO commands (see
15310 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15311 to do more extensive checking of the data supplied by these commands. The ACL
15312 condition &`verify = helo`& is provided to make this possible.
15313 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15314 to force the check to occur. From release 4.53 onwards, this is no longer
15315 necessary. If the check has not been done before &`verify = helo`& is
15316 encountered, it is done at that time. Consequently, this option is obsolete.
15317 Its specification is retained here for backwards compatibility.
15318
15319 When an EHLO or HELO command is received, if the calling host matches
15320 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15321 EHLO command either:
15322
15323 .ilist
15324 is an IP literal matching the calling address of the host, or
15325 .next
15326 .cindex "DNS" "reverse lookup"
15327 .cindex "reverse DNS lookup"
15328 matches the host name that Exim obtains by doing a reverse lookup of the
15329 calling host address, or
15330 .next
15331 when looked up in DNS yields the calling host address.
15332 .endlist
15333
15334 However, the EHLO or HELO command is not rejected if any of the checks
15335 fail. Processing continues, but the result of the check is remembered, and can
15336 be detected later in an ACL by the &`verify = helo`& condition.
15337
15338 If DNS was used for successful verification, the variable
15339 .cindex "DNS" "DNSSEC"
15340 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15341
15342 .option helo_verify_hosts main "host list&!!" unset
15343 .cindex "HELO verifying" "mandatory"
15344 .cindex "EHLO" "verifying, mandatory"
15345 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15346 backwards compatibility. For hosts that match this option, Exim checks the host
15347 name given in the HELO or EHLO in the same way as for
15348 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15349 rejected with a 550 error, and entries are written to the main and reject logs.
15350 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15351 error.
15352
15353 .option hold_domains main "domain list&!!" unset
15354 .cindex "domain" "delaying delivery"
15355 .cindex "delivery" "delaying certain domains"
15356 This option allows mail for particular domains to be held on the queue
15357 manually. The option is overridden if a message delivery is forced with the
15358 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15359 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15360 item in &%hold_domains%&, no routing or delivery for that address is done, and
15361 it is deferred every time the message is looked at.
15362
15363 This option is intended as a temporary operational measure for delaying the
15364 delivery of mail while some problem is being sorted out, or some new
15365 configuration tested. If you just want to delay the processing of some
15366 domains until a queue run occurs, you should use &%queue_domains%& or
15367 &%queue_smtp_domains%&, not &%hold_domains%&.
15368
15369 A setting of &%hold_domains%& does not override Exim's code for removing
15370 messages from the queue if they have been there longer than the longest retry
15371 time in any retry rule. If you want to hold messages for longer than the normal
15372 retry times, insert a dummy retry rule with a long retry time.
15373
15374
15375 .option host_lookup main "host list&!!" unset
15376 .cindex "host name" "lookup, forcing"
15377 Exim does not look up the name of a calling host from its IP address unless it
15378 is required to compare against some host list, or the host matches
15379 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15380 option (which normally contains IP addresses rather than host names). The
15381 default configuration file contains
15382 .code
15383 host_lookup = *
15384 .endd
15385 which causes a lookup to happen for all hosts. If the expense of these lookups
15386 is felt to be too great, the setting can be changed or removed.
15387
15388 After a successful reverse lookup, Exim does a forward lookup on the name it
15389 has obtained, to verify that it yields the IP address that it started with. If
15390 this check fails, Exim behaves as if the name lookup failed.
15391
15392 .vindex "&$host_lookup_failed$&"
15393 .vindex "&$sender_host_name$&"
15394 After any kind of failure, the host name (in &$sender_host_name$&) remains
15395 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15396 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15397 &`verify = reverse_host_lookup`& in ACLs.
15398
15399
15400 .option host_lookup_order main "string list" &`bydns:byaddr`&
15401 This option specifies the order of different lookup methods when Exim is trying
15402 to find a host name from an IP address. The default is to do a DNS lookup
15403 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15404 if that fails. You can change the order of these lookups, or omit one entirely,
15405 if you want.
15406
15407 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15408 multiple PTR records in the DNS and the IP address is not listed in
15409 &_/etc/hosts_&. Different operating systems give different results in this
15410 case. That is why the default tries a DNS lookup first.
15411
15412
15413
15414 .option host_reject_connection main "host list&!!" unset
15415 .cindex "host" "rejecting connections from"
15416 If this option is set, incoming SMTP calls from the hosts listed are rejected
15417 as soon as the connection is made.
15418 This option is obsolete, and retained only for backward compatibility, because
15419 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15420 connections immediately.
15421
15422 The ability to give an immediate rejection (either by this option or using an
15423 ACL) is provided for use in unusual cases. Many hosts will just try again,
15424 sometimes without much delay. Normally, it is better to use an ACL to reject
15425 incoming messages at a later stage, such as after RCPT commands. See
15426 chapter &<<CHAPACL>>&.
15427
15428
15429 .option hosts_connection_nolog main "host list&!!" unset
15430 .cindex "host" "not logging connections from"
15431 This option defines a list of hosts for which connection logging does not
15432 happen, even though the &%smtp_connection%& log selector is set. For example,
15433 you might want not to log SMTP connections from local processes, or from
15434 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15435 the daemon; you should therefore strive to restrict its value to a short inline
15436 list of IP addresses and networks. To disable logging SMTP connections from
15437 local processes, you must create a host list with an empty item. For example:
15438 .code
15439 hosts_connection_nolog = :
15440 .endd
15441 If the &%smtp_connection%& log selector is not set, this option has no effect.
15442
15443
15444
15445 .option hosts_proxy main "host list&!!" unset
15446 .cindex proxy "proxy protocol"
15447 This option enables use of Proxy Protocol proxies for incoming
15448 connections.  For details see section &<<SECTproxyInbound>>&.
15449
15450
15451 .option hosts_treat_as_local main "domain list&!!" unset
15452 .cindex "local host" "domains treated as"
15453 .cindex "host" "treated as local"
15454 If this option is set, any host names that match the domain list are treated as
15455 if they were the local host when Exim is scanning host lists obtained from MX
15456 records
15457 or other sources. Note that the value of this option is a domain list, not a
15458 host list, because it is always used to check host names, not IP addresses.
15459
15460 This option also applies when Exim is matching the special items
15461 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15462 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15463 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15464 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15465 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15466 interfaces and recognizing the local host.
15467
15468
15469 .option ibase_servers main "string list" unset
15470 .cindex "InterBase" "server list"
15471 This option provides a list of InterBase servers and associated connection data,
15472 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15473 The option is available only if Exim has been built with InterBase support.
15474
15475
15476
15477 .option ignore_bounce_errors_after main time 10w
15478 .cindex "bounce message" "discarding"
15479 .cindex "discarding bounce message"
15480 This option affects the processing of bounce messages that cannot be delivered,
15481 that is, those that suffer a permanent delivery failure. (Bounce messages that
15482 suffer temporary delivery failures are of course retried in the usual way.)
15483
15484 After a permanent delivery failure, bounce messages are frozen,
15485 because there is no sender to whom they can be returned. When a frozen bounce
15486 message has been on the queue for more than the given time, it is unfrozen at
15487 the next queue run, and a further delivery is attempted. If delivery fails
15488 again, the bounce message is discarded. This makes it possible to keep failed
15489 bounce messages around for a shorter time than the normal maximum retry time
15490 for frozen messages. For example,
15491 .code
15492 ignore_bounce_errors_after = 12h
15493 .endd
15494 retries failed bounce message deliveries after 12 hours, discarding any further
15495 failures. If the value of this option is set to a zero time period, bounce
15496 failures are discarded immediately. Setting a very long time (as in the default
15497 value) has the effect of disabling this option. For ways of automatically
15498 dealing with other kinds of frozen message, see &%auto_thaw%& and
15499 &%timeout_frozen_after%&.
15500
15501
15502 .option ignore_fromline_hosts main "host list&!!" unset
15503 .cindex "&""From""& line"
15504 .cindex "UUCP" "&""From""& line"
15505 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15506 the headers of a message. By default this is treated as the start of the
15507 message's body, which means that any following headers are not recognized as
15508 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15509 match those hosts that insist on sending it. If the sender is actually a local
15510 process rather than a remote host, and is using &%-bs%& to inject the messages,
15511 &%ignore_fromline_local%& must be set to achieve this effect.
15512
15513
15514 .option ignore_fromline_local main boolean false
15515 See &%ignore_fromline_hosts%& above.
15516
15517 .option keep_environment main "string list" unset
15518 .cindex "environment" "values from"
15519 This option contains a string list of environment variables to keep.
15520 You have to trust these variables or you have to be sure that
15521 these variables do not impose any security risk. Keep in mind that
15522 during the startup phase Exim is running with an effective UID 0 in most
15523 installations. As the default value is an empty list, the default
15524 environment for using libraries, running embedded Perl code, or running
15525 external binaries is empty, and does not not even contain PATH or HOME.
15526
15527 Actually the list is interpreted as a list of patterns
15528 (&<<SECTlistexpand>>&), except that it is not expanded first.
15529
15530 WARNING: Macro substitution is still done first, so having a macro
15531 FOO and having FOO_HOME in your &%keep_environment%& option may have
15532 unexpected results. You may work around this using a regular expression
15533 that does not match the macro name: ^[F]OO_HOME$.
15534
15535 Current versions of Exim issue a warning during startup if you do not mention
15536 &%keep_environment%& in your runtime configuration file and if your
15537 current environment is not empty. Future versions may not issue that warning
15538 anymore.
15539
15540 See the &%add_environment%& main config option for a way to set
15541 environment variables to a fixed value.  The environment for &(pipe)&
15542 transports is handled separately, see section &<<SECTpipeenv>>& for
15543 details.
15544
15545
15546 .option keep_malformed main time 4d
15547 This option specifies the length of time to keep messages whose spool files
15548 have been corrupted in some way. This should, of course, never happen. At the
15549 next attempt to deliver such a message, it gets removed. The incident is
15550 logged.
15551
15552
15553 .option ldap_ca_cert_dir main string unset
15554 .cindex "LDAP", "TLS CA certificate directory"
15555 .cindex certificate "directory for LDAP"
15556 This option indicates which directory contains CA certificates for verifying
15557 a TLS certificate presented by an LDAP server.
15558 While Exim does not provide a default value, your SSL library may.
15559 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15560 and constrained to be a directory.
15561
15562
15563 .option ldap_ca_cert_file main string unset
15564 .cindex "LDAP", "TLS CA certificate file"
15565 .cindex certificate "file for LDAP"
15566 This option indicates which file contains CA certificates for verifying
15567 a TLS certificate presented by an LDAP server.
15568 While Exim does not provide a default value, your SSL library may.
15569 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15570 and constrained to be a file.
15571
15572
15573 .option ldap_cert_file main string unset
15574 .cindex "LDAP" "TLS client certificate file"
15575 .cindex certificate "file for LDAP"
15576 This option indicates which file contains an TLS client certificate which
15577 Exim should present to the LDAP server during TLS negotiation.
15578 Should be used together with &%ldap_cert_key%&.
15579
15580
15581 .option ldap_cert_key main string unset
15582 .cindex "LDAP" "TLS client key file"
15583 .cindex certificate "key for LDAP"
15584 This option indicates which file contains the secret/private key to use
15585 to prove identity to the LDAP server during TLS negotiation.
15586 Should be used together with &%ldap_cert_file%&, which contains the
15587 identity to be proven.
15588
15589
15590 .option ldap_cipher_suite main string unset
15591 .cindex "LDAP" "TLS cipher suite"
15592 This controls the TLS cipher-suite negotiation during TLS negotiation with
15593 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15594 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15595
15596
15597 .option ldap_default_servers main "string list" unset
15598 .cindex "LDAP" "default servers"
15599 This option provides a list of LDAP servers which are tried in turn when an
15600 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15601 details of LDAP queries. This option is available only when Exim has been built
15602 with LDAP support.
15603
15604
15605 .option ldap_require_cert main string unset.
15606 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15607 This should be one of the values "hard", "demand", "allow", "try" or "never".
15608 A value other than one of these is interpreted as "never".
15609 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15610 Although Exim does not set a default, the LDAP library probably defaults
15611 to hard/demand.
15612
15613
15614 .option ldap_start_tls main boolean false
15615 .cindex "LDAP" "whether or not to negotiate TLS"
15616 If set, Exim will attempt to negotiate TLS with the LDAP server when
15617 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15618 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15619 of SSL-on-connect.
15620 In the event of failure to negotiate TLS, the action taken is controlled
15621 by &%ldap_require_cert%&.
15622 This option is ignored for &`ldapi`& connections.
15623
15624
15625 .option ldap_version main integer unset
15626 .cindex "LDAP" "protocol version, forcing"
15627 This option can be used to force Exim to set a specific protocol version for
15628 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15629 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15630 the LDAP headers; otherwise it is 2. This option is available only when Exim
15631 has been built with LDAP support.
15632
15633
15634
15635 .option local_from_check main boolean true
15636 .cindex "&'Sender:'& header line" "disabling addition of"
15637 .cindex "&'From:'& header line" "disabling checking of"
15638 When a message is submitted locally (that is, not over a TCP/IP connection) by
15639 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15640 checks that the &'From:'& header line matches the login of the calling user and
15641 the domain specified by &%qualify_domain%&.
15642
15643 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15644 locally submitted message is automatically qualified by Exim, unless the
15645 &%-bnq%& command line option is used.
15646
15647 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15648 on the local part. If the &'From:'& header line does not match, Exim adds a
15649 &'Sender:'& header with an address constructed from the calling user's login
15650 and the default qualify domain.
15651
15652 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15653 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15654 &'Sender:'& header lines supplied by untrusted users, you must also set
15655 &%local_sender_retain%& to be true.
15656
15657 .cindex "envelope sender"
15658 These options affect only the header lines in the message. The envelope sender
15659 is still forced to be the login id at the qualify domain unless
15660 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15661
15662 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15663 request similar header line checking. See section &<<SECTthesenhea>>&, which
15664 has more details about &'Sender:'& processing.
15665
15666
15667
15668
15669 .option local_from_prefix main string unset
15670 When Exim checks the &'From:'& header line of locally submitted messages for
15671 matching the login id (see &%local_from_check%& above), it can be configured to
15672 ignore certain prefixes and suffixes in the local part of the address. This is
15673 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15674 appropriate lists, in the same form as the &%local_part_prefix%& and
15675 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15676 example, if
15677 .code
15678 local_from_prefix = *-
15679 .endd
15680 is set, a &'From:'& line containing
15681 .code
15682 From: anything-user@your.domain.example
15683 .endd
15684 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15685 matches the actual sender address that is constructed from the login name and
15686 qualify domain.
15687
15688
15689 .option local_from_suffix main string unset
15690 See &%local_from_prefix%& above.
15691
15692
15693 .option local_interfaces main "string list" "see below"
15694 This option controls which network interfaces are used by the daemon for
15695 listening; they are also used to identify the local host when routing. Chapter
15696 &<<CHAPinterfaces>>& contains a full description of this option and the related
15697 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15698 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15699 &%local_interfaces%& is
15700 .code
15701 local_interfaces = 0.0.0.0
15702 .endd
15703 when Exim is built without IPv6 support; otherwise it is
15704 .code
15705 local_interfaces = <; ::0 ; 0.0.0.0
15706 .endd
15707
15708 .option local_scan_timeout main time 5m
15709 .cindex "timeout" "for &[local_scan()]& function"
15710 .cindex "&[local_scan()]& function" "timeout"
15711 This timeout applies to the &[local_scan()]& function (see chapter
15712 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15713 the incoming message is rejected with a temporary error if it is an SMTP
15714 message. For a non-SMTP message, the message is dropped and Exim ends with a
15715 non-zero code. The incident is logged on the main and reject logs.
15716
15717
15718
15719 .option local_sender_retain main boolean false
15720 .cindex "&'Sender:'& header line" "retaining from local submission"
15721 When a message is submitted locally (that is, not over a TCP/IP connection) by
15722 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15723 do not want this to happen, you must set &%local_sender_retain%&, and you must
15724 also set &%local_from_check%& to be false (Exim will complain if you do not).
15725 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15726 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15727
15728
15729
15730
15731 .option localhost_number main string&!! unset
15732 .cindex "host" "locally unique number for"
15733 .cindex "message ids" "with multiple hosts"
15734 .vindex "&$localhost_number$&"
15735 Exim's message ids are normally unique only within the local host. If
15736 uniqueness among a set of hosts is required, each host must set a different
15737 value for the &%localhost_number%& option. The string is expanded immediately
15738 after reading the configuration file (so that a number can be computed from the
15739 host name, for example) and the result of the expansion must be a number in the
15740 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15741 systems). This is available in subsequent string expansions via the variable
15742 &$localhost_number$&. When &%localhost_number is set%&, the final two
15743 characters of the message id, instead of just being a fractional part of the
15744 time, are computed from the time and the local host number as described in
15745 section &<<SECTmessiden>>&.
15746
15747
15748
15749 .option log_file_path main "string list&!!" "set at compile time"
15750 .cindex "log" "file path for"
15751 This option sets the path which is used to determine the names of Exim's log
15752 files, or indicates that logging is to be to syslog, or both. It is expanded
15753 when Exim is entered, so it can, for example, contain a reference to the host
15754 name. If no specific path is set for the log files at compile or run time,
15755 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15756 they are written in a sub-directory called &_log_& in Exim's spool directory.
15757 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15758 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15759 used. If this string is fixed at your installation (contains no expansion
15760 variables) it is recommended that you do not set this option in the
15761 configuration file, but instead supply the path using LOG_FILE_PATH in
15762 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15763 early on &-- in particular, failure to read the configuration file.
15764
15765
15766 .option log_selector main string unset
15767 .cindex "log" "selectors"
15768 This option can be used to reduce or increase the number of things that Exim
15769 writes to its log files. Its argument is made up of names preceded by plus or
15770 minus characters. For example:
15771 .code
15772 log_selector = +arguments -retry_defer
15773 .endd
15774 A list of possible names and what they control is given in the chapter on
15775 logging, in section &<<SECTlogselector>>&.
15776
15777
15778 .option log_timezone main boolean false
15779 .cindex "log" "timezone for entries"
15780 .vindex "&$tod_log$&"
15781 .vindex "&$tod_zone$&"
15782 By default, the timestamps on log lines are in local time without the
15783 timezone. This means that if your timezone changes twice a year, the timestamps
15784 in log lines are ambiguous for an hour when the clocks go back. One way of
15785 avoiding this problem is to set the timezone to UTC. An alternative is to set
15786 &%log_timezone%& true. This turns on the addition of the timezone offset to
15787 timestamps in log lines. Turning on this option can add quite a lot to the size
15788 of log files because each line is extended by 6 characters. Note that the
15789 &$tod_log$& variable contains the log timestamp without the zone, but there is
15790 another variable called &$tod_zone$& that contains just the timezone offset.
15791
15792
15793 .option lookup_open_max main integer 25
15794 .cindex "too many open files"
15795 .cindex "open files, too many"
15796 .cindex "file" "too many open"
15797 .cindex "lookup" "maximum open files"
15798 .cindex "limit" "open files for lookups"
15799 This option limits the number of simultaneously open files for single-key
15800 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15801 Exim normally keeps these files open during routing, because often the same
15802 file is required several times. If the limit is reached, Exim closes the least
15803 recently used file. Note that if you are using the &'ndbm'& library, it
15804 actually opens two files for each logical DBM database, though it still counts
15805 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15806 open files"& errors with NDBM, you need to reduce the value of
15807 &%lookup_open_max%&.
15808
15809
15810 .option max_username_length main integer 0
15811 .cindex "length of login name"
15812 .cindex "user name" "maximum length"
15813 .cindex "limit" "user name length"
15814 Some operating systems are broken in that they truncate long arguments to
15815 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15816 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15817 an argument that is longer behaves as if &[getpwnam()]& failed.
15818
15819
15820 .option message_body_newlines main bool false
15821 .cindex "message body" "newlines in variables"
15822 .cindex "newline" "in message body variables"
15823 .vindex "&$message_body$&"
15824 .vindex "&$message_body_end$&"
15825 By default, newlines in the message body are replaced by spaces when setting
15826 the &$message_body$& and &$message_body_end$& expansion variables. If this
15827 option is set true, this no longer happens.
15828
15829
15830 .option message_body_visible main integer 500
15831 .cindex "body of message" "visible size"
15832 .cindex "message body" "visible size"
15833 .vindex "&$message_body$&"
15834 .vindex "&$message_body_end$&"
15835 This option specifies how much of a message's body is to be included in the
15836 &$message_body$& and &$message_body_end$& expansion variables.
15837
15838
15839 .option message_id_header_domain main string&!! unset
15840 .cindex "&'Message-ID:'& header line"
15841 If this option is set, the string is expanded and used as the right hand side
15842 (domain) of the &'Message-ID:'& header that Exim creates if a
15843 locally-originated incoming message does not have one. &"Locally-originated"&
15844 means &"not received over TCP/IP."&
15845 Otherwise, the primary host name is used.
15846 Only letters, digits, dot and hyphen are accepted; any other characters are
15847 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15848 empty string, the option is ignored.
15849
15850
15851 .option message_id_header_text main string&!! unset
15852 If this variable is set, the string is expanded and used to augment the text of
15853 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15854 message does not have one. The text of this header is required by RFC 2822 to
15855 take the form of an address. By default, Exim uses its internal message id as
15856 the local part, and the primary host name as the domain. If this option is set,
15857 it is expanded, and provided the expansion is not forced to fail, and does not
15858 yield an empty string, the result is inserted into the header immediately
15859 before the @, separated from the internal message id by a dot. Any characters
15860 that are illegal in an address are automatically converted into hyphens. This
15861 means that variables such as &$tod_log$& can be used, because the spaces and
15862 colons will become hyphens.
15863
15864
15865 .option message_logs main boolean true
15866 .cindex "message logs" "disabling"
15867 .cindex "log" "message log; disabling"
15868 If this option is turned off, per-message log files are not created in the
15869 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15870 Exim, by reducing the number of files involved in handling a message from a
15871 minimum of four (header spool file, body spool file, delivery journal, and
15872 per-message log) to three. The other major I/O activity is Exim's main log,
15873 which is not affected by this option.
15874
15875
15876 .option message_size_limit main string&!! 50M
15877 .cindex "message" "size limit"
15878 .cindex "limit" "message size"
15879 .cindex "size" "of message, limit"
15880 This option limits the maximum size of message that Exim will process. The
15881 value is expanded for each incoming connection so, for example, it can be made
15882 to depend on the IP address of the remote host for messages arriving via
15883 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15884 optionally followed by K or M.
15885
15886 &*Note*&: This limit cannot be made to depend on a message's sender or any
15887 other properties of an individual message, because it has to be advertised in
15888 the server's response to EHLO. String expansion failure causes a temporary
15889 error. A value of zero means no limit, but its use is not recommended. See also
15890 &%bounce_return_size_limit%&.
15891
15892 Incoming SMTP messages are failed with a 552 error if the limit is
15893 exceeded; locally-generated messages either get a stderr message or a delivery
15894 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15895 an oversized message is logged in both the main and the reject logs. See also
15896 the generic transport option &%message_size_limit%&, which limits the size of
15897 message that an individual transport can process.
15898
15899 If you use a virus-scanner and set this option to to a value larger than the
15900 maximum size that your virus-scanner is configured to support, you may get
15901 failures triggered by large mails.  The right size to configure for the
15902 virus-scanner depends upon what data is passed and the options in use but it's
15903 probably safest to just set it to a little larger than this value.  E.g., with a
15904 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15905 some problems may result.
15906
15907 A value of 0 will disable size limit checking; Exim will still advertise the
15908 SIZE extension in an EHLO response, but without a limit, so as to permit
15909 SMTP clients to still indicate the message size along with the MAIL verb.
15910
15911
15912 .option move_frozen_messages main boolean false
15913 .cindex "frozen messages" "moving"
15914 This option, which is available only if Exim has been built with the setting
15915 .code
15916 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15917 .endd
15918 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15919 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15920 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15921 standard utilities for handling such moved messages, and they do not show up in
15922 lists generated by &%-bp%& or by the Exim monitor.
15923
15924
15925 .option mua_wrapper main boolean false
15926 Setting this option true causes Exim to run in a very restrictive mode in which
15927 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15928 contains a full description of this facility.
15929
15930
15931
15932 .option mysql_servers main "string list" unset
15933 .cindex "MySQL" "server list"
15934 This option provides a list of MySQL servers and associated connection data, to
15935 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15936 option is available only if Exim has been built with MySQL support.
15937
15938
15939 .option never_users main "string list&!!" unset
15940 This option is expanded just once, at the start of Exim's processing. Local
15941 message deliveries are normally run in processes that are setuid to the
15942 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15943 It is usually desirable to prevent any deliveries from running as root, as a
15944 safety precaution.
15945
15946 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15947 list of users that must not be used for local deliveries. This list is fixed in
15948 the binary and cannot be overridden by the configuration file. By default, it
15949 contains just the single user name &"root"&. The &%never_users%& runtime option
15950 can be used to add more users to the fixed list.
15951
15952 If a message is to be delivered as one of the users on the fixed list or the
15953 &%never_users%& list, an error occurs, and delivery is deferred. A common
15954 example is
15955 .code
15956 never_users = root:daemon:bin
15957 .endd
15958 Including root is redundant if it is also on the fixed list, but it does no
15959 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15960 transport driver.
15961
15962
15963 .option openssl_options main "string list" "+no_sslv2 +single_dh_use +no_ticket"
15964 .cindex "OpenSSL "compatibility options"
15965 This option allows an administrator to adjust the SSL options applied
15966 by OpenSSL to connections.  It is given as a space-separated list of items,
15967 each one to be +added or -subtracted from the current value.
15968
15969 This option is only available if Exim is built against OpenSSL.  The values
15970 available for this option vary according to the age of your OpenSSL install.
15971 The &"all"& value controls a subset of flags which are available, typically
15972 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15973 list the values known on your system and Exim should support all the
15974 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15975 names lose the leading &"SSL_OP_"& and are lower-cased.
15976
15977 Note that adjusting the options can have severe impact upon the security of
15978 SSL as used by Exim.  It is possible to disable safety checks and shoot
15979 yourself in the foot in various unpleasant ways.  This option should not be
15980 adjusted lightly.  An unrecognised item will be detected at startup, by
15981 invoking Exim with the &%-bV%& flag.
15982
15983 The option affects Exim operating both as a server and as a client.
15984
15985 Historical note: prior to release 4.80, Exim defaulted this value to
15986 "+dont_insert_empty_fragments", which may still be needed for compatibility
15987 with some clients, but which lowers security by increasing exposure to
15988 some now infamous attacks.
15989
15990 Examples:
15991 .code
15992 # Make both old MS and old Eudora happy:
15993 openssl_options = -all +microsoft_big_sslv3_buffer \
15994                        +dont_insert_empty_fragments
15995
15996 # Disable older protocol versions:
15997 openssl_options = +no_sslv2 +no_sslv3
15998 .endd
15999
16000 Possible options may include:
16001 .ilist
16002 &`all`&
16003 .next
16004 &`allow_unsafe_legacy_renegotiation`&
16005 .next
16006 &`cipher_server_preference`&
16007 .next
16008 &`dont_insert_empty_fragments`&
16009 .next
16010 &`ephemeral_rsa`&
16011 .next
16012 &`legacy_server_connect`&
16013 .next
16014 &`microsoft_big_sslv3_buffer`&
16015 .next
16016 &`microsoft_sess_id_bug`&
16017 .next
16018 &`msie_sslv2_rsa_padding`&
16019 .next
16020 &`netscape_challenge_bug`&
16021 .next
16022 &`netscape_reuse_cipher_change_bug`&
16023 .next
16024 &`no_compression`&
16025 .next
16026 &`no_session_resumption_on_renegotiation`&
16027 .next
16028 &`no_sslv2`&
16029 .next
16030 &`no_sslv3`&
16031 .next
16032 &`no_ticket`&
16033 .next
16034 &`no_tlsv1`&
16035 .next
16036 &`no_tlsv1_1`&
16037 .next
16038 &`no_tlsv1_2`&
16039 .next
16040 &`safari_ecdhe_ecdsa_bug`&
16041 .next
16042 &`single_dh_use`&
16043 .next
16044 &`single_ecdh_use`&
16045 .next
16046 &`ssleay_080_client_dh_bug`&
16047 .next
16048 &`sslref2_reuse_cert_type_bug`&
16049 .next
16050 &`tls_block_padding_bug`&
16051 .next
16052 &`tls_d5_bug`&
16053 .next
16054 &`tls_rollback_bug`&
16055 .endlist
16056
16057 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16058 all clients connecting using the MacOS SecureTransport TLS facility prior
16059 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16060 to negotiate TLS then this option value might help, provided that your OpenSSL
16061 release is new enough to contain this work-around.  This may be a situation
16062 where you have to upgrade OpenSSL to get buggy clients working.
16063
16064
16065 .option oracle_servers main "string list" unset
16066 .cindex "Oracle" "server list"
16067 This option provides a list of Oracle servers and associated connection data,
16068 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16069 The option is available only if Exim has been built with Oracle support.
16070
16071
16072 .option percent_hack_domains main "domain list&!!" unset
16073 .cindex "&""percent hack""&"
16074 .cindex "source routing" "in email address"
16075 .cindex "address" "source-routed"
16076 The &"percent hack"& is the convention whereby a local part containing a
16077 percent sign is re-interpreted as a new email address, with the percent
16078 replaced by @. This is sometimes called &"source routing"&, though that term is
16079 also applied to RFC 2822 addresses that begin with an @ character. If this
16080 option is set, Exim implements the percent facility for those domains listed,
16081 but no others. This happens before an incoming SMTP address is tested against
16082 an ACL.
16083
16084 &*Warning*&: The &"percent hack"& has often been abused by people who are
16085 trying to get round relaying restrictions. For this reason, it is best avoided
16086 if at all possible. Unfortunately, a number of less security-conscious MTAs
16087 implement it unconditionally. If you are running Exim on a gateway host, and
16088 routing mail through to internal MTAs without processing the local parts, it is
16089 a good idea to reject recipient addresses with percent characters in their
16090 local parts. Exim's default configuration does this.
16091
16092
16093 .option perl_at_start main boolean false
16094 .cindex "Perl"
16095 This option is available only when Exim is built with an embedded Perl
16096 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16097
16098
16099 .option perl_startup main string unset
16100 .cindex "Perl"
16101 This option is available only when Exim is built with an embedded Perl
16102 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16103
16104 .option perl_startup main boolean false
16105 .cindex "Perl"
16106 This Option enables the taint mode of the embedded Perl interpreter.
16107
16108
16109 .option pgsql_servers main "string list" unset
16110 .cindex "PostgreSQL lookup type" "server list"
16111 This option provides a list of PostgreSQL servers and associated connection
16112 data, to be used in conjunction with &(pgsql)& lookups (see section
16113 &<<SECID72>>&). The option is available only if Exim has been built with
16114 PostgreSQL support.
16115
16116
16117 .option pid_file_path main string&!! "set at compile time"
16118 .cindex "daemon" "pid file path"
16119 .cindex "pid file, path for"
16120 This option sets the name of the file to which the Exim daemon writes its
16121 process id. The string is expanded, so it can contain, for example, references
16122 to the host name:
16123 .code
16124 pid_file_path = /var/log/$primary_hostname/exim.pid
16125 .endd
16126 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16127 spool directory.
16128 The value set by the option can be overridden by the &%-oP%& command line
16129 option. A pid file is not written if a &"non-standard"& daemon is run by means
16130 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16131
16132
16133 .option pipelining_advertise_hosts main "host list&!!" *
16134 .cindex "PIPELINING" "suppressing advertising"
16135 This option can be used to suppress the advertisement of the SMTP
16136 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16137 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16138 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16139 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16140 that clients will use it; &"out of order"& commands that are &"expected"& do
16141 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16142
16143
16144 .option prdr_enable main boolean false
16145 .cindex "PRDR" "enabling on server"
16146 This option can be used to enable the Per-Recipient Data Response extension
16147 to SMTP, defined by Eric Hall.
16148 If the option is set, PRDR is advertised by Exim when operating as a server.
16149 If the client requests PRDR, and more than one recipient, for a message
16150 an additional ACL is called for each recipient after the message content
16151 is received.  See section &<<SECTPRDRACL>>&.
16152
16153 .option preserve_message_logs main boolean false
16154 .cindex "message logs" "preserving"
16155 If this option is set, message log files are not deleted when messages are
16156 completed. Instead, they are moved to a sub-directory of the spool directory
16157 called &_msglog.OLD_&, where they remain available for statistical or debugging
16158 purposes. This is a dangerous option to set on systems with any appreciable
16159 volume of mail. Use with care!
16160
16161
16162 .option primary_hostname main string "see below"
16163 .cindex "name" "of local host"
16164 .cindex "host" "name of local"
16165 .cindex "local host" "name of"
16166 .vindex "&$primary_hostname$&"
16167 This specifies the name of the current host. It is used in the default EHLO or
16168 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16169 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16170 The value is also used by default in some SMTP response messages from an Exim
16171 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16172
16173 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16174 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16175 contains only one component, Exim passes it to &[gethostbyname()]& (or
16176 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16177 version. The variable &$primary_hostname$& contains the host name, whether set
16178 explicitly by this option, or defaulted.
16179
16180
16181 .option print_topbitchars main boolean false
16182 .cindex "printing characters"
16183 .cindex "8-bit characters"
16184 By default, Exim considers only those characters whose codes lie in the range
16185 32&--126 to be printing characters. In a number of circumstances (for example,
16186 when writing log entries) non-printing characters are converted into escape
16187 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16188 is set, code values of 128 and above are also considered to be printing
16189 characters.
16190
16191 This option also affects the header syntax checks performed by the
16192 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16193 the user's full name when constructing From: and Sender: addresses (as
16194 described in section &<<SECTconstr>>&). Setting this option can cause
16195 Exim to generate eight bit message headers that do not conform to the
16196 standards.
16197
16198
16199 .option process_log_path main string unset
16200 .cindex "process log path"
16201 .cindex "log" "process log"
16202 .cindex "&'exiwhat'&"
16203 This option sets the name of the file to which an Exim process writes its
16204 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16205 utility script. If this option is unset, the file called &_exim-process.info_&
16206 in Exim's spool directory is used. The ability to specify the name explicitly
16207 can be useful in environments where two different Exims are running, using
16208 different spool directories.
16209
16210
16211 .option prod_requires_admin main boolean true
16212 .cindex "restricting access to features"
16213 .oindex "&%-M%&"
16214 .oindex "&%-R%&"
16215 .oindex "&%-q%&"
16216 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16217 admin user unless &%prod_requires_admin%& is set false. See also
16218 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16219
16220
16221 .option qualify_domain main string "see below"
16222 .cindex "domain" "for qualifying addresses"
16223 .cindex "address" "qualification"
16224 This option specifies the domain name that is added to any envelope sender
16225 addresses that do not have a domain qualification. It also applies to
16226 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16227 are accepted by default only for locally-generated messages. Qualification is
16228 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16229 locally-generated messages, unless the &%-bnq%& command line option is used.
16230
16231 Messages from external sources must always contain fully qualified addresses,
16232 unless the sending host matches &%sender_unqualified_hosts%& or
16233 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16234 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16235 necessary. Internally, Exim always works with fully qualified envelope
16236 addresses. If &%qualify_domain%& is not set, it defaults to the
16237 &%primary_hostname%& value.
16238
16239
16240 .option qualify_recipient main string "see below"
16241 This option allows you to specify a different domain for qualifying recipient
16242 addresses to the one that is used for senders. See &%qualify_domain%& above.
16243
16244
16245
16246 .option queue_domains main "domain list&!!" unset
16247 .cindex "domain" "specifying non-immediate delivery"
16248 .cindex "queueing incoming messages"
16249 .cindex "message" "queueing certain domains"
16250 This option lists domains for which immediate delivery is not required.
16251 A delivery process is started whenever a message is received, but only those
16252 domains that do not match are processed. All other deliveries wait until the
16253 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16254
16255
16256 .option queue_list_requires_admin main boolean true
16257 .cindex "restricting access to features"
16258 .oindex "&%-bp%&"
16259 The &%-bp%& command-line option, which lists the messages that are on the
16260 queue, requires the caller to be an admin user unless
16261 &%queue_list_requires_admin%& is set false.
16262 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16263
16264
16265 .option queue_only main boolean false
16266 .cindex "queueing incoming messages"
16267 .cindex "message" "queueing unconditionally"
16268 If &%queue_only%& is set, a delivery process is not automatically started
16269 whenever a message is received. Instead, the message waits on the queue for the
16270 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16271 delivered immediately when certain conditions (such as heavy load) occur.
16272
16273 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16274 and &%-odi%& command line options override &%queue_only%& unless
16275 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16276 &%queue_only_load%&, and &%smtp_accept_queue%&.
16277
16278
16279 .option queue_only_file main string unset
16280 .cindex "queueing incoming messages"
16281 .cindex "message" "queueing by file existence"
16282 This option can be set to a colon-separated list of absolute path names, each
16283 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16284 it tests for the existence of each listed path using a call to &[stat()]&. For
16285 each path that exists, the corresponding queueing option is set.
16286 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16287 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16288 .code
16289 queue_only_file = smtp/some/file
16290 .endd
16291 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16292 &_/some/file_& exists.
16293
16294
16295 .option queue_only_load main fixed-point unset
16296 .cindex "load average"
16297 .cindex "queueing incoming messages"
16298 .cindex "message" "queueing by load"
16299 If the system load average is higher than this value, incoming messages from
16300 all sources are queued, and no automatic deliveries are started. If this
16301 happens during local or remote SMTP input, all subsequent messages received on
16302 the same SMTP connection are queued by default, whatever happens to the load in
16303 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16304 false.
16305
16306 Deliveries will subsequently be performed by queue runner processes. This
16307 option has no effect on ancient operating systems on which Exim cannot
16308 determine the load average. See also &%deliver_queue_load_max%& and
16309 &%smtp_load_reserve%&.
16310
16311
16312 .option queue_only_load_latch main boolean true
16313 .cindex "load average" "re-evaluating per message"
16314 When this option is true (the default), once one message has been queued
16315 because the load average is higher than the value set by &%queue_only_load%&,
16316 all subsequent messages received on the same SMTP connection are also queued.
16317 This is a deliberate choice; even though the load average may fall below the
16318 threshold, it doesn't seem right to deliver later messages on the same
16319 connection when not delivering earlier ones. However, there are special
16320 circumstances such as very long-lived connections from scanning appliances
16321 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16322 should be set false. This causes the value of the load average to be
16323 re-evaluated for each message.
16324
16325
16326 .option queue_only_override main boolean true
16327 .cindex "queueing incoming messages"
16328 When this option is true, the &%-od%&&'x'& command line options override the
16329 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16330 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16331 to override; they are accepted, but ignored.
16332
16333
16334 .option queue_run_in_order main boolean false
16335 .cindex "queue runner" "processing messages in order"
16336 If this option is set, queue runs happen in order of message arrival instead of
16337 in an arbitrary order. For this to happen, a complete list of the entire queue
16338 must be set up before the deliveries start. When the queue is all held in a
16339 single directory (the default), a single list is created for both the ordered
16340 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16341 single list is not created when &%queue_run_in_order%& is false. In this case,
16342 the sub-directories are processed one at a time (in a random order), and this
16343 avoids setting up one huge list for the whole queue. Thus, setting
16344 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16345 when the queue is large, because of the extra work in setting up the single,
16346 large list. In most situations, &%queue_run_in_order%& should not be set.
16347
16348
16349
16350 .option queue_run_max main integer&!! 5
16351 .cindex "queue runner" "maximum number of"
16352 This controls the maximum number of queue runner processes that an Exim daemon
16353 can run simultaneously. This does not mean that it starts them all at once,
16354 but rather that if the maximum number are still running when the time comes to
16355 start another one, it refrains from starting another one. This can happen with
16356 very large queues and/or very sluggish deliveries. This option does not,
16357 however, interlock with other processes, so additional queue runners can be
16358 started by other means, or by killing and restarting the daemon.
16359
16360 Setting this option to zero does not suppress queue runs; rather, it disables
16361 the limit, allowing any number of simultaneous queue runner processes to be
16362 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16363 the daemon's command line.
16364
16365 .cindex queues named
16366 .cindex "named queues"
16367 To set limits for different named queues use
16368 an expansion depending on the &$queue_name$& variable.
16369
16370 .option queue_smtp_domains main "domain list&!!" unset
16371 .cindex "queueing incoming messages"
16372 .cindex "message" "queueing remote deliveries"
16373 When this option is set, a delivery process is started whenever a message is
16374 received, routing is performed, and local deliveries take place.
16375 However, if any SMTP deliveries are required for domains that match
16376 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16377 message waits on the queue for the next queue run. Since routing of the message
16378 has taken place, Exim knows to which remote hosts it must be delivered, and so
16379 when the queue run happens, multiple messages for the same host are delivered
16380 over a single SMTP connection. The &%-odqs%& command line option causes all
16381 SMTP deliveries to be queued in this way, and is equivalent to setting
16382 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16383 &%queue_domains%&.
16384
16385
16386 .option receive_timeout main time 0s
16387 .cindex "timeout" "for non-SMTP input"
16388 This option sets the timeout for accepting a non-SMTP message, that is, the
16389 maximum time that Exim waits when reading a message on the standard input. If
16390 the value is zero, it will wait for ever. This setting is overridden by the
16391 &%-or%& command line option. The timeout for incoming SMTP messages is
16392 controlled by &%smtp_receive_timeout%&.
16393
16394 .option received_header_text main string&!! "see below"
16395 .cindex "customizing" "&'Received:'& header"
16396 .cindex "&'Received:'& header line" "customizing"
16397 This string defines the contents of the &'Received:'& message header that is
16398 added to each message, except for the timestamp, which is automatically added
16399 on at the end (preceded by a semicolon). The string is expanded each time it is
16400 used. If the expansion yields an empty string, no &'Received:'& header line is
16401 added to the message. Otherwise, the string should start with the text
16402 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16403 header lines. The default setting is:
16404
16405 .code
16406 received_header_text = Received: \
16407   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16408   {${if def:sender_ident \
16409   {from ${quote_local_part:$sender_ident} }}\
16410   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16411   by $primary_hostname \
16412   ${if def:received_protocol {with $received_protocol}} \
16413   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
16414   (Exim $version_number)\n\t\
16415   ${if def:sender_address \
16416   {(envelope-from <$sender_address>)\n\t}}\
16417   id $message_exim_id\
16418   ${if def:received_for {\n\tfor $received_for}}
16419 .endd
16420
16421 The reference to the TLS cipher is omitted when Exim is built without TLS
16422 support. The use of conditional expansions ensures that this works for both
16423 locally generated messages and messages received from remote hosts, giving
16424 header lines such as the following:
16425 .code
16426 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16427 by marley.carol.example with esmtp (Exim 4.00)
16428 (envelope-from <bob@carol.example>)
16429 id 16IOWa-00019l-00
16430 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16431 Received: by scrooge.carol.example with local (Exim 4.00)
16432 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16433 .endd
16434 Until the body of the message has been received, the timestamp is the time when
16435 the message started to be received. Once the body has arrived, and all policy
16436 checks have taken place, the timestamp is updated to the time at which the
16437 message was accepted.
16438
16439
16440 .option received_headers_max main integer 30
16441 .cindex "loop" "prevention"
16442 .cindex "mail loop prevention"
16443 .cindex "&'Received:'& header line" "counting"
16444 When a message is to be delivered, the number of &'Received:'& headers is
16445 counted, and if it is greater than this parameter, a mail loop is assumed to
16446 have occurred, the delivery is abandoned, and an error message is generated.
16447 This applies to both local and remote deliveries.
16448
16449
16450 .option recipient_unqualified_hosts main "host list&!!" unset
16451 .cindex "unqualified addresses"
16452 .cindex "host" "unqualified addresses from"
16453 This option lists those hosts from which Exim is prepared to accept unqualified
16454 recipient addresses in message envelopes. The addresses are made fully
16455 qualified by the addition of the &%qualify_recipient%& value. This option also
16456 affects message header lines. Exim does not reject unqualified recipient
16457 addresses in headers, but it qualifies them only if the message came from a
16458 host that matches &%recipient_unqualified_hosts%&,
16459 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16460 option was not set.
16461
16462
16463 .option recipients_max main integer 0
16464 .cindex "limit" "number of recipients"
16465 .cindex "recipient" "maximum number"
16466 If this option is set greater than zero, it specifies the maximum number of
16467 original recipients for any message. Additional recipients that are generated
16468 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16469 all recipients over the limit; earlier recipients are delivered as normal.
16470 Non-SMTP messages with too many recipients are failed, and no deliveries are
16471 done.
16472
16473 .cindex "RCPT" "maximum number of incoming"
16474 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16475 RCPT commands in a single message.
16476
16477
16478 .option recipients_max_reject main boolean false
16479 If this option is set true, Exim rejects SMTP messages containing too many
16480 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16481 error to the eventual DATA command. Otherwise (the default) it gives a 452
16482 error to the surplus RCPT commands and accepts the message on behalf of the
16483 initial set of recipients. The remote server should then re-send the message
16484 for the remaining recipients at a later time.
16485
16486
16487 .option remote_max_parallel main integer 2
16488 .cindex "delivery" "parallelism for remote"
16489 This option controls parallel delivery of one message to a number of remote
16490 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16491 does all the remote deliveries for a message one by one. Otherwise, if a single
16492 message has to be delivered to more than one remote host, or if several copies
16493 have to be sent to the same remote host, up to &%remote_max_parallel%&
16494 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16495 deliveries are required, the maximum number of processes are started, and as
16496 each one finishes, another is begun. The order of starting processes is the
16497 same as if sequential delivery were being done, and can be controlled by the
16498 &%remote_sort_domains%& option. If parallel delivery takes place while running
16499 with debugging turned on, the debugging output from each delivery process is
16500 tagged with its process id.
16501
16502 This option controls only the maximum number of parallel deliveries for one
16503 message in one Exim delivery process. Because Exim has no central queue
16504 manager, there is no way of controlling the total number of simultaneous
16505 deliveries if the configuration allows a delivery attempt as soon as a message
16506 is received.
16507
16508 .cindex "number of deliveries"
16509 .cindex "delivery" "maximum number of"
16510 If you want to control the total number of deliveries on the system, you
16511 need to set the &%queue_only%& option. This ensures that all incoming messages
16512 are added to the queue without starting a delivery process. Then set up an Exim
16513 daemon to start queue runner processes at appropriate intervals (probably
16514 fairly often, for example, every minute), and limit the total number of queue
16515 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16516 delivers only one message at a time, the maximum number of deliveries that can
16517 then take place at once is &%queue_run_max%& multiplied by
16518 &%remote_max_parallel%&.
16519
16520 If it is purely remote deliveries you want to control, use
16521 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16522 doing the SMTP routing before queueing, so that several messages for the same
16523 host will eventually get delivered down the same connection.
16524
16525
16526 .option remote_sort_domains main "domain list&!!" unset
16527 .cindex "sorting remote deliveries"
16528 .cindex "delivery" "sorting remote"
16529 When there are a number of remote deliveries for a message, they are sorted by
16530 domain into the order given by this list. For example,
16531 .code
16532 remote_sort_domains = *.cam.ac.uk:*.uk
16533 .endd
16534 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16535 then to those in the &%uk%& domain, then to any others.
16536
16537
16538 .option retry_data_expire main time 7d
16539 .cindex "hints database" "data expiry"
16540 This option sets a &"use before"& time on retry information in Exim's hints
16541 database. Any older retry data is ignored. This means that, for example, once a
16542 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16543 past failures.
16544
16545
16546 .option retry_interval_max main time 24h
16547 .cindex "retry" "limit on interval"
16548 .cindex "limit" "on retry interval"
16549 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16550 intervals between delivery attempts for messages that cannot be delivered
16551 straight away. This option sets an overall limit to the length of time between
16552 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16553 the default value.
16554
16555
16556 .option return_path_remove main boolean true
16557 .cindex "&'Return-path:'& header line" "removing"
16558 RFC 2821, section 4.4, states that an SMTP server must insert a
16559 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16560 The &'Return-path:'& header preserves the sender address as received in the
16561 MAIL command. This description implies that this header should not be present
16562 in an incoming message. If &%return_path_remove%& is true, any existing
16563 &'Return-path:'& headers are removed from messages at the time they are
16564 received. Exim's transports have options for adding &'Return-path:'& headers at
16565 the time of delivery. They are normally used only for final local deliveries.
16566
16567
16568 .option return_size_limit main integer 100K
16569 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16570
16571
16572 .option rfc1413_hosts main "host list&!!" @[]
16573 .cindex "RFC 1413"
16574 .cindex "host" "for RFC 1413 calls"
16575 RFC 1413 identification calls are made to any client host which matches
16576 an item in the list.
16577 The default value specifies just this host, being any local interface
16578 for the system.
16579
16580 .option rfc1413_query_timeout main time 0s
16581 .cindex "RFC 1413" "query timeout"
16582 .cindex "timeout" "for RFC 1413 call"
16583 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16584 no RFC 1413 calls are ever made.
16585
16586
16587 .option sender_unqualified_hosts main "host list&!!" unset
16588 .cindex "unqualified addresses"
16589 .cindex "host" "unqualified addresses from"
16590 This option lists those hosts from which Exim is prepared to accept unqualified
16591 sender addresses. The addresses are made fully qualified by the addition of
16592 &%qualify_domain%&. This option also affects message header lines. Exim does
16593 not reject unqualified addresses in headers that contain sender addresses, but
16594 it qualifies them only if the message came from a host that matches
16595 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16596 using TCP/IP), and the &%-bnq%& option was not set.
16597
16598 .option set_environment main "string list" empty
16599 .cindex "environment"
16600 This option allows to set individual environment variables that the
16601 currently linked libraries and programs in child processes use. The
16602 default list is empty,
16603
16604
16605 .option slow_lookup_log main integer 0
16606 .cindex "logging" "slow lookups"
16607 .cindex "dns" "logging slow lookups"
16608 This option controls logging of slow lookups.
16609 If the value is nonzero it is taken as a number of milliseconds
16610 and lookups taking longer than this are logged.
16611 Currently this applies only to DNS lookups.
16612
16613
16614
16615 .option smtp_accept_keepalive main boolean true
16616 .cindex "keepalive" "on incoming connection"
16617 This option controls the setting of the SO_KEEPALIVE option on incoming
16618 TCP/IP socket connections. When set, it causes the kernel to probe idle
16619 connections periodically, by sending packets with &"old"& sequence numbers. The
16620 other end of the connection should send an acknowledgment if the connection is
16621 still okay or a reset if the connection has been aborted. The reason for doing
16622 this is that it has the beneficial effect of freeing up certain types of
16623 connection that can get stuck when the remote host is disconnected without
16624 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16625 hours to detect unreachable hosts.
16626
16627
16628
16629 .option smtp_accept_max main integer 20
16630 .cindex "limit" "incoming SMTP connections"
16631 .cindex "SMTP" "incoming connection count"
16632 .cindex "inetd"
16633 This option specifies the maximum number of simultaneous incoming SMTP calls
16634 that Exim will accept. It applies only to the listening daemon; there is no
16635 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16636 value is set to zero, no limit is applied. However, it is required to be
16637 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16638 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16639
16640 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16641 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16642 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16643 and &%smtp_load_reserve%& are then checked before accepting the connection.
16644
16645
16646 .option smtp_accept_max_nonmail main integer 10
16647 .cindex "limit" "non-mail SMTP commands"
16648 .cindex "SMTP" "limiting non-mail commands"
16649 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16650 the connection if there are too many. This option defines &"too many"&. The
16651 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16652 client looping sending EHLO, for example. The check is applied only if the
16653 client host matches &%smtp_accept_max_nonmail_hosts%&.
16654
16655 When a new message is expected, one occurrence of RSET is not counted. This
16656 allows a client to send one RSET between messages (this is not necessary,
16657 but some clients do it). Exim also allows one uncounted occurrence of HELO
16658 or EHLO, and one occurrence of STARTTLS between messages. After
16659 starting up a TLS session, another EHLO is expected, and so it too is not
16660 counted. The first occurrence of AUTH in a connection, or immediately
16661 following STARTTLS is not counted. Otherwise, all commands other than
16662 MAIL, RCPT, DATA, and QUIT are counted.
16663
16664
16665 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16666 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16667 check by setting this option. The default value makes it apply to all hosts. By
16668 changing the value, you can exclude any badly-behaved hosts that you have to
16669 live with.
16670
16671
16672 . Allow this long option name to split; give it unsplit as a fifth argument
16673 . for the automatic .oindex that is generated by .option.
16674 . We insert " &~&~" which is both pretty nasty visually and results in
16675 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16676 . zero-width-space, which would be nicer visually and results in (at least)
16677 . html that Firefox will split on when it's forced to reflow (rather than
16678 . inserting a horizontal scrollbar).  However, the text is still not
16679 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16680 . the option name to split.
16681
16682 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16683          smtp_accept_max_per_connection
16684 .cindex "SMTP" "limiting incoming message count"
16685 .cindex "limit" "messages per SMTP connection"
16686 The value of this option limits the number of MAIL commands that Exim is
16687 prepared to accept over a single SMTP connection, whether or not each command
16688 results in the transfer of a message. After the limit is reached, a 421
16689 response is given to subsequent MAIL commands. This limit is a safety
16690 precaution against a client that goes mad (incidents of this type have been
16691 seen).
16692
16693
16694 .option smtp_accept_max_per_host main string&!! unset
16695 .cindex "limit" "SMTP connections from one host"
16696 .cindex "host" "limiting SMTP connections from"
16697 This option restricts the number of simultaneous IP connections from a single
16698 host (strictly, from a single IP address) to the Exim daemon. The option is
16699 expanded, to enable different limits to be applied to different hosts by
16700 reference to &$sender_host_address$&. Once the limit is reached, additional
16701 connection attempts from the same host are rejected with error code 421. This
16702 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16703 of zero imposes no limit. If this option is set greater than zero, it is
16704 required that &%smtp_accept_max%& be non-zero.
16705
16706 &*Warning*&: When setting this option you should not use any expansion
16707 constructions that take an appreciable amount of time. The expansion and test
16708 happen in the main daemon loop, in order to reject additional connections
16709 without forking additional processes (otherwise a denial-of-service attack
16710 could cause a vast number or processes to be created). While the daemon is
16711 doing this processing, it cannot accept any other incoming connections.
16712
16713
16714
16715 .option smtp_accept_queue main integer 0
16716 .cindex "SMTP" "incoming connection count"
16717 .cindex "queueing incoming messages"
16718 .cindex "message" "queueing by SMTP connection count"
16719 If the number of simultaneous incoming SMTP connections being handled via the
16720 listening daemon exceeds this value, messages received by SMTP are just placed
16721 on the queue; no delivery processes are started automatically. The count is
16722 fixed at the start of an SMTP connection. It cannot be updated in the
16723 subprocess that receives messages, and so the queueing or not queueing applies
16724 to all messages received in the same connection.
16725
16726 A value of zero implies no limit, and clearly any non-zero value is useful only
16727 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16728 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16729 various &%-od%&&'x'& command line options.
16730
16731
16732 . See the comment on smtp_accept_max_per_connection
16733
16734 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16735          smtp_accept_queue_per_connection
16736 .cindex "queueing incoming messages"
16737 .cindex "message" "queueing by message count"
16738 This option limits the number of delivery processes that Exim starts
16739 automatically when receiving messages via SMTP, whether via the daemon or by
16740 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16741 and the number of messages received in a single SMTP session exceeds this
16742 number, subsequent messages are placed on the queue, but no delivery processes
16743 are started. This helps to limit the number of Exim processes when a server
16744 restarts after downtime and there is a lot of mail waiting for it on other
16745 systems. On large systems, the default should probably be increased, and on
16746 dial-in client systems it should probably be set to zero (that is, disabled).
16747
16748
16749 .option smtp_accept_reserve main integer 0
16750 .cindex "SMTP" "incoming call count"
16751 .cindex "host" "reserved"
16752 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16753 number of SMTP connections that are reserved for connections from the hosts
16754 that are specified in &%smtp_reserve_hosts%&. The value set in
16755 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16756 restricted to this number of connections; the option specifies a minimum number
16757 of connection slots for them, not a maximum. It is a guarantee that this group
16758 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16759 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16760 individual host.
16761
16762 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16763 set to 5, once there are 45 active connections (from any hosts), new
16764 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16765 provided the other criteria for acceptance are met.
16766
16767
16768 .option smtp_active_hostname main string&!! unset
16769 .cindex "host" "name in SMTP responses"
16770 .cindex "SMTP" "host name in responses"
16771 .vindex "&$primary_hostname$&"
16772 This option is provided for multi-homed servers that want to masquerade as
16773 several different hosts. At the start of an incoming SMTP connection, its value
16774 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16775 responses. For example, it is used as domain name in the response to an
16776 incoming HELO or EHLO command.
16777
16778 .vindex "&$smtp_active_hostname$&"
16779 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16780 is saved with any messages that are received. It is therefore available for use
16781 in routers and transports when the message is later delivered.
16782
16783 If this option is unset, or if its expansion is forced to fail, or if the
16784 expansion results in an empty string, the value of &$primary_hostname$& is
16785 used. Other expansion failures cause a message to be written to the main and
16786 panic logs, and the SMTP command receives a temporary error. Typically, the
16787 value of &%smtp_active_hostname%& depends on the incoming interface address.
16788 For example:
16789 .code
16790 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16791   {cox.mydomain}{box.mydomain}}
16792 .endd
16793
16794 Although &$smtp_active_hostname$& is primarily concerned with incoming
16795 messages, it is also used as the default for HELO commands in callout
16796 verification if there is no remote transport from which to obtain a
16797 &%helo_data%& value.
16798
16799 .option smtp_banner main string&!! "see below"
16800 .cindex "SMTP" "welcome banner"
16801 .cindex "banner for SMTP"
16802 .cindex "welcome banner for SMTP"
16803 .cindex "customizing" "SMTP banner"
16804 This string, which is expanded every time it is used, is output as the initial
16805 positive response to an SMTP connection. The default setting is:
16806 .code
16807 smtp_banner = $smtp_active_hostname ESMTP Exim \
16808   $version_number $tod_full
16809 .endd
16810 Failure to expand the string causes a panic error. If you want to create a
16811 multiline response to the initial SMTP connection, use &"\n"& in the string at
16812 appropriate points, but not at the end. Note that the 220 code is not included
16813 in this string. Exim adds it automatically (several times in the case of a
16814 multiline response).
16815
16816
16817 .option smtp_check_spool_space main boolean true
16818 .cindex "checking disk space"
16819 .cindex "disk space, checking"
16820 .cindex "spool directory" "checking space"
16821 When this option is set, if an incoming SMTP session encounters the SIZE
16822 option on a MAIL command, it checks that there is enough space in the
16823 spool directory's partition to accept a message of that size, while still
16824 leaving free the amount specified by &%check_spool_space%& (even if that value
16825 is zero). If there isn't enough space, a temporary error code is returned.
16826
16827
16828 .option smtp_connect_backlog main integer 20
16829 .cindex "connection backlog"
16830 .cindex "SMTP" "connection backlog"
16831 .cindex "backlog of connections"
16832 This option specifies a maximum number of waiting SMTP connections. Exim passes
16833 this value to the TCP/IP system when it sets up its listener. Once this number
16834 of connections are waiting for the daemon's attention, subsequent connection
16835 attempts are refused at the TCP/IP level. At least, that is what the manuals
16836 say; in some circumstances such connection attempts have been observed to time
16837 out instead. For large systems it is probably a good idea to increase the
16838 value (to 50, say). It also gives some protection against denial-of-service
16839 attacks by SYN flooding.
16840
16841
16842 .option smtp_enforce_sync main boolean true
16843 .cindex "SMTP" "synchronization checking"
16844 .cindex "synchronization checking in SMTP"
16845 The SMTP protocol specification requires the client to wait for a response from
16846 the server at certain points in the dialogue. Without PIPELINING these
16847 synchronization points are after every command; with PIPELINING they are
16848 fewer, but they still exist.
16849
16850 Some spamming sites send out a complete set of SMTP commands without waiting
16851 for any response. Exim protects against this by rejecting a message if the
16852 client has sent further input when it should not have. The error response &"554
16853 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16854 for this error cannot be perfect because of transmission delays (unexpected
16855 input may be on its way but not yet received when Exim checks). However, it
16856 does detect many instances.
16857
16858 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16859 If you want to disable the check selectively (for example, only for certain
16860 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16861 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16862
16863
16864
16865 .option smtp_etrn_command main string&!! unset
16866 .cindex "ETRN" "command to be run"
16867 .vindex "&$domain$&"
16868 If this option is set, the given command is run whenever an SMTP ETRN
16869 command is received from a host that is permitted to issue such commands (see
16870 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16871 are independently expanded. The expansion variable &$domain$& is set to the
16872 argument of the ETRN command, and no syntax checking is done on it. For
16873 example:
16874 .code
16875 smtp_etrn_command = /etc/etrn_command $domain \
16876                     $sender_host_address
16877 .endd
16878 A new process is created to run the command, but Exim does not wait for it to
16879 complete. Consequently, its status cannot be checked. If the command cannot be
16880 run, a line is written to the panic log, but the ETRN caller still receives
16881 a 250 success response. Exim is normally running under its own uid when
16882 receiving SMTP, so it is not possible for it to change the uid before running
16883 the command.
16884
16885
16886 .option smtp_etrn_serialize main boolean true
16887 .cindex "ETRN" "serializing"
16888 When this option is set, it prevents the simultaneous execution of more than
16889 one identical command as a result of ETRN in an SMTP connection. See
16890 section &<<SECTETRN>>& for details.
16891
16892
16893 .option smtp_load_reserve main fixed-point unset
16894 .cindex "load average"
16895 If the system load average ever gets higher than this, incoming SMTP calls are
16896 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16897 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16898 the load is over the limit. The option has no effect on ancient operating
16899 systems on which Exim cannot determine the load average. See also
16900 &%deliver_queue_load_max%& and &%queue_only_load%&.
16901
16902
16903
16904 .option smtp_max_synprot_errors main integer 3
16905 .cindex "SMTP" "limiting syntax and protocol errors"
16906 .cindex "limit" "SMTP syntax and protocol errors"
16907 Exim rejects SMTP commands that contain syntax or protocol errors. In
16908 particular, a syntactically invalid email address, as in this command:
16909 .code
16910 RCPT TO:<abc xyz@a.b.c>
16911 .endd
16912 causes immediate rejection of the command, before any other tests are done.
16913 (The ACL cannot be run if there is no valid address to set up for it.) An
16914 example of a protocol error is receiving RCPT before MAIL. If there are
16915 too many syntax or protocol errors in one SMTP session, the connection is
16916 dropped. The limit is set by this option.
16917
16918 .cindex "PIPELINING" "expected errors"
16919 When the PIPELINING extension to SMTP is in use, some protocol errors are
16920 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16921 Exim assumes that PIPELINING will be used if it advertises it (see
16922 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16923 not count towards the limit.
16924
16925
16926
16927 .option smtp_max_unknown_commands main integer 3
16928 .cindex "SMTP" "limiting unknown commands"
16929 .cindex "limit" "unknown SMTP commands"
16930 If there are too many unrecognized commands in an incoming SMTP session, an
16931 Exim server drops the connection. This is a defence against some kinds of abuse
16932 that subvert web
16933 clients
16934 into making connections to SMTP ports; in these circumstances, a number of
16935 non-SMTP command lines are sent first.
16936
16937
16938
16939 .option smtp_ratelimit_hosts main "host list&!!" unset
16940 .cindex "SMTP" "rate limiting"
16941 .cindex "limit" "rate of message arrival"
16942 .cindex "RCPT" "rate limiting"
16943 Some sites find it helpful to be able to limit the rate at which certain hosts
16944 can send them messages, and the rate at which an individual message can specify
16945 recipients.
16946
16947 Exim has two rate-limiting facilities. This section describes the older
16948 facility, which can limit rates within a single connection. The newer
16949 &%ratelimit%& ACL condition can limit rates across all connections. See section
16950 &<<SECTratelimiting>>& for details of the newer facility.
16951
16952 When a host matches &%smtp_ratelimit_hosts%&, the values of
16953 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16954 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16955 respectively. Each option, if set, must contain a set of four comma-separated
16956 values:
16957
16958 .ilist
16959 A threshold, before which there is no rate limiting.
16960 .next
16961 An initial time delay. Unlike other times in Exim, numbers with decimal
16962 fractional parts are allowed here.
16963 .next
16964 A factor by which to increase the delay each time.
16965 .next
16966 A maximum value for the delay. This should normally be less than 5 minutes,
16967 because after that time, the client is liable to timeout the SMTP command.
16968 .endlist
16969
16970 For example, these settings have been used successfully at the site which
16971 first suggested this feature, for controlling mail from their customers:
16972 .code
16973 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16974 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16975 .endd
16976 The first setting specifies delays that are applied to MAIL commands after
16977 two have been received over a single connection. The initial delay is 0.5
16978 seconds, increasing by a factor of 1.05 each time. The second setting applies
16979 delays to RCPT commands when more than four occur in a single message.
16980
16981
16982 .option smtp_ratelimit_mail main string unset
16983 See &%smtp_ratelimit_hosts%& above.
16984
16985
16986 .option smtp_ratelimit_rcpt main string unset
16987 See &%smtp_ratelimit_hosts%& above.
16988
16989
16990 .option smtp_receive_timeout main time&!! 5m
16991 .cindex "timeout" "for SMTP input"
16992 .cindex "SMTP" "input timeout"
16993 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16994 input, including batch SMTP. If a line of input (either an SMTP command or a
16995 data line) is not received within this time, the SMTP connection is dropped and
16996 the message is abandoned.
16997 A line is written to the log containing one of the following messages:
16998 .code
16999 SMTP command timeout on connection from...
17000 SMTP data timeout on connection from...
17001 .endd
17002 The former means that Exim was expecting to read an SMTP command; the latter
17003 means that it was in the DATA phase, reading the contents of a message.
17004
17005 If the first character of the option is a &"$"& the option is
17006 expanded before use and may depend on
17007 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17008
17009
17010 .oindex "&%-os%&"
17011 The value set by this option can be overridden by the
17012 &%-os%& command-line option. A setting of zero time disables the timeout, but
17013 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17014 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17015 timeout is controlled by &%receive_timeout%& and &%-or%&.
17016
17017
17018 .option smtp_reserve_hosts main "host list&!!" unset
17019 This option defines hosts for which SMTP connections are reserved; see
17020 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17021
17022
17023 .option smtp_return_error_details main boolean false
17024 .cindex "SMTP" "details policy failures"
17025 .cindex "policy control" "rejection, returning details"
17026 In the default state, Exim uses bland messages such as
17027 &"Administrative prohibition"& when it rejects SMTP commands for policy
17028 reasons. Many sysadmins like this because it gives away little information
17029 to spammers. However, some other sysadmins who are applying strict checking
17030 policies want to give out much fuller information about failures. Setting
17031 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17032 example, instead of &"Administrative prohibition"&, it might give:
17033 .code
17034 550-Rejected after DATA: '>' missing at end of address:
17035 550 failing address in "From" header is: <user@dom.ain
17036 .endd
17037
17038
17039 .option smtputf8_advertise_hosts main "host list&!!" *
17040 .cindex "SMTPUTF8" "advertising"
17041 When Exim is built with support for internationalised mail names,
17042 the availability thereof is advertised in
17043 response to EHLO only to those client hosts that match this option. See
17044 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17045
17046
17047 .option spamd_address main string "127.0.0.1 783"
17048 This option is available when Exim is compiled with the content-scanning
17049 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17050 See section &<<SECTscanspamass>>& for more details.
17051
17052
17053
17054 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17055 This option is available when Exim is compiled with SPF support.
17056 See section &<<SECSPF>>& for more details.
17057
17058
17059
17060 .option split_spool_directory main boolean false
17061 .cindex "multiple spool directories"
17062 .cindex "spool directory" "split"
17063 .cindex "directories, multiple"
17064 If this option is set, it causes Exim to split its input directory into 62
17065 subdirectories, each with a single alphanumeric character as its name. The
17066 sixth character of the message id is used to allocate messages to
17067 subdirectories; this is the least significant base-62 digit of the time of
17068 arrival of the message.
17069
17070 Splitting up the spool in this way may provide better performance on systems
17071 where there are long mail queues, by reducing the number of files in any one
17072 directory. The msglog directory is also split up in a similar way to the input
17073 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17074 are still placed in the single directory &_msglog.OLD_&.
17075
17076 It is not necessary to take any special action for existing messages when
17077 changing &%split_spool_directory%&. Exim notices messages that are in the
17078 &"wrong"& place, and continues to process them. If the option is turned off
17079 after a period of being on, the subdirectories will eventually empty and be
17080 automatically deleted.
17081
17082 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17083 changes. Instead of creating a list of all messages in the queue, and then
17084 trying to deliver each one in turn, it constructs a list of those in one
17085 sub-directory and tries to deliver them, before moving on to the next
17086 sub-directory. The sub-directories are processed in a random order. This
17087 spreads out the scanning of the input directories, and uses less memory. It is
17088 particularly beneficial when there are lots of messages on the queue. However,
17089 if &%queue_run_in_order%& is set, none of this new processing happens. The
17090 entire queue has to be scanned and sorted before any deliveries can start.
17091
17092
17093 .option spool_directory main string&!! "set at compile time"
17094 .cindex "spool directory" "path to"
17095 This defines the directory in which Exim keeps its spool, that is, the messages
17096 it is waiting to deliver. The default value is taken from the compile-time
17097 configuration setting, if there is one. If not, this option must be set. The
17098 string is expanded, so it can contain, for example, a reference to
17099 &$primary_hostname$&.
17100
17101 If the spool directory name is fixed on your installation, it is recommended
17102 that you set it at build time rather than from this option, particularly if the
17103 log files are being written to the spool directory (see &%log_file_path%&).
17104 Otherwise log files cannot be used for errors that are detected early on, such
17105 as failures in the configuration file.
17106
17107 By using this option to override the compiled-in path, it is possible to run
17108 tests of Exim without using the standard spool.
17109
17110 .option spool_wireformat main boolean false
17111 .cindex "spool directory" "file formats"
17112 If this option is set, Exim may for some messages use an alternative format
17113 for data-files in the spool which matches the wire format.
17114 Doing this permits more efficient message reception and transmission.
17115 Currently it is only done for messages received using the ESMTP CHUNKING
17116 option.
17117
17118 The following variables will not have useful values:
17119 .code
17120 $max_received_linelength
17121 $body_linecount
17122 $body_zerocount
17123 .endd
17124
17125 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17126 and any external programs which are passed a reference to a message data file
17127 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17128 will need to be aware of the different formats potentially available.
17129
17130 Using any of the ACL conditions noted will negate the reception benefit
17131 (as a Unix-mbox-format file is constructed for them).
17132 The transmission benefit is maintained.
17133
17134 .option sqlite_lock_timeout main time 5s
17135 .cindex "sqlite lookup type" "lock timeout"
17136 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17137 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17138
17139 .option strict_acl_vars main boolean false
17140 .cindex "&ACL;" "variables, handling unset"
17141 This option controls what happens if a syntactically valid but undefined ACL
17142 variable is referenced. If it is false (the default), an empty string
17143 is substituted; if it is true, an error is generated. See section
17144 &<<SECTaclvariables>>& for details of ACL variables.
17145
17146 .option strip_excess_angle_brackets main boolean false
17147 .cindex "angle brackets, excess"
17148 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17149 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17150 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17151 passed on to another MTA, the excess angle brackets are not passed on. If this
17152 option is not set, multiple pairs of angle brackets cause a syntax error.
17153
17154
17155 .option strip_trailing_dot main boolean false
17156 .cindex "trailing dot on domain"
17157 .cindex "dot" "trailing on domain"
17158 If this option is set, a trailing dot at the end of a domain in an address is
17159 ignored. If this is in the envelope and the message is passed on to another
17160 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17161 domain causes a syntax error.
17162 However, addresses in header lines are checked only when an ACL requests header
17163 syntax checking.
17164
17165
17166 .option syslog_duplication main boolean true
17167 .cindex "syslog" "duplicate log lines; suppressing"
17168 When Exim is logging to syslog, it writes the log lines for its three
17169 separate logs at different syslog priorities so that they can in principle
17170 be separated on the logging hosts. Some installations do not require this
17171 separation, and in those cases, the duplication of certain log lines is a
17172 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17173 particular log line is written to syslog. For lines that normally go to
17174 both the main log and the reject log, the reject log version (possibly
17175 containing message header lines) is written, at LOG_NOTICE priority.
17176 Lines that normally go to both the main and the panic log are written at
17177 the LOG_ALERT priority.
17178
17179
17180 .option syslog_facility main string unset
17181 .cindex "syslog" "facility; setting"
17182 This option sets the syslog &"facility"& name, used when Exim is logging to
17183 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17184 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17185 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17186 details of Exim's logging.
17187
17188
17189 .option syslog_pid main boolean true
17190 .cindex "syslog" "pid"
17191 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17192 omitted when these lines are sent to syslog. (Syslog normally prefixes
17193 the log lines with the PID of the logging process automatically.) You need
17194 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17195 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17196
17197
17198
17199 .option syslog_processname main string &`exim`&
17200 .cindex "syslog" "process name; setting"
17201 This option sets the syslog &"ident"& name, used when Exim is logging to
17202 syslog. The value must be no longer than 32 characters. See chapter
17203 &<<CHAPlog>>& for details of Exim's logging.
17204
17205
17206
17207 .option syslog_timestamp main boolean true
17208 .cindex "syslog" "timestamps"
17209 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17210 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17211 details of Exim's logging.
17212
17213
17214 .option system_filter main string&!! unset
17215 .cindex "filter" "system filter"
17216 .cindex "system filter" "specifying"
17217 .cindex "Sieve filter" "not available for system filter"
17218 This option specifies an Exim filter file that is applied to all messages at
17219 the start of each delivery attempt, before any routing is done. System filters
17220 must be Exim filters; they cannot be Sieve filters. If the system filter
17221 generates any deliveries to files or pipes, or any new mail messages, the
17222 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17223 which transports are to be used. Details of this facility are given in chapter
17224 &<<CHAPsystemfilter>>&.
17225 A forced expansion failure results in no filter operation.
17226
17227
17228 .option system_filter_directory_transport main string&!! unset
17229 .vindex "&$address_file$&"
17230 This sets the name of the transport driver that is to be used when the
17231 &%save%& command in a system message filter specifies a path ending in &"/"&,
17232 implying delivery of each message into a separate file in some directory.
17233 During the delivery, the variable &$address_file$& contains the path name.
17234
17235
17236 .option system_filter_file_transport main string&!! unset
17237 .cindex "file" "transport for system filter"
17238 This sets the name of the transport driver that is to be used when the &%save%&
17239 command in a system message filter specifies a path not ending in &"/"&. During
17240 the delivery, the variable &$address_file$& contains the path name.
17241
17242 .option system_filter_group main string unset
17243 .cindex "gid (group id)" "system filter"
17244 This option is used only when &%system_filter_user%& is also set. It sets the
17245 gid under which the system filter is run, overriding any gid that is associated
17246 with the user. The value may be numerical or symbolic.
17247
17248 .option system_filter_pipe_transport main string&!! unset
17249 .cindex "&(pipe)& transport" "for system filter"
17250 .vindex "&$address_pipe$&"
17251 This specifies the transport driver that is to be used when a &%pipe%& command
17252 is used in a system filter. During the delivery, the variable &$address_pipe$&
17253 contains the pipe command.
17254
17255
17256 .option system_filter_reply_transport main string&!! unset
17257 .cindex "&(autoreply)& transport" "for system filter"
17258 This specifies the transport driver that is to be used when a &%mail%& command
17259 is used in a system filter.
17260
17261
17262 .option system_filter_user main string unset
17263 .cindex "uid (user id)" "system filter"
17264 If this option is set to root, the system filter is run in the main Exim
17265 delivery process, as root.  Otherwise, the system filter runs in a separate
17266 process, as the given user, defaulting to the Exim run-time user.
17267 Unless the string consists entirely of digits, it
17268 is looked up in the password data. Failure to find the named user causes a
17269 configuration error. The gid is either taken from the password data, or
17270 specified by &%system_filter_group%&. When the uid is specified numerically,
17271 &%system_filter_group%& is required to be set.
17272
17273 If the system filter generates any pipe, file, or reply deliveries, the uid
17274 under which the filter is run is used when transporting them, unless a
17275 transport option overrides.
17276
17277
17278 .option tcp_nodelay main boolean true
17279 .cindex "daemon" "TCP_NODELAY on sockets"
17280 .cindex "Nagle algorithm"
17281 .cindex "TCP_NODELAY on listening sockets"
17282 If this option is set false, it stops the Exim daemon setting the
17283 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17284 turns off the &"Nagle algorithm"&, which is a way of improving network
17285 performance in interactive (character-by-character) situations. Turning it off
17286 should improve Exim's performance a bit, so that is what happens by default.
17287 However, it appears that some broken clients cannot cope, and time out. Hence
17288 this option. It affects only those sockets that are set up for listening by the
17289 daemon. Sockets created by the smtp transport for delivering mail always set
17290 TCP_NODELAY.
17291
17292
17293 .option timeout_frozen_after main time 0s
17294 .cindex "frozen messages" "timing out"
17295 .cindex "timeout" "frozen messages"
17296 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17297 message of any kind that has been on the queue for longer than the given time
17298 is automatically cancelled at the next queue run. If the frozen message is a
17299 bounce message, it is just discarded; otherwise, a bounce is sent to the
17300 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17301 If you want to timeout frozen bounce messages earlier than other kinds of
17302 frozen message, see &%ignore_bounce_errors_after%&.
17303
17304 &*Note:*& the default value of zero means no timeouts; with this setting,
17305 frozen messages remain on the queue forever (except for any frozen bounce
17306 messages that are released by &%ignore_bounce_errors_after%&).
17307
17308
17309 .option timezone main string unset
17310 .cindex "timezone, setting"
17311 .cindex "environment" "values from"
17312 The value of &%timezone%& is used to set the environment variable TZ while
17313 running Exim (if it is different on entry). This ensures that all timestamps
17314 created by Exim are in the required timezone. If you want all your timestamps
17315 to be in UTC (aka GMT) you should set
17316 .code
17317 timezone = UTC
17318 .endd
17319 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17320 or, if that is not set, from the value of the TZ environment variable when Exim
17321 is built. If &%timezone%& is set to the empty string, either at build or run
17322 time, any existing TZ variable is removed from the environment when Exim
17323 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17324 unfortunately not all, operating systems.
17325
17326
17327 .option tls_advertise_hosts main "host list&!!" *
17328 .cindex "TLS" "advertising"
17329 .cindex "encryption" "on SMTP connection"
17330 .cindex "SMTP" "encrypted connection"
17331 When Exim is built with support for TLS encrypted connections, the availability
17332 of the STARTTLS command to set up an encrypted session is advertised in
17333 response to EHLO only to those client hosts that match this option. See
17334 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17335 Note that the default value requires that a certificate be supplied
17336 using the &%tls_certificate%& option.  If TLS support for incoming connections
17337 is not required the &%tls_advertise_hosts%& option should be set empty.
17338
17339
17340 .option tls_certificate main string list&!! unset
17341 .cindex "TLS" "server certificate; location of"
17342 .cindex "certificate" "server, location of"
17343 The value of this option is expanded, and must then be a list of absolute paths to
17344 files which contains the server's certificates.  Commonly only one file is
17345 needed.
17346 The server's private key is also
17347 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17348 &<<CHAPTLS>>& for further details.
17349
17350 &*Note*&: The certificates defined by this option are used only when Exim is
17351 receiving incoming messages as a server. If you want to supply certificates for
17352 use when sending messages as a client, you must set the &%tls_certificate%&
17353 option in the relevant &(smtp)& transport.
17354
17355 &*Note*&: If you use filenames based on IP addresses, change the list
17356 separator in the usual way to avoid confusion under IPv6.
17357
17358 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
17359 when a list of more than one
17360 file is used, the &$tls_in_ourcert$& variable is unreliable.
17361
17362 &*Note*&: OCSP stapling is not usable under OpenSSL
17363 when a list of more than one file is used.
17364
17365 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17366 if the OpenSSL build supports TLS extensions and the TLS client sends the
17367 Server Name Indication extension, then this option and others documented in
17368 &<<SECTtlssni>>& will be re-expanded.
17369
17370 If this option is unset or empty a fresh self-signed certificate will be
17371 generated for every connection.
17372
17373 .option tls_crl main string&!! unset
17374 .cindex "TLS" "server certificate revocation list"
17375 .cindex "certificate" "revocation list for server"
17376 This option specifies a certificate revocation list. The expanded value must
17377 be the name of a file that contains CRLs in PEM format.
17378
17379 Under OpenSSL the option can specify a directory with CRL files.
17380
17381 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
17382 for each signing element of the certificate chain (i.e. all but the leaf).
17383 For the file variant this can be multiple PEM blocks in the one file.
17384
17385 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17386
17387
17388 .option tls_dh_max_bits main integer 2236
17389 .cindex "TLS" "D-H bit count"
17390 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17391 the chosen TLS library.  That value might prove to be too high for
17392 interoperability.  This option provides a maximum clamp on the value
17393 suggested, trading off security for interoperability.
17394
17395 The value must be at least 1024.
17396
17397 The value 2236 was chosen because, at time of adding the option, it was the
17398 hard-coded maximum value supported by the NSS cryptographic library, as used
17399 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17400
17401 If you prefer more security and are willing to break some clients, raise this
17402 number.
17403
17404 Note that the value passed to GnuTLS for *generating* a new prime may be a
17405 little less than this figure, because GnuTLS is inexact and may produce a
17406 larger prime than requested.
17407
17408
17409 .option tls_dhparam main string&!! unset
17410 .cindex "TLS" "D-H parameters for server"
17411 The value of this option is expanded and indicates the source of DH parameters
17412 to be used by Exim.
17413
17414 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
17415 local DH parameters*&, which has been supported across all versions of Exim.  The
17416 other specific constants available are a fallback so that even when
17417 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17418
17419 If &%tls_dhparam%& is a filename starting with a &`/`&,
17420 then it names a file from which DH
17421 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17422 PKCS#3 representation of the DH prime.  If the file does not exist, for
17423 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17424 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17425 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17426 and treated as though the &%tls_dhparam%& were set to "none".
17427
17428 If this option expands to the string "none", then no DH parameters will be
17429 loaded by Exim.
17430
17431 If this option expands to the string "historic" and Exim is using GnuTLS, then
17432 Exim will attempt to load a file from inside the spool directory.  If the file
17433 does not exist, Exim will attempt to create it.
17434 See section &<<SECTgnutlsparam>>& for further details.
17435
17436 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17437 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17438
17439 In older versions of Exim the default was the 2048 bit prime described in section
17440 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17441 in IKE is assigned number 23.
17442
17443 Otherwise, the option must expand to the name used by Exim for any of a number
17444 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17445 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17446 the number used by IKE, or "default" which corresponds to
17447 &`exim.dev.20160529.3`&.
17448
17449 The available standard primes are:
17450 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17451 &`ike1`&, &`ike2`&, &`ike5`&,
17452 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17453 &`ike22`&, &`ike23`& and &`ike24`&.
17454
17455 The available additional primes are:
17456 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17457
17458 Some of these will be too small to be accepted by clients.
17459 Some may be too large to be accepted by clients.
17460 The open cryptographic community has suspicions about the integrity of some
17461 of the later IKE values, which led into RFC7919 providing new fixed constants
17462 (the "ffdhe" identifiers).
17463
17464 At this point, all of the "ike" values should be considered obsolete;
17465 they're still in Exim to avoid breaking unusual configurations, but are
17466 candidates for removal the next time we have backwards-incompatible changes.
17467
17468 The TLS protocol does not negotiate an acceptable size for this; clients tend
17469 to hard-drop connections if what is offered by the server is unacceptable,
17470 whether too large or too small, and there's no provision for the client to
17471 tell the server what these constraints are.  Thus, as a server operator, you
17472 need to make an educated guess as to what is most likely to work for your
17473 userbase.
17474
17475 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17476 is most likely to maximise interoperability.  The upper bound comes from
17477 applications using the Mozilla Network Security Services (NSS) library, which
17478 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17479 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17480 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17481 acceptable bound from 1024 to 2048.
17482
17483
17484 .option tls_eccurve main string&!! &`auto`&
17485 .cindex TLS "EC cryptography"
17486 This option selects a EC curve for use by Exim when used with OpenSSL.
17487 It has no effect when Exim is used with GnuTLS.
17488
17489 After expansion it must contain a valid EC curve parameter, such as
17490 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17491 for valid selections.
17492
17493 For OpenSSL versions before (and not including) 1.0.2, the string
17494 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17495 &`auto`& tells the library to choose.
17496
17497 If the option expands to an empty string, no EC curves will be enabled.
17498
17499
17500 .option tls_ocsp_file main string&!! unset
17501 .cindex TLS "certificate status"
17502 .cindex TLS "OCSP proof file"
17503 This option
17504 must if set expand to the absolute path to a file which contains a current
17505 status proof for the server's certificate, as obtained from the
17506 Certificate Authority.
17507
17508 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17509
17510 For GnuTLS 3.5.6 or later the expanded value of this option can be a list
17511 of files, to match a list given for the &%tls_certificate%& option.
17512 The ordering of the two lists must match.
17513
17514
17515 .option tls_on_connect_ports main "string list" unset
17516 .cindex SSMTP
17517 .cindex SMTPS
17518 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17519 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
17520 set up without waiting for the client to issue a STARTTLS command. For
17521 further details, see section &<<SECTsupobssmt>>&.
17522
17523
17524
17525 .option tls_privatekey main string list&!! unset
17526 .cindex "TLS" "server private key; location of"
17527 The value of this option is expanded, and must then be a list of absolute paths to
17528 files which contains the server's private keys.
17529 If this option is unset, or if
17530 the expansion is forced to fail, or the result is an empty string, the private
17531 key is assumed to be in the same file as the server's certificates. See chapter
17532 &<<CHAPTLS>>& for further details.
17533
17534 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17535
17536
17537 .option tls_remember_esmtp main boolean false
17538 .cindex "TLS" "esmtp state; remembering"
17539 .cindex "TLS" "broken clients"
17540 If this option is set true, Exim violates the RFCs by remembering that it is in
17541 &"esmtp"& state after successfully negotiating a TLS session. This provides
17542 support for broken clients that fail to send a new EHLO after starting a
17543 TLS session.
17544
17545
17546 .option tls_require_ciphers main string&!! unset
17547 .cindex "TLS" "requiring specific ciphers"
17548 .cindex "cipher" "requiring specific"
17549 This option controls which ciphers can be used for incoming TLS connections.
17550 The &(smtp)& transport has an option of the same name for controlling outgoing
17551 connections. This option is expanded for each connection, so can be varied for
17552 different clients if required. The value of this option must be a list of
17553 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17554 in somewhat different ways. If GnuTLS is being used, the client controls the
17555 preference order of the available ciphers. Details are given in sections
17556 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17557
17558
17559 .option tls_try_verify_hosts main "host list&!!" unset
17560 .cindex "TLS" "client certificate verification"
17561 .cindex "certificate" "verification of client"
17562 See &%tls_verify_hosts%& below.
17563
17564
17565 .option tls_verify_certificates main string&!! system
17566 .cindex "TLS" "client certificate verification"
17567 .cindex "certificate" "verification of client"
17568 The value of this option is expanded, and must then be either the
17569 word "system"
17570 or the absolute path to
17571 a file or directory containing permitted certificates for clients that
17572 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17573
17574 The "system" value for the option will use a
17575 system default location compiled into the SSL library.
17576 This is not available for GnuTLS versions preceding 3.0.20,
17577 and will be taken as empty; an explicit location
17578 must be specified.
17579
17580 The use of a directory for the option value is not available for GnuTLS versions
17581 preceding 3.3.6 and a single file must be used.
17582
17583 With OpenSSL the certificates specified
17584 explicitly
17585 either by file or directory
17586 are added to those given by the system default location.
17587
17588 These certificates should be for the certificate authorities trusted, rather
17589 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17590 the value is a file then the certificates are sent by Exim as a server to
17591 connecting clients, defining the list of accepted certificate authorities.
17592 Thus the values defined should be considered public data.  To avoid this,
17593 use the explicit directory version.
17594
17595 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17596
17597 A forced expansion failure or setting to an empty string is equivalent to
17598 being unset.
17599
17600
17601 .option tls_verify_hosts main "host list&!!" unset
17602 .cindex "TLS" "client certificate verification"
17603 .cindex "certificate" "verification of client"
17604 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17605 certificates from clients. The expected certificates are defined by
17606 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17607 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17608 &%tls_verify_certificates%& is not set.
17609
17610 Any client that matches &%tls_verify_hosts%& is constrained by
17611 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17612 present one of the listed certificates. If it does not, the connection is
17613 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17614 the host to use TLS. It can still send SMTP commands through unencrypted
17615 connections. Forcing a client to use TLS has to be done separately using an
17616 ACL to reject inappropriate commands when the connection is not encrypted.
17617
17618 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17619 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17620 certificate and checks it against &%tls_verify_certificates%&, but does not
17621 abort the connection if there is no certificate or if it does not match. This
17622 state can be detected in an ACL, which makes it possible to implement policies
17623 such as &"accept for relay only if a verified certificate has been received,
17624 but accept for local delivery if encrypted, even without a verified
17625 certificate"&.
17626
17627 Client hosts that match neither of these lists are not asked to present
17628 certificates.
17629
17630
17631 .option trusted_groups main "string list&!!" unset
17632 .cindex "trusted groups"
17633 .cindex "groups" "trusted"
17634 This option is expanded just once, at the start of Exim's processing. If this
17635 option is set, any process that is running in one of the listed groups, or
17636 which has one of them as a supplementary group, is trusted. The groups can be
17637 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17638 details of what trusted callers are permitted to do. If neither
17639 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17640 are trusted.
17641
17642 .option trusted_users main "string list&!!" unset
17643 .cindex "trusted users"
17644 .cindex "user" "trusted"
17645 This option is expanded just once, at the start of Exim's processing. If this
17646 option is set, any process that is running as one of the listed users is
17647 trusted. The users can be specified numerically or by name. See section
17648 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17649 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17650 Exim user are trusted.
17651
17652 .option unknown_login main string&!! unset
17653 .cindex "uid (user id)" "unknown caller"
17654 .vindex "&$caller_uid$&"
17655 This is a specialized feature for use in unusual configurations. By default, if
17656 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17657 gives up. The &%unknown_login%& option can be used to set a login name to be
17658 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17659 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17660 is used for the user's real name (gecos field), unless this has been set by the
17661 &%-F%& option.
17662
17663 .option unknown_username main string unset
17664 See &%unknown_login%&.
17665
17666 .option untrusted_set_sender main "address list&!!" unset
17667 .cindex "trusted users"
17668 .cindex "sender" "setting by untrusted user"
17669 .cindex "untrusted user setting sender"
17670 .cindex "user" "untrusted setting sender"
17671 .cindex "envelope sender"
17672 When an untrusted user submits a message to Exim using the standard input, Exim
17673 normally creates an envelope sender address from the user's login and the
17674 default qualification domain. Data from the &%-f%& option (for setting envelope
17675 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17676 is used) is ignored.
17677
17678 However, untrusted users are permitted to set an empty envelope sender address,
17679 to declare that a message should never generate any bounces. For example:
17680 .code
17681 exim -f '<>' user@domain.example
17682 .endd
17683 .vindex "&$sender_ident$&"
17684 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17685 other envelope sender addresses in a controlled way. When it is set, untrusted
17686 users are allowed to set envelope sender addresses that match any of the
17687 patterns in the list. Like all address lists, the string is expanded. The
17688 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17689 users to setting senders that start with their login ids
17690 followed by a hyphen
17691 by a setting like this:
17692 .code
17693 untrusted_set_sender = ^$sender_ident-
17694 .endd
17695 If you want to allow untrusted users to set envelope sender addresses without
17696 restriction, you can use
17697 .code
17698 untrusted_set_sender = *
17699 .endd
17700 The &%untrusted_set_sender%& option applies to all forms of local input, but
17701 only to the setting of the envelope sender. It does not permit untrusted users
17702 to use the other options which trusted user can use to override message
17703 parameters. Furthermore, it does not stop Exim from removing an existing
17704 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17705 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17706 overriding these actions. The handling of the &'Sender:'& header is also
17707 described in section &<<SECTthesenhea>>&.
17708
17709 The log line for a message's arrival shows the envelope sender following
17710 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17711 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17712 envelope sender address, the user's login is shown in parentheses after the
17713 sender address.
17714
17715
17716 .option uucp_from_pattern main string "see below"
17717 .cindex "&""From""& line"
17718 .cindex "UUCP" "&""From""& line"
17719 Some applications that pass messages to an MTA via a command line interface use
17720 an initial line starting with &"From&~"& to pass the envelope sender. In
17721 particular, this is used by UUCP software. Exim recognizes such a line by means
17722 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17723 matches, the sender address is constructed by expanding the contents of
17724 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17725 default pattern recognizes lines in the following two forms:
17726 .code
17727 From ph10 Fri Jan  5 12:35 GMT 1996
17728 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17729 .endd
17730 The pattern can be seen by running
17731 .code
17732 exim -bP uucp_from_pattern
17733 .endd
17734 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17735 year in the second case. The first word after &"From&~"& is matched in the
17736 regular expression by a parenthesized subpattern. The default value for
17737 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17738 (&"ph10"& in the example above) as the message's sender. See also
17739 &%ignore_fromline_hosts%&.
17740
17741
17742 .option uucp_from_sender main string&!! &`$1`&
17743 See &%uucp_from_pattern%& above.
17744
17745
17746 .option warn_message_file main string unset
17747 .cindex "warning of delay" "customizing the message"
17748 .cindex "customizing" "warning message"
17749 This option defines a template file containing paragraphs of text to be used
17750 for constructing the warning message which is sent by Exim when a message has
17751 been on the queue for a specified amount of time, as specified by
17752 &%delay_warning%&. Details of the file's contents are given in chapter
17753 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
17754
17755
17756 .option write_rejectlog main boolean true
17757 .cindex "reject log" "disabling"
17758 If this option is set false, Exim no longer writes anything to the reject log.
17759 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
17760 .ecindex IIDconfima
17761 .ecindex IIDmaiconf
17762
17763
17764
17765
17766 . ////////////////////////////////////////////////////////////////////////////
17767 . ////////////////////////////////////////////////////////////////////////////
17768
17769 .chapter "Generic options for routers" "CHAProutergeneric"
17770 .scindex IIDgenoprou1 "options" "generic; for routers"
17771 .scindex IIDgenoprou2 "generic options" "router"
17772 This chapter describes the generic options that apply to all routers.
17773 Those that are preconditions are marked with &Dagger; in the &"use"& field.
17774
17775 For a general description of how a router operates, see sections
17776 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
17777 which the preconditions are tested. The order of expansion of the options that
17778 provide data for a transport is: &%errors_to%&, &%headers_add%&,
17779 &%headers_remove%&, &%transport%&.
17780
17781
17782
17783 .option address_data routers string&!! unset
17784 .cindex "router" "data attached to address"
17785 The string is expanded just before the router is run, that is, after all the
17786 precondition tests have succeeded. If the expansion is forced to fail, the
17787 router declines, the value of &%address_data%& remains unchanged, and the
17788 &%more%& option controls what happens next. Other expansion failures cause
17789 delivery of the address to be deferred.
17790
17791 .vindex "&$address_data$&"
17792 When the expansion succeeds, the value is retained with the address, and can be
17793 accessed using the variable &$address_data$& in the current router, subsequent
17794 routers, and the eventual transport.
17795
17796 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
17797 that runs a user's filter file, the contents of &$address_data$& are accessible
17798 in the filter. This is not normally a problem, because such data is usually
17799 either not confidential or it &"belongs"& to the current user, but if you do
17800 put confidential data into &$address_data$& you need to remember this point.
17801
17802 Even if the router declines or passes, the value of &$address_data$& remains
17803 with the address, though it can be changed by another &%address_data%& setting
17804 on a subsequent router. If a router generates child addresses, the value of
17805 &$address_data$& propagates to them. This also applies to the special kind of
17806 &"child"& that is generated by a router with the &%unseen%& option.
17807
17808 The idea of &%address_data%& is that you can use it to look up a lot of data
17809 for the address once, and then pick out parts of the data later. For example,
17810 you could use a single LDAP lookup to return a string of the form
17811 .code
17812 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
17813 .endd
17814 In the transport you could pick out the mailbox by a setting such as
17815 .code
17816 file = ${extract{mailbox}{$address_data}}
17817 .endd
17818 This makes the configuration file less messy, and also reduces the number of
17819 lookups (though Exim does cache lookups).
17820
17821 .vindex "&$sender_address_data$&"
17822 .vindex "&$address_data$&"
17823 The &%address_data%& facility is also useful as a means of passing information
17824 from one router to another, and from a router to a transport. In addition, if
17825 &$address_data$& is set by a router when verifying a recipient address from an
17826 ACL, it remains available for use in the rest of the ACL statement. After
17827 verifying a sender, the value is transferred to &$sender_address_data$&.
17828
17829
17830
17831 .option address_test routers&!? boolean true
17832 .oindex "&%-bt%&"
17833 .cindex "router" "skipping when address testing"
17834 If this option is set false, the router is skipped when routing is being tested
17835 by means of the &%-bt%& command line option. This can be a convenience when
17836 your first router sends messages to an external scanner, because it saves you
17837 having to set the &"already scanned"& indicator when testing real address
17838 routing.
17839
17840
17841
17842 .option cannot_route_message routers string&!! unset
17843 .cindex "router" "customizing &""cannot route""& message"
17844 .cindex "customizing" "&""cannot route""& message"
17845 This option specifies a text message that is used when an address cannot be
17846 routed because Exim has run out of routers. The default message is
17847 &"Unrouteable address"&. This option is useful only on routers that have
17848 &%more%& set false, or on the very last router in a configuration, because the
17849 value that is used is taken from the last router that is considered. This
17850 includes a router that is skipped because its preconditions are not met, as
17851 well as a router that declines. For example, using the default configuration,
17852 you could put:
17853 .code
17854 cannot_route_message = Remote domain not found in DNS
17855 .endd
17856 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17857 and
17858 .code
17859 cannot_route_message = Unknown local user
17860 .endd
17861 on the final router that checks for local users. If string expansion fails for
17862 this option, the default message is used. Unless the expansion failure was
17863 explicitly forced, a message about the failure is written to the main and panic
17864 logs, in addition to the normal message about the routing failure.
17865
17866
17867 .option caseful_local_part routers boolean false
17868 .cindex "case of local parts"
17869 .cindex "router" "case of local parts"
17870 By default, routers handle the local parts of addresses in a case-insensitive
17871 manner, though the actual case is preserved for transmission with the message.
17872 If you want the case of letters to be significant in a router, you must set
17873 this option true. For individual router options that contain address or local
17874 part lists (for example, &%local_parts%&), case-sensitive matching can be
17875 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
17876 more details.
17877
17878 .vindex "&$local_part$&"
17879 .vindex "&$original_local_part$&"
17880 .vindex "&$parent_local_part$&"
17881 The value of the &$local_part$& variable is forced to lower case while a
17882 router is running unless &%caseful_local_part%& is set. When a router assigns
17883 an address to a transport, the value of &$local_part$& when the transport runs
17884 is the same as it was in the router. Similarly, when a router generates child
17885 addresses by aliasing or forwarding, the values of &$original_local_part$&
17886 and &$parent_local_part$& are those that were used by the redirecting router.
17887
17888 This option applies to the processing of an address by a router. When a
17889 recipient address is being processed in an ACL, there is a separate &%control%&
17890 modifier that can be used to specify case-sensitive processing within the ACL
17891 (see section &<<SECTcontrols>>&).
17892
17893
17894
17895 .option check_local_user routers&!? boolean false
17896 .cindex "local user, checking in router"
17897 .cindex "router" "checking for local user"
17898 .cindex "&_/etc/passwd_&"
17899 .vindex "&$home$&"
17900 When this option is true, Exim checks that the local part of the recipient
17901 address (with affixes removed if relevant) is the name of an account on the
17902 local system. The check is done by calling the &[getpwnam()]& function rather
17903 than trying to read &_/etc/passwd_& directly. This means that other methods of
17904 holding password data (such as NIS) are supported. If the local part is a local
17905 user, &$home$& is set from the password data, and can be tested in other
17906 preconditions that are evaluated after this one (the order of evaluation is
17907 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17908 overridden by &%router_home_directory%&. If the local part is not a local user,
17909 the router is skipped.
17910
17911 If you want to check that the local part is either the name of a local user
17912 or matches something else, you cannot combine &%check_local_user%& with a
17913 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17914 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17915 setting to achieve this. For example:
17916 .code
17917 local_parts = passwd;$local_part : lsearch;/etc/other/users
17918 .endd
17919 Note, however, that the side effects of &%check_local_user%& (such as setting
17920 up a home directory) do not occur when a &(passwd)& lookup is used in a
17921 &%local_parts%& (or any other) precondition.
17922
17923
17924
17925 .option condition routers&!? string&!! unset
17926 .cindex "router" "customized precondition"
17927 This option specifies a general precondition test that has to succeed for the
17928 router to be called. The &%condition%& option is the last precondition to be
17929 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17930 result is a forced failure, or an empty string, or one of the strings &"0"& or
17931 &"no"& or &"false"& (checked without regard to the case of the letters), the
17932 router is skipped, and the address is offered to the next one.
17933
17934 If the result is any other value, the router is run (as this is the last
17935 precondition to be evaluated, all the other preconditions must be true).
17936
17937 This option is unusual in that multiple &%condition%& options may be present.
17938 All &%condition%& options must succeed.
17939
17940 The &%condition%& option provides a means of applying custom conditions to the
17941 running of routers. Note that in the case of a simple conditional expansion,
17942 the default expansion values are exactly what is wanted. For example:
17943 .code
17944 condition = ${if >{$message_age}{600}}
17945 .endd
17946 Because of the default behaviour of the string expansion, this is equivalent to
17947 .code
17948 condition = ${if >{$message_age}{600}{true}{}}
17949 .endd
17950
17951 A multiple condition example, which succeeds:
17952 .code
17953 condition = ${if >{$message_age}{600}}
17954 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17955 condition = foobar
17956 .endd
17957
17958 If the expansion fails (other than forced failure) delivery is deferred. Some
17959 of the other precondition options are common special cases that could in fact
17960 be specified using &%condition%&.
17961
17962 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17963 are far older, and use one set of semantics.  ACLs are newer and when
17964 they were created, the ACL &%condition%& process was given far stricter
17965 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17966 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17967 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17968 Router rules processing behavior.
17969
17970 This is best illustrated in an example:
17971 .code
17972 # If used in an ACL condition will fail with a syntax error, but
17973 # in a router condition any extra characters are treated as a string
17974
17975 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17976 true {yes} {no}}
17977
17978 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17979  {yes} {no}}
17980 .endd
17981 In each example above, the &%if%& statement actually ends after
17982 &"{google.com}}"&.  Since no true or false braces were defined, the
17983 default &%if%& behavior is to return a boolean true or a null answer
17984 (which evaluates to false). The rest of the line is then treated as a
17985 string. So the first example resulted in the boolean answer &"true"&
17986 with the string &" {yes} {no}}"& appended to it. The second example
17987 resulted in the null output (indicating false) with the string
17988 &" {yes} {no}}"& appended to it.
17989
17990 In fact you can put excess forward braces in too.  In the router
17991 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17992 mean something, like after a &"$"& or when required as part of a
17993 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17994 string characters.
17995
17996 Thus, in a Router, the above expansion strings will both always evaluate
17997 true, as the result of expansion is a non-empty string which doesn't
17998 match an explicit false value.  This can be tricky to debug.  By
17999 contrast, in an ACL either of those strings will always result in an
18000 expansion error because the result doesn't look sufficiently boolean.
18001
18002
18003 .option debug_print routers string&!! unset
18004 .cindex "testing" "variables in drivers"
18005 If this option is set and debugging is enabled (see the &%-d%& command line
18006 option) or in address-testing mode (see the &%-bt%& command line option),
18007 the string is expanded and included in the debugging output.
18008 If expansion of the string fails, the error message is written to the debugging
18009 output, and Exim carries on processing.
18010 This option is provided to help with checking out the values of variables and
18011 so on when debugging router configurations. For example, if a &%condition%&
18012 option appears not to be working, &%debug_print%& can be used to output the
18013 variables it references. The output happens after checks for &%domains%&,
18014 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18015 are tested. A newline is added to the text if it does not end with one.
18016 The variable &$router_name$& contains the name of the router.
18017
18018
18019
18020 .option disable_logging routers boolean false
18021 If this option is set true, nothing is logged for any routing errors
18022 or for any deliveries caused by this router. You should not set this option
18023 unless you really, really know what you are doing. See also the generic
18024 transport option of the same name.
18025
18026 .option dnssec_request_domains routers "domain list&!!" unset
18027 .cindex "MX record" "security"
18028 .cindex "DNSSEC" "MX lookup"
18029 .cindex "security" "MX lookup"
18030 .cindex "DNS" "DNSSEC"
18031 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18032 the dnssec request bit set.
18033 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18034
18035 .option dnssec_require_domains routers "domain list&!!" unset
18036 .cindex "MX record" "security"
18037 .cindex "DNSSEC" "MX lookup"
18038 .cindex "security" "MX lookup"
18039 .cindex "DNS" "DNSSEC"
18040 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18041 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18042 (AD bit) set will be ignored and logged as a host-lookup failure.
18043 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18044
18045
18046 .option domains routers&!? "domain list&!!" unset
18047 .cindex "router" "restricting to specific domains"
18048 .vindex "&$domain_data$&"
18049 If this option is set, the router is skipped unless the current domain matches
18050 the list. If the match is achieved by means of a file lookup, the data that the
18051 lookup returned for the domain is placed in &$domain_data$& for use in string
18052 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18053 a list of the order in which preconditions are evaluated.
18054
18055
18056
18057 .option driver routers string unset
18058 This option must always be set. It specifies which of the available routers is
18059 to be used.
18060
18061
18062 .option dsn_lasthop routers boolean false
18063 .cindex "DSN" "success"
18064 .cindex "Delivery Status Notification" "success"
18065 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18066 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18067 instead send a success DSN as if the next hop does not support DSN.
18068 Not effective on redirect routers.
18069
18070
18071
18072 .option errors_to routers string&!! unset
18073 .cindex "envelope sender"
18074 .cindex "router" "changing address for errors"
18075 If a router successfully handles an address, it may assign the address to a
18076 transport for delivery or it may generate child addresses. In both cases, if
18077 there is a delivery problem during later processing, the resulting bounce
18078 message is sent to the address that results from expanding this string,
18079 provided that the address verifies successfully. The &%errors_to%& option is
18080 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18081
18082 The &%errors_to%& setting associated with an address can be overridden if it
18083 subsequently passes through other routers that have their own &%errors_to%&
18084 settings, or if the message is delivered by a transport with a &%return_path%&
18085 setting.
18086
18087 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18088 the expansion fails to verify, the errors address associated with the incoming
18089 address is used. At top level, this is the envelope sender. A non-forced
18090 expansion failure causes delivery to be deferred.
18091
18092 If an address for which &%errors_to%& has been set ends up being delivered over
18093 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18094 any bounces that are generated by other MTAs on the delivery route are also
18095 sent there. You can set &%errors_to%& to the empty string by either of these
18096 settings:
18097 .code
18098 errors_to =
18099 errors_to = ""
18100 .endd
18101 An expansion item that yields an empty string has the same effect. If you do
18102 this, a locally detected delivery error for addresses processed by this router
18103 no longer gives rise to a bounce message; the error is discarded. If the
18104 address is delivered to a remote host, the return path is set to &`<>`&, unless
18105 overridden by the &%return_path%& option on the transport.
18106
18107 .vindex "&$address_data$&"
18108 If for some reason you want to discard local errors, but use a non-empty
18109 MAIL command for remote delivery, you can preserve the original return
18110 path in &$address_data$& in the router, and reinstate it in the transport by
18111 setting &%return_path%&.
18112
18113 The most common use of &%errors_to%& is to direct mailing list bounces to the
18114 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18115 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18116
18117
18118
18119 .option expn routers&!? boolean true
18120 .cindex "address" "testing"
18121 .cindex "testing" "addresses"
18122 .cindex "EXPN" "router skipping"
18123 .cindex "router" "skipping for EXPN"
18124 If this option is turned off, the router is skipped when testing an address
18125 as a result of processing an SMTP EXPN command. You might, for example,
18126 want to turn it off on a router for users' &_.forward_& files, while leaving it
18127 on for the system alias file.
18128 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18129 are evaluated.
18130
18131 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18132 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18133 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18134
18135
18136
18137 .option fail_verify routers boolean false
18138 .cindex "router" "forcing verification failure"
18139 Setting this option has the effect of setting both &%fail_verify_sender%& and
18140 &%fail_verify_recipient%& to the same value.
18141
18142
18143
18144 .option fail_verify_recipient routers boolean false
18145 If this option is true and an address is accepted by this router when
18146 verifying a recipient, verification fails.
18147
18148
18149
18150 .option fail_verify_sender routers boolean false
18151 If this option is true and an address is accepted by this router when
18152 verifying a sender, verification fails.
18153
18154
18155
18156 .option fallback_hosts routers "string list" unset
18157 .cindex "router" "fallback hosts"
18158 .cindex "fallback" "hosts specified on router"
18159 String expansion is not applied to this option. The argument must be a
18160 colon-separated list of host names or IP addresses. The list separator can be
18161 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
18162 each name or address. In fact, the format of each item is exactly the same as
18163 defined for the list of hosts in a &(manualroute)& router (see section
18164 &<<SECTformatonehostitem>>&).
18165
18166 If a router queues an address for a remote transport, this host list is
18167 associated with the address, and used instead of the transport's fallback host
18168 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18169 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18170 transport for further details.
18171
18172
18173 .option group routers string&!! "see below"
18174 .cindex "gid (group id)" "local delivery"
18175 .cindex "local transports" "uid and gid"
18176 .cindex "transport" "local"
18177 .cindex "router" "setting group"
18178 When a router queues an address for a transport, and the transport does not
18179 specify a group, the group given here is used when running the delivery
18180 process.
18181 The group may be specified numerically or by name. If expansion fails, the
18182 error is logged and delivery is deferred.
18183 The default is unset, unless &%check_local_user%& is set, when the default
18184 is taken from the password information. See also &%initgroups%& and &%user%&
18185 and the discussion in chapter &<<CHAPenvironment>>&.
18186
18187
18188
18189 .option headers_add routers list&!! unset
18190 .cindex "header lines" "adding"
18191 .cindex "router" "adding header lines"
18192 This option specifies a list of text headers,
18193 newline-separated (by default, changeable in the usual way),
18194 that is associated with any addresses that are accepted by the router.
18195 Each item is separately expanded, at routing time.  However, this
18196 option has no effect when an address is just being verified. The way in which
18197 the text is used to add header lines at transport time is described in section
18198 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18199 message is in the process of being transported. This means that references to
18200 header lines in string expansions in the transport's configuration do not
18201 &"see"& the added header lines.
18202
18203 The &%headers_add%& option is expanded after &%errors_to%&, but before
18204 &%headers_remove%& and &%transport%&. If an item is empty, or if
18205 an item expansion is forced to fail, the item has no effect. Other expansion
18206 failures are treated as configuration errors.
18207
18208 Unlike most options, &%headers_add%& can be specified multiple times
18209 for a router; all listed headers are added.
18210
18211 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
18212 router that has the &%one_time%& option set.
18213
18214 .cindex "duplicate addresses"
18215 .oindex "&%unseen%&"
18216 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18217 additions are deleted when the address is passed on to subsequent routers.
18218 For a &%redirect%& router, if a generated address is the same as the incoming
18219 address, this can lead to duplicate addresses with different header
18220 modifications. Exim does not do duplicate deliveries (except, in certain
18221 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
18222 which of the duplicates is discarded, so this ambiguous situation should be
18223 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
18224
18225
18226
18227 .option headers_remove routers list&!! unset
18228 .cindex "header lines" "removing"
18229 .cindex "router" "removing header lines"
18230 This option specifies a list of text headers,
18231 colon-separated (by default, changeable in the usual way),
18232 that is associated with any addresses that are accepted by the router.
18233 Each item is separately expanded, at routing time.  However, this
18234 option has no effect when an address is just being verified. The way in which
18235 the text is used to remove header lines at transport time is described in
18236 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
18237 the message is in the process of being transported. This means that references
18238 to header lines in string expansions in the transport's configuration still
18239 &"see"& the original header lines.
18240
18241 The &%headers_remove%& option is expanded after &%errors_to%& and
18242 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
18243 the item has no effect. Other expansion failures are treated as configuration
18244 errors.
18245
18246 Unlike most options, &%headers_remove%& can be specified multiple times
18247 for a router; all listed headers are removed.
18248
18249 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
18250 router that has the &%one_time%& option set.
18251
18252 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18253 removal requests are deleted when the address is passed on to subsequent
18254 routers, and this can lead to problems with duplicates -- see the similar
18255 warning for &%headers_add%& above.
18256
18257 &*Warning 3*&: Because of the separate expansion of the list items,
18258 items that contain a list separator must have it doubled.
18259 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18260
18261
18262
18263 .option ignore_target_hosts routers "host list&!!" unset
18264 .cindex "IP address" "discarding"
18265 .cindex "router" "discarding IP addresses"
18266 Although this option is a host list, it should normally contain IP address
18267 entries rather than names. If any host that is looked up by the router has an
18268 IP address that matches an item in this list, Exim behaves as if that IP
18269 address did not exist. This option allows you to cope with rogue DNS entries
18270 like
18271 .code
18272 remote.domain.example.  A  127.0.0.1
18273 .endd
18274 by setting
18275 .code
18276 ignore_target_hosts = 127.0.0.1
18277 .endd
18278 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18279 discarded in this way, the router declines. In a conventional configuration, an
18280 attempt to mail to such a domain would normally provoke the &"unrouteable
18281 domain"& error, and an attempt to verify an address in the domain would fail.
18282 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18283 router declines if presented with one of the listed addresses.
18284
18285 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18286 means of the first or the second of the following settings, respectively:
18287 .code
18288 ignore_target_hosts = 0.0.0.0/0
18289 ignore_target_hosts = <; 0::0/0
18290 .endd
18291 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18292 in the second line matches all IPv6 addresses.
18293
18294 This option may also be useful for ignoring link-local and site-local IPv6
18295 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18296 is expanded before use as a list, it is possible to make it dependent on the
18297 domain that is being routed.
18298
18299 .vindex "&$host_address$&"
18300 During its expansion, &$host_address$& is set to the IP address that is being
18301 checked.
18302
18303 .option initgroups routers boolean false
18304 .cindex "additional groups"
18305 .cindex "groups" "additional"
18306 .cindex "local transports" "uid and gid"
18307 .cindex "transport" "local"
18308 If the router queues an address for a transport, and this option is true, and
18309 the uid supplied by the router is not overridden by the transport, the
18310 &[initgroups()]& function is called when running the transport to ensure that
18311 any additional groups associated with the uid are set up. See also &%group%&
18312 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18313
18314
18315
18316 .option local_part_prefix routers&!? "string list" unset
18317 .cindex affix "router precondition"
18318 .cindex "router" "prefix for local part"
18319 .cindex "prefix" "for local part, used in router"
18320 If this option is set, the router is skipped unless the local part starts with
18321 one of the given strings, or &%local_part_prefix_optional%& is true. See
18322 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18323 evaluated.
18324
18325 The list is scanned from left to right, and the first prefix that matches is
18326 used. A limited form of wildcard is available; if the prefix begins with an
18327 asterisk, it matches the longest possible sequence of arbitrary characters at
18328 the start of the local part. An asterisk should therefore always be followed by
18329 some character that does not occur in normal local parts.
18330 .cindex "multiple mailboxes"
18331 .cindex "mailbox" "multiple"
18332 Wildcarding can be used to set up multiple user mailboxes, as described in
18333 section &<<SECTmulbox>>&.
18334
18335 .vindex "&$local_part$&"
18336 .vindex "&$local_part_prefix$&"
18337 During the testing of the &%local_parts%& option, and while the router is
18338 running, the prefix is removed from the local part, and is available in the
18339 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18340 the router accepts the address, this remains true during subsequent delivery by
18341 a transport. In particular, the local part that is transmitted in the RCPT
18342 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18343 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18344 the relevant transport.
18345
18346 When an address is being verified, &%local_part_prefix%& affects only the
18347 behaviour of the router. If the callout feature of verification is in use, this
18348 means that the full address, including the prefix, will be used during the
18349 callout.
18350
18351 The prefix facility is commonly used to handle local parts of the form
18352 &%owner-something%&. Another common use is to support local parts of the form
18353 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18354 to tell a user their forwarding is broken &-- by placing a router like this one
18355 immediately before the router that handles &_.forward_& files:
18356 .code
18357 real_localuser:
18358   driver = accept
18359   local_part_prefix = real-
18360   check_local_user
18361   transport = local_delivery
18362 .endd
18363 For security, it would probably be a good idea to restrict the use of this
18364 router to locally-generated messages, using a condition such as this:
18365 .code
18366   condition = ${if match {$sender_host_address}\
18367                          {\N^(|127\.0\.0\.1)$\N}}
18368 .endd
18369
18370 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18371 both conditions must be met if not optional. Care must be taken if wildcards
18372 are used in both a prefix and a suffix on the same router. Different
18373 separator characters must be used to avoid ambiguity.
18374
18375
18376 .option local_part_prefix_optional routers boolean false
18377 See &%local_part_prefix%& above.
18378
18379
18380
18381 .option local_part_suffix routers&!? "string list" unset
18382 .cindex "router" "suffix for local part"
18383 .cindex "suffix for local part" "used in router"
18384 This option operates in the same way as &%local_part_prefix%&, except that the
18385 local part must end (rather than start) with the given string, the
18386 &%local_part_suffix_optional%& option determines whether the suffix is
18387 mandatory, and the wildcard * character, if present, must be the last
18388 character of the suffix. This option facility is commonly used to handle local
18389 parts of the form &%something-request%& and multiple user mailboxes of the form
18390 &%username-foo%&.
18391
18392
18393 .option local_part_suffix_optional routers boolean false
18394 See &%local_part_suffix%& above.
18395
18396
18397
18398 .option local_parts routers&!? "local part list&!!" unset
18399 .cindex "router" "restricting to specific local parts"
18400 .cindex "local part" "checking in router"
18401 The router is run only if the local part of the address matches the list.
18402 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18403 are evaluated, and
18404 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18405 string is expanded, it is possible to make it depend on the domain, for
18406 example:
18407 .code
18408 local_parts = dbm;/usr/local/specials/$domain
18409 .endd
18410 .vindex "&$local_part_data$&"
18411 If the match is achieved by a lookup, the data that the lookup returned
18412 for the local part is placed in the variable &$local_part_data$& for use in
18413 expansions of the router's private options. You might use this option, for
18414 example, if you have a large number of local virtual domains, and you want to
18415 send all postmaster mail to the same place without having to set up an alias in
18416 each virtual domain:
18417 .code
18418 postmaster:
18419   driver = redirect
18420   local_parts = postmaster
18421   data = postmaster@real.domain.example
18422 .endd
18423
18424
18425 .option log_as_local routers boolean "see below"
18426 .cindex "log" "delivery line"
18427 .cindex "delivery" "log line format"
18428 Exim has two logging styles for delivery, the idea being to make local
18429 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18430 recipient address is given just as the local part, without a domain. The use of
18431 this style is controlled by this option. It defaults to true for the &(accept)&
18432 router, and false for all the others. This option applies only when a
18433 router assigns an address to a transport. It has no effect on routers that
18434 redirect addresses.
18435
18436
18437
18438 .option more routers boolean&!! true
18439 The result of string expansion for this option must be a valid boolean value,
18440 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18441 result causes an error, and delivery is deferred. If the expansion is forced to
18442 fail, the default value for the option (true) is used. Other failures cause
18443 delivery to be deferred.
18444
18445 If this option is set false, and the router declines to handle the address, no
18446 further routers are tried, routing fails, and the address is bounced.
18447 .oindex "&%self%&"
18448 However, if the router explicitly passes an address to the following router by
18449 means of the setting
18450 .code
18451 self = pass
18452 .endd
18453 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18454 does not affect the behaviour if one of the precondition tests fails. In that
18455 case, the address is always passed to the next router.
18456
18457 Note that &%address_data%& is not considered to be a precondition. If its
18458 expansion is forced to fail, the router declines, and the value of &%more%&
18459 controls what happens next.
18460
18461
18462 .option pass_on_timeout routers boolean false
18463 .cindex "timeout" "of router"
18464 .cindex "router" "timeout"
18465 If a router times out during a host lookup, it normally causes deferral of the
18466 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18467 router, overriding &%no_more%&. This may be helpful for systems that are
18468 intermittently connected to the Internet, or those that want to pass to a smart
18469 host any messages that cannot immediately be delivered.
18470
18471 There are occasional other temporary errors that can occur while doing DNS
18472 lookups. They are treated in the same way as a timeout, and this option
18473 applies to all of them.
18474
18475
18476
18477 .option pass_router routers string unset
18478 .cindex "router" "go to after &""pass""&"
18479 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18480 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18481 routing to continue, and overriding a false setting of &%more%&. When one of
18482 these routers returns &"pass"&, the address is normally handed on to the next
18483 router in sequence. This can be changed by setting &%pass_router%& to the name
18484 of another router. However (unlike &%redirect_router%&) the named router must
18485 be below the current router, to avoid loops. Note that this option applies only
18486 to the special case of &"pass"&. It does not apply when a router returns
18487 &"decline"& because it cannot handle an address.
18488
18489
18490
18491 .option redirect_router routers string unset
18492 .cindex "router" "start at after redirection"
18493 Sometimes an administrator knows that it is pointless to reprocess addresses
18494 generated from alias or forward files with the same router again. For
18495 example, if an alias file translates real names into login ids there is no
18496 point searching the alias file a second time, especially if it is a large file.
18497
18498 The &%redirect_router%& option can be set to the name of any router instance.
18499 It causes the routing of any generated addresses to start at the named router
18500 instead of at the first router. This option has no effect if the router in
18501 which it is set does not generate new addresses.
18502
18503
18504
18505 .option require_files routers&!? "string list&!!" unset
18506 .cindex "file" "requiring for router"
18507 .cindex "router" "requiring file existence"
18508 This option provides a general mechanism for predicating the running of a
18509 router on the existence or non-existence of certain files or directories.
18510 Before running a router, as one of its precondition tests, Exim works its way
18511 through the &%require_files%& list, expanding each item separately.
18512
18513 Because the list is split before expansion, any colons in expansion items must
18514 be doubled, or the facility for using a different list separator must be used.
18515 If any expansion is forced to fail, the item is ignored. Other expansion
18516 failures cause routing of the address to be deferred.
18517
18518 If any expanded string is empty, it is ignored. Otherwise, except as described
18519 below, each string must be a fully qualified file path, optionally preceded by
18520 &"!"&. The paths are passed to the &[stat()]& function to test for the
18521 existence of the files or directories. The router is skipped if any paths not
18522 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18523
18524 .cindex "NFS"
18525 If &[stat()]& cannot determine whether a file exists or not, delivery of
18526 the message is deferred. This can happen when NFS-mounted filesystems are
18527 unavailable.
18528
18529 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18530 options, so you cannot use it to check for the existence of a file in which to
18531 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18532 full list of the order in which preconditions are evaluated.) However, as
18533 these options are all expanded, you can use the &%exists%& expansion condition
18534 to make such tests. The &%require_files%& option is intended for checking files
18535 that the router may be going to use internally, or which are needed by a
18536 transport (for example &_.procmailrc_&).
18537
18538 During delivery, the &[stat()]& function is run as root, but there is a
18539 facility for some checking of the accessibility of a file by another user.
18540 This is not a proper permissions check, but just a &"rough"& check that
18541 operates as follows:
18542
18543 If an item in a &%require_files%& list does not contain any forward slash
18544 characters, it is taken to be the user (and optional group, separated by a
18545 comma) to be checked for subsequent files in the list. If no group is specified
18546 but the user is specified symbolically, the gid associated with the uid is
18547 used. For example:
18548 .code
18549 require_files = mail:/some/file
18550 require_files = $local_part:$home/.procmailrc
18551 .endd
18552 If a user or group name in a &%require_files%& list does not exist, the
18553 &%require_files%& condition fails.
18554
18555 Exim performs the check by scanning along the components of the file path, and
18556 checking the access for the given uid and gid. It checks for &"x"& access on
18557 directories, and &"r"& access on the final file. Note that this means that file
18558 access control lists, if the operating system has them, are ignored.
18559
18560 &*Warning 1*&: When the router is being run to verify addresses for an
18561 incoming SMTP message, Exim is not running as root, but under its own uid. This
18562 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18563 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18564 user is not permitted to read one of the directories on the file's path.
18565
18566 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18567 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18568 without root access. In this case, if a check for access by a particular user
18569 is requested, Exim creates a subprocess that runs as that user, and tries the
18570 check again in that process.
18571
18572 The default action for handling an unresolved EACCES is to consider it to
18573 be caused by a configuration error, and routing is deferred because the
18574 existence or non-existence of the file cannot be determined. However, in some
18575 circumstances it may be desirable to treat this condition as if the file did
18576 not exist. If the file name (or the exclamation mark that precedes the file
18577 name for non-existence) is preceded by a plus sign, the EACCES error is treated
18578 as if the file did not exist. For example:
18579 .code
18580 require_files = +/some/file
18581 .endd
18582 If the router is not an essential part of verification (for example, it
18583 handles users' &_.forward_& files), another solution is to set the &%verify%&
18584 option false so that the router is skipped when verifying.
18585
18586
18587
18588 .option retry_use_local_part routers boolean "see below"
18589 .cindex "hints database" "retry keys"
18590 .cindex "local part" "in retry keys"
18591 When a delivery suffers a temporary routing failure, a retry record is created
18592 in Exim's hints database. For addresses whose routing depends only on the
18593 domain, the key for the retry record should not involve the local part, but for
18594 other addresses, both the domain and the local part should be included.
18595 Usually, remote routing is of the former kind, and local routing is of the
18596 latter kind.
18597
18598 This option controls whether the local part is used to form the key for retry
18599 hints for addresses that suffer temporary errors while being handled by this
18600 router. The default value is true for any router that has &%check_local_user%&
18601 set, and false otherwise. Note that this option does not apply to hints keys
18602 for transport delays; they are controlled by a generic transport option of the
18603 same name.
18604
18605 The setting of &%retry_use_local_part%& applies only to the router on which it
18606 appears. If the router generates child addresses, they are routed
18607 independently; this setting does not become attached to them.
18608
18609
18610
18611 .option router_home_directory routers string&!! unset
18612 .cindex "router" "home directory for"
18613 .cindex "home directory" "for router"
18614 .vindex "&$home$&"
18615 This option sets a home directory for use while the router is running. (Compare
18616 &%transport_home_directory%&, which sets a home directory for later
18617 transporting.) In particular, if used on a &(redirect)& router, this option
18618 sets a value for &$home$& while a filter is running. The value is expanded;
18619 forced expansion failure causes the option to be ignored &-- other failures
18620 cause the router to defer.
18621
18622 Expansion of &%router_home_directory%& happens immediately after the
18623 &%check_local_user%& test (if configured), before any further expansions take
18624 place.
18625 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18626 are evaluated.)
18627 While the router is running, &%router_home_directory%& overrides the value of
18628 &$home$& that came from &%check_local_user%&.
18629
18630 When a router accepts an address and assigns it to a local transport (including
18631 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18632 delivery), the home directory setting for the transport is taken from the first
18633 of these values that is set:
18634
18635 .ilist
18636 The &%home_directory%& option on the transport;
18637 .next
18638 The &%transport_home_directory%& option on the router;
18639 .next
18640 The password data if &%check_local_user%& is set on the router;
18641 .next
18642 The &%router_home_directory%& option on the router.
18643 .endlist
18644
18645 In other words, &%router_home_directory%& overrides the password data for the
18646 router, but not for the transport.
18647
18648
18649
18650 .option self routers string freeze
18651 .cindex "MX record" "pointing to local host"
18652 .cindex "local host" "MX pointing to"
18653 This option applies to those routers that use a recipient address to find a
18654 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18655 and &(manualroute)& routers.
18656 Certain configurations of the &(queryprogram)& router can also specify a list
18657 of remote hosts.
18658 Usually such routers are configured to send the message to a remote host via an
18659 &(smtp)& transport. The &%self%& option specifies what happens when the first
18660 host on the list turns out to be the local host.
18661 The way in which Exim checks for the local host is described in section
18662 &<<SECTreclocipadd>>&.
18663
18664 Normally this situation indicates either an error in Exim's configuration (for
18665 example, the router should be configured not to process this domain), or an
18666 error in the DNS (for example, the MX should not point to this host). For this
18667 reason, the default action is to log the incident, defer the address, and
18668 freeze the message. The following alternatives are provided for use in special
18669 cases:
18670
18671 .vlist
18672 .vitem &%defer%&
18673 Delivery of the message is tried again later, but the message is not frozen.
18674
18675 .vitem "&%reroute%&: <&'domain'&>"
18676 The domain is changed to the given domain, and the address is passed back to
18677 be reprocessed by the routers. No rewriting of headers takes place. This
18678 behaviour is essentially a redirection.
18679
18680 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18681 The domain is changed to the given domain, and the address is passed back to be
18682 reprocessed by the routers. Any headers that contain the original domain are
18683 rewritten.
18684
18685 .vitem &%pass%&
18686 .oindex "&%more%&"
18687 .vindex "&$self_hostname$&"
18688 The router passes the address to the next router, or to the router named in the
18689 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18690 subsequent routing and delivery, the variable &$self_hostname$& contains the
18691 name of the local host that the router encountered. This can be used to
18692 distinguish between different cases for hosts with multiple names. The
18693 combination
18694 .code
18695 self = pass
18696 no_more
18697 .endd
18698 ensures that only those addresses that routed to the local host are passed on.
18699 Without &%no_more%&, addresses that were declined for other reasons would also
18700 be passed to the next router.
18701
18702 .vitem &%fail%&
18703 Delivery fails and an error report is generated.
18704
18705 .vitem &%send%&
18706 .cindex "local host" "sending to"
18707 The anomaly is ignored and the address is queued for the transport. This
18708 setting should be used with extreme caution. For an &(smtp)& transport, it
18709 makes sense only in cases where the program that is listening on the SMTP port
18710 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18711 different configuration file that handles the domain in another way.
18712 .endlist
18713
18714
18715
18716 .option senders routers&!? "address list&!!" unset
18717 .cindex "router" "checking senders"
18718 If this option is set, the router is skipped unless the message's sender
18719 address matches something on the list.
18720 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18721 are evaluated.
18722
18723 There are issues concerning verification when the running of routers is
18724 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18725 setting, it sets the sender to the null string. When using the &%-bt%& option
18726 to check a configuration file, it is necessary also to use the &%-f%& option to
18727 set an appropriate sender. For incoming mail, the sender is unset when
18728 verifying the sender, but is available when verifying any recipients. If the
18729 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18730 matters.
18731
18732
18733 .option translate_ip_address routers string&!! unset
18734 .cindex "IP address" "translating"
18735 .cindex "packet radio"
18736 .cindex "router" "IP address translation"
18737 There exist some rare networking situations (for example, packet radio) where
18738 it is helpful to be able to translate IP addresses generated by normal routing
18739 mechanisms into other IP addresses, thus performing a kind of manual IP
18740 routing. This should be done only if the normal IP routing of the TCP/IP stack
18741 is inadequate or broken. Because this is an extremely uncommon requirement, the
18742 code to support this option is not included in the Exim binary unless
18743 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18744
18745 .vindex "&$host_address$&"
18746 The &%translate_ip_address%& string is expanded for every IP address generated
18747 by the router, with the generated address set in &$host_address$&. If the
18748 expansion is forced to fail, no action is taken.
18749 For any other expansion error, delivery of the message is deferred.
18750 If the result of the expansion is an IP address, that replaces the original
18751 address; otherwise the result is assumed to be a host name &-- this is looked
18752 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
18753 produce one or more replacement IP addresses. For example, to subvert all IP
18754 addresses in some specific networks, this could be added to a router:
18755 .code
18756 translate_ip_address = \
18757   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
18758     {$value}fail}}
18759 .endd
18760 The file would contain lines like
18761 .code
18762 10.2.3.128/26    some.host
18763 10.8.4.34/26     10.44.8.15
18764 .endd
18765 You should not make use of this facility unless you really understand what you
18766 are doing.
18767
18768
18769
18770 .option transport routers string&!! unset
18771 This option specifies the transport to be used when a router accepts an address
18772 and sets it up for delivery. A transport is never needed if a router is used
18773 only for verification. The value of the option is expanded at routing time,
18774 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
18775 and result must be the name of one of the configured transports. If it is not,
18776 delivery is deferred.
18777
18778 The &%transport%& option is not used by the &(redirect)& router, but it does
18779 have some private options that set up transports for pipe and file deliveries
18780 (see chapter &<<CHAPredirect>>&).
18781
18782
18783
18784 .option transport_current_directory routers string&!! unset
18785 .cindex "current directory for local transport"
18786 This option associates a current directory with any address that is routed
18787 to a local transport. This can happen either because a transport is
18788 explicitly configured for the router, or because it generates a delivery to a
18789 file or a pipe. During the delivery process (that is, at transport time), this
18790 option string is expanded and is set as the current directory, unless
18791 overridden by a setting on the transport.
18792 If the expansion fails for any reason, including forced failure, an error is
18793 logged, and delivery is deferred.
18794 See chapter &<<CHAPenvironment>>& for details of the local delivery
18795 environment.
18796
18797
18798
18799
18800 .option transport_home_directory routers string&!! "see below"
18801 .cindex "home directory" "for local transport"
18802 This option associates a home directory with any address that is routed to a
18803 local transport. This can happen either because a transport is explicitly
18804 configured for the router, or because it generates a delivery to a file or a
18805 pipe. During the delivery process (that is, at transport time), the option
18806 string is expanded and is set as the home directory, unless overridden by a
18807 setting of &%home_directory%& on the transport.
18808 If the expansion fails for any reason, including forced failure, an error is
18809 logged, and delivery is deferred.
18810
18811 If the transport does not specify a home directory, and
18812 &%transport_home_directory%& is not set for the router, the home directory for
18813 the transport is taken from the password data if &%check_local_user%& is set for
18814 the router. Otherwise it is taken from &%router_home_directory%& if that option
18815 is set; if not, no home directory is set for the transport.
18816
18817 See chapter &<<CHAPenvironment>>& for further details of the local delivery
18818 environment.
18819
18820
18821
18822
18823 .option unseen routers boolean&!! false
18824 .cindex "router" "carrying on after success"
18825 The result of string expansion for this option must be a valid boolean value,
18826 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18827 result causes an error, and delivery is deferred. If the expansion is forced to
18828 fail, the default value for the option (false) is used. Other failures cause
18829 delivery to be deferred.
18830
18831 When this option is set true, routing does not cease if the router accepts the
18832 address. Instead, a copy of the incoming address is passed to the next router,
18833 overriding a false setting of &%more%&. There is little point in setting
18834 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18835 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18836 sometimes true and sometimes false).
18837
18838 .cindex "copy of message (&%unseen%& option)"
18839 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18840 qualifier in filter files. It can be used to cause copies of messages to be
18841 delivered to some other destination, while also carrying out a normal delivery.
18842 In effect, the current address is made into a &"parent"& that has two children
18843 &-- one that is delivered as specified by this router, and a clone that goes on
18844 to be routed further. For this reason, &%unseen%& may not be combined with the
18845 &%one_time%& option in a &(redirect)& router.
18846
18847 &*Warning*&: Header lines added to the address (or specified for removal) by
18848 this router or by previous routers affect the &"unseen"& copy of the message
18849 only. The clone that continues to be processed by further routers starts with
18850 no added headers and none specified for removal. For a &%redirect%& router, if
18851 a generated address is the same as the incoming address, this can lead to
18852 duplicate addresses with different header modifications. Exim does not do
18853 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18854 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18855 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18856 &%redirect%& router may be of help.
18857
18858 Unlike the handling of header modifications, any data that was set by the
18859 &%address_data%& option in the current or previous routers &'is'& passed on to
18860 subsequent routers.
18861
18862
18863 .option user routers string&!! "see below"
18864 .cindex "uid (user id)" "local delivery"
18865 .cindex "local transports" "uid and gid"
18866 .cindex "transport" "local"
18867 .cindex "router" "user for filter processing"
18868 .cindex "filter" "user for processing"
18869 When a router queues an address for a transport, and the transport does not
18870 specify a user, the user given here is used when running the delivery process.
18871 The user may be specified numerically or by name. If expansion fails, the
18872 error is logged and delivery is deferred.
18873 This user is also used by the &(redirect)& router when running a filter file.
18874 The default is unset, except when &%check_local_user%& is set. In this case,
18875 the default is taken from the password information. If the user is specified as
18876 a name, and &%group%& is not set, the group associated with the user is used.
18877 See also &%initgroups%& and &%group%& and the discussion in chapter
18878 &<<CHAPenvironment>>&.
18879
18880
18881
18882 .option verify routers&!? boolean true
18883 Setting this option has the effect of setting &%verify_sender%& and
18884 &%verify_recipient%& to the same value.
18885
18886
18887 .option verify_only routers&!? boolean false
18888 .cindex "EXPN" "with &%verify_only%&"
18889 .oindex "&%-bv%&"
18890 .cindex "router" "used only when verifying"
18891 If this option is set, the router is used only when verifying an address,
18892 delivering in cutthrough mode or
18893 testing with the &%-bv%& option, not when actually doing a delivery, testing
18894 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18895 restricted to verifying only senders or recipients by means of
18896 &%verify_sender%& and &%verify_recipient%&.
18897
18898 &*Warning*&: When the router is being run to verify addresses for an incoming
18899 SMTP message, Exim is not running as root, but under its own uid. If the router
18900 accesses any files, you need to make sure that they are accessible to the Exim
18901 user or group.
18902
18903
18904 .option verify_recipient routers&!? boolean true
18905 If this option is false, the router is skipped when verifying recipient
18906 addresses,
18907 delivering in cutthrough mode
18908 or testing recipient verification using &%-bv%&.
18909 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18910 are evaluated.
18911 See also the &$verify_mode$& variable.
18912
18913
18914 .option verify_sender routers&!? boolean true
18915 If this option is false, the router is skipped when verifying sender addresses
18916 or testing sender verification using &%-bvs%&.
18917 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18918 are evaluated.
18919 See also the &$verify_mode$& variable.
18920 .ecindex IIDgenoprou1
18921 .ecindex IIDgenoprou2
18922
18923
18924
18925
18926
18927
18928 . ////////////////////////////////////////////////////////////////////////////
18929 . ////////////////////////////////////////////////////////////////////////////
18930
18931 .chapter "The accept router" "CHID4"
18932 .cindex "&(accept)& router"
18933 .cindex "routers" "&(accept)&"
18934 The &(accept)& router has no private options of its own. Unless it is being
18935 used purely for verification (see &%verify_only%&) a transport is required to
18936 be defined by the generic &%transport%& option. If the preconditions that are
18937 specified by generic options are met, the router accepts the address and queues
18938 it for the given transport. The most common use of this router is for setting
18939 up deliveries to local mailboxes. For example:
18940 .code
18941 localusers:
18942   driver = accept
18943   domains = mydomain.example
18944   check_local_user
18945   transport = local_delivery
18946 .endd
18947 The &%domains%& condition in this example checks the domain of the address, and
18948 &%check_local_user%& checks that the local part is the login of a local user.
18949 When both preconditions are met, the &(accept)& router runs, and queues the
18950 address for the &(local_delivery)& transport.
18951
18952
18953
18954
18955
18956
18957 . ////////////////////////////////////////////////////////////////////////////
18958 . ////////////////////////////////////////////////////////////////////////////
18959
18960 .chapter "The dnslookup router" "CHAPdnslookup"
18961 .scindex IIDdnsrou1 "&(dnslookup)& router"
18962 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18963 The &(dnslookup)& router looks up the hosts that handle mail for the
18964 recipient's domain in the DNS. A transport must always be set for this router,
18965 unless &%verify_only%& is set.
18966
18967 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18968 SRV records. If none are found, or if SRV support is not configured,
18969 MX records are looked up. If no MX records exist, address records are sought.
18970 However, &%mx_domains%& can be set to disable the direct use of address
18971 records.
18972
18973 MX records of equal priority are sorted by Exim into a random order. Exim then
18974 looks for address records for the host names obtained from MX or SRV records.
18975 When a host has more than one IP address, they are sorted into a random order,
18976 except that IPv6 addresses are sorted before IPv4 addresses. If all the
18977 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18978 generic option, the router declines.
18979
18980 Unless they have the highest priority (lowest MX value), MX records that point
18981 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18982 are discarded, together with any other MX records of equal or lower priority.
18983
18984 .cindex "MX record" "pointing to local host"
18985 .cindex "local host" "MX pointing to"
18986 .oindex "&%self%&" "in &(dnslookup)& router"
18987 If the host pointed to by the highest priority MX record, or looked up as an
18988 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18989 happens is controlled by the generic &%self%& option.
18990
18991
18992 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18993 There have been problems with DNS servers when SRV records are looked up.
18994 Some misbehaving servers return a DNS error or timeout when a non-existent
18995 SRV record is sought. Similar problems have in the past been reported for
18996 MX records. The global &%dns_again_means_nonexist%& option can help with this
18997 problem, but it is heavy-handed because it is a global option.
18998
18999 For this reason, there are two options, &%srv_fail_domains%& and
19000 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19001 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19002 an attempt to look up an SRV or MX record causes one of these results, and the
19003 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19004 such record"&. In the case of an SRV lookup, this means that the router
19005 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19006 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19007 case routing fails.
19008
19009
19010 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19011 .cindex "&(dnslookup)& router" "declines"
19012 There are a few cases where a &(dnslookup)& router will decline to accept
19013 an address; if such a router is expected to handle "all remaining non-local
19014 domains", then it is important to set &%no_more%&.
19015
19016 The router will defer rather than decline if the domain
19017 is found in the &%fail_defer_domains%& router option.
19018
19019 Reasons for a &(dnslookup)& router to decline currently include:
19020 .ilist
19021 The domain does not exist in DNS
19022 .next
19023 The domain exists but the MX record's host part is just "."; this is a common
19024 convention (borrowed from SRV) used to indicate that there is no such service
19025 for this domain and to not fall back to trying A/AAAA records.
19026 .next
19027 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19028 .next
19029 MX record points to a non-existent host.
19030 .next
19031 MX record points to an IP address and the main section option
19032 &%allow_mx_to_ip%& is not set.
19033 .next
19034 MX records exist and point to valid hosts, but all hosts resolve only to
19035 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19036 .next
19037 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19038 &%dns_check_names_pattern%& for handling one variant of this)
19039 .next
19040 &%check_secondary_mx%& is set on this router but the local host can
19041 not be found in the MX records (see below)
19042 .endlist
19043
19044
19045
19046
19047 .section "Private options for dnslookup" "SECID118"
19048 .cindex "options" "&(dnslookup)& router"
19049 The private options for the &(dnslookup)& router are as follows:
19050
19051 .option check_secondary_mx dnslookup boolean false
19052 .cindex "MX record" "checking for secondary"
19053 If this option is set, the router declines unless the local host is found in
19054 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19055 process domains for which the local host is a secondary mail exchanger
19056 differently to other domains. The way in which Exim decides whether a host is
19057 the local host is described in section &<<SECTreclocipadd>>&.
19058
19059
19060 .option check_srv dnslookup string&!! unset
19061 .cindex "SRV record" "enabling use of"
19062 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19063 addition to MX and address records. The support is disabled by default. To
19064 enable SRV support, set the &%check_srv%& option to the name of the service
19065 required. For example,
19066 .code
19067 check_srv = smtp
19068 .endd
19069 looks for SRV records that refer to the normal smtp service. The option is
19070 expanded, so the service name can vary from message to message or address
19071 to address. This might be helpful if SRV records are being used for a
19072 submission service. If the expansion is forced to fail, the &%check_srv%&
19073 option is ignored, and the router proceeds to look for MX records in the
19074 normal way.
19075
19076 When the expansion succeeds, the router searches first for SRV records for
19077 the given service (it assumes TCP protocol). A single SRV record with a
19078 host name that consists of just a single dot indicates &"no such service for
19079 this domain"&; if this is encountered, the router declines. If other kinds of
19080 SRV record are found, they are used to construct a host list for delivery
19081 according to the rules of RFC 2782. MX records are not sought in this case.
19082
19083 When no SRV records are found, MX records (and address records) are sought in
19084 the traditional way. In other words, SRV records take precedence over MX
19085 records, just as MX records take precedence over address records. Note that
19086 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19087 defined it. It is apparently believed that MX records are sufficient for email
19088 and that SRV records should not be used for this purpose. However, SRV records
19089 have an additional &"weight"& feature which some people might find useful when
19090 trying to split an SMTP load between hosts of different power.
19091
19092 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19093 when there is a DNS lookup error.
19094
19095
19096
19097
19098 .option fail_defer_domains dnslookup "domain list&!!" unset
19099 .cindex "MX record" "not found"
19100 DNS lookups for domains matching &%fail_defer_domains%&
19101 which find no matching record will cause the router to defer
19102 rather than the default behaviour of decline.
19103 This maybe be useful for queueing messages for a newly created
19104 domain while the DNS configuration is not ready.
19105 However, it will result in any message with mistyped domains
19106 also being queued.
19107
19108
19109 .option ipv4_only "string&!!" unset
19110 .cindex IPv6 disabling
19111 .cindex DNS "IPv6 disabling"
19112 The string is expanded, and if the result is anything but a forced failure,
19113 or an empty string, or one of the strings “0” or “no” or “false”
19114 (checked without regard to the case of the letters),
19115 only A records are used.
19116
19117 .option ipv4_prefer "string&!!" unset
19118 .cindex IPv4 preference
19119 .cindex DNS "IPv4 preference"
19120 The string is expanded, and if the result is anything but a forced failure,
19121 or an empty string, or one of the strings “0” or “no” or “false”
19122 (checked without regard to the case of the letters),
19123 A records are sorted before AAAA records (inverting the default).
19124
19125 .option mx_domains dnslookup "domain list&!!" unset
19126 .cindex "MX record" "required to exist"
19127 .cindex "SRV record" "required to exist"
19128 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19129 record in order to be recognized. (The name of this option could be improved.)
19130 For example, if all the mail hosts in &'fict.example'& are known to have MX
19131 records, except for those in &'discworld.fict.example'&, you could use this
19132 setting:
19133 .code
19134 mx_domains = ! *.discworld.fict.example : *.fict.example
19135 .endd
19136 This specifies that messages addressed to a domain that matches the list but
19137 has no MX record should be bounced immediately instead of being routed using
19138 the address record.
19139
19140
19141 .option mx_fail_domains dnslookup "domain list&!!" unset
19142 If the DNS lookup for MX records for one of the domains in this list causes a
19143 DNS lookup error, Exim behaves as if no MX records were found. See section
19144 &<<SECTprowitdnsloo>>& for more discussion.
19145
19146
19147
19148
19149 .option qualify_single dnslookup boolean true
19150 .cindex "DNS" "resolver options"
19151 .cindex "DNS" "qualifying single-component names"
19152 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19153 lookups. Typically, but not standardly, this causes the resolver to qualify
19154 single-component names with the default domain. For example, on a machine
19155 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
19156 &'thesaurus.ref.example'& inside the resolver. For details of what your
19157 resolver actually does, consult your man pages for &'resolver'& and
19158 &'resolv.conf'&.
19159
19160
19161
19162 .option rewrite_headers dnslookup boolean true
19163 .cindex "rewriting" "header lines"
19164 .cindex "header lines" "rewriting"
19165 If the domain name in the address that is being processed is not fully
19166 qualified, it may be expanded to its full form by a DNS lookup. For example, if
19167 an address is specified as &'dormouse@teaparty'&, the domain might be
19168 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
19169 occur as a result of setting the &%widen_domains%& option. If
19170 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
19171 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
19172 header lines of the message are rewritten with the full domain name.
19173
19174 This option should be turned off only when it is known that no message is
19175 ever going to be sent outside an environment where the abbreviation makes
19176 sense.
19177
19178 When an MX record is looked up in the DNS and matches a wildcard record, name
19179 servers normally return a record containing the name that has been looked up,
19180 making it impossible to detect whether a wildcard was present or not. However,
19181 some name servers have recently been seen to return the wildcard entry. If the
19182 name returned by a DNS lookup begins with an asterisk, it is not used for
19183 header rewriting.
19184
19185
19186 .option same_domain_copy_routing dnslookup boolean false
19187 .cindex "address" "copying routing"
19188 Addresses with the same domain are normally routed by the &(dnslookup)& router
19189 to the same list of hosts. However, this cannot be presumed, because the router
19190 options and preconditions may refer to the local part of the address. By
19191 default, therefore, Exim routes each address in a message independently. DNS
19192 servers run caches, so repeated DNS lookups are not normally expensive, and in
19193 any case, personal messages rarely have more than a few recipients.
19194
19195 If you are running mailing lists with large numbers of subscribers at the same
19196 domain, and you are using a &(dnslookup)& router which is independent of the
19197 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19198 lookups for identical domains in one message. In this case, when &(dnslookup)&
19199 routes an address to a remote transport, any other unrouted addresses in the
19200 message that have the same domain are automatically given the same routing
19201 without processing them independently,
19202 provided the following conditions are met:
19203
19204 .ilist
19205 No router that processed the address specified &%headers_add%& or
19206 &%headers_remove%&.
19207 .next
19208 The router did not change the address in any way, for example, by &"widening"&
19209 the domain.
19210 .endlist
19211
19212
19213
19214
19215 .option search_parents dnslookup boolean false
19216 .cindex "DNS" "resolver options"
19217 When this option is true, the resolver option RES_DNSRCH is set for DNS
19218 lookups. This is different from the &%qualify_single%& option in that it
19219 applies to domains containing dots. Typically, but not standardly, it causes
19220 the resolver to search for the name in the current domain and in parent
19221 domains. For example, on a machine in the &'fict.example'& domain, if looking
19222 up &'teaparty.wonderland'& failed, the resolver would try
19223 &'teaparty.wonderland.fict.example'&. For details of what your resolver
19224 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
19225
19226 Setting this option true can cause problems in domains that have a wildcard MX
19227 record, because any domain that does not have its own MX record matches the
19228 local wildcard.
19229
19230
19231
19232 .option srv_fail_domains dnslookup "domain list&!!" unset
19233 If the DNS lookup for SRV records for one of the domains in this list causes a
19234 DNS lookup error, Exim behaves as if no SRV records were found. See section
19235 &<<SECTprowitdnsloo>>& for more discussion.
19236
19237
19238
19239
19240 .option widen_domains dnslookup "string list" unset
19241 .cindex "domain" "partial; widening"
19242 If a DNS lookup fails and this option is set, each of its strings in turn is
19243 added onto the end of the domain, and the lookup is tried again. For example,
19244 if
19245 .code
19246 widen_domains = fict.example:ref.example
19247 .endd
19248 is set and a lookup of &'klingon.dictionary'& fails,
19249 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
19250 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
19251 and &%search_parents%& options can cause some widening to be undertaken inside
19252 the DNS resolver. &%widen_domains%& is not applied to sender addresses
19253 when verifying, unless &%rewrite_headers%& is false (not the default).
19254
19255
19256 .section "Effect of qualify_single and search_parents" "SECID119"
19257 When a domain from an envelope recipient is changed by the resolver as a result
19258 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
19259 corresponding address in the message's header lines unless &%rewrite_headers%&
19260 is set false. Exim then re-routes the address, using the full domain.
19261
19262 These two options affect only the DNS lookup that takes place inside the router
19263 for the domain of the address that is being routed. They do not affect lookups
19264 such as that implied by
19265 .code
19266 domains = @mx_any
19267 .endd
19268 that may happen while processing a router precondition before the router is
19269 entered. No widening ever takes place for these lookups.
19270 .ecindex IIDdnsrou1
19271 .ecindex IIDdnsrou2
19272
19273
19274
19275
19276
19277
19278
19279
19280
19281 . ////////////////////////////////////////////////////////////////////////////
19282 . ////////////////////////////////////////////////////////////////////////////
19283
19284 .chapter "The ipliteral router" "CHID5"
19285 .cindex "&(ipliteral)& router"
19286 .cindex "domain literal" "routing"
19287 .cindex "routers" "&(ipliteral)&"
19288 This router has no private options. Unless it is being used purely for
19289 verification (see &%verify_only%&) a transport is required to be defined by the
19290 generic &%transport%& option. The router accepts the address if its domain part
19291 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
19292 router handles the address
19293 .code
19294 root@[192.168.1.1]
19295 .endd
19296 by setting up delivery to the host with that IP address. IPv4 domain literals
19297 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19298 are similar, but the address is preceded by &`ipv6:`&. For example:
19299 .code
19300 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19301 .endd
19302 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19303 grounds that sooner or later somebody will try it.
19304
19305 .oindex "&%self%&" "in &(ipliteral)& router"
19306 If the IP address matches something in &%ignore_target_hosts%&, the router
19307 declines. If an IP literal turns out to refer to the local host, the generic
19308 &%self%& option determines what happens.
19309
19310 The RFCs require support for domain literals; however, their use is
19311 controversial in today's Internet. If you want to use this router, you must
19312 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19313 Exim will not recognize the domain literal syntax in addresses.
19314
19315
19316
19317 . ////////////////////////////////////////////////////////////////////////////
19318 . ////////////////////////////////////////////////////////////////////////////
19319
19320 .chapter "The iplookup router" "CHID6"
19321 .cindex "&(iplookup)& router"
19322 .cindex "routers" "&(iplookup)&"
19323 The &(iplookup)& router was written to fulfil a specific requirement in
19324 Cambridge University (which in fact no longer exists). For this reason, it is
19325 not included in the binary of Exim by default. If you want to include it, you
19326 must set
19327 .code
19328 ROUTER_IPLOOKUP=yes
19329 .endd
19330 in your &_Local/Makefile_& configuration file.
19331
19332 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19333 connection to one or more specific hosts. The host can then return the same or
19334 a different address &-- in effect rewriting the recipient address in the
19335 message's envelope. The new address is then passed on to subsequent routers. If
19336 this process fails, the address can be passed on to other routers, or delivery
19337 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19338 must not be specified for it.
19339
19340 .cindex "options" "&(iplookup)& router"
19341 .option hosts iplookup string unset
19342 This option must be supplied. Its value is a colon-separated list of host
19343 names. The hosts are looked up using &[gethostbyname()]&
19344 (or &[getipnodebyname()]& when available)
19345 and are tried in order until one responds to the query. If none respond, what
19346 happens is controlled by &%optional%&.
19347
19348
19349 .option optional iplookup boolean false
19350 If &%optional%& is true, if no response is obtained from any host, the address
19351 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19352 delivery to the address is deferred.
19353
19354
19355 .option port iplookup integer 0
19356 .cindex "port" "&(iplookup)& router"
19357 This option must be supplied. It specifies the port number for the TCP or UDP
19358 call.
19359
19360
19361 .option protocol iplookup string udp
19362 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19363 protocols is to be used.
19364
19365
19366 .option query iplookup string&!! "see below"
19367 This defines the content of the query that is sent to the remote hosts. The
19368 default value is:
19369 .code
19370 $local_part@$domain $local_part@$domain
19371 .endd
19372 The repetition serves as a way of checking that a response is to the correct
19373 query in the default case (see &%response_pattern%& below).
19374
19375
19376 .option reroute iplookup string&!! unset
19377 If this option is not set, the rerouted address is precisely the byte string
19378 returned by the remote host, up to the first white space, if any. If set, the
19379 string is expanded to form the rerouted address. It can include parts matched
19380 in the response by &%response_pattern%& by means of numeric variables such as
19381 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19382 whether or not a pattern is in use. In all cases, the rerouted address must end
19383 up in the form &'local_part@domain'&.
19384
19385
19386 .option response_pattern iplookup string unset
19387 This option can be set to a regular expression that is applied to the string
19388 returned from the remote host. If the pattern does not match the response, the
19389 router declines. If &%response_pattern%& is not set, no checking of the
19390 response is done, unless the query was defaulted, in which case there is a
19391 check that the text returned after the first white space is the original
19392 address. This checks that the answer that has been received is in response to
19393 the correct question. For example, if the response is just a new domain, the
19394 following could be used:
19395 .code
19396 response_pattern = ^([^@]+)$
19397 reroute = $local_part@$1
19398 .endd
19399
19400 .option timeout iplookup time 5s
19401 This specifies the amount of time to wait for a response from the remote
19402 machine. The same timeout is used for the &[connect()]& function for a TCP
19403 call. It does not apply to UDP.
19404
19405
19406
19407
19408 . ////////////////////////////////////////////////////////////////////////////
19409 . ////////////////////////////////////////////////////////////////////////////
19410
19411 .chapter "The manualroute router" "CHID7"
19412 .scindex IIDmanrou1 "&(manualroute)& router"
19413 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19414 .cindex "domain" "manually routing"
19415 The &(manualroute)& router is so-called because it provides a way of manually
19416 routing an address according to its domain. It is mainly used when you want to
19417 route addresses to remote hosts according to your own rules, bypassing the
19418 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19419 route to local transports, a facility that may be useful if you want to save
19420 messages for dial-in hosts in local files.
19421
19422 The &(manualroute)& router compares a list of domain patterns with the domain
19423 it is trying to route. If there is no match, the router declines. Each pattern
19424 has associated with it a list of hosts and some other optional data, which may
19425 include a transport. The combination of a pattern and its data is called a
19426 &"routing rule"&. For patterns that do not have an associated transport, the
19427 generic &%transport%& option must specify a transport, unless the router is
19428 being used purely for verification (see &%verify_only%&).
19429
19430 .vindex "&$host$&"
19431 In the case of verification, matching the domain pattern is sufficient for the
19432 router to accept the address. When actually routing an address for delivery,
19433 an address that matches a domain pattern is queued for the associated
19434 transport. If the transport is not a local one, a host list must be associated
19435 with the pattern; IP addresses are looked up for the hosts, and these are
19436 passed to the transport along with the mail address. For local transports, a
19437 host list is optional. If it is present, it is passed in &$host$& as a single
19438 text string.
19439
19440 The list of routing rules can be provided as an inline string in
19441 &%route_list%&, or the data can be obtained by looking up the domain in a file
19442 or database by setting &%route_data%&. Only one of these settings may appear in
19443 any one instance of &(manualroute)&. The format of routing rules is described
19444 below, following the list of private options.
19445
19446
19447 .section "Private options for manualroute" "SECTprioptman"
19448
19449 .cindex "options" "&(manualroute)& router"
19450 The private options for the &(manualroute)& router are as follows:
19451
19452 .option host_all_ignored manualroute string defer
19453 See &%host_find_failed%&.
19454
19455 .option host_find_failed manualroute string freeze
19456 This option controls what happens when &(manualroute)& tries to find an IP
19457 address for a host, and the host does not exist. The option can be set to one
19458 of the following values:
19459 .code
19460 decline
19461 defer
19462 fail
19463 freeze
19464 ignore
19465 pass
19466 .endd
19467 The default (&"freeze"&) assumes that this state is a serious configuration
19468 error. The difference between &"pass"& and &"decline"& is that the former
19469 forces the address to be passed to the next router (or the router defined by
19470 &%pass_router%&),
19471 .oindex "&%more%&"
19472 overriding &%no_more%&, whereas the latter passes the address to the next
19473 router only if &%more%& is true.
19474
19475 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19476 cannot be found. If all the hosts in the list are ignored, the behaviour is
19477 controlled by the &%host_all_ignored%& option. This takes the same values
19478 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19479
19480 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19481 state; if a host lookup gets a temporary error, delivery is deferred unless the
19482 generic &%pass_on_timeout%& option is set.
19483
19484
19485 .option hosts_randomize manualroute boolean false
19486 .cindex "randomized host list"
19487 .cindex "host" "list of; randomized"
19488 If this option is set, the order of the items in a host list in a routing rule
19489 is randomized each time the list is used, unless an option in the routing rule
19490 overrides (see below). Randomizing the order of a host list can be used to do
19491 crude load sharing. However, if more than one mail address is routed by the
19492 same router to the same host list, the host lists are considered to be the same
19493 (even though they may be randomized into different orders) for the purpose of
19494 deciding whether to batch the deliveries into a single SMTP transaction.
19495
19496 When &%hosts_randomize%& is true, a host list may be split
19497 into groups whose order is separately randomized. This makes it possible to
19498 set up MX-like behaviour. The boundaries between groups are indicated by an
19499 item that is just &`+`& in the host list. For example:
19500 .code
19501 route_list = * host1:host2:host3:+:host4:host5
19502 .endd
19503 The order of the first three hosts and the order of the last two hosts is
19504 randomized for each use, but the first three always end up before the last two.
19505 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19506 randomized host list is passed to an &(smtp)& transport that also has
19507 &%hosts_randomize set%&, the list is not re-randomized.
19508
19509
19510 .option route_data manualroute string&!! unset
19511 If this option is set, it must expand to yield the data part of a routing rule.
19512 Typically, the expansion string includes a lookup based on the domain. For
19513 example:
19514 .code
19515 route_data = ${lookup{$domain}dbm{/etc/routes}}
19516 .endd
19517 If the expansion is forced to fail, or the result is an empty string, the
19518 router declines. Other kinds of expansion failure cause delivery to be
19519 deferred.
19520
19521
19522 .option route_list manualroute "string list" unset
19523 This string is a list of routing rules, in the form defined below. Note that,
19524 unlike most string lists, the items are separated by semicolons. This is so
19525 that they may contain colon-separated host lists.
19526
19527
19528 .option same_domain_copy_routing manualroute boolean false
19529 .cindex "address" "copying routing"
19530 Addresses with the same domain are normally routed by the &(manualroute)&
19531 router to the same list of hosts. However, this cannot be presumed, because the
19532 router options and preconditions may refer to the local part of the address. By
19533 default, therefore, Exim routes each address in a message independently. DNS
19534 servers run caches, so repeated DNS lookups are not normally expensive, and in
19535 any case, personal messages rarely have more than a few recipients.
19536
19537 If you are running mailing lists with large numbers of subscribers at the same
19538 domain, and you are using a &(manualroute)& router which is independent of the
19539 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19540 lookups for identical domains in one message. In this case, when
19541 &(manualroute)& routes an address to a remote transport, any other unrouted
19542 addresses in the message that have the same domain are automatically given the
19543 same routing without processing them independently. However, this is only done
19544 if &%headers_add%& and &%headers_remove%& are unset.
19545
19546
19547
19548
19549 .section "Routing rules in route_list" "SECID120"
19550 The value of &%route_list%& is a string consisting of a sequence of routing
19551 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19552 entered as two semicolons. Alternatively, the list separator can be changed as
19553 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19554 Empty rules are ignored. The format of each rule is
19555 .display
19556 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19557 .endd
19558 The following example contains two rules, each with a simple domain pattern and
19559 no options:
19560 .code
19561 route_list = \
19562   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19563   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19564 .endd
19565 The three parts of a rule are separated by white space. The pattern and the
19566 list of hosts can be enclosed in quotes if necessary, and if they are, the
19567 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19568 single domain pattern, which is the only mandatory item in the rule. The
19569 pattern is in the same format as one item in a domain list (see section
19570 &<<SECTdomainlist>>&),
19571 except that it may not be the name of an interpolated file.
19572 That is, it may be wildcarded, or a regular expression, or a file or database
19573 lookup (with semicolons doubled, because of the use of semicolon as a separator
19574 in a &%route_list%&).
19575
19576 The rules in &%route_list%& are searched in order until one of the patterns
19577 matches the domain that is being routed. The list of hosts and then options are
19578 then used as described below. If there is no match, the router declines. When
19579 &%route_list%& is set, &%route_data%& must not be set.
19580
19581
19582
19583 .section "Routing rules in route_data" "SECID121"
19584 The use of &%route_list%& is convenient when there are only a small number of
19585 routing rules. For larger numbers, it is easier to use a file or database to
19586 hold the routing information, and use the &%route_data%& option instead.
19587 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19588 Most commonly, &%route_data%& is set as a string that contains an
19589 expansion lookup. For example, suppose we place two routing rules in a file
19590 like this:
19591 .code
19592 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19593 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19594 .endd
19595 This data can be accessed by setting
19596 .code
19597 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19598 .endd
19599 Failure of the lookup results in an empty string, causing the router to
19600 decline. However, you do not have to use a lookup in &%route_data%&. The only
19601 requirement is that the result of expanding the string is a list of hosts,
19602 possibly followed by options, separated by white space. The list of hosts must
19603 be enclosed in quotes if it contains white space.
19604
19605
19606
19607
19608 .section "Format of the list of hosts" "SECID122"
19609 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19610 always separately expanded before use. If the expansion fails, the router
19611 declines. The result of the expansion must be a colon-separated list of names
19612 and/or IP addresses, optionally also including ports. The format of each item
19613 in the list is described in the next section. The list separator can be changed
19614 as described in section &<<SECTlistconstruct>>&.
19615
19616 If the list of hosts was obtained from a &%route_list%& item, the following
19617 variables are set during its expansion:
19618
19619 .ilist
19620 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19621 If the domain was matched against a regular expression, the numeric variables
19622 &$1$&, &$2$&, etc. may be set. For example:
19623 .code
19624 route_list = ^domain(\d+)   host-$1.text.example
19625 .endd
19626 .next
19627 &$0$& is always set to the entire domain.
19628 .next
19629 &$1$& is also set when partial matching is done in a file lookup.
19630
19631 .next
19632 .vindex "&$value$&"
19633 If the pattern that matched the domain was a lookup item, the data that was
19634 looked up is available in the expansion variable &$value$&. For example:
19635 .code
19636 route_list = lsearch;;/some/file.routes  $value
19637 .endd
19638 .endlist
19639
19640 Note the doubling of the semicolon in the pattern that is necessary because
19641 semicolon is the default route list separator.
19642
19643
19644
19645 .section "Format of one host item" "SECTformatonehostitem"
19646 Each item in the list of hosts is either a host name or an IP address,
19647 optionally with an attached port number. When no port is given, an IP address
19648 is not enclosed in brackets. When a port is specified, it overrides the port
19649 specification on the transport. The port is separated from the name or address
19650 by a colon. This leads to some complications:
19651
19652 .ilist
19653 Because colon is the default separator for the list of hosts, either
19654 the colon that specifies a port must be doubled, or the list separator must
19655 be changed. The following two examples have the same effect:
19656 .code
19657 route_list = * "host1.tld::1225 : host2.tld::1226"
19658 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19659 .endd
19660 .next
19661 When IPv6 addresses are involved, it gets worse, because they contain
19662 colons of their own. To make this case easier, it is permitted to
19663 enclose an IP address (either v4 or v6) in square brackets if a port
19664 number follows. For example:
19665 .code
19666 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19667 .endd
19668 .endlist
19669
19670 .section "How the list of hosts is used" "SECThostshowused"
19671 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19672 the hosts is tried, in the order specified, when carrying out the SMTP
19673 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19674 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19675 transport.
19676
19677 Hosts may be listed by name or by IP address. An unadorned name in the list of
19678 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19679 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19680 records in the DNS. For example:
19681 .code
19682 route_list = *  x.y.z:p.q.r/MX:e.f.g
19683 .endd
19684 If this feature is used with a port specifier, the port must come last. For
19685 example:
19686 .code
19687 route_list = *  dom1.tld/mx::1225
19688 .endd
19689 If the &%hosts_randomize%& option is set, the order of the items in the list is
19690 randomized before any lookups are done. Exim then scans the list; for any name
19691 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19692 be an interface on the local host and the item is not the first in the list,
19693 Exim discards it and any subsequent items. If it is the first item, what
19694 happens is controlled by the
19695 .oindex "&%self%&" "in &(manualroute)& router"
19696 &%self%& option of the router.
19697
19698 A name on the list that is followed by &`/MX`& is replaced with the list of
19699 hosts obtained by looking up MX records for the name. This is always a DNS
19700 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19701 below) are not relevant here. The order of these hosts is determined by the
19702 preference values in the MX records, according to the usual rules. Because
19703 randomizing happens before the MX lookup, it does not affect the order that is
19704 defined by MX preferences.
19705
19706 If the local host is present in the sublist obtained from MX records, but is
19707 not the most preferred host in that list, it and any equally or less
19708 preferred hosts are removed before the sublist is inserted into the main list.
19709
19710 If the local host is the most preferred host in the MX list, what happens
19711 depends on where in the original list of hosts the &`/MX`& item appears. If it
19712 is not the first item (that is, there are previous hosts in the main list),
19713 Exim discards this name and any subsequent items in the main list.
19714
19715 If the MX item is first in the list of hosts, and the local host is the
19716 most preferred host, what happens is controlled by the &%self%& option of the
19717 router.
19718
19719 DNS failures when lookup up the MX records are treated in the same way as DNS
19720 failures when looking up IP addresses: &%pass_on_timeout%& and
19721 &%host_find_failed%& are used when relevant.
19722
19723 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19724 whether obtained from an MX lookup or not.
19725
19726
19727
19728 .section "How the options are used" "SECThowoptused"
19729 The options are a sequence of words, space-separated.
19730 One of the words can be the name of a transport; this overrides the
19731 &%transport%& option on the router for this particular routing rule only. The
19732 other words (if present) control randomization of the list of hosts on a
19733 per-rule basis, and how the IP addresses of the hosts are to be found when
19734 routing to a remote transport. These options are as follows:
19735
19736 .ilist
19737 &%randomize%&: randomize the order of the hosts in this list, overriding the
19738 setting of &%hosts_randomize%& for this routing rule only.
19739 .next
19740 &%no_randomize%&: do not randomize the order of the hosts in this list,
19741 overriding the setting of &%hosts_randomize%& for this routing rule only.
19742 .next
19743 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19744 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19745 also look in &_/etc/hosts_& or other sources of information.
19746 .next
19747 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
19748 no address records are found. If there is a temporary DNS error (such as a
19749 timeout), delivery is deferred.
19750 .next
19751 &%ipv4_only%&: in direct DNS lookups, look up only A records.
19752 .next
19753 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
19754 .endlist
19755
19756 For example:
19757 .code
19758 route_list = domain1  host1:host2:host3  randomize bydns;\
19759              domain2  host4:host5
19760 .endd
19761 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
19762 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
19763 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
19764 or &[gethostbyname()]&, and the result of the lookup is the result of that
19765 call.
19766
19767 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
19768 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
19769 instead of TRY_AGAIN. That is why the default action is to try a DNS
19770 lookup first. Only if that gives a definite &"no such host"& is the local
19771 function called.
19772
19773 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
19774 inadvertent constraint that a transport name as an option had to be the last
19775 option specified.
19776
19777
19778
19779 If no IP address for a host can be found, what happens is controlled by the
19780 &%host_find_failed%& option.
19781
19782 .vindex "&$host$&"
19783 When an address is routed to a local transport, IP addresses are not looked up.
19784 The host list is passed to the transport in the &$host$& variable.
19785
19786
19787
19788 .section "Manualroute examples" "SECID123"
19789 In some of the examples that follow, the presence of the &%remote_smtp%&
19790 transport, as defined in the default configuration file, is assumed:
19791
19792 .ilist
19793 .cindex "smart host" "example router"
19794 The &(manualroute)& router can be used to forward all external mail to a
19795 &'smart host'&. If you have set up, in the main part of the configuration, a
19796 named domain list that contains your local domains, for example:
19797 .code
19798 domainlist local_domains = my.domain.example
19799 .endd
19800 You can arrange for all other domains to be routed to a smart host by making
19801 your first router something like this:
19802 .code
19803 smart_route:
19804   driver = manualroute
19805   domains = !+local_domains
19806   transport = remote_smtp
19807   route_list = * smarthost.ref.example
19808 .endd
19809 This causes all non-local addresses to be sent to the single host
19810 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
19811 they are tried in order
19812 (but you can use &%hosts_randomize%& to vary the order each time).
19813 Another way of configuring the same thing is this:
19814 .code
19815 smart_route:
19816   driver = manualroute
19817   transport = remote_smtp
19818   route_list = !+local_domains  smarthost.ref.example
19819 .endd
19820 There is no difference in behaviour between these two routers as they stand.
19821 However, they behave differently if &%no_more%& is added to them. In the first
19822 example, the router is skipped if the domain does not match the &%domains%&
19823 precondition; the following router is always tried. If the router runs, it
19824 always matches the domain and so can never decline. Therefore, &%no_more%&
19825 would have no effect. In the second case, the router is never skipped; it
19826 always runs. However, if it doesn't match the domain, it declines. In this case
19827 &%no_more%& would prevent subsequent routers from running.
19828
19829 .next
19830 .cindex "mail hub example"
19831 A &'mail hub'& is a host which receives mail for a number of domains via MX
19832 records in the DNS and delivers it via its own private routing mechanism. Often
19833 the final destinations are behind a firewall, with the mail hub being the one
19834 machine that can connect to machines both inside and outside the firewall. The
19835 &(manualroute)& router is usually used on a mail hub to route incoming messages
19836 to the correct hosts. For a small number of domains, the routing can be inline,
19837 using the &%route_list%& option, but for a larger number a file or database
19838 lookup is easier to manage.
19839
19840 If the domain names are in fact the names of the machines to which the mail is
19841 to be sent by the mail hub, the configuration can be quite simple. For
19842 example:
19843 .code
19844 hub_route:
19845   driver = manualroute
19846   transport = remote_smtp
19847   route_list = *.rhodes.tvs.example  $domain
19848 .endd
19849 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
19850 whose names are the same as the mail domains. A similar approach can be taken
19851 if the host name can be obtained from the domain name by a string manipulation
19852 that the expansion facilities can handle. Otherwise, a lookup based on the
19853 domain can be used to find the host:
19854 .code
19855 through_firewall:
19856   driver = manualroute
19857   transport = remote_smtp
19858   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19859 .endd
19860 The result of the lookup must be the name or IP address of the host (or
19861 hosts) to which the address is to be routed. If the lookup fails, the route
19862 data is empty, causing the router to decline. The address then passes to the
19863 next router.
19864
19865 .next
19866 .cindex "batched SMTP output example"
19867 .cindex "SMTP" "batched outgoing; example"
19868 You can use &(manualroute)& to deliver messages to pipes or files in batched
19869 SMTP format for onward transportation by some other means. This is one way of
19870 storing mail for a dial-up host when it is not connected. The route list entry
19871 can be as simple as a single domain name in a configuration like this:
19872 .code
19873 save_in_file:
19874   driver = manualroute
19875   transport = batchsmtp_appendfile
19876   route_list = saved.domain.example
19877 .endd
19878 though often a pattern is used to pick up more than one domain. If there are
19879 several domains or groups of domains with different transport requirements,
19880 different transports can be listed in the routing information:
19881 .code
19882 save_in_file:
19883   driver = manualroute
19884   route_list = \
19885     *.saved.domain1.example  $domain  batch_appendfile; \
19886     *.saved.domain2.example  \
19887       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
19888       batch_pipe
19889 .endd
19890 .vindex "&$domain$&"
19891 .vindex "&$host$&"
19892 The first of these just passes the domain in the &$host$& variable, which
19893 doesn't achieve much (since it is also in &$domain$&), but the second does a
19894 file lookup to find a value to pass, causing the router to decline to handle
19895 the address if the lookup fails.
19896
19897 .next
19898 .cindex "UUCP" "example of router for"
19899 Routing mail directly to UUCP software is a specific case of the use of
19900 &(manualroute)& in a gateway to another mail environment. This is an example of
19901 one way it can be done:
19902 .code
19903 # Transport
19904 uucp:
19905   driver = pipe
19906   user = nobody
19907   command = /usr/local/bin/uux -r - \
19908     ${substr_-5:$host}!rmail ${local_part}
19909   return_fail_output = true
19910
19911 # Router
19912 uucphost:
19913   transport = uucp
19914   driver = manualroute
19915   route_data = \
19916     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19917 .endd
19918 The file &_/usr/local/exim/uucphosts_& contains entries like
19919 .code
19920 darksite.ethereal.example:           darksite.UUCP
19921 .endd
19922 It can be set up more simply without adding and removing &".UUCP"& but this way
19923 makes clear the distinction between the domain name
19924 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19925 .endlist
19926 .ecindex IIDmanrou1
19927 .ecindex IIDmanrou2
19928
19929
19930
19931
19932
19933
19934
19935
19936 . ////////////////////////////////////////////////////////////////////////////
19937 . ////////////////////////////////////////////////////////////////////////////
19938
19939 .chapter "The queryprogram router" "CHAPdriverlast"
19940 .scindex IIDquerou1 "&(queryprogram)& router"
19941 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19942 .cindex "routing" "by external program"
19943 The &(queryprogram)& router routes an address by running an external command
19944 and acting on its output. This is an expensive way to route, and is intended
19945 mainly for use in lightly-loaded systems, or for performing experiments.
19946 However, if it is possible to use the precondition options (&%domains%&,
19947 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19948 be used in special cases, even on a busy host. There are the following private
19949 options:
19950 .cindex "options" "&(queryprogram)& router"
19951
19952 .option command queryprogram string&!! unset
19953 This option must be set. It specifies the command that is to be run. The
19954 command is split up into a command name and arguments, and then each is
19955 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19956 &<<CHAPpipetransport>>&).
19957
19958
19959 .option command_group queryprogram string unset
19960 .cindex "gid (group id)" "in &(queryprogram)& router"
19961 This option specifies a gid to be set when running the command while routing an
19962 address for deliver. It must be set if &%command_user%& specifies a numerical
19963 uid. If it begins with a digit, it is interpreted as the numerical value of the
19964 gid. Otherwise it is looked up using &[getgrnam()]&.
19965
19966
19967 .option command_user queryprogram string unset
19968 .cindex "uid (user id)" "for &(queryprogram)&"
19969 This option must be set. It specifies the uid which is set when running the
19970 command while routing an address for delivery. If the value begins with a digit,
19971 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19972 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19973 not set, a value for the gid also.
19974
19975 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19976 root, which it does during a normal delivery in a conventional configuration.
19977 However, when an address is being verified during message reception, Exim is
19978 usually running as the Exim user, not as root. If the &(queryprogram)& router
19979 is called from a non-root process, Exim cannot change uid or gid before running
19980 the command. In this circumstance the command runs under the current uid and
19981 gid.
19982
19983
19984 .option current_directory queryprogram string /
19985 This option specifies an absolute path which is made the current directory
19986 before running the command.
19987
19988
19989 .option timeout queryprogram time 1h
19990 If the command does not complete within the timeout period, its process group
19991 is killed and the message is frozen. A value of zero time specifies no
19992 timeout.
19993
19994
19995 The standard output of the command is connected to a pipe, which is read when
19996 the command terminates. It should consist of a single line of output,
19997 containing up to five fields, separated by white space. The maximum length of
19998 the line is 1023 characters. Longer lines are silently truncated. The first
19999 field is one of the following words (case-insensitive):
20000
20001 .ilist
20002 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20003 below).
20004 .next
20005 &'Decline'&: the router declines; pass the address to the next router, unless
20006 &%no_more%& is set.
20007 .next
20008 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20009 subsequent text on the line is an error message. If the router is run as part
20010 of address verification during an incoming SMTP message, the message is
20011 included in the SMTP response.
20012 .next
20013 &'Defer'&: routing could not be completed at this time; try again later. Any
20014 subsequent text on the line is an error message which is logged. It is not
20015 included in any SMTP response.
20016 .next
20017 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20018 .next
20019 &'Pass'&: pass the address to the next router (or the router specified by
20020 &%pass_router%&), overriding &%no_more%&.
20021 .next
20022 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20023 new addresses, which are routed independently, starting with the first router,
20024 or the router specified by &%redirect_router%&, if set.
20025 .endlist
20026
20027 When the first word is &'accept'&, the remainder of the line consists of a
20028 number of keyed data values, as follows (split into two lines here, to fit on
20029 the page):
20030 .code
20031 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20032 LOOKUP=byname|bydns DATA=<text>
20033 .endd
20034 The data items can be given in any order, and all are optional. If no transport
20035 is included, the transport specified by the generic &%transport%& option is
20036 used. The list of hosts and the lookup type are needed only if the transport is
20037 an &(smtp)& transport that does not itself supply a list of hosts.
20038
20039 The format of the list of hosts is the same as for the &(manualroute)& router.
20040 As well as host names and IP addresses with optional port numbers, as described
20041 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20042 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20043 (see section &<<SECThostshowused>>&).
20044
20045 If the lookup type is not specified, Exim behaves as follows when trying to
20046 find an IP address for each host: First, a DNS lookup is done. If this yields
20047 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20048 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20049 result of the lookup is the result of that call.
20050
20051 .vindex "&$address_data$&"
20052 If the DATA field is set, its value is placed in the &$address_data$&
20053 variable. For example, this return line
20054 .code
20055 accept hosts=x1.y.example:x2.y.example data="rule1"
20056 .endd
20057 routes the address to the default transport, passing a list of two hosts. When
20058 the transport runs, the string &"rule1"& is in &$address_data$&.
20059 .ecindex IIDquerou1
20060 .ecindex IIDquerou2
20061
20062
20063
20064
20065 . ////////////////////////////////////////////////////////////////////////////
20066 . ////////////////////////////////////////////////////////////////////////////
20067
20068 .chapter "The redirect router" "CHAPredirect"
20069 .scindex IIDredrou1 "&(redirect)& router"
20070 .scindex IIDredrou2 "routers" "&(redirect)&"
20071 .cindex "alias file" "in a &(redirect)& router"
20072 .cindex "address redirection" "&(redirect)& router"
20073 The &(redirect)& router handles several kinds of address redirection. Its most
20074 common uses are for resolving local part aliases from a central alias file
20075 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20076 files, but it has many other potential uses. The incoming address can be
20077 redirected in several different ways:
20078
20079 .ilist
20080 It can be replaced by one or more new addresses which are themselves routed
20081 independently.
20082 .next
20083 It can be routed to be delivered to a given file or directory.
20084 .next
20085 It can be routed to be delivered to a specified pipe command.
20086 .next
20087 It can cause an automatic reply to be generated.
20088 .next
20089 It can be forced to fail, optionally with a custom error message.
20090 .next
20091 It can be temporarily deferred, optionally with a custom message.
20092 .next
20093 It can be discarded.
20094 .endlist
20095
20096 The generic &%transport%& option must not be set for &(redirect)& routers.
20097 However, there are some private options which define transports for delivery to
20098 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20099 &%pipe_transport%& and &%reply_transport%& descriptions below.
20100
20101 If success DSNs have been requested
20102 .cindex "DSN" "success"
20103 .cindex "Delivery Status Notification" "success"
20104 redirection triggers one and the DSN options are not passed any further.
20105
20106
20107
20108 .section "Redirection data" "SECID124"
20109 The router operates by interpreting a text string which it obtains either by
20110 expanding the contents of the &%data%& option, or by reading the entire
20111 contents of a file whose name is given in the &%file%& option. These two
20112 options are mutually exclusive. The first is commonly used for handling system
20113 aliases, in a configuration like this:
20114 .code
20115 system_aliases:
20116   driver = redirect
20117   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20118 .endd
20119 If the lookup fails, the expanded string in this example is empty. When the
20120 expansion of &%data%& results in an empty string, the router declines. A forced
20121 expansion failure also causes the router to decline; other expansion failures
20122 cause delivery to be deferred.
20123
20124 A configuration using &%file%& is commonly used for handling users'
20125 &_.forward_& files, like this:
20126 .code
20127 userforward:
20128   driver = redirect
20129   check_local_user
20130   file = $home/.forward
20131   no_verify
20132 .endd
20133 If the file does not exist, or causes no action to be taken (for example, it is
20134 empty or consists only of comments), the router declines. &*Warning*&: This
20135 is not the case when the file contains syntactically valid items that happen to
20136 yield empty addresses, for example, items containing only RFC 2822 address
20137 comments.
20138
20139
20140
20141 .section "Forward files and address verification" "SECID125"
20142 .cindex "address redirection" "while verifying"
20143 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
20144 &_.forward_& files, as in the example above. There are two reasons for this:
20145
20146 .ilist
20147 When Exim is receiving an incoming SMTP message from a remote host, it is
20148 running under the Exim uid, not as root. Exim is unable to change uid to read
20149 the file as the user, and it may not be able to read it as the Exim user. So in
20150 practice the router may not be able to operate.
20151 .next
20152 However, even when the router can operate, the existence of a &_.forward_& file
20153 is unimportant when verifying an address. What should be checked is whether the
20154 local part is a valid user name or not. Cutting out the redirection processing
20155 saves some resources.
20156 .endlist
20157
20158
20159
20160
20161
20162
20163 .section "Interpreting redirection data" "SECID126"
20164 .cindex "Sieve filter" "specifying in redirection data"
20165 .cindex "filter" "specifying in redirection data"
20166 The contents of the data string, whether obtained from &%data%& or &%file%&,
20167 can be interpreted in two different ways:
20168
20169 .ilist
20170 If the &%allow_filter%& option is set true, and the data begins with the text
20171 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
20172 &'filtering'& instructions in the form of an Exim or Sieve filter file,
20173 respectively. Details of the syntax and semantics of filter files are described
20174 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
20175 document is intended for use by end users.
20176 .next
20177 Otherwise, the data must be a comma-separated list of redirection items, as
20178 described in the next section.
20179 .endlist
20180
20181 When a message is redirected to a file (a &"mail folder"&), the file name given
20182 in a non-filter redirection list must always be an absolute path. A filter may
20183 generate a relative path &-- how this is handled depends on the transport's
20184 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
20185 for the &(appendfile)& transport.
20186
20187
20188
20189 .section "Items in a non-filter redirection list" "SECTitenonfilred"
20190 .cindex "address redirection" "non-filter list items"
20191 When the redirection data is not an Exim or Sieve filter, for example, if it
20192 comes from a conventional alias or forward file, it consists of a list of
20193 addresses, file names, pipe commands, or certain special items (see section
20194 &<<SECTspecitredli>>& below). The special items can be individually enabled or
20195 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
20196 depending on their default values. The items in the list are separated by
20197 commas or newlines.
20198 If a comma is required in an item, the entire item must be enclosed in double
20199 quotes.
20200
20201 Lines starting with a # character are comments, and are ignored, and # may
20202 also appear following a comma, in which case everything between the # and the
20203 next newline character is ignored.
20204
20205 If an item is entirely enclosed in double quotes, these are removed. Otherwise
20206 double quotes are retained because some forms of mail address require their use
20207 (but never to enclose the entire address). In the following description,
20208 &"item"& refers to what remains after any surrounding double quotes have been
20209 removed.
20210
20211 .vindex "&$local_part$&"
20212 &*Warning*&: If you use an Exim expansion to construct a redirection address,
20213 and the expansion contains a reference to &$local_part$&, you should make use
20214 of the &%quote_local_part%& expansion operator, in case the local part contains
20215 special characters. For example, to redirect all mail for the domain
20216 &'obsolete.example'&, retaining the existing local part, you could use this
20217 setting:
20218 .code
20219 data = ${quote_local_part:$local_part}@newdomain.example
20220 .endd
20221
20222
20223 .section "Redirecting to a local mailbox" "SECTredlocmai"
20224 .cindex "routing" "loops in"
20225 .cindex "loop" "while routing, avoidance of"
20226 .cindex "address redirection" "to local mailbox"
20227 A redirection item may safely be the same as the address currently under
20228 consideration. This does not cause a routing loop, because a router is
20229 automatically skipped if any ancestor of the address that is being processed
20230 is the same as the current address and was processed by the current router.
20231 Such an address is therefore passed to the following routers, so it is handled
20232 as if there were no redirection. When making this loop-avoidance test, the
20233 complete local part, including any prefix or suffix, is used.
20234
20235 .cindex "address redirection" "local part without domain"
20236 Specifying the same local part without a domain is a common usage in personal
20237 filter files when the user wants to have messages delivered to the local
20238 mailbox and also forwarded elsewhere. For example, the user whose login is
20239 &'cleo'& might have a &_.forward_& file containing this:
20240 .code
20241 cleo, cleopatra@egypt.example
20242 .endd
20243 .cindex "backslash in alias file"
20244 .cindex "alias file" "backslash in"
20245 For compatibility with other MTAs, such unqualified local parts may be
20246 preceded by &"\"&, but this is not a requirement for loop prevention. However,
20247 it does make a difference if more than one domain is being handled
20248 synonymously.
20249
20250 If an item begins with &"\"& and the rest of the item parses as a valid RFC
20251 2822 address that does not include a domain, the item is qualified using the
20252 domain of the incoming address. In the absence of a leading &"\"&, unqualified
20253 addresses are qualified using the value in &%qualify_recipient%&, but you can
20254 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
20255
20256 Care must be taken if there are alias names for local users.
20257 Consider an MTA handling a single local domain where the system alias file
20258 contains:
20259 .code
20260 Sam.Reman: spqr
20261 .endd
20262 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
20263 messages in the local mailbox, and also forward copies elsewhere. He creates
20264 this forward file:
20265 .code
20266 Sam.Reman, spqr@reme.elsewhere.example
20267 .endd
20268 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
20269 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
20270 second time round, because it has previously routed it,
20271 and the following routers presumably cannot handle the alias. The forward file
20272 should really contain
20273 .code
20274 spqr, spqr@reme.elsewhere.example
20275 .endd
20276 but because this is such a common error, the &%check_ancestor%& option (see
20277 below) exists to provide a way to get round it. This is normally set on a
20278 &(redirect)& router that is handling users' &_.forward_& files.
20279
20280
20281
20282 .section "Special items in redirection lists" "SECTspecitredli"
20283 In addition to addresses, the following types of item may appear in redirection
20284 lists (that is, in non-filter redirection data):
20285
20286 .ilist
20287 .cindex "pipe" "in redirection list"
20288 .cindex "address redirection" "to pipe"
20289 An item is treated as a pipe command if it begins with &"|"& and does not parse
20290 as a valid RFC 2822 address that includes a domain. A transport for running the
20291 command must be specified by the &%pipe_transport%& option.
20292 Normally, either the router or the transport specifies a user and a group under
20293 which to run the delivery. The default is to use the Exim user and group.
20294
20295 Single or double quotes can be used for enclosing the individual arguments of
20296 the pipe command; no interpretation of escapes is done for single quotes. If
20297 the command contains a comma character, it is necessary to put the whole item
20298 in double quotes, for example:
20299 .code
20300 "|/some/command ready,steady,go"
20301 .endd
20302 since items in redirection lists are terminated by commas. Do not, however,
20303 quote just the command. An item such as
20304 .code
20305 |"/some/command ready,steady,go"
20306 .endd
20307 is interpreted as a pipe with a rather strange command name, and no arguments.
20308
20309 Note that the above example assumes that the text comes from a lookup source
20310 of some sort, so that the quotes are part of the data.  If composing a
20311 redirect router with a &%data%& option directly specifying this command, the
20312 quotes will be used by the configuration parser to define the extent of one
20313 string, but will not be passed down into the redirect router itself.  There
20314 are two main approaches to get around this: escape quotes to be part of the
20315 data itself, or avoid using this mechanism and instead create a custom
20316 transport with the &%command%& option set and reference that transport from
20317 an &%accept%& router.
20318
20319 .next
20320 .cindex "file" "in redirection list"
20321 .cindex "address redirection" "to file"
20322 An item is interpreted as a path name if it begins with &"/"& and does not
20323 parse as a valid RFC 2822 address that includes a domain. For example,
20324 .code
20325 /home/world/minbari
20326 .endd
20327 is treated as a file name, but
20328 .code
20329 /s=molari/o=babylon/@x400gate.way
20330 .endd
20331 is treated as an address. For a file name, a transport must be specified using
20332 the &%file_transport%& option. However, if the generated path name ends with a
20333 forward slash character, it is interpreted as a directory name rather than a
20334 file name, and &%directory_transport%& is used instead.
20335
20336 Normally, either the router or the transport specifies a user and a group under
20337 which to run the delivery. The default is to use the Exim user and group.
20338
20339 .cindex "&_/dev/null_&"
20340 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20341 bypassed at a high level, and the log entry shows &"**bypassed**"&
20342 instead of a transport name. In this case the user and group are not used.
20343
20344 .next
20345 .cindex "included address list"
20346 .cindex "address redirection" "included external list"
20347 If an item is of the form
20348 .code
20349 :include:<path name>
20350 .endd
20351 a list of further items is taken from the given file and included at that
20352 point. &*Note*&: Such a file can not be a filter file; it is just an
20353 out-of-line addition to the list. The items in the included list are separated
20354 by commas or newlines and are not subject to expansion. If this is the first
20355 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20356 the alias name. This example is incorrect:
20357 .code
20358 list1    :include:/opt/lists/list1
20359 .endd
20360 It must be given as
20361 .code
20362 list1:   :include:/opt/lists/list1
20363 .endd
20364 .next
20365 .cindex "address redirection" "to black hole"
20366 .cindex "delivery" "discard"
20367 .cindex "delivery" "blackhole"
20368 .cindex "black hole"
20369 .cindex "abandoning mail"
20370 Sometimes you want to throw away mail to a particular local part.  Making the
20371 &%data%& option expand to an empty string does not work, because that causes
20372 the router to decline. Instead, the alias item
20373 .code
20374 :blackhole:
20375 .endd
20376 can be used. It does what its name implies. No delivery is
20377 done, and no error message is generated. This has the same effect as specifying
20378 &_/dev/null_& as a destination, but it can be independently disabled.
20379
20380 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20381 delivery is done for the original local part, even if other redirection items
20382 are present. If you are generating a multi-item list (for example, by reading a
20383 database) and need the ability to provide a no-op item, you must use
20384 &_/dev/null_&.
20385
20386 .next
20387 .cindex "delivery" "forcing failure"
20388 .cindex "delivery" "forcing deferral"
20389 .cindex "failing delivery" "forcing"
20390 .cindex "deferred delivery, forcing"
20391 .cindex "customizing" "failure message"
20392 An attempt to deliver a particular address can be deferred or forced to fail by
20393 redirection items of the form
20394 .code
20395 :defer:
20396 :fail:
20397 .endd
20398 respectively. When a redirection list contains such an item, it applies
20399 to the entire redirection; any other items in the list are ignored. Any
20400 text following &':fail:'& or &':defer:'& is placed in the error text
20401 associated with the failure. For example, an alias file might contain:
20402 .code
20403 X.Employee:  :fail: Gone away, no forwarding address
20404 .endd
20405 In the case of an address that is being verified from an ACL or as the subject
20406 of a
20407 .cindex "VRFY" "error text, display of"
20408 VRFY command, the text is included in the SMTP error response by
20409 default.
20410 .cindex "EXPN" "error text, display of"
20411 The text is not included in the response to an EXPN command. In non-SMTP cases
20412 the text is included in the error message that Exim generates.
20413
20414 .cindex "SMTP" "error codes"
20415 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20416 &':fail:'&. However, if the message starts with three digits followed by a
20417 space, optionally followed by an extended code of the form &'n.n.n'&, also
20418 followed by a space, and the very first digit is the same as the default error
20419 code, the code from the message is used instead. If the very first digit is
20420 incorrect, a panic error is logged, and the default code is used. You can
20421 suppress the use of the supplied code in a redirect router by setting the
20422 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20423 ignored.
20424
20425 .vindex "&$acl_verify_message$&"
20426 In an ACL, an explicitly provided message overrides the default, but the
20427 default message is available in the variable &$acl_verify_message$& and can
20428 therefore be included in a custom message if this is desired.
20429
20430 Normally the error text is the rest of the redirection list &-- a comma does
20431 not terminate it &-- but a newline does act as a terminator. Newlines are not
20432 normally present in alias expansions. In &(lsearch)& lookups they are removed
20433 as part of the continuation process, but they may exist in other kinds of
20434 lookup and in &':include:'& files.
20435
20436 During routing for message delivery (as opposed to verification), a redirection
20437 containing &':fail:'& causes an immediate failure of the incoming address,
20438 whereas &':defer:'& causes the message to remain on the queue so that a
20439 subsequent delivery attempt can happen at a later time. If an address is
20440 deferred for too long, it will ultimately fail, because the normal retry
20441 rules still apply.
20442
20443 .next
20444 .cindex "alias file" "exception to default"
20445 Sometimes it is useful to use a single-key search type with a default (see
20446 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20447 for exceptions to the default. These can be handled by aliasing them to
20448 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20449 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20450 results in an empty redirection list has the same effect.
20451 .endlist
20452
20453
20454 .section "Duplicate addresses" "SECTdupaddr"
20455 .cindex "duplicate addresses"
20456 .cindex "address duplicate, discarding"
20457 .cindex "pipe" "duplicated"
20458 Exim removes duplicate addresses from the list to which it is delivering, so as
20459 to deliver just one copy to each address. This does not apply to deliveries
20460 routed to pipes by different immediate parent addresses, but an indirect
20461 aliasing scheme of the type
20462 .code
20463 pipe:       |/some/command $local_part
20464 localpart1: pipe
20465 localpart2: pipe
20466 .endd
20467 does not work with a message that is addressed to both local parts, because
20468 when the second is aliased to the intermediate local part &"pipe"& it gets
20469 discarded as being the same as a previously handled address. However, a scheme
20470 such as
20471 .code
20472 localpart1: |/some/command $local_part
20473 localpart2: |/some/command $local_part
20474 .endd
20475 does result in two different pipe deliveries, because the immediate parents of
20476 the pipes are distinct.
20477
20478
20479
20480 .section "Repeated redirection expansion" "SECID128"
20481 .cindex "repeated redirection expansion"
20482 .cindex "address redirection" "repeated for each delivery attempt"
20483 When a message cannot be delivered to all of its recipients immediately,
20484 leading to two or more delivery attempts, redirection expansion is carried out
20485 afresh each time for those addresses whose children were not all previously
20486 delivered. If redirection is being used as a mailing list, this can lead to new
20487 members of the list receiving copies of old messages. The &%one_time%& option
20488 can be used to avoid this.
20489
20490
20491 .section "Errors in redirection lists" "SECID129"
20492 .cindex "address redirection" "errors"
20493 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20494 error is skipped, and an entry is written to the main log. This may be useful
20495 for mailing lists that are automatically managed. Otherwise, if an error is
20496 detected while generating the list of new addresses, the original address is
20497 deferred. See also &%syntax_errors_to%&.
20498
20499
20500
20501 .section "Private options for the redirect router" "SECID130"
20502
20503 .cindex "options" "&(redirect)& router"
20504 The private options for the &(redirect)& router are as follows:
20505
20506
20507 .option allow_defer redirect boolean false
20508 Setting this option allows the use of &':defer:'& in non-filter redirection
20509 data, or the &%defer%& command in an Exim filter file.
20510
20511
20512 .option allow_fail redirect boolean false
20513 .cindex "failing delivery" "from filter"
20514 If this option is true, the &':fail:'& item can be used in a redirection list,
20515 and the &%fail%& command may be used in an Exim filter file.
20516
20517
20518 .option allow_filter redirect boolean false
20519 .cindex "filter" "enabling use of"
20520 .cindex "Sieve filter" "enabling use of"
20521 Setting this option allows Exim to interpret redirection data that starts with
20522 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20523 are some features of Exim filter files that some administrators may wish to
20524 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20525
20526 It is also possible to lock out Exim filters or Sieve filters while allowing
20527 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20528
20529
20530 The filter is run using the uid and gid set by the generic &%user%& and
20531 &%group%& options. These take their defaults from the password data if
20532 &%check_local_user%& is set, so in the normal case of users' personal filter
20533 files, the filter is run as the relevant user. When &%allow_filter%& is set
20534 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20535
20536
20537
20538 .option allow_freeze redirect boolean false
20539 .cindex "freezing messages" "allowing in filter"
20540 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20541 This command is more normally encountered in system filters, and is disabled by
20542 default for redirection filters because it isn't something you usually want to
20543 let ordinary users do.
20544
20545
20546
20547 .option check_ancestor redirect boolean false
20548 This option is concerned with handling generated addresses that are the same
20549 as some address in the list of redirection ancestors of the current address.
20550 Although it is turned off by default in the code, it is set in the default
20551 configuration file for handling users' &_.forward_& files. It is recommended
20552 for this use of the &(redirect)& router.
20553
20554 When &%check_ancestor%& is set, if a generated address (including the domain)
20555 is the same as any ancestor of the current address, it is replaced by a copy of
20556 the current address. This helps in the case where local part A is aliased to B,
20557 and B has a &_.forward_& file pointing back to A. For example, within a single
20558 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20559 &_&~jb/.forward_& contains:
20560 .code
20561 \Joe.Bloggs, <other item(s)>
20562 .endd
20563 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20564 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20565 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20566 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20567 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20568 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20569 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20570 original address. See also the &%repeat_use%& option below.
20571
20572
20573 .option check_group redirect boolean "see below"
20574 When the &%file%& option is used, the group owner of the file is checked only
20575 when this option is set. The permitted groups are those listed in the
20576 &%owngroups%& option, together with the user's default group if
20577 &%check_local_user%& is set. If the file has the wrong group, routing is
20578 deferred. The default setting for this option is true if &%check_local_user%&
20579 is set and the &%modemask%& option permits the group write bit, or if the
20580 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20581
20582
20583
20584 .option check_owner redirect boolean "see below"
20585 When the &%file%& option is used, the owner of the file is checked only when
20586 this option is set. If &%check_local_user%& is set, the local user is
20587 permitted; otherwise the owner must be one of those listed in the &%owners%&
20588 option. The default value for this option is true if &%check_local_user%& or
20589 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20590
20591
20592 .option data redirect string&!! unset
20593 This option is mutually exclusive with &%file%&. One or other of them must be
20594 set, but not both. The contents of &%data%& are expanded, and then used as the
20595 list of forwarding items, or as a set of filtering instructions. If the
20596 expansion is forced to fail, or the result is an empty string or a string that
20597 has no effect (consists entirely of comments), the router declines.
20598
20599 When filtering instructions are used, the string must begin with &"#Exim
20600 filter"&, and all comments in the string, including this initial one, must be
20601 terminated with newline characters. For example:
20602 .code
20603 data = #Exim filter\n\
20604        if $h_to: contains Exim then save $home/mail/exim endif
20605 .endd
20606 If you are reading the data from a database where newlines cannot be included,
20607 you can use the &${sg}$& expansion item to turn the escape string of your
20608 choice into a newline.
20609
20610
20611 .option directory_transport redirect string&!! unset
20612 A &(redirect)& router sets up a direct delivery to a directory when a path name
20613 ending with a slash is specified as a new &"address"&. The transport used is
20614 specified by this option, which, after expansion, must be the name of a
20615 configured transport. This should normally be an &(appendfile)& transport.
20616
20617
20618 .option file redirect string&!! unset
20619 This option specifies the name of a file that contains the redirection data. It
20620 is mutually exclusive with the &%data%& option. The string is expanded before
20621 use; if the expansion is forced to fail, the router declines. Other expansion
20622 failures cause delivery to be deferred. The result of a successful expansion
20623 must be an absolute path. The entire file is read and used as the redirection
20624 data. If the data is an empty string or a string that has no effect (consists
20625 entirely of comments), the router declines.
20626
20627 .cindex "NFS" "checking for file existence"
20628 If the attempt to open the file fails with a &"does not exist"& error, Exim
20629 runs a check on the containing directory,
20630 unless &%ignore_enotdir%& is true (see below).
20631 If the directory does not appear to exist, delivery is deferred. This can
20632 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20633 is a mount problem. If the containing directory does exist, but the file does
20634 not, the router declines.
20635
20636
20637 .option file_transport redirect string&!! unset
20638 .vindex "&$address_file$&"
20639 A &(redirect)& router sets up a direct delivery to a file when a path name not
20640 ending in a slash is specified as a new &"address"&. The transport used is
20641 specified by this option, which, after expansion, must be the name of a
20642 configured transport. This should normally be an &(appendfile)& transport. When
20643 it is running, the file name is in &$address_file$&.
20644
20645
20646 .option filter_prepend_home redirect boolean true
20647 When this option is true, if a &(save)& command in an Exim filter specifies a
20648 relative path, and &$home$& is defined, it is automatically prepended to the
20649 relative path. If this option is set false, this action does not happen. The
20650 relative path is then passed to the transport unmodified.
20651
20652
20653 .option forbid_blackhole redirect boolean false
20654 .cindex "restricting access to features"
20655 .cindex "filter" "locking out certain features"
20656 If this option is true, the &':blackhole:'& item may not appear in a
20657 redirection list.
20658
20659
20660 .option forbid_exim_filter redirect boolean false
20661 .cindex "restricting access to features"
20662 .cindex "filter" "locking out certain features"
20663 If this option is set true, only Sieve filters are permitted when
20664 &%allow_filter%& is true.
20665
20666
20667
20668
20669 .option forbid_file redirect boolean false
20670 .cindex "restricting access to features"
20671 .cindex "delivery" "to file; forbidding"
20672 .cindex "filter" "locking out certain features"
20673 .cindex "Sieve filter" "forbidding delivery to a file"
20674 .cindex "Sieve filter" "&""keep""& facility; disabling"
20675 If this option is true, this router may not generate a new address that
20676 specifies delivery to a local file or directory, either from a filter or from a
20677 conventional forward file. This option is forced to be true if &%one_time%& is
20678 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20679 locks out the Sieve's &"keep"& facility.
20680
20681
20682 .option forbid_filter_dlfunc redirect boolean false
20683 .cindex "restricting access to features"
20684 .cindex "filter" "locking out certain features"
20685 If this option is true, string expansions in Exim filters are not allowed to
20686 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20687 functions.
20688
20689 .option forbid_filter_existstest redirect boolean false
20690 .cindex "restricting access to features"
20691 .cindex "filter" "locking out certain features"
20692 .cindex "expansion" "statting a file"
20693 If this option is true, string expansions in Exim filters are not allowed to
20694 make use of the &%exists%& condition or the &%stat%& expansion item.
20695
20696 .option forbid_filter_logwrite redirect boolean false
20697 .cindex "restricting access to features"
20698 .cindex "filter" "locking out certain features"
20699 If this option is true, use of the logging facility in Exim filters is not
20700 permitted. Logging is in any case available only if the filter is being run
20701 under some unprivileged uid (which is normally the case for ordinary users'
20702 &_.forward_& files).
20703
20704
20705 .option forbid_filter_lookup redirect boolean false
20706 .cindex "restricting access to features"
20707 .cindex "filter" "locking out certain features"
20708 If this option is true, string expansions in Exim filter files are not allowed
20709 to make use of &%lookup%& items.
20710
20711
20712 .option forbid_filter_perl redirect boolean false
20713 .cindex "restricting access to features"
20714 .cindex "filter" "locking out certain features"
20715 This option has an effect only if Exim is built with embedded Perl support. If
20716 it is true, string expansions in Exim filter files are not allowed to make use
20717 of the embedded Perl support.
20718
20719
20720 .option forbid_filter_readfile redirect boolean false
20721 .cindex "restricting access to features"
20722 .cindex "filter" "locking out certain features"
20723 If this option is true, string expansions in Exim filter files are not allowed
20724 to make use of &%readfile%& items.
20725
20726
20727 .option forbid_filter_readsocket redirect boolean false
20728 .cindex "restricting access to features"
20729 .cindex "filter" "locking out certain features"
20730 If this option is true, string expansions in Exim filter files are not allowed
20731 to make use of &%readsocket%& items.
20732
20733
20734 .option forbid_filter_reply redirect boolean false
20735 .cindex "restricting access to features"
20736 .cindex "filter" "locking out certain features"
20737 If this option is true, this router may not generate an automatic reply
20738 message. Automatic replies can be generated only from Exim or Sieve filter
20739 files, not from traditional forward files. This option is forced to be true if
20740 &%one_time%& is set.
20741
20742
20743 .option forbid_filter_run redirect boolean false
20744 .cindex "restricting access to features"
20745 .cindex "filter" "locking out certain features"
20746 If this option is true, string expansions in Exim filter files are not allowed
20747 to make use of &%run%& items.
20748
20749
20750 .option forbid_include redirect boolean false
20751 .cindex "restricting access to features"
20752 .cindex "filter" "locking out certain features"
20753 If this option is true, items of the form
20754 .code
20755 :include:<path name>
20756 .endd
20757 are not permitted in non-filter redirection lists.
20758
20759
20760 .option forbid_pipe redirect boolean false
20761 .cindex "restricting access to features"
20762 .cindex "filter" "locking out certain features"
20763 .cindex "delivery" "to pipe; forbidding"
20764 If this option is true, this router may not generate a new address which
20765 specifies delivery to a pipe, either from an Exim filter or from a conventional
20766 forward file. This option is forced to be true if &%one_time%& is set.
20767
20768
20769 .option forbid_sieve_filter redirect boolean false
20770 .cindex "restricting access to features"
20771 .cindex "filter" "locking out certain features"
20772 If this option is set true, only Exim filters are permitted when
20773 &%allow_filter%& is true.
20774
20775
20776 .cindex "SMTP" "error codes"
20777 .option forbid_smtp_code redirect boolean false
20778 If this option is set true, any SMTP error codes that are present at the start
20779 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
20780 the default codes (451 and 550, respectively) are always used.
20781
20782
20783
20784
20785 .option hide_child_in_errmsg redirect boolean false
20786 .cindex "bounce message" "redirection details; suppressing"
20787 If this option is true, it prevents Exim from quoting a child address if it
20788 generates a bounce or delay message for it. Instead it says &"an address
20789 generated from <&'the top level address'&>"&. Of course, this applies only to
20790 bounces generated locally. If a message is forwarded to another host, &'its'&
20791 bounce may well quote the generated address.
20792
20793
20794 .option ignore_eacces redirect boolean false
20795 .cindex "EACCES"
20796 If this option is set and an attempt to open a redirection file yields the
20797 EACCES error (permission denied), the &(redirect)& router behaves as if the
20798 file did not exist.
20799
20800
20801 .option ignore_enotdir redirect boolean false
20802 .cindex "ENOTDIR"
20803 If this option is set and an attempt to open a redirection file yields the
20804 ENOTDIR error (something on the path is not a directory), the &(redirect)&
20805 router behaves as if the file did not exist.
20806
20807 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
20808 router that has the &%file%& option set discovers that the file does not exist
20809 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
20810 against unmounted NFS directories. If the parent can not be statted, delivery
20811 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
20812 is set, because that option tells Exim to ignore &"something on the path is not
20813 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
20814 that some operating systems give ENOENT where others give ENOTDIR.
20815
20816
20817
20818 .option include_directory redirect string unset
20819 If this option is set, the path names of any &':include:'& items in a
20820 redirection list must start with this directory.
20821
20822
20823 .option modemask redirect "octal integer" 022
20824 This specifies mode bits which must not be set for a file specified by the
20825 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
20826
20827
20828 .option one_time redirect boolean false
20829 .cindex "one-time aliasing/forwarding expansion"
20830 .cindex "alias file" "one-time expansion"
20831 .cindex "forward file" "one-time expansion"
20832 .cindex "mailing lists" "one-time expansion"
20833 .cindex "address redirection" "one-time expansion"
20834 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
20835 files each time it tries to deliver a message causes a problem when one or more
20836 of the generated addresses fails be delivered at the first attempt. The problem
20837 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
20838 but of what happens when the redirection list changes during the time that the
20839 message is on Exim's queue. This is particularly true in the case of mailing
20840 lists, where new subscribers might receive copies of messages that were posted
20841 before they subscribed.
20842
20843 If &%one_time%& is set and any addresses generated by the router fail to
20844 deliver at the first attempt, the failing addresses are added to the message as
20845 &"top level"& addresses, and the parent address that generated them is marked
20846 &"delivered"&. Thus, redirection does not happen again at the next delivery
20847 attempt.
20848
20849 &*Warning 1*&: Any header line addition or removal that is specified by this
20850 router would be lost if delivery did not succeed at the first attempt. For this
20851 reason, the &%headers_add%& and &%headers_remove%& generic options are not
20852 permitted when &%one_time%& is set.
20853
20854 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
20855 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
20856 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
20857
20858 &*Warning 3*&: The &%unseen%& generic router option may not be set with
20859 &%one_time%&.
20860
20861 The original top-level address is remembered with each of the generated
20862 addresses, and is output in any log messages. However, any intermediate parent
20863 addresses are not recorded. This makes a difference to the log only if
20864 &%all_parents%& log selector is set. It is expected that &%one_time%& will
20865 typically be used for mailing lists, where there is normally just one level of
20866 expansion.
20867
20868
20869 .option owners redirect "string list" unset
20870 .cindex "ownership" "alias file"
20871 .cindex "ownership" "forward file"
20872 .cindex "alias file" "ownership"
20873 .cindex "forward file" "ownership"
20874 This specifies a list of permitted owners for the file specified by &%file%&.
20875 This list is in addition to the local user when &%check_local_user%& is set.
20876 See &%check_owner%& above.
20877
20878
20879 .option owngroups redirect "string list" unset
20880 This specifies a list of permitted groups for the file specified by &%file%&.
20881 The list is in addition to the local user's primary group when
20882 &%check_local_user%& is set. See &%check_group%& above.
20883
20884
20885 .option pipe_transport redirect string&!! unset
20886 .vindex "&$address_pipe$&"
20887 A &(redirect)& router sets up a direct delivery to a pipe when a string
20888 starting with a vertical bar character is specified as a new &"address"&. The
20889 transport used is specified by this option, which, after expansion, must be the
20890 name of a configured transport. This should normally be a &(pipe)& transport.
20891 When the transport is run, the pipe command is in &$address_pipe$&.
20892
20893
20894 .option qualify_domain redirect string&!! unset
20895 .vindex "&$qualify_recipient$&"
20896 If this option is set, and an unqualified address (one without a domain) is
20897 generated, and that address would normally be qualified by the global setting
20898 in &%qualify_recipient%&, it is instead qualified with the domain specified by
20899 expanding this string. If the expansion fails, the router declines. If you want
20900 to revert to the default, you can have the expansion generate
20901 &$qualify_recipient$&.
20902
20903 This option applies to all unqualified addresses generated by Exim filters,
20904 but for traditional &_.forward_& files, it applies only to addresses that are
20905 not preceded by a backslash. Sieve filters cannot generate unqualified
20906 addresses.
20907
20908 .option qualify_preserve_domain redirect boolean false
20909 .cindex "domain" "in redirection; preserving"
20910 .cindex "preserving domain in redirection"
20911 .cindex "address redirection" "domain; preserving"
20912 If this option is set, the router's local &%qualify_domain%& option must not be
20913 set (a configuration error occurs if it is). If an unqualified address (one
20914 without a domain) is generated, it is qualified with the domain of the parent
20915 address (the immediately preceding ancestor) instead of the global
20916 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
20917 this applies whether or not the address is preceded by a backslash.
20918
20919
20920 .option repeat_use redirect boolean true
20921 If this option is set false, the router is skipped for a child address that has
20922 any ancestor that was routed by this router. This test happens before any of
20923 the other preconditions are tested. Exim's default anti-looping rules skip
20924 only when the ancestor is the same as the current address. See also
20925 &%check_ancestor%& above and the generic &%redirect_router%& option.
20926
20927
20928 .option reply_transport redirect string&!! unset
20929 A &(redirect)& router sets up an automatic reply when a &%mail%& or
20930 &%vacation%& command is used in a filter file. The transport used is specified
20931 by this option, which, after expansion, must be the name of a configured
20932 transport. This should normally be an &(autoreply)& transport. Other transports
20933 are unlikely to do anything sensible or useful.
20934
20935
20936 .option rewrite redirect boolean true
20937 .cindex "address redirection" "disabling rewriting"
20938 If this option is set false, addresses generated by the router are not
20939 subject to address rewriting. Otherwise, they are treated like new addresses
20940 and are rewritten according to the global rewriting rules.
20941
20942
20943 .option sieve_subaddress redirect string&!! unset
20944 The value of this option is passed to a Sieve filter to specify the
20945 :subaddress part of an address.
20946
20947 .option sieve_useraddress redirect string&!! unset
20948 The value of this option is passed to a Sieve filter to specify the :user part
20949 of an address. However, if it is unset, the entire original local part
20950 (including any prefix or suffix) is used for :user.
20951
20952
20953 .option sieve_vacation_directory redirect string&!! unset
20954 .cindex "Sieve filter" "vacation directory"
20955 To enable the &"vacation"& extension for Sieve filters, you must set
20956 &%sieve_vacation_directory%& to the directory where vacation databases are held
20957 (do not put anything else in that directory), and ensure that the
20958 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20959 needs their own directory; Exim will create it if necessary.
20960
20961
20962
20963 .option skip_syntax_errors redirect boolean false
20964 .cindex "forward file" "broken"
20965 .cindex "address redirection" "broken files"
20966 .cindex "alias file" "broken"
20967 .cindex "broken alias or forward files"
20968 .cindex "ignoring faulty addresses"
20969 .cindex "skipping faulty addresses"
20970 .cindex "error" "skipping bad syntax"
20971 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20972 non-filter redirection data are skipped, and each failing address is logged. If
20973 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20974 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20975 are expanded and placed at the head of the error message generated by
20976 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20977 be the same address as the generic &%errors_to%& option. The
20978 &%skip_syntax_errors%& option is often used when handling mailing lists.
20979
20980 If all the addresses in a redirection list are skipped because of syntax
20981 errors, the router declines to handle the original address, and it is passed to
20982 the following routers.
20983
20984 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20985 error in the filter causes filtering to be abandoned without any action being
20986 taken. The incident is logged, and the router declines to handle the address,
20987 so it is passed to the following routers.
20988
20989 .cindex "Sieve filter" "syntax errors in"
20990 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20991 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20992 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20993
20994 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20995 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20996 option, used with an address that does not get redirected, can be used to
20997 notify users of these errors, by means of a router like this:
20998 .code
20999 userforward:
21000   driver = redirect
21001   allow_filter
21002   check_local_user
21003   file = $home/.forward
21004   file_transport = address_file
21005   pipe_transport = address_pipe
21006   reply_transport = address_reply
21007   no_verify
21008   skip_syntax_errors
21009   syntax_errors_to = real-$local_part@$domain
21010   syntax_errors_text = \
21011    This is an automatically generated message. An error has\n\
21012    been found in your .forward file. Details of the error are\n\
21013    reported below. While this error persists, you will receive\n\
21014    a copy of this message for every message that is addressed\n\
21015    to you. If your .forward file is a filter file, or if it is\n\
21016    a non-filter file containing no valid forwarding addresses,\n\
21017    a copy of each incoming message will be put in your normal\n\
21018    mailbox. If a non-filter file contains at least one valid\n\
21019    forwarding address, forwarding to the valid addresses will\n\
21020    happen, and those will be the only deliveries that occur.
21021 .endd
21022 You also need a router to ensure that local addresses that are prefixed by
21023 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21024 put this immediately before the &(userforward)& router:
21025 .code
21026 real_localuser:
21027   driver = accept
21028   check_local_user
21029   local_part_prefix = real-
21030   transport = local_delivery
21031 .endd
21032 For security, it would probably be a good idea to restrict the use of this
21033 router to locally-generated messages, using a condition such as this:
21034 .code
21035   condition = ${if match {$sender_host_address}\
21036                          {\N^(|127\.0\.0\.1)$\N}}
21037 .endd
21038
21039
21040 .option syntax_errors_text redirect string&!! unset
21041 See &%skip_syntax_errors%& above.
21042
21043
21044 .option syntax_errors_to redirect string unset
21045 See &%skip_syntax_errors%& above.
21046 .ecindex IIDredrou1
21047 .ecindex IIDredrou2
21048
21049
21050
21051
21052
21053
21054 . ////////////////////////////////////////////////////////////////////////////
21055 . ////////////////////////////////////////////////////////////////////////////
21056
21057 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21058          "Environment for local transports"
21059 .scindex IIDenvlotra1 "local transports" "environment for"
21060 .scindex IIDenvlotra2 "environment" "local transports"
21061 .scindex IIDenvlotra3 "transport" "local; environment for"
21062 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21063 transport can be thought of as similar to a pipe.) Exim always runs transports
21064 in subprocesses, under specified uids and gids. Typical deliveries to local
21065 mailboxes run under the uid and gid of the local user.
21066
21067 Exim also sets a specific current directory while running the transport; for
21068 some transports a home directory setting is also relevant. The &(pipe)&
21069 transport is the only one that sets up environment variables; see section
21070 &<<SECTpipeenv>>& for details.
21071
21072 The values used for the uid, gid, and the directories may come from several
21073 different places. In many cases, the router that handles the address associates
21074 settings with that address as a result of its &%check_local_user%&, &%group%&,
21075 or &%user%& options. However, values may also be given in the transport's own
21076 configuration, and these override anything that comes from the router.
21077
21078
21079
21080 .section "Concurrent deliveries" "SECID131"
21081 .cindex "concurrent deliveries"
21082 .cindex "simultaneous deliveries"
21083 If two different messages for the same local recipient arrive more or less
21084 simultaneously, the two delivery processes are likely to run concurrently. When
21085 the &(appendfile)& transport is used to write to a file, Exim applies locking
21086 rules to stop concurrent processes from writing to the same file at the same
21087 time.
21088
21089 However, when you use a &(pipe)& transport, it is up to you to arrange any
21090 locking that is needed. Here is a silly example:
21091 .code
21092 my_transport:
21093   driver = pipe
21094   command = /bin/sh -c 'cat >>/some/file'
21095 .endd
21096 This is supposed to write the message at the end of the file. However, if two
21097 messages arrive at the same time, the file will be scrambled. You can use the
21098 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21099 file using the same algorithm that Exim itself uses.
21100
21101
21102
21103
21104 .section "Uids and gids" "SECTenvuidgid"
21105 .cindex "local transports" "uid and gid"
21106 .cindex "transport" "local; uid and gid"
21107 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21108 overrides any group that the router set in the address, even if &%user%& is not
21109 set for the transport. This makes it possible, for example, to run local mail
21110 delivery under the uid of the recipient (set by the router), but in a special
21111 group (set by the transport). For example:
21112 .code
21113 # Routers ...
21114 # User/group are set by check_local_user in this router
21115 local_users:
21116   driver = accept
21117   check_local_user
21118   transport = group_delivery
21119
21120 # Transports ...
21121 # This transport overrides the group
21122 group_delivery:
21123   driver = appendfile
21124   file = /var/spool/mail/$local_part
21125   group = mail
21126 .endd
21127 If &%user%& is set for a transport, its value overrides what is set in the
21128 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21129 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21130 set.
21131
21132 .oindex "&%initgroups%&"
21133 When the uid is taken from the transport's configuration, the &[initgroups()]&
21134 function is called for the groups associated with that uid if the
21135 &%initgroups%& option is set for the transport. When the uid is not specified
21136 by the transport, but is associated with the address by a router, the option
21137 for calling &[initgroups()]& is taken from the router configuration.
21138
21139 .cindex "&(pipe)& transport" "uid for"
21140 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
21141 is set and &%user%& is not set, the uid of the process that called Exim to
21142 receive the message is used, and if &%group%& is not set, the corresponding
21143 original gid is also used.
21144
21145 This is the detailed preference order for obtaining a gid; the first of the
21146 following that is set is used:
21147
21148 .ilist
21149 A &%group%& setting of the transport;
21150 .next
21151 A &%group%& setting of the router;
21152 .next
21153 A gid associated with a user setting of the router, either as a result of
21154 &%check_local_user%& or an explicit non-numeric &%user%& setting;
21155 .next
21156 The group associated with a non-numeric &%user%& setting of the transport;
21157 .next
21158 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
21159 the uid is the creator's uid;
21160 .next
21161 The Exim gid if the Exim uid is being used as a default.
21162 .endlist
21163
21164 If, for example, the user is specified numerically on the router and there are
21165 no group settings, no gid is available. In this situation, an error occurs.
21166 This is different for the uid, for which there always is an ultimate default.
21167 The first of the following that is set is used:
21168
21169 .ilist
21170 A &%user%& setting of the transport;
21171 .next
21172 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
21173 .next
21174 A &%user%& setting of the router;
21175 .next
21176 A &%check_local_user%& setting of the router;
21177 .next
21178 The Exim uid.
21179 .endlist
21180
21181 Of course, an error will still occur if the uid that is chosen is on the
21182 &%never_users%& list.
21183
21184
21185
21186
21187
21188 .section "Current and home directories" "SECID132"
21189 .cindex "current directory for local transport"
21190 .cindex "home directory" "for local transport"
21191 .cindex "transport" "local; home directory for"
21192 .cindex "transport" "local; current directory for"
21193 Routers may set current and home directories for local transports by means of
21194 the &%transport_current_directory%& and &%transport_home_directory%& options.
21195 However, if the transport's &%current_directory%& or &%home_directory%& options
21196 are set, they override the router's values. In detail, the home directory
21197 for a local transport is taken from the first of these values that is set:
21198
21199 .ilist
21200 The &%home_directory%& option on the transport;
21201 .next
21202 The &%transport_home_directory%& option on the router;
21203 .next
21204 The password data if &%check_local_user%& is set on the router;
21205 .next
21206 The &%router_home_directory%& option on the router.
21207 .endlist
21208
21209 The current directory is taken from the first of these values that is set:
21210
21211 .ilist
21212 The &%current_directory%& option on the transport;
21213 .next
21214 The &%transport_current_directory%& option on the router.
21215 .endlist
21216
21217
21218 If neither the router nor the transport sets a current directory, Exim uses the
21219 value of the home directory, if it is set. Otherwise it sets the current
21220 directory to &_/_& before running a local transport.
21221
21222
21223
21224 .section "Expansion variables derived from the address" "SECID133"
21225 .vindex "&$domain$&"
21226 .vindex "&$local_part$&"
21227 .vindex "&$original_domain$&"
21228 Normally a local delivery is handling a single address, and in that case the
21229 variables such as &$domain$& and &$local_part$& are set during local
21230 deliveries. However, in some circumstances more than one address may be handled
21231 at once (for example, while writing batch SMTP for onward transmission by some
21232 other means). In this case, the variables associated with the local part are
21233 never set, &$domain$& is set only if all the addresses have the same domain,
21234 and &$original_domain$& is never set.
21235 .ecindex IIDenvlotra1
21236 .ecindex IIDenvlotra2
21237 .ecindex IIDenvlotra3
21238
21239
21240
21241
21242
21243
21244
21245 . ////////////////////////////////////////////////////////////////////////////
21246 . ////////////////////////////////////////////////////////////////////////////
21247
21248 .chapter "Generic options for transports" "CHAPtransportgeneric"
21249 .scindex IIDgenoptra1 "generic options" "transport"
21250 .scindex IIDgenoptra2 "options" "generic; for transports"
21251 .scindex IIDgenoptra3 "transport" "generic options for"
21252 The following generic options apply to all transports:
21253
21254
21255 .option body_only transports boolean false
21256 .cindex "transport" "body only"
21257 .cindex "message" "transporting body only"
21258 .cindex "body of message" "transporting"
21259 If this option is set, the message's headers are not transported. It is
21260 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
21261 or &(pipe)& transports, the settings of &%message_prefix%& and
21262 &%message_suffix%& should be checked, because this option does not
21263 automatically suppress them.
21264
21265
21266 .option current_directory transports string&!! unset
21267 .cindex "transport" "current directory for"
21268 This specifies the current directory that is to be set while running the
21269 transport, overriding any value that may have been set by the router.
21270 If the expansion fails for any reason, including forced failure, an error is
21271 logged, and delivery is deferred.
21272
21273
21274 .option disable_logging transports boolean false
21275 If this option is set true, nothing is logged for any
21276 deliveries by the transport or for any
21277 transport errors. You should not set this option unless you really, really know
21278 what you are doing.
21279
21280
21281 .option debug_print transports string&!! unset
21282 .cindex "testing" "variables in drivers"
21283 If this option is set and debugging is enabled (see the &%-d%& command line
21284 option), the string is expanded and included in the debugging output when the
21285 transport is run.
21286 If expansion of the string fails, the error message is written to the debugging
21287 output, and Exim carries on processing.
21288 This facility is provided to help with checking out the values of variables and
21289 so on when debugging driver configurations. For example, if a &%headers_add%&
21290 option is not working properly, &%debug_print%& could be used to output the
21291 variables it references. A newline is added to the text if it does not end with
21292 one.
21293 The variables &$transport_name$& and &$router_name$& contain the name of the
21294 transport and the router that called it.
21295
21296 .option delivery_date_add transports boolean false
21297 .cindex "&'Delivery-date:'& header line"
21298 If this option is true, a &'Delivery-date:'& header is added to the message.
21299 This gives the actual time the delivery was made. As this is not a standard
21300 header, Exim has a configuration option (&%delivery_date_remove%&) which
21301 requests its removal from incoming messages, so that delivered messages can
21302 safely be resent to other recipients.
21303
21304
21305 .option driver transports string unset
21306 This specifies which of the available transport drivers is to be used.
21307 There is no default, and this option must be set for every transport.
21308
21309
21310 .option envelope_to_add transports boolean false
21311 .cindex "&'Envelope-to:'& header line"
21312 If this option is true, an &'Envelope-to:'& header is added to the message.
21313 This gives the original address(es) in the incoming envelope that caused this
21314 delivery to happen. More than one address may be present if the transport is
21315 configured to handle several addresses at once, or if more than one original
21316 address was redirected to the same final address. As this is not a standard
21317 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21318 its removal from incoming messages, so that delivered messages can safely be
21319 resent to other recipients.
21320
21321
21322 .option event_action transports string&!! unset
21323 .cindex events
21324 This option declares a string to be expanded for Exim's events mechanism.
21325 For details see chapter &<<CHAPevents>>&.
21326
21327
21328 .option group transports string&!! "Exim group"
21329 .cindex "transport" "group; specifying"
21330 This option specifies a gid for running the transport process, overriding any
21331 value that the router supplies, and also overriding any value associated with
21332 &%user%& (see below).
21333
21334
21335 .option headers_add transports list&!! unset
21336 .cindex "header lines" "adding in transport"
21337 .cindex "transport" "header lines; adding"
21338 This option specifies a list of text headers,
21339 newline-separated (by default, changeable in the usual way),
21340 which are (separately) expanded and added to the header
21341 portion of a message as it is transported, as described in section
21342 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
21343 routers. If the result of the expansion is an empty string, or if the expansion
21344 is forced to fail, no action is taken. Other expansion failures are treated as
21345 errors and cause the delivery to be deferred.
21346
21347 Unlike most options, &%headers_add%& can be specified multiple times
21348 for a transport; all listed headers are added.
21349
21350
21351 .option headers_only transports boolean false
21352 .cindex "transport" "header lines only"
21353 .cindex "message" "transporting headers only"
21354 .cindex "header lines" "transporting"
21355 If this option is set, the message's body is not transported. It is mutually
21356 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
21357 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
21358 checked, since this option does not automatically suppress them.
21359
21360
21361 .option headers_remove transports list&!! unset
21362 .cindex "header lines" "removing"
21363 .cindex "transport" "header lines; removing"
21364 This option specifies a list of header names,
21365 colon-separated (by default, changeable in the usual way);
21366 these headers are omitted from the message as it is transported, as described
21367 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21368 routers.
21369 Each list item is separately expanded.
21370 If the result of the expansion is an empty string, or if the expansion
21371 is forced to fail, no action is taken. Other expansion failures are treated as
21372 errors and cause the delivery to be deferred.
21373
21374 Unlike most options, &%headers_remove%& can be specified multiple times
21375 for a transport; all listed headers are removed.
21376
21377 &*Warning*&: Because of the separate expansion of the list items,
21378 items that contain a list separator must have it doubled.
21379 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21380
21381
21382
21383 .option headers_rewrite transports string unset
21384 .cindex "transport" "header lines; rewriting"
21385 .cindex "rewriting" "at transport time"
21386 This option allows addresses in header lines to be rewritten at transport time,
21387 that is, as the message is being copied to its destination. The contents of the
21388 option are a colon-separated list of rewriting rules. Each rule is in exactly
21389 the same form as one of the general rewriting rules that are applied when a
21390 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21391 example,
21392 .code
21393 headers_rewrite = a@b c@d f : \
21394                   x@y w@z
21395 .endd
21396 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21397 &'w@z'& in all address-bearing header lines. The rules are applied to the
21398 header lines just before they are written out at transport time, so they affect
21399 only those copies of the message that pass through the transport. However, only
21400 the message's original header lines, and any that were added by a system
21401 filter, are rewritten. If a router or transport adds header lines, they are not
21402 affected by this option. These rewriting rules are &'not'& applied to the
21403 envelope. You can change the return path using &%return_path%&, but you cannot
21404 change envelope recipients at this time.
21405
21406
21407 .option home_directory transports string&!! unset
21408 .cindex "transport" "home directory for"
21409 .vindex "&$home$&"
21410 This option specifies a home directory setting for a local transport,
21411 overriding any value that may be set by the router. The home directory is
21412 placed in &$home$& while expanding the transport's private options. It is also
21413 used as the current directory if no current directory is set by the
21414 &%current_directory%& option on the transport or the
21415 &%transport_current_directory%& option on the router. If the expansion fails
21416 for any reason, including forced failure, an error is logged, and delivery is
21417 deferred.
21418
21419
21420 .option initgroups transports boolean false
21421 .cindex "additional groups"
21422 .cindex "groups" "additional"
21423 .cindex "transport" "group; additional"
21424 If this option is true and the uid for the delivery process is provided by the
21425 transport, the &[initgroups()]& function is called when running the transport
21426 to ensure that any additional groups associated with the uid are set up.
21427
21428
21429 .option max_parallel transports integer&!! unset
21430 .cindex limit "transport parallelism"
21431 .cindex transport "parallel processes"
21432 .cindex transport "concurrency limit"
21433 .cindex "delivery" "parallelism for transport"
21434 If this option is set and expands to an integer greater than zero
21435 it limits the number of concurrent runs of the transport.
21436 The control does not apply to shadow transports.
21437
21438 .cindex "hints database" "transport concurrency control"
21439 Exim implements this control by means of a hints database in which a record is
21440 incremented whenever a transport process is being created. The record
21441 is decremented and possibly removed when the process terminates.
21442 Obviously there is scope for
21443 records to get left lying around if there is a system or program crash. To
21444 guard against this, Exim ignores any records that are more than six hours old.
21445
21446 If you use this option, you should also arrange to delete the
21447 relevant hints database whenever your system reboots. The names of the files
21448 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21449 may be one or two files, depending on the type of DBM in use. The same files
21450 are used for ETRN and smtp transport serialization.
21451
21452
21453 .option message_size_limit transports string&!! 0
21454 .cindex "limit" "message size per transport"
21455 .cindex "size" "of message, limit"
21456 .cindex "transport" "message size; limiting"
21457 This option controls the size of messages passed through the transport. It is
21458 expanded before use; the result of the expansion must be a sequence of decimal
21459 digits, optionally followed by K or M. If the expansion fails for any reason,
21460 including forced failure, or if the result is not of the required form,
21461 delivery is deferred. If the value is greater than zero and the size of a
21462 message exceeds this limit, the address is failed. If there is any chance that
21463 the resulting bounce message could be routed to the same transport, you should
21464 ensure that &%return_size_limit%& is less than the transport's
21465 &%message_size_limit%&, as otherwise the bounce message will fail to get
21466 delivered.
21467
21468
21469
21470 .option rcpt_include_affixes transports boolean false
21471 .cindex "prefix" "for local part, including in envelope"
21472 .cindex "suffix for local part" "including in envelope"
21473 .cindex "local part" "prefix"
21474 .cindex "local part" "suffix"
21475 When this option is false (the default), and an address that has had any
21476 affixes (prefixes or suffixes) removed from the local part is delivered by any
21477 form of SMTP or LMTP, the affixes are not included. For example, if a router
21478 that contains
21479 .code
21480 local_part_prefix = *-
21481 .endd
21482 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21483 is delivered with
21484 .code
21485 RCPT TO:<xyz@some.domain>
21486 .endd
21487 This is also the case when an ACL-time callout is being used to verify a
21488 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21489 whole local part is included in the RCPT command. This option applies to BSMTP
21490 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21491 &(lmtp)& and &(smtp)& transports.
21492
21493
21494 .option retry_use_local_part transports boolean "see below"
21495 .cindex "hints database" "retry keys"
21496 When a delivery suffers a temporary failure, a retry record is created
21497 in Exim's hints database. For remote deliveries, the key for the retry record
21498 is based on the name and/or IP address of the failing remote host. For local
21499 deliveries, the key is normally the entire address, including both the local
21500 part and the domain. This is suitable for most common cases of local delivery
21501 temporary failure &-- for example, exceeding a mailbox quota should delay only
21502 deliveries to that mailbox, not to the whole domain.
21503
21504 However, in some special cases you may want to treat a temporary local delivery
21505 as a failure associated with the domain, and not with a particular local part.
21506 (For example, if you are storing all mail for some domain in files.) You can do
21507 this by setting &%retry_use_local_part%& false.
21508
21509 For all the local transports, its default value is true. For remote transports,
21510 the default value is false for tidiness, but changing the value has no effect
21511 on a remote transport in the current implementation.
21512
21513
21514 .option return_path transports string&!! unset
21515 .cindex "envelope sender"
21516 .cindex "transport" "return path; changing"
21517 .cindex "return path" "changing in transport"
21518 If this option is set, the string is expanded at transport time and replaces
21519 the existing return path (envelope sender) value in the copy of the message
21520 that is being delivered. An empty return path is permitted. This feature is
21521 designed for remote deliveries, where the value of this option is used in the
21522 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21523 only effect is to change the address that is placed in the &'Return-path:'&
21524 header line, if one is added to the message (see the next option).
21525
21526 &*Note:*& A changed return path is not logged unless you add
21527 &%return_path_on_delivery%& to the log selector.
21528
21529 .vindex "&$return_path$&"
21530 The expansion can refer to the existing value via &$return_path$&. This is
21531 either the message's envelope sender, or an address set by the
21532 &%errors_to%& option on a router. If the expansion is forced to fail, no
21533 replacement occurs; if it fails for another reason, delivery is deferred. This
21534 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21535 section &<<SECTverp>>&.
21536
21537 &*Note*&: If a delivery error is detected locally, including the case when a
21538 remote server rejects a message at SMTP time, the bounce message is not sent to
21539 the value of this option. It is sent to the previously set errors address.
21540 This defaults to the incoming sender address, but can be changed by setting
21541 &%errors_to%& in a router.
21542
21543
21544
21545 .option return_path_add transports boolean false
21546 .cindex "&'Return-path:'& header line"
21547 If this option is true, a &'Return-path:'& header is added to the message.
21548 Although the return path is normally available in the prefix line of BSD
21549 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21550 have easy access to it.
21551
21552 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21553 the delivery SMTP server makes the final delivery"&. This implies that this
21554 header should not be present in incoming messages. Exim has a configuration
21555 option, &%return_path_remove%&, which requests removal of this header from
21556 incoming messages, so that delivered messages can safely be resent to other
21557 recipients.
21558
21559
21560 .option shadow_condition transports string&!! unset
21561 See &%shadow_transport%& below.
21562
21563
21564 .option shadow_transport transports string unset
21565 .cindex "shadow transport"
21566 .cindex "transport" "shadow"
21567 A local transport may set the &%shadow_transport%& option to the name of
21568 another local transport. Shadow remote transports are not supported.
21569
21570 Whenever a delivery to the main transport succeeds, and either
21571 &%shadow_condition%& is unset, or its expansion does not result in the empty
21572 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21573 passed to the shadow transport, with the same delivery address or addresses. If
21574 expansion fails, no action is taken except that non-forced expansion failures
21575 cause a log line to be written.
21576
21577 The result of the shadow transport is discarded and does not affect the
21578 subsequent processing of the message. Only a single level of shadowing is
21579 provided; the &%shadow_transport%& option is ignored on any transport when it
21580 is running as a shadow. Options concerned with output from pipes are also
21581 ignored. The log line for the successful delivery has an item added on the end,
21582 of the form
21583 .code
21584 ST=<shadow transport name>
21585 .endd
21586 If the shadow transport did not succeed, the error message is put in
21587 parentheses afterwards. Shadow transports can be used for a number of different
21588 purposes, including keeping more detailed log information than Exim normally
21589 provides, and implementing automatic acknowledgment policies based on message
21590 headers that some sites insist on.
21591
21592
21593 .option transport_filter transports string&!! unset
21594 .cindex "transport" "filter"
21595 .cindex "filter" "transport filter"
21596 This option sets up a filtering (in the Unix shell sense) process for messages
21597 at transport time. It should not be confused with mail filtering as set up by
21598 individual users or via a system filter.
21599 If unset, or expanding to an empty string, no filtering is done.
21600
21601 When the message is about to be written out, the command specified by
21602 &%transport_filter%& is started up in a separate, parallel process, and
21603 the entire message, including the header lines, is passed to it on its standard
21604 input (this in fact is done from a third process, to avoid deadlock). The
21605 command must be specified as an absolute path.
21606
21607 The lines of the message that are written to the transport filter are
21608 terminated by newline (&"\n"&). The message is passed to the filter before any
21609 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21610 lines beginning with a dot, and also before any processing implied by the
21611 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21612 &(pipe)& transports.
21613
21614 The standard error for the filter process is set to the same destination as its
21615 standard output; this is read and written to the message's ultimate
21616 destination. The process that writes the message to the filter, the
21617 filter itself, and the original process that reads the result and delivers it
21618 are all run in parallel, like a shell pipeline.
21619
21620 The filter can perform any transformations it likes, but of course should take
21621 care not to break RFC 2822 syntax. Exim does not check the result, except to
21622 test for a final newline when SMTP is in use. All messages transmitted over
21623 SMTP must end with a newline, so Exim supplies one if it is missing.
21624
21625 .cindex "content scanning" "per user"
21626 A transport filter can be used to provide content-scanning on a per-user basis
21627 at delivery time if the only required effect of the scan is to modify the
21628 message. For example, a content scan could insert a new header line containing
21629 a spam score. This could be interpreted by a filter in the user's MUA. It is
21630 not possible to discard a message at this stage.
21631
21632 .cindex "SMTP" "SIZE"
21633 A problem might arise if the filter increases the size of a message that is
21634 being sent down an SMTP connection. If the receiving SMTP server has indicated
21635 support for the SIZE parameter, Exim will have sent the size of the message
21636 at the start of the SMTP session. If what is actually sent is substantially
21637 more, the server might reject the message. This can be worked round by setting
21638 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21639 additions to the message, or to disable the use of SIZE altogether.
21640
21641 .vindex "&$pipe_addresses$&"
21642 The value of the &%transport_filter%& option is the command string for starting
21643 the filter, which is run directly from Exim, not under a shell. The string is
21644 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21645 Exim breaks it up into arguments and then expands each argument separately (see
21646 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21647 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
21648 of arguments, one for each address that applies to this delivery. (This isn't
21649 an ideal name for this feature here, but as it was already implemented for the
21650 &(pipe)& transport, it seemed sensible not to change it.)
21651
21652 .vindex "&$host$&"
21653 .vindex "&$host_address$&"
21654 The expansion variables &$host$& and &$host_address$& are available when the
21655 transport is a remote one. They contain the name and IP address of the host to
21656 which the message is being sent. For example:
21657 .code
21658 transport_filter = /some/directory/transport-filter.pl \
21659   $host $host_address $sender_address $pipe_addresses
21660 .endd
21661
21662 Two problems arise if you want to use more complicated expansion items to
21663 generate transport filter commands, both of which due to the fact that the
21664 command is split up &'before'& expansion.
21665 .ilist
21666 If an expansion item contains white space, you must quote it, so that it is all
21667 part of the same command item. If the entire option setting is one such
21668 expansion item, you have to take care what kind of quoting you use. For
21669 example:
21670 .code
21671 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21672 .endd
21673 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21674 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21675 stripped by Exim when it read the option's value. When the value is used, if
21676 the single quotes were missing, the line would be split into two items,
21677 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21678 Exim tried to expand the first one.
21679 .next
21680 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21681 expansion cannot generate multiple arguments, or a command name followed by
21682 arguments. Consider this example:
21683 .code
21684 transport_filter = ${lookup{$host}lsearch{/a/file}\
21685                     {$value}{/bin/cat}}
21686 .endd
21687 The result of the lookup is interpreted as the name of the command, even
21688 if it contains white space. The simplest way round this is to use a shell:
21689 .code
21690 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21691                                {$value}{/bin/cat}}
21692 .endd
21693 .endlist
21694
21695 The filter process is run under the same uid and gid as the normal delivery.
21696 For remote deliveries this is the Exim uid/gid by default. The command should
21697 normally yield a zero return code. Transport filters are not supposed to fail.
21698 A non-zero code is taken to mean that the transport filter encountered some
21699 serious problem. Delivery of the message is deferred; the message remains on
21700 the queue and is tried again later. It is not possible to cause a message to be
21701 bounced from a transport filter.
21702
21703 If a transport filter is set on an autoreply transport, the original message is
21704 passed through the filter as it is being copied into the newly generated
21705 message, which happens if the &%return_message%& option is set.
21706
21707
21708 .option transport_filter_timeout transports time 5m
21709 .cindex "transport" "filter, timeout"
21710 When Exim is reading the output of a transport filter, it applies a timeout
21711 that can be set by this option. Exceeding the timeout is normally treated as a
21712 temporary delivery failure. However, if a transport filter is used with a
21713 &(pipe)& transport, a timeout in the transport filter is treated in the same
21714 way as a timeout in the pipe command itself. By default, a timeout is a hard
21715 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21716 becomes a temporary error.
21717
21718
21719 .option user transports string&!! "Exim user"
21720 .cindex "uid (user id)" "local delivery"
21721 .cindex "transport" "user, specifying"
21722 This option specifies the user under whose uid the delivery process is to be
21723 run, overriding any uid that may have been set by the router. If the user is
21724 given as a name, the uid is looked up from the password data, and the
21725 associated group is taken as the value of the gid to be used if the &%group%&
21726 option is not set.
21727
21728 For deliveries that use local transports, a user and group are normally
21729 specified explicitly or implicitly (for example, as a result of
21730 &%check_local_user%&) by the router or transport.
21731
21732 .cindex "hints database" "access by remote transport"
21733 For remote transports, you should leave this option unset unless you really are
21734 sure you know what you are doing. When a remote transport is running, it needs
21735 to be able to access Exim's hints databases, because each host may have its own
21736 retry data.
21737 .ecindex IIDgenoptra1
21738 .ecindex IIDgenoptra2
21739 .ecindex IIDgenoptra3
21740
21741
21742
21743
21744
21745
21746 . ////////////////////////////////////////////////////////////////////////////
21747 . ////////////////////////////////////////////////////////////////////////////
21748
21749 .chapter "Address batching in local transports" "CHAPbatching" &&&
21750          "Address batching"
21751 .cindex "transport" "local; address batching in"
21752 The only remote transport (&(smtp)&) is normally configured to handle more than
21753 one address at a time, so that when several addresses are routed to the same
21754 remote host, just one copy of the message is sent. Local transports, however,
21755 normally handle one address at a time. That is, a separate instance of the
21756 transport is run for each address that is routed to the transport. A separate
21757 copy of the message is delivered each time.
21758
21759 .cindex "batched local delivery"
21760 .oindex "&%batch_max%&"
21761 .oindex "&%batch_id%&"
21762 In special cases, it may be desirable to handle several addresses at once in a
21763 local transport, for example:
21764
21765 .ilist
21766 In an &(appendfile)& transport, when storing messages in files for later
21767 delivery by some other means, a single copy of the message with multiple
21768 recipients saves space.
21769 .next
21770 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
21771 a single copy saves time, and is the normal way LMTP is expected to work.
21772 .next
21773 In a &(pipe)& transport, when passing the message
21774 to a scanner program or
21775 to some other delivery mechanism such as UUCP, multiple recipients may be
21776 acceptable.
21777 .endlist
21778
21779 These three local transports all have the same options for controlling multiple
21780 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
21781 repeating the information for each transport, these options are described here.
21782
21783 The &%batch_max%& option specifies the maximum number of addresses that can be
21784 delivered together in a single run of the transport. Its default value is one
21785 (no batching). When more than one address is routed to a transport that has a
21786 &%batch_max%& value greater than one, the addresses are delivered in a batch
21787 (that is, in a single run of the transport with multiple recipients), subject
21788 to certain conditions:
21789
21790 .ilist
21791 .vindex "&$local_part$&"
21792 If any of the transport's options contain a reference to &$local_part$&, no
21793 batching is possible.
21794 .next
21795 .vindex "&$domain$&"
21796 If any of the transport's options contain a reference to &$domain$&, only
21797 addresses with the same domain are batched.
21798 .next
21799 .cindex "customizing" "batching condition"
21800 If &%batch_id%& is set, it is expanded for each address, and only those
21801 addresses with the same expanded value are batched. This allows you to specify
21802 customized batching conditions. Failure of the expansion for any reason,
21803 including forced failure, disables batching, but it does not stop the delivery
21804 from taking place.
21805 .next
21806 Batched addresses must also have the same errors address (where to send
21807 delivery errors), the same header additions and removals, the same user and
21808 group for the transport, and if a host list is present, the first host must
21809 be the same.
21810 .endlist
21811
21812 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
21813 both when the file or pipe command is specified in the transport, and when it
21814 is specified by a &(redirect)& router, but all the batched addresses must of
21815 course be routed to the same file or pipe command. These two transports have an
21816 option called &%use_bsmtp%&, which causes them to deliver the message in
21817 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
21818 &%check_string%& and &%escape_string%& options are forced to the values
21819 .code
21820 check_string = "."
21821 escape_string = ".."
21822 .endd
21823 when batched SMTP is in use. A full description of the batch SMTP mechanism is
21824 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
21825 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
21826
21827 .cindex "&'Envelope-to:'& header line"
21828 If the generic &%envelope_to_add%& option is set for a batching transport, the
21829 &'Envelope-to:'& header that is added to the message contains all the addresses
21830 that are being processed together. If you are using a batching &(appendfile)&
21831 transport without &%use_bsmtp%&, the only way to preserve the recipient
21832 addresses is to set the &%envelope_to_add%& option.
21833
21834 .cindex "&(pipe)& transport" "with multiple addresses"
21835 .vindex "&$pipe_addresses$&"
21836 If you are using a &(pipe)& transport without BSMTP, and setting the
21837 transport's &%command%& option, you can include &$pipe_addresses$& as part of
21838 the command. This is not a true variable; it is a bit of magic that causes each
21839 of the recipient addresses to be inserted into the command as a separate
21840 argument. This provides a way of accessing all the addresses that are being
21841 delivered in the batch. &*Note:*& This is not possible for pipe commands that
21842 are specified by a &(redirect)& router.
21843
21844
21845
21846
21847 . ////////////////////////////////////////////////////////////////////////////
21848 . ////////////////////////////////////////////////////////////////////////////
21849
21850 .chapter "The appendfile transport" "CHAPappendfile"
21851 .scindex IIDapptra1 "&(appendfile)& transport"
21852 .scindex IIDapptra2 "transports" "&(appendfile)&"
21853 .cindex "directory creation"
21854 .cindex "creating directories"
21855 The &(appendfile)& transport delivers a message by appending it to an existing
21856 file, or by creating an entirely new file in a specified directory. Single
21857 files to which messages are appended can be in the traditional Unix mailbox
21858 format, or optionally in the MBX format supported by the Pine MUA and
21859 University of Washington IMAP daemon, &'inter alia'&. When each message is
21860 being delivered as a separate file, &"maildir"& format can optionally be used
21861 to give added protection against failures that happen part-way through the
21862 delivery. A third form of separate-file delivery known as &"mailstore"& is also
21863 supported. For all file formats, Exim attempts to create as many levels of
21864 directory as necessary, provided that &%create_directory%& is set.
21865
21866 The code for the optional formats is not included in the Exim binary by
21867 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
21868 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
21869 included.
21870
21871 .cindex "quota" "system"
21872 Exim recognizes system quota errors, and generates an appropriate message. Exim
21873 also supports its own quota control within the transport, for use when the
21874 system facility is unavailable or cannot be used for some reason.
21875
21876 If there is an error while appending to a file (for example, quota exceeded or
21877 partition filled), Exim attempts to reset the file's length and last
21878 modification time back to what they were before. If there is an error while
21879 creating an entirely new file, the new file is removed.
21880
21881 Before appending to a file, a number of security checks are made, and the
21882 file is locked. A detailed description is given below, after the list of
21883 private options.
21884
21885 The &(appendfile)& transport is most commonly used for local deliveries to
21886 users' mailboxes. However, it can also be used as a pseudo-remote transport for
21887 putting messages into files for remote delivery by some means other than Exim.
21888 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
21889 option).
21890
21891
21892
21893 .section "The file and directory options" "SECTfildiropt"
21894 The &%file%& option specifies a single file, to which the message is appended;
21895 the &%directory%& option specifies a directory, in which a new file containing
21896 the message is created. Only one of these two options can be set, and for
21897 normal deliveries to mailboxes, one of them &'must'& be set.
21898
21899 .vindex "&$address_file$&"
21900 .vindex "&$local_part$&"
21901 However, &(appendfile)& is also used for delivering messages to files or
21902 directories whose names (or parts of names) are obtained from alias,
21903 forwarding, or filtering operations (for example, a &%save%& command in a
21904 user's Exim filter). When such a transport is running, &$local_part$& contains
21905 the local part that was aliased or forwarded, and &$address_file$& contains the
21906 name (or partial name) of the file or directory generated by the redirection
21907 operation. There are two cases:
21908
21909 .ilist
21910 If neither &%file%& nor &%directory%& is set, the redirection operation
21911 must specify an absolute path (one that begins with &`/`&). This is the most
21912 common case when users with local accounts use filtering to sort mail into
21913 different folders. See for example, the &(address_file)& transport in the
21914 default configuration. If the path ends with a slash, it is assumed to be the
21915 name of a directory. A delivery to a directory can also be forced by setting
21916 &%maildir_format%& or &%mailstore_format%&.
21917 .next
21918 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
21919 used to determine the file or directory name for the delivery. Normally, the
21920 contents of &$address_file$& are used in some way in the string expansion.
21921 .endlist
21922
21923
21924 .cindex "Sieve filter" "configuring &(appendfile)&"
21925 .cindex "Sieve filter" "relative mailbox path handling"
21926 As an example of the second case, consider an environment where users do not
21927 have home directories. They may be permitted to use Exim filter commands of the
21928 form:
21929 .code
21930 save folder23
21931 .endd
21932 or Sieve filter commands of the form:
21933 .code
21934 require "fileinto";
21935 fileinto "folder23";
21936 .endd
21937 In this situation, the expansion of &%file%& or &%directory%& in the transport
21938 must transform the relative path into an appropriate absolute file name. In the
21939 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
21940 is used as a result of a &"keep"& action in the filter. This example shows one
21941 way of handling this requirement:
21942 .code
21943 file = ${if eq{$address_file}{inbox} \
21944             {/var/mail/$local_part} \
21945             {${if eq{${substr_0_1:$address_file}}{/} \
21946                   {$address_file} \
21947                   {$home/mail/$address_file} \
21948             }} \
21949        }
21950 .endd
21951 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
21952 location, absolute paths are used without change, and other folders are in the
21953 &_mail_& directory within the home directory.
21954
21955 &*Note 1*&: While processing an Exim filter, a relative path such as
21956 &_folder23_& is turned into an absolute path if a home directory is known to
21957 the router. In particular, this is the case if &%check_local_user%& is set. If
21958 you want to prevent this happening at routing time, you can set
21959 &%router_home_directory%& empty. This forces the router to pass the relative
21960 path to the transport.
21961
21962 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
21963 the &%file%& or &%directory%& option is still used if it is set.
21964
21965
21966
21967
21968 .section "Private options for appendfile" "SECID134"
21969 .cindex "options" "&(appendfile)& transport"
21970
21971
21972
21973 .option allow_fifo appendfile boolean false
21974 .cindex "fifo (named pipe)"
21975 .cindex "named pipe (fifo)"
21976 .cindex "pipe" "named (fifo)"
21977 Setting this option permits delivery to named pipes (FIFOs) as well as to
21978 regular files. If no process is reading the named pipe at delivery time, the
21979 delivery is deferred.
21980
21981
21982 .option allow_symlink appendfile boolean false
21983 .cindex "symbolic link" "to mailbox"
21984 .cindex "mailbox" "symbolic link"
21985 By default, &(appendfile)& will not deliver if the path name for the file is
21986 that of a symbolic link. Setting this option relaxes that constraint, but there
21987 are security issues involved in the use of symbolic links. Be sure you know
21988 what you are doing if you set this. Details of exactly what this option affects
21989 are included in the discussion which follows this list of options.
21990
21991
21992 .option batch_id appendfile string&!! unset
21993 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21994 However, batching is automatically disabled for &(appendfile)& deliveries that
21995 happen as a result of forwarding or aliasing or other redirection directly to a
21996 file.
21997
21998
21999 .option batch_max appendfile integer 1
22000 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22001
22002
22003 .option check_group appendfile boolean false
22004 When this option is set, the group owner of the file defined by the &%file%&
22005 option is checked to see that it is the same as the group under which the
22006 delivery process is running. The default setting is false because the default
22007 file mode is 0600, which means that the group is irrelevant.
22008
22009
22010 .option check_owner appendfile boolean true
22011 When this option is set, the owner of the file defined by the &%file%& option
22012 is checked to ensure that it is the same as the user under which the delivery
22013 process is running.
22014
22015
22016 .option check_string appendfile string "see below"
22017 .cindex "&""From""& line"
22018 As &(appendfile)& writes the message, the start of each line is tested for
22019 matching &%check_string%&, and if it does, the initial matching characters are
22020 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22021 a literal string, not a regular expression, and the case of any letters it
22022 contains is significant.
22023
22024 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22025 are forced to &"."& and &".."& respectively, and any settings in the
22026 configuration are ignored. Otherwise, they default to &"From&~"& and
22027 &">From&~"& when the &%file%& option is set, and unset when any of the
22028 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22029
22030 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22031 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22032 &"From&~"& indicates the start of a new message. All four options need changing
22033 if another format is used. For example, to deliver to mailboxes in MMDF format:
22034 .cindex "MMDF format mailbox"
22035 .cindex "mailbox" "MMDF format"
22036 .code
22037 check_string = "\1\1\1\1\n"
22038 escape_string = "\1\1\1\1 \n"
22039 message_prefix = "\1\1\1\1\n"
22040 message_suffix = "\1\1\1\1\n"
22041 .endd
22042 .option create_directory appendfile boolean true
22043 .cindex "directory creation"
22044 When this option is true, Exim attempts to create any missing superior
22045 directories for the file that it is about to write. A created directory's mode
22046 is given by the &%directory_mode%& option.
22047
22048 The group ownership of a newly created directory is highly dependent on the
22049 operating system (and possibly the file system) that is being used. For
22050 example, in Solaris, if the parent directory has the setgid bit set, its group
22051 is propagated to the child; if not, the currently set group is used. However,
22052 in FreeBSD, the parent's group is always used.
22053
22054
22055
22056 .option create_file appendfile string anywhere
22057 This option constrains the location of files and directories that are created
22058 by this transport. It applies to files defined by the &%file%& option and
22059 directories defined by the &%directory%& option. In the case of maildir
22060 delivery, it applies to the top level directory, not the maildir directories
22061 beneath.
22062
22063 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22064 &"belowhome"&. In the second and third cases, a home directory must have been
22065 set for the transport. This option is not useful when an explicit file name is
22066 given for normal mailbox deliveries. It is intended for the case when file
22067 names are generated from users' &_.forward_& files. These are usually handled
22068 by an &(appendfile)& transport called &%address_file%&. See also
22069 &%file_must_exist%&.
22070
22071
22072 .option directory appendfile string&!! unset
22073 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22074 or &%directory%& must be set, unless the delivery is the direct result of a
22075 redirection (see section &<<SECTfildiropt>>&).
22076
22077 When &%directory%& is set, the string is expanded, and the message is delivered
22078 into a new file or files in or below the given directory, instead of being
22079 appended to a single mailbox file. A number of different formats are provided
22080 (see &%maildir_format%& and &%mailstore_format%&), and see section
22081 &<<SECTopdir>>& for further details of this form of delivery.
22082
22083
22084 .option directory_file appendfile string&!! "see below"
22085 .cindex "base62"
22086 .vindex "&$inode$&"
22087 When &%directory%& is set, but neither &%maildir_format%& nor
22088 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22089 whose name is obtained by expanding this string. The default value is:
22090 .code
22091 q${base62:$tod_epoch}-$inode
22092 .endd
22093 This generates a unique name from the current time, in base 62 form, and the
22094 inode of the file. The variable &$inode$& is available only when expanding this
22095 option.
22096
22097
22098 .option directory_mode appendfile "octal integer" 0700
22099 If &(appendfile)& creates any directories as a result of the
22100 &%create_directory%& option, their mode is specified by this option.
22101
22102
22103 .option escape_string appendfile string "see description"
22104 See &%check_string%& above.
22105
22106
22107 .option file appendfile string&!! unset
22108 This option is mutually exclusive with the &%directory%& option, but one of
22109 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22110 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22111 specifies a single file, to which the message is appended. One or more of
22112 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22113 &%file%&.
22114
22115 .cindex "NFS" "lock file"
22116 .cindex "locking files"
22117 .cindex "lock files"
22118 If you are using more than one host to deliver over NFS into the same
22119 mailboxes, you should always use lock files.
22120
22121 The string value is expanded for each delivery, and must yield an absolute
22122 path. The most common settings of this option are variations on one of these
22123 examples:
22124 .code
22125 file = /var/spool/mail/$local_part
22126 file = /home/$local_part/inbox
22127 file = $home/inbox
22128 .endd
22129 .cindex "&""sticky""& bit"
22130 In the first example, all deliveries are done into the same directory. If Exim
22131 is configured to use lock files (see &%use_lockfile%& below) it must be able to
22132 create a file in the directory, so the &"sticky"& bit must be turned on for
22133 deliveries to be possible, or alternatively the &%group%& option can be used to
22134 run the delivery under a group id which has write access to the directory.
22135
22136
22137
22138 .option file_format appendfile string unset
22139 .cindex "file" "mailbox; checking existing format"
22140 This option requests the transport to check the format of an existing file
22141 before adding to it. The check consists of matching a specific string at the
22142 start of the file. The value of the option consists of an even number of
22143 colon-separated strings. The first of each pair is the test string, and the
22144 second is the name of a transport. If the transport associated with a matched
22145 string is not the current transport, control is passed over to the other
22146 transport. For example, suppose the standard &(local_delivery)& transport has
22147 this added to it:
22148 .code
22149 file_format = "From       : local_delivery :\
22150                \1\1\1\1\n : local_mmdf_delivery"
22151 .endd
22152 Mailboxes that begin with &"From"& are still handled by this transport, but if
22153 a mailbox begins with four binary ones followed by a newline, control is passed
22154 to a transport called &%local_mmdf_delivery%&, which presumably is configured
22155 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
22156 is assumed to match the current transport. If the start of a mailbox doesn't
22157 match any string, or if the transport named for a given string is not defined,
22158 delivery is deferred.
22159
22160
22161 .option file_must_exist appendfile boolean false
22162 If this option is true, the file specified by the &%file%& option must exist.
22163 A temporary error occurs if it does not, causing delivery to be deferred.
22164 If this option is false, the file is created if it does not exist.
22165
22166
22167 .option lock_fcntl_timeout appendfile time 0s
22168 .cindex "timeout" "mailbox locking"
22169 .cindex "mailbox" "locking, blocking and non-blocking"
22170 .cindex "locking files"
22171 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
22172 when locking an open mailbox file. If the call fails, the delivery process
22173 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
22174 Non-blocking calls are used so that the file is not kept open during the wait
22175 for the lock; the reason for this is to make it as safe as possible for
22176 deliveries over NFS in the case when processes might be accessing an NFS
22177 mailbox without using a lock file. This should not be done, but
22178 misunderstandings and hence misconfigurations are not unknown.
22179
22180 On a busy system, however, the performance of a non-blocking lock approach is
22181 not as good as using a blocking lock with a timeout. In this case, the waiting
22182 is done inside the system call, and Exim's delivery process acquires the lock
22183 and can proceed as soon as the previous lock holder releases it.
22184
22185 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
22186 timeout, are used. There may still be some retrying: the maximum number of
22187 retries is
22188 .code
22189 (lock_retries * lock_interval) / lock_fcntl_timeout
22190 .endd
22191 rounded up to the next whole number. In other words, the total time during
22192 which &(appendfile)& is trying to get a lock is roughly the same, unless
22193 &%lock_fcntl_timeout%& is set very large.
22194
22195 You should consider setting this option if you are getting a lot of delayed
22196 local deliveries because of errors of the form
22197 .code
22198 failed to lock mailbox /some/file (fcntl)
22199 .endd
22200
22201 .option lock_flock_timeout appendfile time 0s
22202 This timeout applies to file locking when using &[flock()]& (see
22203 &%use_flock%&); the timeout operates in a similar manner to
22204 &%lock_fcntl_timeout%&.
22205
22206
22207 .option lock_interval appendfile time 3s
22208 This specifies the time to wait between attempts to lock the file. See below
22209 for details of locking.
22210
22211
22212 .option lock_retries appendfile integer 10
22213 This specifies the maximum number of attempts to lock the file. A value of zero
22214 is treated as 1. See below for details of locking.
22215
22216
22217 .option lockfile_mode appendfile "octal integer" 0600
22218 This specifies the mode of the created lock file, when a lock file is being
22219 used (see &%use_lockfile%& and &%use_mbx_lock%&).
22220
22221
22222 .option lockfile_timeout appendfile time 30m
22223 .cindex "timeout" "mailbox locking"
22224 When a lock file is being used (see &%use_lockfile%&), if a lock file already
22225 exists and is older than this value, it is assumed to have been left behind by
22226 accident, and Exim attempts to remove it.
22227
22228
22229 .option mailbox_filecount appendfile string&!! unset
22230 .cindex "mailbox" "specifying size of"
22231 .cindex "size" "of mailbox"
22232 If this option is set, it is expanded, and the result is taken as the current
22233 number of files in the mailbox. It must be a decimal number, optionally
22234 followed by K or M. This provides a way of obtaining this information from an
22235 external source that maintains the data.
22236
22237
22238 .option mailbox_size appendfile string&!! unset
22239 .cindex "mailbox" "specifying size of"
22240 .cindex "size" "of mailbox"
22241 If this option is set, it is expanded, and the result is taken as the current
22242 size the mailbox. It must be a decimal number, optionally followed by K or M.
22243 This provides a way of obtaining this information from an external source that
22244 maintains the data. This is likely to be helpful for maildir deliveries where
22245 it is computationally expensive to compute the size of a mailbox.
22246
22247
22248
22249 .option maildir_format appendfile boolean false
22250 .cindex "maildir format" "specifying"
22251 If this option is set with the &%directory%& option, the delivery is into a new
22252 file, in the &"maildir"& format that is used by other mail software. When the
22253 transport is activated directly from a &(redirect)& router (for example, the
22254 &(address_file)& transport in the default configuration), setting
22255 &%maildir_format%& causes the path received from the router to be treated as a
22256 directory, whether or not it ends with &`/`&. This option is available only if
22257 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
22258 &<<SECTmaildirdelivery>>& below for further details.
22259
22260
22261 .option maildir_quota_directory_regex appendfile string "See below"
22262 .cindex "maildir format" "quota; directories included in"
22263 .cindex "quota" "maildir; directories included in"
22264 This option is relevant only when &%maildir_use_size_file%& is set. It defines
22265 a regular expression for specifying directories, relative to the quota
22266 directory (see &%quota_directory%&), that should be included in the quota
22267 calculation. The default value is:
22268 .code
22269 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
22270 .endd
22271 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
22272 (directories whose names begin with a dot). If you want to exclude the
22273 &_Trash_&
22274 folder from the count (as some sites do), you need to change this setting to
22275 .code
22276 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
22277 .endd
22278 This uses a negative lookahead in the regular expression to exclude the
22279 directory whose name is &_.Trash_&. When a directory is excluded from quota
22280 calculations, quota processing is bypassed for any messages that are delivered
22281 directly into that directory.
22282
22283
22284 .option maildir_retries appendfile integer 10
22285 This option specifies the number of times to retry when writing a file in
22286 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
22287
22288
22289 .option maildir_tag appendfile string&!! unset
22290 This option applies only to deliveries in maildir format, and is described in
22291 section &<<SECTmaildirdelivery>>& below.
22292
22293
22294 .option maildir_use_size_file appendfile&!! boolean false
22295 .cindex "maildir format" "&_maildirsize_& file"
22296 The result of string expansion for this option must be a valid boolean value.
22297 If it is true, it enables support for &_maildirsize_& files. Exim
22298 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
22299 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
22300 value is zero. See &%maildir_quota_directory_regex%& above and section
22301 &<<SECTmaildirdelivery>>& below for further details.
22302
22303 .option maildirfolder_create_regex appendfile string unset
22304 .cindex "maildir format" "&_maildirfolder_& file"
22305 .cindex "&_maildirfolder_&, creating"
22306 The value of this option is a regular expression. If it is unset, it has no
22307 effect. Otherwise, before a maildir delivery takes place, the pattern is
22308 matched against the name of the maildir directory, that is, the directory
22309 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22310 delivery. If there is a match, Exim checks for the existence of a file called
22311 &_maildirfolder_& in the directory, and creates it if it does not exist.
22312 See section &<<SECTmaildirdelivery>>& for more details.
22313
22314
22315 .option mailstore_format appendfile boolean false
22316 .cindex "mailstore format" "specifying"
22317 If this option is set with the &%directory%& option, the delivery is into two
22318 new files in  &"mailstore"& format. The option is available only if
22319 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
22320 below for further details.
22321
22322
22323 .option mailstore_prefix appendfile string&!! unset
22324 This option applies only to deliveries in mailstore format, and is described in
22325 section &<<SECTopdir>>& below.
22326
22327
22328 .option mailstore_suffix appendfile string&!! unset
22329 This option applies only to deliveries in mailstore format, and is described in
22330 section &<<SECTopdir>>& below.
22331
22332
22333 .option mbx_format appendfile boolean false
22334 .cindex "locking files"
22335 .cindex "file" "locking"
22336 .cindex "file" "MBX format"
22337 .cindex "MBX format, specifying"
22338 This option is available only if Exim has been compiled with SUPPORT_MBX
22339 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
22340 the message is appended to the mailbox file in MBX format instead of
22341 traditional Unix format. This format is supported by Pine4 and its associated
22342 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
22343
22344 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
22345 automatically changed by the use of &%mbx_format%&. They should normally be set
22346 empty when using MBX format, so this option almost always appears in this
22347 combination:
22348 .code
22349 mbx_format = true
22350 message_prefix =
22351 message_suffix =
22352 .endd
22353 If none of the locking options are mentioned in the configuration,
22354 &%use_mbx_lock%& is assumed and the other locking options default to false. It
22355 is possible to specify the other kinds of locking with &%mbx_format%&, but
22356 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
22357 interworks with &'c-client'&, providing for shared access to the mailbox. It
22358 should not be used if any program that does not use this form of locking is
22359 going to access the mailbox, nor should it be used if the mailbox file is NFS
22360 mounted, because it works only when the mailbox is accessed from a single host.
22361
22362 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22363 the standard version of &'c-client'&, because as long as it has a mailbox open
22364 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22365 append messages to it.
22366
22367
22368 .option message_prefix appendfile string&!! "see below"
22369 .cindex "&""From""& line"
22370 The string specified here is expanded and output at the start of every message.
22371 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22372 in which case it is:
22373 .code
22374 message_prefix = "From ${if def:return_path{$return_path}\
22375   {MAILER-DAEMON}} $tod_bsdinbox\n"
22376 .endd
22377 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22378 &`\n`& to &`\r\n`& in &%message_prefix%&.
22379
22380 .option message_suffix appendfile string&!! "see below"
22381 The string specified here is expanded and output at the end of every message.
22382 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22383 in which case it is a single newline character. The suffix can be suppressed by
22384 setting
22385 .code
22386 message_suffix =
22387 .endd
22388 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22389 &`\n`& to &`\r\n`& in &%message_suffix%&.
22390
22391 .option mode appendfile "octal integer" 0600
22392 If the output file is created, it is given this mode. If it already exists and
22393 has wider permissions, they are reduced to this mode. If it has narrower
22394 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22395 if the delivery is the result of a &%save%& command in a filter file specifying
22396 a particular mode, the mode of the output file is always forced to take that
22397 value, and this option is ignored.
22398
22399
22400 .option mode_fail_narrower appendfile boolean true
22401 This option applies in the case when an existing mailbox file has a narrower
22402 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22403 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22404 continues with the delivery attempt, using the existing mode of the file.
22405
22406
22407 .option notify_comsat appendfile boolean false
22408 If this option is true, the &'comsat'& daemon is notified after every
22409 successful delivery to a user mailbox. This is the daemon that notifies logged
22410 on users about incoming mail.
22411
22412
22413 .option quota appendfile string&!! unset
22414 .cindex "quota" "imposed by Exim"
22415 This option imposes a limit on the size of the file to which Exim is appending,
22416 or to the total space used in the directory tree when the &%directory%& option
22417 is set. In the latter case, computation of the space used is expensive, because
22418 all the files in the directory (and any sub-directories) have to be
22419 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22420 &%maildir_use_size_file%& for ways to avoid this in environments where users
22421 have no shell access to their mailboxes).
22422
22423 As there is no interlock against two simultaneous deliveries into a
22424 multi-file mailbox, it is possible for the quota to be overrun in this case.
22425 For single-file mailboxes, of course, an interlock is a necessity.
22426
22427 A file's size is taken as its &'used'& value. Because of blocking effects, this
22428 may be a lot less than the actual amount of disk space allocated to the file.
22429 If the sizes of a number of files are being added up, the rounding effect can
22430 become quite noticeable, especially on systems that have large block sizes.
22431 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22432 the obvious value which users understand most easily.
22433
22434 The value of the option is expanded, and must then be a numerical value
22435 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22436 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
22437 and further option modifiers. If Exim is running on a system with
22438 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22439 be handled.
22440
22441 The option modifier &%no_check%& can be used to force delivery even if the over
22442 quota condition is met. The quota gets updated as usual.
22443
22444 &*Note*&: A value of zero is interpreted as &"no quota"&.
22445
22446 The expansion happens while Exim is running as root, before it changes uid for
22447 the delivery. This means that files that are inaccessible to the end user can
22448 be used to hold quota values that are looked up in the expansion. When delivery
22449 fails because this quota is exceeded, the handling of the error is as for
22450 system quota failures.
22451
22452 By default, Exim's quota checking mimics system quotas, and restricts the
22453 mailbox to the specified maximum size, though the value is not accurate to the
22454 last byte, owing to separator lines and additional headers that may get added
22455 during message delivery. When a mailbox is nearly full, large messages may get
22456 refused even though small ones are accepted, because the size of the current
22457 message is added to the quota when the check is made. This behaviour can be
22458 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22459 for exceeding the quota does not include the current message. Thus, deliveries
22460 continue until the quota has been exceeded; thereafter, no further messages are
22461 delivered. See also &%quota_warn_threshold%&.
22462
22463
22464 .option quota_directory appendfile string&!! unset
22465 This option defines the directory to check for quota purposes when delivering
22466 into individual files. The default is the delivery directory, or, if a file
22467 called &_maildirfolder_& exists in a maildir directory, the parent of the
22468 delivery directory.
22469
22470
22471 .option quota_filecount appendfile string&!! 0
22472 This option applies when the &%directory%& option is set. It limits the total
22473 number of files in the directory (compare the inode limit in system quotas). It
22474 can only be used if &%quota%& is also set. The value is expanded; an expansion
22475 failure causes delivery to be deferred. A value of zero is interpreted as
22476 &"no quota"&.
22477
22478 The option modifier &%no_check%& can be used to force delivery even if the over
22479 quota condition is met. The quota gets updated as usual.
22480
22481 .option quota_is_inclusive appendfile boolean true
22482 See &%quota%& above.
22483
22484
22485 .option quota_size_regex appendfile string unset
22486 This option applies when one of the delivery modes that writes a separate file
22487 for each message is being used. When Exim wants to find the size of one of
22488 these files in order to test the quota, it first checks &%quota_size_regex%&.
22489 If this is set to a regular expression that matches the file name, and it
22490 captures one string, that string is interpreted as a representation of the
22491 file's size. The value of &%quota_size_regex%& is not expanded.
22492
22493 This feature is useful only when users have no shell access to their mailboxes
22494 &-- otherwise they could defeat the quota simply by renaming the files. This
22495 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22496 the file length to the file name. For example:
22497 .code
22498 maildir_tag = ,S=$message_size
22499 quota_size_regex = ,S=(\d+)
22500 .endd
22501 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22502 number of lines in the message.
22503
22504 The regular expression should not assume that the length is at the end of the
22505 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
22506 sometimes add other information onto the ends of message file names.
22507
22508 Section &<<SECID136>>& contains further information.
22509
22510
22511 .option quota_warn_message appendfile string&!! "see below"
22512 See below for the use of this option. If it is not set when
22513 &%quota_warn_threshold%& is set, it defaults to
22514 .code
22515 quota_warn_message = "\
22516   To: $local_part@$domain\n\
22517   Subject: Your mailbox\n\n\
22518   This message is automatically created \
22519   by mail delivery software.\n\n\
22520   The size of your mailbox has exceeded \
22521   a warning threshold that is\n\
22522   set by the system administrator.\n"
22523 .endd
22524
22525
22526 .option quota_warn_threshold appendfile string&!! 0
22527 .cindex "quota" "warning threshold"
22528 .cindex "mailbox" "size warning"
22529 .cindex "size" "of mailbox"
22530 This option is expanded in the same way as &%quota%& (see above). If the
22531 resulting value is greater than zero, and delivery of the message causes the
22532 size of the file or total space in the directory tree to cross the given
22533 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22534 may be specified as a percentage of it by following the value with a percent
22535 sign. For example:
22536 .code
22537 quota = 10M
22538 quota_warn_threshold = 75%
22539 .endd
22540 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22541 percent sign is ignored.
22542
22543 The warning message itself is specified by the &%quota_warn_message%& option,
22544 and it must start with a &'To:'& header line containing the recipient(s) of the
22545 warning message. These do not necessarily have to include the recipient(s) of
22546 the original message. A &'Subject:'& line should also normally be supplied. You
22547 can include any other header lines that you want. If you do not include a
22548 &'From:'& line, the default is:
22549 .code
22550 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22551 .endd
22552 .oindex &%errors_reply_to%&
22553 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22554 option.
22555
22556 The &%quota%& option does not have to be set in order to use this option; they
22557 are independent of one another except when the threshold is specified as a
22558 percentage.
22559
22560
22561 .option use_bsmtp appendfile boolean false
22562 .cindex "envelope sender"
22563 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22564 format, with the envelope sender and recipient(s) included as SMTP commands. If
22565 you want to include a leading HELO command with such messages, you can do
22566 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22567 for details of batch SMTP.
22568
22569
22570 .option use_crlf appendfile boolean false
22571 .cindex "carriage return"
22572 .cindex "linefeed"
22573 This option causes lines to be terminated with the two-character CRLF sequence
22574 (carriage return, linefeed) instead of just a linefeed character. In the case
22575 of batched SMTP, the byte sequence written to the file is then an exact image
22576 of what would be sent down a real SMTP connection.
22577
22578 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22579 (which are used to supply the traditional &"From&~"& and blank line separators
22580 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22581 carriage return characters if these are needed. In cases where these options
22582 have non-empty defaults, the values end with a single linefeed, so they must be
22583 changed to end with &`\r\n`& if &%use_crlf%& is set.
22584
22585
22586 .option use_fcntl_lock appendfile boolean "see below"
22587 This option controls the use of the &[fcntl()]& function to lock a file for
22588 exclusive use when a message is being appended. It is set by default unless
22589 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22590 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22591 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
22592
22593
22594 .option use_flock_lock appendfile boolean false
22595 This option is provided to support the use of &[flock()]& for file locking, for
22596 the few situations where it is needed. Most modern operating systems support
22597 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
22598 each other. Exim uses &[fcntl()]& locking by default.
22599
22600 This option is required only if you are using an operating system where
22601 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
22602 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
22603 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
22604
22605 .cindex "Solaris" "&[flock()]& support"
22606 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
22607 have it (and some, I think, provide a not quite right version built on top of
22608 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
22609 the ability to use it, and any attempt to do so will cause a configuration
22610 error.
22611
22612 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
22613 is just being mapped onto &[fcntl()]& by the OS).
22614
22615
22616 .option use_lockfile appendfile boolean "see below"
22617 If this option is turned off, Exim does not attempt to create a lock file when
22618 appending to a mailbox file. In this situation, the only locking is by
22619 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22620 sure that every MUA that is ever going to look at your users' mailboxes uses
22621 &[fcntl()]& rather than a lock file, and even then only when you are not
22622 delivering over NFS from more than one host.
22623
22624 .cindex "NFS" "lock file"
22625 In order to append to an NFS file safely from more than one host, it is
22626 necessary to take out a lock &'before'& opening the file, and the lock file
22627 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22628 file corruption.
22629
22630 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22631 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22632 except when &%mbx_format%& is set.
22633
22634
22635 .option use_mbx_lock appendfile boolean "see below"
22636 This option is available only if Exim has been compiled with SUPPORT_MBX
22637 set in &_Local/Makefile_&. Setting the option specifies that special MBX
22638 locking rules be used. It is set by default if &%mbx_format%& is set and none
22639 of the locking options are mentioned in the configuration. The locking rules
22640 are the same as are used by the &'c-client'& library that underlies Pine and
22641 the IMAP4 and POP daemons that come with it (see the discussion below). The
22642 rules allow for shared access to the mailbox. However, this kind of locking
22643 does not work when the mailbox is NFS mounted.
22644
22645 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
22646 &%use_flock_lock%& to control what kind of locking is used in implementing the
22647 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
22648 without &%use_fcntl_lock%& or &%use_flock_lock%&.
22649
22650
22651
22652
22653 .section "Operational details for appending" "SECTopappend"
22654 .cindex "appending to a file"
22655 .cindex "file" "appending"
22656 Before appending to a file, the following preparations are made:
22657
22658 .ilist
22659 If the name of the file is &_/dev/null_&, no action is taken, and a success
22660 return is given.
22661
22662 .next
22663 .cindex "directory creation"
22664 If any directories on the file's path are missing, Exim creates them if the
22665 &%create_directory%& option is set. A created directory's mode is given by the
22666 &%directory_mode%& option.
22667
22668 .next
22669 If &%file_format%& is set, the format of an existing file is checked. If this
22670 indicates that a different transport should be used, control is passed to that
22671 transport.
22672
22673 .next
22674 .cindex "file" "locking"
22675 .cindex "locking files"
22676 .cindex "NFS" "lock file"
22677 If &%use_lockfile%& is set, a lock file is built in a way that will work
22678 reliably over NFS, as follows:
22679
22680 .olist
22681 Create a &"hitching post"& file whose name is that of the lock file with the
22682 current time, primary host name, and process id added, by opening for writing
22683 as a new file. If this fails with an access error, delivery is deferred.
22684 .next
22685 Close the hitching post file, and hard link it to the lock file name.
22686 .next
22687 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22688 Unlink the hitching post name.
22689 .next
22690 Otherwise, use &[stat()]& to get information about the hitching post file, and
22691 then unlink hitching post name. If the number of links is exactly two, creation
22692 of the lock file succeeded but something (for example, an NFS server crash and
22693 restart) caused this fact not to be communicated to the &[link()]& call.
22694 .next
22695 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22696 up to &%lock_retries%& times. However, since any program that writes to a
22697 mailbox should complete its task very quickly, it is reasonable to time out old
22698 lock files that are normally the result of user agent and system crashes. If an
22699 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22700 it before trying again.
22701 .endlist olist
22702
22703 .next
22704 A call is made to &[lstat()]& to discover whether the main file exists, and if
22705 so, what its characteristics are. If &[lstat()]& fails for any reason other
22706 than non-existence, delivery is deferred.
22707
22708 .next
22709 .cindex "symbolic link" "to mailbox"
22710 .cindex "mailbox" "symbolic link"
22711 If the file does exist and is a symbolic link, delivery is deferred, unless the
22712 &%allow_symlink%& option is set, in which case the ownership of the link is
22713 checked, and then &[stat()]& is called to find out about the real file, which
22714 is then subjected to the checks below. The check on the top-level link
22715 ownership prevents one user creating a link for another's mailbox in a sticky
22716 directory, though allowing symbolic links in this case is definitely not a good
22717 idea. If there is a chain of symbolic links, the intermediate ones are not
22718 checked.
22719
22720 .next
22721 If the file already exists but is not a regular file, or if the file's owner
22722 and group (if the group is being checked &-- see &%check_group%& above) are
22723 different from the user and group under which the delivery is running,
22724 delivery is deferred.
22725
22726 .next
22727 If the file's permissions are more generous than specified, they are reduced.
22728 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22729 is set false, in which case the delivery is tried using the existing
22730 permissions.
22731
22732 .next
22733 The file's inode number is saved, and the file is then opened for appending.
22734 If this fails because the file has vanished, &(appendfile)& behaves as if it
22735 hadn't existed (see below). For any other failures, delivery is deferred.
22736
22737 .next
22738 If the file is opened successfully, check that the inode number hasn't
22739 changed, that it is still a regular file, and that the owner and permissions
22740 have not changed. If anything is wrong, defer delivery and freeze the message.
22741
22742 .next
22743 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22744 option is set. Otherwise, check that the file is being created in a permitted
22745 directory if the &%create_file%& option is set (deferring on failure), and then
22746 open for writing as a new file, with the O_EXCL and O_CREAT options,
22747 except when dealing with a symbolic link (the &%allow_symlink%& option must be
22748 set). In this case, which can happen if the link points to a non-existent file,
22749 the file is opened for writing using O_CREAT but not O_EXCL, because
22750 that prevents link following.
22751
22752 .next
22753 .cindex "loop" "while file testing"
22754 If opening fails because the file exists, obey the tests given above for
22755 existing files. However, to avoid looping in a situation where the file is
22756 being continuously created and destroyed, the exists/not-exists loop is broken
22757 after 10 repetitions, and the message is then frozen.
22758
22759 .next
22760 If opening fails with any other error, defer delivery.
22761
22762 .next
22763 .cindex "file" "locking"
22764 .cindex "locking files"
22765 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
22766 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
22767 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
22768 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
22769 file, and an exclusive lock on the file whose name is
22770 .code
22771 /tmp/.<device-number>.<inode-number>
22772 .endd
22773 using the device and inode numbers of the open mailbox file, in accordance with
22774 the MBX locking rules. This file is created with a mode that is specified by
22775 the &%lockfile_mode%& option.
22776
22777 If Exim fails to lock the file, there are two possible courses of action,
22778 depending on the value of the locking timeout. This is obtained from
22779 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
22780
22781 If the timeout value is zero, the file is closed, Exim waits for
22782 &%lock_interval%&, and then goes back and re-opens the file as above and tries
22783 to lock it again. This happens up to &%lock_retries%& times, after which the
22784 delivery is deferred.
22785
22786 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
22787 &[flock()]& are used (with the given timeout), so there has already been some
22788 waiting involved by the time locking fails. Nevertheless, Exim does not give up
22789 immediately. It retries up to
22790 .code
22791 (lock_retries * lock_interval) / <timeout>
22792 .endd
22793 times (rounded up).
22794 .endlist
22795
22796 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
22797 and/or &[flock()]& locks) and then deletes the lock file if one was created.
22798
22799
22800 .section "Operational details for delivery to a new file" "SECTopdir"
22801 .cindex "delivery" "to single file"
22802 .cindex "&""From""& line"
22803 When the &%directory%& option is set instead of &%file%&, each message is
22804 delivered into a newly-created file or set of files. When &(appendfile)& is
22805 activated directly from a &(redirect)& router, neither &%file%& nor
22806 &%directory%& is normally set, because the path for delivery is supplied by the
22807 router. (See for example, the &(address_file)& transport in the default
22808 configuration.) In this case, delivery is to a new file if either the path name
22809 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
22810
22811 No locking is required while writing the message to a new file, so the various
22812 locking options of the transport are ignored. The &"From"& line that by default
22813 separates messages in a single file is not normally needed, nor is the escaping
22814 of message lines that start with &"From"&, and there is no need to ensure a
22815 newline at the end of each message. Consequently, the default values for
22816 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
22817 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
22818
22819 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
22820 the files in the delivery directory by default. However, you can specify a
22821 different directory by setting &%quota_directory%&. Also, for maildir
22822 deliveries (see below) the &_maildirfolder_& convention is honoured.
22823
22824
22825 .cindex "maildir format"
22826 .cindex "mailstore format"
22827 There are three different ways in which delivery to individual files can be
22828 done, controlled by the settings of the &%maildir_format%& and
22829 &%mailstore_format%& options. Note that code to support maildir or mailstore
22830 formats is not included in the binary unless SUPPORT_MAILDIR or
22831 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
22832
22833 .cindex "directory creation"
22834 In all three cases an attempt is made to create the directory and any necessary
22835 sub-directories if they do not exist, provided that the &%create_directory%&
22836 option is set (the default). The location of a created directory can be
22837 constrained by setting &%create_file%&. A created directory's mode is given by
22838 the &%directory_mode%& option. If creation fails, or if the
22839 &%create_directory%& option is not set when creation is required, delivery is
22840 deferred.
22841
22842
22843
22844 .section "Maildir delivery" "SECTmaildirdelivery"
22845 .cindex "maildir format" "description of"
22846 If the &%maildir_format%& option is true, Exim delivers each message by writing
22847 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
22848 directory that is defined by the &%directory%& option (the &"delivery
22849 directory"&). If the delivery is successful, the file is renamed into the
22850 &_new_& subdirectory.
22851
22852 In the file name, <&'stime'&> is the current time of day in seconds, and
22853 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
22854 Exim checks that the time-of-day clock has moved on by at least one microsecond
22855 before terminating the delivery process. This guarantees uniqueness for the
22856 file name. However, as a precaution, Exim calls &[stat()]& for the file before
22857 opening it. If any response other than ENOENT (does not exist) is given,
22858 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
22859
22860 Before Exim carries out a maildir delivery, it ensures that subdirectories
22861 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
22862 do not exist, Exim tries to create them and any superior directories in their
22863 path, subject to the &%create_directory%& and &%create_file%& options. If the
22864 &%maildirfolder_create_regex%& option is set, and the regular expression it
22865 contains matches the delivery directory, Exim also ensures that a file called
22866 &_maildirfolder_& exists in the delivery directory. If a missing directory or
22867 &_maildirfolder_& file cannot be created, delivery is deferred.
22868
22869 These features make it possible to use Exim to create all the necessary files
22870 and directories in a maildir mailbox, including subdirectories for maildir++
22871 folders. Consider this example:
22872 .code
22873 maildir_format = true
22874 directory = /var/mail/$local_part\
22875            ${if eq{$local_part_suffix}{}{}\
22876            {/.${substr_1:$local_part_suffix}}}
22877 maildirfolder_create_regex = /\.[^/]+$
22878 .endd
22879 If &$local_part_suffix$& is empty (there was no suffix for the local part),
22880 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
22881 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
22882 not match this name, so Exim will not look for or create the file
22883 &_/var/mail/pimbo/maildirfolder_&, though it will create
22884 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
22885
22886 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
22887 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
22888 does match &%maildirfolder_create_regex%&. In this case, Exim will create
22889 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
22890 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
22891
22892 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
22893 not inadvertently match the toplevel maildir directory, because a
22894 &_maildirfolder_& file at top level would completely break quota calculations.
22895
22896 .cindex "quota" "in maildir delivery"
22897 .cindex "maildir++"
22898 If Exim is required to check a &%quota%& setting before a maildir delivery, and
22899 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
22900 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
22901 Exim assumes the directory is a maildir++ folder directory, which is one level
22902 down from the user's top level mailbox directory. This causes it to start at
22903 the parent directory instead of the current directory when calculating the
22904 amount of space used.
22905
22906 One problem with delivering into a multi-file mailbox is that it is
22907 computationally expensive to compute the size of the mailbox for quota
22908 checking. Various approaches have been taken to reduce the amount of work
22909 needed. The next two sections describe two of them. A third alternative is to
22910 use some external process for maintaining the size data, and use the expansion
22911 of the &%mailbox_size%& option as a way of importing it into Exim.
22912
22913
22914
22915
22916 .section "Using tags to record message sizes" "SECID135"
22917 If &%maildir_tag%& is set, the string is expanded for each delivery.
22918 When the maildir file is renamed into the &_new_& sub-directory, the
22919 tag is added to its name. However, if adding the tag takes the length of the
22920 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
22921 the tag is dropped and the maildir file is created with no tag.
22922
22923
22924 .vindex "&$message_size$&"
22925 Tags can be used to encode the size of files in their names; see
22926 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
22927 happens after the message has been written. The value of the &$message_size$&
22928 variable is set to the number of bytes actually written. If the expansion is
22929 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
22930 be deferred. The expanded tag may contain any printing characters except &"/"&.
22931 Non-printing characters in the string are ignored; if the resulting string is
22932 empty, it is ignored. If it starts with an alphanumeric character, a leading
22933 colon is inserted; this default has not proven to be the path that popular
22934 maildir implementations have chosen (but changing it in Exim would break
22935 backwards compatibility).
22936
22937 For one common implementation, you might set:
22938 .code
22939 maildir_tag = ,S=${message_size}
22940 .endd
22941 but you should check the documentation of the other software to be sure.
22942
22943 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
22944 as this allows Exim to extract the size from your tag, instead of having to
22945 &[stat()]& each message file.
22946
22947
22948 .section "Using a maildirsize file" "SECID136"
22949 .cindex "quota" "in maildir delivery"
22950 .cindex "maildir format" "&_maildirsize_& file"
22951 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
22952 storing quota and message size information in a file called &_maildirsize_&
22953 within the toplevel maildir directory. If this file does not exist, Exim
22954 creates it, setting the quota from the &%quota%& option of the transport. If
22955 the maildir directory itself does not exist, it is created before any attempt
22956 to write a &_maildirsize_& file.
22957
22958 The &_maildirsize_& file is used to hold information about the sizes of
22959 messages in the maildir, thus speeding up quota calculations. The quota value
22960 in the file is just a cache; if the quota is changed in the transport, the new
22961 value overrides the cached value when the next message is delivered. The cache
22962 is maintained for the benefit of other programs that access the maildir and
22963 need to know the quota.
22964
22965 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
22966 file is maintained (with a zero quota setting), but no quota is imposed.
22967
22968 A regular expression is available for controlling which directories in the
22969 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
22970 See the description of the &%maildir_quota_directory_regex%& option above for
22971 details.
22972
22973
22974 .section "Mailstore delivery" "SECID137"
22975 .cindex "mailstore format" "description of"
22976 If the &%mailstore_format%& option is true, each message is written as two
22977 files in the given directory. A unique base name is constructed from the
22978 message id and the current delivery process, and the files that are written use
22979 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22980 contains the message's envelope, and the &_.msg_& file contains the message
22981 itself. The base name is placed in the variable &$mailstore_basename$&.
22982
22983 During delivery, the envelope is first written to a file with the suffix
22984 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22985 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22986 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22987 file before accessing either of them. An alternative approach is to wait for
22988 the absence of a &_.tmp_& file.
22989
22990 The envelope file starts with any text defined by the &%mailstore_prefix%&
22991 option, expanded and terminated by a newline if there isn't one. Then follows
22992 the sender address on one line, then all the recipient addresses, one per line.
22993 There can be more than one recipient only if the &%batch_max%& option is set
22994 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22995 appended to the file, followed by a newline if it does not end with one.
22996
22997 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22998 failure, it is ignored. Other expansion errors are treated as serious
22999 configuration errors, and delivery is deferred. The variable
23000 &$mailstore_basename$& is available for use during these expansions.
23001
23002
23003 .section "Non-special new file delivery" "SECID138"
23004 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23005 file is created directly in the named directory. For example, when delivering
23006 messages into files in batched SMTP format for later delivery to some host (see
23007 section &<<SECTbatchSMTP>>&), a setting such as
23008 .code
23009 directory = /var/bsmtp/$host
23010 .endd
23011 might be used. A message is written to a file with a temporary name, which is
23012 then renamed when the delivery is complete. The final name is obtained by
23013 expanding the contents of the &%directory_file%& option.
23014 .ecindex IIDapptra1
23015 .ecindex IIDapptra2
23016
23017
23018
23019
23020
23021
23022 . ////////////////////////////////////////////////////////////////////////////
23023 . ////////////////////////////////////////////////////////////////////////////
23024
23025 .chapter "The autoreply transport" "CHID8"
23026 .scindex IIDauttra1 "transports" "&(autoreply)&"
23027 .scindex IIDauttra2 "&(autoreply)& transport"
23028 The &(autoreply)& transport is not a true transport in that it does not cause
23029 the message to be transmitted. Instead, it generates a new mail message as an
23030 automatic reply to the incoming message. &'References:'& and
23031 &'Auto-Submitted:'& header lines are included. These are constructed according
23032 to the rules in RFCs 2822 and 3834, respectively.
23033
23034 If the router that passes the message to this transport does not have the
23035 &%unseen%& option set, the original message (for the current recipient) is not
23036 delivered anywhere. However, when the &%unseen%& option is set on the router
23037 that passes the message to this transport, routing of the address continues, so
23038 another router can set up a normal message delivery.
23039
23040
23041 The &(autoreply)& transport is usually run as the result of mail filtering, a
23042 &"vacation"& message being the standard example. However, it can also be run
23043 directly from a router like any other transport. To reduce the possibility of
23044 message cascades, messages created by the &(autoreply)& transport always have
23045 empty envelope sender addresses, like bounce messages.
23046
23047 The parameters of the message to be sent can be specified in the configuration
23048 by options described below. However, these are used only when the address
23049 passed to the transport does not contain its own reply information. When the
23050 transport is run as a consequence of a
23051 &%mail%&
23052 or &%vacation%& command in a filter file, the parameters of the message are
23053 supplied by the filter, and passed with the address. The transport's options
23054 that define the message are then ignored (so they are not usually set in this
23055 case). The message is specified entirely by the filter or by the transport; it
23056 is never built from a mixture of options. However, the &%file_optional%&,
23057 &%mode%&, and &%return_message%& options apply in all cases.
23058
23059 &(Autoreply)& is implemented as a local transport. When used as a result of a
23060 command in a user's filter file, &(autoreply)& normally runs under the uid and
23061 gid of the user, and with appropriate current and home directories (see chapter
23062 &<<CHAPenvironment>>&).
23063
23064 There is a subtle difference between routing a message to a &(pipe)& transport
23065 that generates some text to be returned to the sender, and routing it to an
23066 &(autoreply)& transport. This difference is noticeable only if more than one
23067 address from the same message is so handled. In the case of a pipe, the
23068 separate outputs from the different addresses are gathered up and returned to
23069 the sender in a single message, whereas if &(autoreply)& is used, a separate
23070 message is generated for each address that is passed to it.
23071
23072 Non-printing characters are not permitted in the header lines generated for the
23073 message that &(autoreply)& creates, with the exception of newlines that are
23074 immediately followed by white space. If any non-printing characters are found,
23075 the transport defers.
23076 Whether characters with the top bit set count as printing characters or not is
23077 controlled by the &%print_topbitchars%& global option.
23078
23079 If any of the generic options for manipulating headers (for example,
23080 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23081 of the original message that is included in the generated message when
23082 &%return_message%& is set. They do not apply to the generated message itself.
23083
23084 .vindex "&$sender_address$&"
23085 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23086 the message, indicating that there were no recipients, it does not treat this
23087 as an error. This means that autoreplies sent to &$sender_address$& when this
23088 is empty (because the incoming message is a bounce message) do not cause
23089 problems. They are just discarded.
23090
23091
23092
23093 .section "Private options for autoreply" "SECID139"
23094 .cindex "options" "&(autoreply)& transport"
23095
23096 .option bcc autoreply string&!! unset
23097 This specifies the addresses that are to receive &"blind carbon copies"& of the
23098 message when the message is specified by the transport.
23099
23100
23101 .option cc autoreply string&!! unset
23102 This specifies recipients of the message and the contents of the &'Cc:'& header
23103 when the message is specified by the transport.
23104
23105
23106 .option file autoreply string&!! unset
23107 The contents of the file are sent as the body of the message when the message
23108 is specified by the transport. If both &%file%& and &%text%& are set, the text
23109 string comes first.
23110
23111
23112 .option file_expand autoreply boolean false
23113 If this is set, the contents of the file named by the &%file%& option are
23114 subjected to string expansion as they are added to the message.
23115
23116
23117 .option file_optional autoreply boolean false
23118 If this option is true, no error is generated if the file named by the &%file%&
23119 option or passed with the address does not exist or cannot be read.
23120
23121
23122 .option from autoreply string&!! unset
23123 This specifies the contents of the &'From:'& header when the message is
23124 specified by the transport.
23125
23126
23127 .option headers autoreply string&!! unset
23128 This specifies additional RFC 2822 headers that are to be added to the message
23129 when the message is specified by the transport. Several can be given by using
23130 &"\n"& to separate them. There is no check on the format.
23131
23132
23133 .option log autoreply string&!! unset
23134 This option names a file in which a record of every message sent is logged when
23135 the message is specified by the transport.
23136
23137
23138 .option mode autoreply "octal integer" 0600
23139 If either the log file or the &"once"& file has to be created, this mode is
23140 used.
23141
23142
23143 .option never_mail autoreply "address list&!!" unset
23144 If any run of the transport creates a message with a recipient that matches any
23145 item in the list, that recipient is quietly discarded. If all recipients are
23146 discarded, no message is created. This applies both when the recipients are
23147 generated by a filter and when they are specified in the transport.
23148
23149
23150
23151 .option once autoreply string&!! unset
23152 This option names a file or DBM database in which a record of each &'To:'&
23153 recipient is kept when the message is specified by the transport. &*Note*&:
23154 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
23155
23156 If &%once%& is unset, or is set to an empty string, the message is always sent.
23157 By default, if &%once%& is set to a non-empty file name, the message
23158 is not sent if a potential recipient is already listed in the database.
23159 However, if the &%once_repeat%& option specifies a time greater than zero, the
23160 message is sent if that much time has elapsed since a message was last sent to
23161 this recipient. A setting of zero time for &%once_repeat%& (the default)
23162 prevents a message from being sent a second time &-- in this case, zero means
23163 infinity.
23164
23165 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
23166 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
23167 greater than zero, it changes the way Exim implements the &%once%& option.
23168 Instead of using a DBM file to record every recipient it sends to, it uses a
23169 regular file, whose size will never get larger than the given value.
23170
23171 In the file, Exim keeps a linear list of recipient addresses and the times at
23172 which they were sent messages. If the file is full when a new address needs to
23173 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
23174 means that a given recipient may receive multiple messages, but at
23175 unpredictable intervals that depend on the rate of turnover of addresses in the
23176 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
23177
23178
23179 .option once_file_size autoreply integer 0
23180 See &%once%& above.
23181
23182
23183 .option once_repeat autoreply time&!! 0s
23184 See &%once%& above.
23185 After expansion, the value of this option must be a valid time value.
23186
23187
23188 .option reply_to autoreply string&!! unset
23189 This specifies the contents of the &'Reply-To:'& header when the message is
23190 specified by the transport.
23191
23192
23193 .option return_message autoreply boolean false
23194 If this is set, a copy of the original message is returned with the new
23195 message, subject to the maximum size set in the &%return_size_limit%& global
23196 configuration option.
23197
23198
23199 .option subject autoreply string&!! unset
23200 This specifies the contents of the &'Subject:'& header when the message is
23201 specified by the transport. It is tempting to quote the original subject in
23202 automatic responses. For example:
23203 .code
23204 subject = Re: $h_subject:
23205 .endd
23206 There is a danger in doing this, however. It may allow a third party to
23207 subscribe your users to an opt-in mailing list, provided that the list accepts
23208 bounce messages as subscription confirmations. Well-managed lists require a
23209 non-bounce message to confirm a subscription, so the danger is relatively
23210 small.
23211
23212
23213
23214 .option text autoreply string&!! unset
23215 This specifies a single string to be used as the body of the message when the
23216 message is specified by the transport. If both &%text%& and &%file%& are set,
23217 the text comes first.
23218
23219
23220 .option to autoreply string&!! unset
23221 This specifies recipients of the message and the contents of the &'To:'& header
23222 when the message is specified by the transport.
23223 .ecindex IIDauttra1
23224 .ecindex IIDauttra2
23225
23226
23227
23228
23229 . ////////////////////////////////////////////////////////////////////////////
23230 . ////////////////////////////////////////////////////////////////////////////
23231
23232 .chapter "The lmtp transport" "CHAPLMTP"
23233 .cindex "transports" "&(lmtp)&"
23234 .cindex "&(lmtp)& transport"
23235 .cindex "LMTP" "over a pipe"
23236 .cindex "LMTP" "over a socket"
23237 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
23238 specified command
23239 or by interacting with a Unix domain socket.
23240 This transport is something of a cross between the &(pipe)& and &(smtp)&
23241 transports. Exim also has support for using LMTP over TCP/IP; this is
23242 implemented as an option for the &(smtp)& transport. Because LMTP is expected
23243 to be of minority interest, the default build-time configure in &_src/EDITME_&
23244 has it commented out. You need to ensure that
23245 .code
23246 TRANSPORT_LMTP=yes
23247 .endd
23248 .cindex "options" "&(lmtp)& transport"
23249 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
23250 included in the Exim binary. The private options of the &(lmtp)& transport are
23251 as follows:
23252
23253 .option batch_id lmtp string&!! unset
23254 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23255
23256
23257 .option batch_max lmtp integer 1
23258 This limits the number of addresses that can be handled in a single delivery.
23259 Most LMTP servers can handle several addresses at once, so it is normally a
23260 good idea to increase this value. See the description of local delivery
23261 batching in chapter &<<CHAPbatching>>&.
23262
23263
23264 .option command lmtp string&!! unset
23265 This option must be set if &%socket%& is not set. The string is a command which
23266 is run in a separate process. It is split up into a command name and list of
23267 arguments, each of which is separately expanded (so expansion cannot change the
23268 number of arguments). The command is run directly, not via a shell. The message
23269 is passed to the new process using the standard input and output to operate the
23270 LMTP protocol.
23271
23272 .option ignore_quota lmtp boolean false
23273 .cindex "LMTP" "ignoring quota errors"
23274 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
23275 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
23276 in its response to the LHLO command.
23277
23278 .option socket lmtp string&!! unset
23279 This option must be set if &%command%& is not set. The result of expansion must
23280 be the name of a Unix domain socket. The transport connects to the socket and
23281 delivers the message to it using the LMTP protocol.
23282
23283
23284 .option timeout lmtp time 5m
23285 The transport is aborted if the created process or Unix domain socket does not
23286 respond to LMTP commands or message input within this timeout. Delivery
23287 is deferred, and will be tried again later. Here is an example of a typical
23288 LMTP transport:
23289 .code
23290 lmtp:
23291   driver = lmtp
23292   command = /some/local/lmtp/delivery/program
23293   batch_max = 20
23294   user = exim
23295 .endd
23296 This delivers up to 20 addresses at a time, in a mixture of domains if
23297 necessary, running as the user &'exim'&.
23298
23299
23300
23301 . ////////////////////////////////////////////////////////////////////////////
23302 . ////////////////////////////////////////////////////////////////////////////
23303
23304 .chapter "The pipe transport" "CHAPpipetransport"
23305 .scindex IIDpiptra1 "transports" "&(pipe)&"
23306 .scindex IIDpiptra2 "&(pipe)& transport"
23307 The &(pipe)& transport is used to deliver messages via a pipe to a command
23308 running in another process. One example is the use of &(pipe)& as a
23309 pseudo-remote transport for passing messages to some other delivery mechanism
23310 (such as UUCP). Another is the use by individual users to automatically process
23311 their incoming messages. The &(pipe)& transport can be used in one of the
23312 following ways:
23313
23314 .ilist
23315 .vindex "&$local_part$&"
23316 A router routes one address to a transport in the normal way, and the
23317 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
23318 contains the local part of the address (as usual), and the command that is run
23319 is specified by the &%command%& option on the transport.
23320 .next
23321 .vindex "&$pipe_addresses$&"
23322 If the &%batch_max%& option is set greater than 1 (the default is 1), the
23323 transport can handle more than one address in a single run. In this case, when
23324 more than one address is routed to the transport, &$local_part$& is not set
23325 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
23326 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
23327 that are routed to the transport.
23328 .next
23329 .vindex "&$address_pipe$&"
23330 A router redirects an address directly to a pipe command (for example, from an
23331 alias or forward file). In this case, &$address_pipe$& contains the text of the
23332 pipe command, and the &%command%& option on the transport is ignored unless
23333 &%force_command%& is set. If only one address is being transported
23334 (&%batch_max%& is not greater than one, or only one address was redirected to
23335 this pipe command), &$local_part$& contains the local part that was redirected.
23336 .endlist
23337
23338
23339 The &(pipe)& transport is a non-interactive delivery method. Exim can also
23340 deliver messages over pipes using the LMTP interactive protocol. This is
23341 implemented by the &(lmtp)& transport.
23342
23343 In the case when &(pipe)& is run as a consequence of an entry in a local user's
23344 &_.forward_& file, the command runs under the uid and gid of that user. In
23345 other cases, the uid and gid have to be specified explicitly, either on the
23346 transport or on the router that handles the address. Current and &"home"&
23347 directories are also controllable. See chapter &<<CHAPenvironment>>& for
23348 details of the local delivery environment and chapter &<<CHAPbatching>>&
23349 for a discussion of local delivery batching.
23350
23351
23352 .section "Concurrent delivery" "SECID140"
23353 If two messages arrive at almost the same time, and both are routed to a pipe
23354 delivery, the two pipe transports may be run concurrently. You must ensure that
23355 any pipe commands you set up are robust against this happening. If the commands
23356 write to a file, the &%exim_lock%& utility might be of use.
23357 Alternatively the &%max_parallel%& option could be used with a value
23358 of "1" to enforce serialization.
23359
23360
23361
23362
23363 .section "Returned status and data" "SECID141"
23364 .cindex "&(pipe)& transport" "returned data"
23365 If the command exits with a non-zero return code, the delivery is deemed to
23366 have failed, unless either the &%ignore_status%& option is set (in which case
23367 the return code is treated as zero), or the return code is one of those listed
23368 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23369 later"&. In this case, delivery is deferred. Details of a permanent failure are
23370 logged, but are not included in the bounce message, which merely contains
23371 &"local delivery failed"&.
23372
23373 If the command exits on a signal and the &%freeze_signal%& option is set then
23374 the message will be frozen in the queue. If that option is not set, a bounce
23375 will be sent as normal.
23376
23377 If the return code is greater than 128 and the command being run is a shell
23378 script, it normally means that the script was terminated by a signal whose
23379 value is the return code minus 128. The &%freeze_signal%& option does not
23380 apply in this case.
23381
23382 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23383 return code is set to 127. This is the value that a shell returns if it is
23384 asked to run a non-existent command. The wording for the log line suggests that
23385 a non-existent command may be the problem.
23386
23387 The &%return_output%& option can affect the result of a pipe delivery. If it is
23388 set and the command produces any output on its standard output or standard
23389 error streams, the command is considered to have failed, even if it gave a zero
23390 return code or if &%ignore_status%& is set. The output from the command is
23391 included as part of the bounce message. The &%return_fail_output%& option is
23392 similar, except that output is returned only when the command exits with a
23393 failure return code, that is, a value other than zero or a code that matches
23394 &%temp_errors%&.
23395
23396
23397
23398 .section "How the command is run" "SECThowcommandrun"
23399 .cindex "&(pipe)& transport" "path for command"
23400 The command line is (by default) broken down into a command name and arguments
23401 by the &(pipe)& transport itself. The &%allow_commands%& and
23402 &%restrict_to_path%& options can be used to restrict the commands that may be
23403 run.
23404
23405 .cindex "quoting" "in pipe command"
23406 Unquoted arguments are delimited by white space. If an argument appears in
23407 double quotes, backslash is interpreted as an escape character in the usual
23408 way. If an argument appears in single quotes, no escaping is done.
23409
23410 String expansion is applied to the command line except when it comes from a
23411 traditional &_.forward_& file (commands from a filter file are expanded). The
23412 expansion is applied to each argument in turn rather than to the whole line.
23413 For this reason, any string expansion item that contains white space must be
23414 quoted so as to be contained within a single argument. A setting such as
23415 .code
23416 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23417 .endd
23418 will not work, because the expansion item gets split between several
23419 arguments. You have to write
23420 .code
23421 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23422 .endd
23423 to ensure that it is all in one argument. The expansion is done in this way,
23424 argument by argument, so that the number of arguments cannot be changed as a
23425 result of expansion, and quotes or backslashes in inserted variables do not
23426 interact with external quoting. However, this leads to problems if you want to
23427 generate multiple arguments (or the command name plus arguments) from a single
23428 expansion. In this situation, the simplest solution is to use a shell. For
23429 example:
23430 .code
23431 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23432 .endd
23433
23434 .cindex "transport" "filter"
23435 .cindex "filter" "transport filter"
23436 .vindex "&$pipe_addresses$&"
23437 Special handling takes place when an argument consists of precisely the text
23438 &`$pipe_addresses`&. This is not a general expansion variable; the only
23439 place this string is recognized is when it appears as an argument for a pipe or
23440 transport filter command. It causes each address that is being handled to be
23441 inserted in the argument list at that point &'as a separate argument'&. This
23442 avoids any problems with spaces or shell metacharacters, and is of use when a
23443 &(pipe)& transport is handling groups of addresses in a batch.
23444
23445 If &%force_command%& is enabled on the transport, Special handling takes place
23446 for an argument that consists of precisely the text &`$address_pipe`&.  It
23447 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23448 argument is inserted in the argument list at that point
23449 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23450 the only item in the argument; in fact, if it were then &%force_command%&
23451 should behave as a no-op.  Rather, it should be used to adjust the command
23452 run while preserving the argument vector separation.
23453
23454 After splitting up into arguments and expansion, the resulting command is run
23455 in a subprocess directly from the transport, &'not'& under a shell. The
23456 message that is being delivered is supplied on the standard input, and the
23457 standard output and standard error are both connected to a single pipe that is
23458 read by Exim. The &%max_output%& option controls how much output the command
23459 may produce, and the &%return_output%& and &%return_fail_output%& options
23460 control what is done with it.
23461
23462 Not running the command under a shell (by default) lessens the security risks
23463 in cases when a command from a user's filter file is built out of data that was
23464 taken from an incoming message. If a shell is required, it can of course be
23465 explicitly specified as the command to be run. However, there are circumstances
23466 where existing commands (for example, in &_.forward_& files) expect to be run
23467 under a shell and cannot easily be modified. To allow for these cases, there is
23468 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23469 works. Instead of breaking up the command line as just described, it expands it
23470 as a single string and passes the result to &_/bin/sh_&. The
23471 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23472 with &%use_shell%&, and the whole mechanism is inherently less secure.
23473
23474
23475
23476 .section "Environment variables" "SECTpipeenv"
23477 .cindex "&(pipe)& transport" "environment for command"
23478 .cindex "environment" "&(pipe)& transport"
23479 The environment variables listed below are set up when the command is invoked.
23480 This list is a compromise for maximum compatibility with other MTAs. Note that
23481 the &%environment%& option can be used to add additional variables to this
23482 environment. The environment for the &(pipe)& transport is not subject
23483 to the &%add_environment%& and &%keep_environment%& main config options.
23484 .display
23485 &`DOMAIN            `&   the domain of the address
23486 &`HOME              `&   the home directory, if set
23487 &`HOST              `&   the host name when called from a router (see below)
23488 &`LOCAL_PART        `&   see below
23489 &`LOCAL_PART_PREFIX `&   see below
23490 &`LOCAL_PART_SUFFIX `&   see below
23491 &`LOGNAME           `&   see below
23492 &`MESSAGE_ID        `&   Exim's local ID for the message
23493 &`PATH              `&   as specified by the &%path%& option below
23494 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23495 &`RECIPIENT         `&   the complete recipient address
23496 &`SENDER            `&   the sender of the message (empty if a bounce)
23497 &`SHELL             `&   &`/bin/sh`&
23498 &`TZ                `&   the value of the &%timezone%& option, if set
23499 &`USER              `&   see below
23500 .endd
23501 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23502 router, LOCAL_PART is set to the local part of the address. When it is
23503 called as a result of a forward or alias expansion, LOCAL_PART is set to
23504 the local part of the address that was expanded. In both cases, any affixes are
23505 removed from the local part, and made available in LOCAL_PART_PREFIX and
23506 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23507 same value as LOCAL_PART for compatibility with other MTAs.
23508
23509 .cindex "HOST"
23510 HOST is set only when a &(pipe)& transport is called from a router that
23511 associates hosts with an address, typically when using &(pipe)& as a
23512 pseudo-remote transport. HOST is set to the first host name specified by
23513 the router.
23514
23515 .cindex "HOME"
23516 If the transport's generic &%home_directory%& option is set, its value is used
23517 for the HOME environment variable. Otherwise, a home directory may be set
23518 by the router's &%transport_home_directory%& option, which defaults to the
23519 user's home directory if &%check_local_user%& is set.
23520
23521
23522 .section "Private options for pipe" "SECID142"
23523 .cindex "options" "&(pipe)& transport"
23524
23525
23526
23527 .option allow_commands pipe "string list&!!" unset
23528 .cindex "&(pipe)& transport" "permitted commands"
23529 The string is expanded, and is then interpreted as a colon-separated list of
23530 permitted commands. If &%restrict_to_path%& is not set, the only commands
23531 permitted are those in the &%allow_commands%& list. They need not be absolute
23532 paths; the &%path%& option is still used for relative paths. If
23533 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23534 in the &%allow_commands%& list, or a name without any slashes that is found on
23535 the path. In other words, if neither &%allow_commands%& nor
23536 &%restrict_to_path%& is set, there is no restriction on the command, but
23537 otherwise only commands that are permitted by one or the other are allowed. For
23538 example, if
23539 .code
23540 allow_commands = /usr/bin/vacation
23541 .endd
23542 and &%restrict_to_path%& is not set, the only permitted command is
23543 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23544 &%use_shell%& is set.
23545
23546
23547 .option batch_id pipe string&!! unset
23548 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23549
23550
23551 .option batch_max pipe integer 1
23552 This limits the number of addresses that can be handled in a single delivery.
23553 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23554
23555
23556 .option check_string pipe string unset
23557 As &(pipe)& writes the message, the start of each line is tested for matching
23558 &%check_string%&, and if it does, the initial matching characters are replaced
23559 by the contents of &%escape_string%&, provided both are set. The value of
23560 &%check_string%& is a literal string, not a regular expression, and the case of
23561 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23562 of &%check_string%& and &%escape_string%& are forced to values that implement
23563 the SMTP escaping protocol. Any settings made in the configuration file are
23564 ignored.
23565
23566
23567 .option command pipe string&!! unset
23568 This option need not be set when &(pipe)& is being used to deliver to pipes
23569 obtained directly from address redirections. In other cases, the option must be
23570 set, to provide a command to be run. It need not yield an absolute path (see
23571 the &%path%& option below). The command is split up into separate arguments by
23572 Exim, and each argument is separately expanded, as described in section
23573 &<<SECThowcommandrun>>& above.
23574
23575
23576 .option environment pipe string&!! unset
23577 .cindex "&(pipe)& transport" "environment for command"
23578 .cindex "environment" "&(pipe)& transport"
23579 This option is used to add additional variables to the environment in which the
23580 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23581 a string which is expanded, and then interpreted as a colon-separated list of
23582 environment settings of the form <&'name'&>=<&'value'&>.
23583
23584
23585 .option escape_string pipe string unset
23586 See &%check_string%& above.
23587
23588
23589 .option freeze_exec_fail pipe boolean false
23590 .cindex "exec failure"
23591 .cindex "failure of exec"
23592 .cindex "&(pipe)& transport" "failure of exec"
23593 Failure to exec the command in a pipe transport is by default treated like
23594 any other failure while running the command. However, if &%freeze_exec_fail%&
23595 is set, failure to exec is treated specially, and causes the message to be
23596 frozen, whatever the setting of &%ignore_status%&.
23597
23598
23599 .option freeze_signal pipe boolean false
23600 .cindex "signal exit"
23601 .cindex "&(pipe)& transport", "signal exit"
23602 Normally if the process run by a command in a pipe transport exits on a signal,
23603 a bounce message is sent. If &%freeze_signal%& is set, the message will be
23604 frozen in Exim's queue instead.
23605
23606
23607 .option force_command pipe boolean false
23608 .cindex "force command"
23609 .cindex "&(pipe)& transport", "force command"
23610 Normally when a router redirects an address directly to a pipe command
23611 the &%command%& option on the transport is ignored.  If &%force_command%&
23612 is set, the &%command%& option will used. This is especially
23613 useful for forcing a wrapper or additional argument to be added to the
23614 command. For example:
23615 .code
23616 command = /usr/bin/remote_exec myhost -- $address_pipe
23617 force_command
23618 .endd
23619
23620 Note that &$address_pipe$& is handled specially in &%command%& when
23621 &%force_command%& is set, expanding out to the original argument vector as
23622 separate items, similarly to a Unix shell &`"$@"`& construct.
23623
23624
23625 .option ignore_status pipe boolean false
23626 If this option is true, the status returned by the subprocess that is set up to
23627 run the command is ignored, and Exim behaves as if zero had been returned.
23628 Otherwise, a non-zero status or termination by signal causes an error return
23629 from the transport unless the status value is one of those listed in
23630 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23631
23632 &*Note*&: This option does not apply to timeouts, which do not return a status.
23633 See the &%timeout_defer%& option for how timeouts are handled.
23634
23635
23636 .option log_defer_output pipe boolean false
23637 .cindex "&(pipe)& transport" "logging output"
23638 If this option is set, and the status returned by the command is
23639 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
23640 and any output was produced on stdout or stderr, the first line of it is
23641 written to the main log.
23642
23643
23644 .option log_fail_output pipe boolean false
23645 If this option is set, and the command returns any output on stdout or
23646 stderr, and also ends with a return code that is neither zero nor one of
23647 the return codes listed in &%temp_errors%& (that is, the delivery
23648 failed), the first line of output is written to the main log. This
23649 option and &%log_output%& are mutually exclusive.  Only one of them may
23650 be set.
23651
23652
23653 .option log_output pipe boolean false
23654 If this option is set and the command returns any output on stdout or
23655 stderr, the first line of output is written to the main log, whatever
23656 the return code. This option and &%log_fail_output%& are mutually
23657 exclusive. Only one of them may be set.
23658
23659
23660 .option max_output pipe integer 20K
23661 This specifies the maximum amount of output that the command may produce on its
23662 standard output and standard error file combined. If the limit is exceeded, the
23663 process running the command is killed. This is intended as a safety measure to
23664 catch runaway processes. The limit is applied independently of the settings of
23665 the options that control what is done with such output (for example,
23666 &%return_output%&). Because of buffering effects, the amount of output may
23667 exceed the limit by a small amount before Exim notices.
23668
23669
23670 .option message_prefix pipe string&!! "see below"
23671 The string specified here is expanded and output at the start of every message.
23672 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23673 .code
23674 message_prefix = \
23675   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23676   ${tod_bsdinbox}\n
23677 .endd
23678 .cindex "Cyrus"
23679 .cindex "&%tmail%&"
23680 .cindex "&""From""& line"
23681 This is required by the commonly used &_/usr/bin/vacation_& program.
23682 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23683 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23684 setting
23685 .code
23686 message_prefix =
23687 .endd
23688 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23689 &`\n`& to &`\r\n`& in &%message_prefix%&.
23690
23691
23692 .option message_suffix pipe string&!! "see below"
23693 The string specified here is expanded and output at the end of every message.
23694 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23695 The suffix can be suppressed by setting
23696 .code
23697 message_suffix =
23698 .endd
23699 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23700 &`\n`& to &`\r\n`& in &%message_suffix%&.
23701
23702
23703 .option path pipe string&!! "/bin:/usr/bin"
23704 This option is expanded and
23705 specifies the string that is set up in the PATH environment
23706 variable of the subprocess.
23707 If the &%command%& option does not yield an absolute path name, the command is
23708 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23709 apply to a command specified as a transport filter.
23710
23711
23712 .option permit_coredump pipe boolean false
23713 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23714 a core-dump of a pipe command, enable this command.  This enables core-dumps
23715 during delivery and affects both the Exim binary and the pipe command run.
23716 It is recommended that this option remain off unless and until you have a need
23717 for it and that this only be enabled when needed, as the risk of excessive
23718 resource consumption can be quite high.  Note also that Exim is typically
23719 installed as a setuid binary and most operating systems will inhibit coredumps
23720 of these by default, so further OS-specific action may be required.
23721
23722
23723 .option pipe_as_creator pipe boolean false
23724 .cindex "uid (user id)" "local delivery"
23725 If the generic &%user%& option is not set and this option is true, the delivery
23726 process is run under the uid that was in force when Exim was originally called
23727 to accept the message. If the group id is not otherwise set (via the generic
23728 &%group%& option), the gid that was in force when Exim was originally called to
23729 accept the message is used.
23730
23731
23732 .option restrict_to_path pipe boolean false
23733 When this option is set, any command name not listed in &%allow_commands%& must
23734 contain no slashes. The command is searched for only in the directories listed
23735 in the &%path%& option. This option is intended for use in the case when a pipe
23736 command has been generated from a user's &_.forward_& file. This is usually
23737 handled by a &(pipe)& transport called &%address_pipe%&.
23738
23739
23740 .option return_fail_output pipe boolean false
23741 If this option is true, and the command produced any output and ended with a
23742 return code other than zero or one of the codes listed in &%temp_errors%& (that
23743 is, the delivery failed), the output is returned in the bounce message.
23744 However, if the message has a null sender (that is, it is itself a bounce
23745 message), output from the command is discarded. This option and
23746 &%return_output%& are mutually exclusive. Only one of them may be set.
23747
23748
23749
23750 .option return_output pipe boolean false
23751 If this option is true, and the command produced any output, the delivery is
23752 deemed to have failed whatever the return code from the command, and the output
23753 is returned in the bounce message. Otherwise, the output is just discarded.
23754 However, if the message has a null sender (that is, it is a bounce message),
23755 output from the command is always discarded, whatever the setting of this
23756 option. This option and &%return_fail_output%& are mutually exclusive. Only one
23757 of them may be set.
23758
23759
23760
23761 .option temp_errors pipe "string list" "see below"
23762 .cindex "&(pipe)& transport" "temporary failure"
23763 This option contains either a colon-separated list of numbers, or a single
23764 asterisk. If &%ignore_status%& is false
23765 and &%return_output%& is not set,
23766 and the command exits with a non-zero return code, the failure is treated as
23767 temporary and the delivery is deferred if the return code matches one of the
23768 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
23769 codes are treated as permanent errors. The default setting contains the codes
23770 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
23771 compiled on a system that does not define these macros, it assumes values of 75
23772 and 73, respectively.
23773
23774
23775 .option timeout pipe time 1h
23776 If the command fails to complete within this time, it is killed. This normally
23777 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
23778 specifies no timeout. In order to ensure that any subprocesses created by the
23779 command are also killed, Exim makes the initial process a process group leader,
23780 and kills the whole process group on a timeout. However, this can be defeated
23781 if one of the processes starts a new process group.
23782
23783 .option timeout_defer pipe boolean false
23784 A timeout in a &(pipe)& transport, either in the command that the transport
23785 runs, or in a transport filter that is associated with it, is by default
23786 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
23787 is set true, both kinds of timeout become temporary errors, causing the
23788 delivery to be deferred.
23789
23790 .option umask pipe "octal integer" 022
23791 This specifies the umask setting for the subprocess that runs the command.
23792
23793
23794 .option use_bsmtp pipe boolean false
23795 .cindex "envelope sender"
23796 If this option is set true, the &(pipe)& transport writes messages in &"batch
23797 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
23798 commands. If you want to include a leading HELO command with such messages,
23799 you can do so by setting the &%message_prefix%& option. See section
23800 &<<SECTbatchSMTP>>& for details of batch SMTP.
23801
23802 .option use_classresources pipe boolean false
23803 .cindex "class resources (BSD)"
23804 This option is available only when Exim is running on FreeBSD, NetBSD, or
23805 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
23806 resource limits when a &(pipe)& transport is run to perform a delivery. The
23807 limits for the uid under which the pipe is to run are obtained from the login
23808 class database.
23809
23810
23811 .option use_crlf pipe boolean false
23812 .cindex "carriage return"
23813 .cindex "linefeed"
23814 This option causes lines to be terminated with the two-character CRLF sequence
23815 (carriage return, linefeed) instead of just a linefeed character. In the case
23816 of batched SMTP, the byte sequence written to the pipe is then an exact image
23817 of what would be sent down a real SMTP connection.
23818
23819 The contents of the &%message_prefix%& and &%message_suffix%& options are
23820 written verbatim, so must contain their own carriage return characters if these
23821 are needed. When &%use_bsmtp%& is not set, the default values for both
23822 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
23823 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
23824
23825
23826 .option use_shell pipe boolean false
23827 .vindex "&$pipe_addresses$&"
23828 If this option is set, it causes the command to be passed to &_/bin/sh_&
23829 instead of being run directly from the transport, as described in section
23830 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
23831 where the command is expected to be run under a shell and cannot easily be
23832 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
23833 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
23834 command is expanded as a single string, and handed to &_/bin/sh_& as data for
23835 its &%-c%& option.
23836
23837
23838
23839 .section "Using an external local delivery agent" "SECID143"
23840 .cindex "local delivery" "using an external agent"
23841 .cindex "&'procmail'&"
23842 .cindex "external local delivery"
23843 .cindex "delivery" "&'procmail'&"
23844 .cindex "delivery" "by external agent"
23845 The &(pipe)& transport can be used to pass all messages that require local
23846 delivery to a separate local delivery agent such as &%procmail%&. When doing
23847 this, care must be taken to ensure that the pipe is run under an appropriate
23848 uid and gid. In some configurations one wants this to be a uid that is trusted
23849 by the delivery agent to supply the correct sender of the message. It may be
23850 necessary to recompile or reconfigure the delivery agent so that it trusts an
23851 appropriate user. The following is an example transport and router
23852 configuration for &%procmail%&:
23853 .code
23854 # transport
23855 procmail_pipe:
23856   driver = pipe
23857   command = /usr/local/bin/procmail -d $local_part
23858   return_path_add
23859   delivery_date_add
23860   envelope_to_add
23861   check_string = "From "
23862   escape_string = ">From "
23863   umask = 077
23864   user = $local_part
23865   group = mail
23866
23867 # router
23868 procmail:
23869   driver = accept
23870   check_local_user
23871   transport = procmail_pipe
23872 .endd
23873 In this example, the pipe is run as the local user, but with the group set to
23874 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
23875 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
23876 user to supply a correct sender address. If you do not specify either a
23877 &%group%& or a &%user%& option, the pipe command is run as the local user. The
23878 home directory is the user's home directory by default.
23879
23880 &*Note*&: The command that the pipe transport runs does &'not'& begin with
23881 .code
23882 IFS=" "
23883 .endd
23884 as shown in some &%procmail%& documentation, because Exim does not by default
23885 use a shell to run pipe commands.
23886
23887 .cindex "Cyrus"
23888 The next example shows a transport and a router for a system where local
23889 deliveries are handled by the Cyrus IMAP server.
23890 .code
23891 # transport
23892 local_delivery_cyrus:
23893   driver = pipe
23894   command = /usr/cyrus/bin/deliver \
23895             -m ${substr_1:$local_part_suffix} -- $local_part
23896   user = cyrus
23897   group = mail
23898   return_output
23899   log_output
23900   message_prefix =
23901   message_suffix =
23902
23903 # router
23904 local_user_cyrus:
23905   driver = accept
23906   check_local_user
23907   local_part_suffix = .*
23908   transport = local_delivery_cyrus
23909 .endd
23910 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
23911 &%return_output%& to cause any text written by Cyrus to be returned to the
23912 sender.
23913 .ecindex IIDpiptra1
23914 .ecindex IIDpiptra2
23915
23916
23917 . ////////////////////////////////////////////////////////////////////////////
23918 . ////////////////////////////////////////////////////////////////////////////
23919
23920 .chapter "The smtp transport" "CHAPsmtptrans"
23921 .scindex IIDsmttra1 "transports" "&(smtp)&"
23922 .scindex IIDsmttra2 "&(smtp)& transport"
23923 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
23924 or LMTP protocol. The list of hosts to try can either be taken from the address
23925 that is being processed (having been set up by the router), or specified
23926 explicitly for the transport. Timeout and retry processing (see chapter
23927 &<<CHAPretry>>&) is applied to each IP address independently.
23928
23929
23930 .section "Multiple messages on a single connection" "SECID144"
23931 The sending of multiple messages over a single TCP/IP connection can arise in
23932 two ways:
23933
23934 .ilist
23935 If a message contains more than &%max_rcpt%& (see below) addresses that are
23936 routed to the same host, more than one copy of the message has to be sent to
23937 that host. In this situation, multiple copies may be sent in a single run of
23938 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
23939 does when it has too many addresses to send in one message also depends on the
23940 value of the global &%remote_max_parallel%& option. Details are given in
23941 section &<<SECToutSMTPTCP>>&.)
23942 .next
23943 .cindex "hints database" "remembering routing"
23944 When a message has been successfully delivered over a TCP/IP connection, Exim
23945 looks in its hints database to see if there are any other messages awaiting a
23946 connection to the same host. If there are, a new delivery process is started
23947 for one of them, and the current TCP/IP connection is passed on to it. The new
23948 process may in turn send multiple copies and possibly create yet another
23949 process.
23950 .endlist
23951
23952
23953 For each copy sent over the same TCP/IP connection, a sequence counter is
23954 incremented, and if it ever gets to the value of &%connection_max_messages%&,
23955 no further messages are sent over that connection.
23956
23957
23958
23959 .section "Use of the $host and $host_address variables" "SECID145"
23960 .vindex "&$host$&"
23961 .vindex "&$host_address$&"
23962 At the start of a run of the &(smtp)& transport, the values of &$host$& and
23963 &$host_address$& are the name and IP address of the first host on the host list
23964 passed by the router. However, when the transport is about to connect to a
23965 specific host, and while it is connected to that host, &$host$& and
23966 &$host_address$& are set to the values for that host. These are the values
23967 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
23968 &%serialize_hosts%&, and the various TLS options are expanded.
23969
23970
23971 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
23972 .vindex &$tls_bits$&
23973 .vindex &$tls_cipher$&
23974 .vindex &$tls_peerdn$&
23975 .vindex &$tls_sni$&
23976 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
23977 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
23978 are the values that were set when the message was received.
23979 These are the values that are used for options that are expanded before any
23980 SMTP connections are made. Just before each connection is made, these four
23981 variables are emptied. If TLS is subsequently started, they are set to the
23982 appropriate values for the outgoing connection, and these are the values that
23983 are in force when any authenticators are run and when the
23984 &%authenticated_sender%& option is expanded.
23985
23986 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23987 and will be removed in a future release.
23988
23989
23990 .section "Private options for smtp" "SECID146"
23991 .cindex "options" "&(smtp)& transport"
23992 The private options of the &(smtp)& transport are as follows:
23993
23994
23995 .option address_retry_include_sender smtp boolean true
23996 .cindex "4&'xx'& responses" "retrying after"
23997 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23998 is the combination of sender and recipient that is delayed in subsequent queue
23999 runs until the retry time is reached. You can delay the recipient without
24000 reference to the sender (which is what earlier versions of Exim did), by
24001 setting &%address_retry_include_sender%& false. However, this can lead to
24002 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24003
24004 .option allow_localhost smtp boolean false
24005 .cindex "local host" "sending to"
24006 .cindex "fallback" "hosts specified on transport"
24007 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24008 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24009 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24010 the delivery anyway. This should be used only in special cases when the
24011 configuration ensures that no looping will result (for example, a differently
24012 configured Exim is listening on the port to which the message is sent).
24013
24014
24015 .option authenticated_sender smtp string&!! unset
24016 .cindex "Cyrus"
24017 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24018 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24019 overriding any existing authenticated sender value. If the string expansion is
24020 forced to fail, the option is ignored. Other expansion failures cause delivery
24021 to be deferred. If the result of expansion is an empty string, that is also
24022 ignored.
24023
24024 The expansion happens after the outgoing connection has been made and TLS
24025 started, if required. This means that the &$host$&, &$host_address$&,
24026 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24027 particular connection.
24028
24029 If the SMTP session is not authenticated, the expansion of
24030 &%authenticated_sender%& still happens (and can cause the delivery to be
24031 deferred if it fails), but no AUTH= item is added to MAIL commands
24032 unless &%authenticated_sender_force%& is true.
24033
24034 This option allows you to use the &(smtp)& transport in LMTP mode to
24035 deliver mail to Cyrus IMAP and provide the proper local part as the
24036 &"authenticated sender"&, via a setting such as:
24037 .code
24038 authenticated_sender = $local_part
24039 .endd
24040 This removes the need for IMAP subfolders to be assigned special ACLs to
24041 allow direct delivery to those subfolders.
24042
24043 Because of expected uses such as that just described for Cyrus (when no
24044 domain is involved), there is no checking on the syntax of the provided
24045 value.
24046
24047
24048 .option authenticated_sender_force smtp boolean false
24049 If this option is set true, the &%authenticated_sender%& option's value
24050 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24051 authenticated as a client.
24052
24053
24054 .option command_timeout smtp time 5m
24055 This sets a timeout for receiving a response to an SMTP command that has been
24056 sent out. It is also used when waiting for the initial banner line from the
24057 remote host. Its value must not be zero.
24058
24059
24060 .option connect_timeout smtp time 5m
24061 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24062 to a remote host. A setting of zero allows the system timeout (typically
24063 several minutes) to act. To have any effect, the value of this option must be
24064 less than the system timeout. However, it has been observed that on some
24065 systems there is no system timeout, which is why the default value for this
24066 option is 5 minutes, a value recommended by RFC 1123.
24067
24068
24069 .option connection_max_messages smtp integer 500
24070 .cindex "SMTP" "passed connection"
24071 .cindex "SMTP" "multiple deliveries"
24072 .cindex "multiple SMTP deliveries"
24073 This controls the maximum number of separate message deliveries that are sent
24074 over a single TCP/IP connection. If the value is zero, there is no limit.
24075 For testing purposes, this value can be overridden by the &%-oB%& command line
24076 option.
24077
24078
24079 .option dane_require_tls_ciphers smtp string&!! unset
24080 .cindex "TLS" "requiring specific ciphers for DANE"
24081 .cindex "cipher" "requiring specific"
24082 .cindex DANE "TLS ciphers"
24083 This option may be used to override &%tls_require_ciphers%& for connections
24084 where DANE has been determined to be in effect.
24085 If not set, then &%tls_require_ciphers%& will be used.
24086 Normal SMTP delivery is not able to make strong demands of TLS cipher
24087 configuration, because delivery will fall back to plaintext.  Once DANE has
24088 been determined to be in effect, there is no plaintext fallback and making the
24089 TLS cipherlist configuration stronger will increase security, rather than
24090 counter-intuitively decreasing it.
24091 If the option expands to be empty or is forced to fail, then it will
24092 be treated as unset and &%tls_require_ciphers%& will be used instead.
24093
24094
24095 .option data_timeout smtp time 5m
24096 This sets a timeout for the transmission of each block in the data portion of
24097 the message. As a result, the overall timeout for a message depends on the size
24098 of the message. Its value must not be zero. See also &%final_timeout%&.
24099
24100
24101 .option dkim_canon smtp string&!! unset
24102 .option dkim_domain smtp string list&!! unset
24103 .option dkim_hash smtp string&!! sha256
24104 .option dkim_identity smtp string&!! unset
24105 .option dkim_private_key smtp string&!! unset
24106 .option dkim_selector smtp string&!! unset
24107 .option dkim_strict smtp string&!! unset
24108 .option dkim_sign_headers smtp string&!! "per RFC"
24109 .option dkim_timestamps smtp string&!! unset
24110 DKIM signing options.  For details see section &<<SECDKIMSIGN>>&.
24111
24112
24113 .option delay_after_cutoff smtp boolean true
24114 This option controls what happens when all remote IP addresses for a given
24115 domain have been inaccessible for so long that they have passed their retry
24116 cutoff times.
24117
24118 In the default state, if the next retry time has not been reached for any of
24119 them, the address is bounced without trying any deliveries. In other words,
24120 Exim delays retrying an IP address after the final cutoff time until a new
24121 retry time is reached, and can therefore bounce an address without ever trying
24122 a delivery, when machines have been down for a long time. Some people are
24123 unhappy at this prospect, so...
24124
24125 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24126 addresses are past their final cutoff time, Exim tries to deliver to those
24127 IP addresses that have not been tried since the message arrived. If there are
24128 none, of if they all fail, the address is bounced. In other words, it does not
24129 delay when a new message arrives, but immediately tries those expired IP
24130 addresses that haven't been tried since the message arrived. If there is a
24131 continuous stream of messages for the dead hosts, unsetting
24132 &%delay_after_cutoff%& means that there will be many more attempts to deliver
24133 to them.
24134
24135
24136 .option dns_qualify_single smtp boolean true
24137 If the &%hosts%& or &%fallback_hosts%& option is being used,
24138 and the &%gethostbyname%& option is false,
24139 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
24140 in chapter &<<CHAPdnslookup>>& for more details.
24141
24142
24143 .option dns_search_parents smtp boolean false
24144 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
24145 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
24146 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
24147 details.
24148
24149
24150 .option dnssec_request_domains smtp "domain list&!!" unset
24151 .cindex "MX record" "security"
24152 .cindex "DNSSEC" "MX lookup"
24153 .cindex "security" "MX lookup"
24154 .cindex "DNS" "DNSSEC"
24155 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
24156 the dnssec request bit set.
24157 This applies to all of the SRV, MX, AAAA, A lookup sequence.
24158
24159
24160
24161 .option dnssec_require_domains smtp "domain list&!!" unset
24162 .cindex "MX record" "security"
24163 .cindex "DNSSEC" "MX lookup"
24164 .cindex "security" "MX lookup"
24165 .cindex "DNS" "DNSSEC"
24166 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
24167 the dnssec request bit set.  Any returns not having the Authenticated Data bit
24168 (AD bit) set will be ignored and logged as a host-lookup failure.
24169 This applies to all of the SRV, MX, AAAA, A lookup sequence.
24170
24171
24172
24173 .option dscp smtp string&!! unset
24174 .cindex "DCSP" "outbound"
24175 This option causes the DSCP value associated with a socket to be set to one
24176 of a number of fixed strings or to numeric value.
24177 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
24178 Common values include &`throughput`&, &`mincost`&, and on newer systems
24179 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
24180
24181 The outbound packets from Exim will be marked with this value in the header
24182 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
24183 that these values will have any effect, not be stripped by networking
24184 equipment, or do much of anything without cooperation with your Network
24185 Engineer and those of all network operators between the source and destination.
24186
24187
24188 .option fallback_hosts smtp "string list" unset
24189 .cindex "fallback" "hosts specified on transport"
24190 String expansion is not applied to this option. The argument must be a
24191 colon-separated list of host names or IP addresses, optionally also including
24192 port numbers, though the separator can be changed, as described in section
24193 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24194 item in a &%route_list%& setting for the &(manualroute)& router, as described
24195 in section &<<SECTformatonehostitem>>&.
24196
24197 Fallback hosts can also be specified on routers, which associate them with the
24198 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
24199 &%fallback_hosts%& specified on the transport is used only if the address does
24200 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
24201 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
24202 However, &%hosts_randomize%& does apply to fallback host lists.
24203
24204 If Exim is unable to deliver to any of the hosts for a particular address, and
24205 the errors are not permanent rejections, the address is put on a separate
24206 transport queue with its host list replaced by the fallback hosts, unless the
24207 address was routed via MX records and the current host was in the original MX
24208 list. In that situation, the fallback host list is not used.
24209
24210 Once normal deliveries are complete, the fallback queue is delivered by
24211 re-running the same transports with the new host lists. If several failing
24212 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
24213 copy of the message is sent.
24214
24215 The resolution of the host names on the fallback list is controlled by the
24216 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
24217 both to cases when the host list comes with the address and when it is taken
24218 from &%hosts%&. This option provides a &"use a smart host only if delivery
24219 fails"& facility.
24220
24221
24222 .option final_timeout smtp time 10m
24223 This is the timeout that applies while waiting for the response to the final
24224 line containing just &"."& that terminates a message. Its value must not be
24225 zero.
24226
24227 .option gethostbyname smtp boolean false
24228 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
24229 being used, names are looked up using &[gethostbyname()]&
24230 (or &[getipnodebyname()]& when available)
24231 instead of using the DNS. Of course, that function may in fact use the DNS, but
24232 it may also consult other sources of information such as &_/etc/hosts_&.
24233
24234 .option gnutls_compat_mode smtp boolean unset
24235 This option controls whether GnuTLS is used in compatibility mode in an Exim
24236 server. This reduces security slightly, but improves interworking with older
24237 implementations of TLS.
24238
24239 .option helo_data smtp string&!! "see below"
24240 .cindex "HELO" "argument, setting"
24241 .cindex "EHLO" "argument, setting"
24242 .cindex "LHLO argument setting"
24243 The value of this option is expanded after a connection to a another host has
24244 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
24245 command that starts the outgoing SMTP or LMTP session. The default value of the
24246 option is:
24247 .code
24248 $primary_hostname
24249 .endd
24250 During the expansion, the variables &$host$& and &$host_address$& are set to
24251 the identity of the remote host, and the variables &$sending_ip_address$& and
24252 &$sending_port$& are set to the local IP address and port number that are being
24253 used. These variables can be used to generate different values for different
24254 servers or different local IP addresses. For example, if you want the string
24255 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
24256 interface address, you could use this:
24257 .code
24258 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
24259   {$primary_hostname}}
24260 .endd
24261 The use of &%helo_data%& applies both to sending messages and when doing
24262 callouts.
24263
24264 .option hosts smtp "string list&!!" unset
24265 Hosts are associated with an address by a router such as &(dnslookup)&, which
24266 finds the hosts by looking up the address domain in the DNS, or by
24267 &(manualroute)&, which has lists of hosts in its configuration. However,
24268 email addresses can be passed to the &(smtp)& transport by any router, and not
24269 all of them can provide an associated list of hosts.
24270
24271 The &%hosts%& option specifies a list of hosts to be used if the address being
24272 processed does not have any hosts associated with it. The hosts specified by
24273 &%hosts%& are also used, whether or not the address has its own hosts, if
24274 &%hosts_override%& is set.
24275
24276 The string is first expanded, before being interpreted as a colon-separated
24277 list of host names or IP addresses, possibly including port numbers. The
24278 separator may be changed to something other than colon, as described in section
24279 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24280 item in a &%route_list%& setting for the &(manualroute)& router, as described
24281 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
24282 of the &(manualroute)& router is not available here.
24283
24284 If the expansion fails, delivery is deferred. Unless the failure was caused by
24285 the inability to complete a lookup, the error is logged to the panic log as
24286 well as the main log. Host names are looked up either by searching directly for
24287 address records in the DNS or by calling &[gethostbyname()]& (or
24288 &[getipnodebyname()]& when available), depending on the setting of the
24289 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
24290 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
24291 address are used.
24292
24293 During delivery, the hosts are tried in order, subject to their retry status,
24294 unless &%hosts_randomize%& is set.
24295
24296
24297 .option hosts_avoid_esmtp smtp "host list&!!" unset
24298 .cindex "ESMTP, avoiding use of"
24299 .cindex "HELO" "forcing use of"
24300 .cindex "EHLO" "avoiding use of"
24301 .cindex "PIPELINING" "avoiding the use of"
24302 This option is for use with broken hosts that announce ESMTP facilities (for
24303 example, PIPELINING) and then fail to implement them properly. When a host
24304 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
24305 start of the SMTP session. This means that it cannot use any of the ESMTP
24306 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
24307
24308
24309 .option hosts_avoid_pipelining smtp "host list&!!" unset
24310 .cindex "PIPELINING" "avoiding the use of"
24311 Exim will not use the SMTP PIPELINING extension when delivering to any host
24312 that matches this list, even if the server host advertises PIPELINING support.
24313
24314
24315 .option hosts_avoid_tls smtp "host list&!!" unset
24316 .cindex "TLS" "avoiding for certain hosts"
24317 Exim will not try to start a TLS session when delivering to any host that
24318 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24319
24320 .option hosts_verify_avoid_tls smtp "host list&!!" unset
24321 .cindex "TLS" "avoiding for certain hosts"
24322 Exim will not try to start a TLS session for a verify callout,
24323 or when delivering in cutthrough mode,
24324 to any host that matches this list.
24325
24326
24327 .option hosts_max_try smtp integer 5
24328 .cindex "host" "maximum number to try"
24329 .cindex "limit" "number of hosts tried"
24330 .cindex "limit" "number of MX tried"
24331 .cindex "MX record" "maximum tried"
24332 This option limits the number of IP addresses that are tried for any one
24333 delivery in cases where there are temporary delivery errors. Section
24334 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
24335
24336
24337 .option hosts_max_try_hardlimit smtp integer 50
24338 This is an additional check on the maximum number of IP addresses that Exim
24339 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
24340 why it exists.
24341
24342
24343
24344 .option hosts_nopass_tls smtp "host list&!!" unset
24345 .cindex "TLS" "passing connection"
24346 .cindex "multiple SMTP deliveries"
24347 .cindex "TLS" "multiple message deliveries"
24348 For any host that matches this list, a connection on which a TLS session has
24349 been started will not be passed to a new delivery process for sending another
24350 message on the same connection. See section &<<SECTmulmessam>>& for an
24351 explanation of when this might be needed.
24352
24353 .option hosts_noproxy_tls smtp "host list&!!" *
24354 .cindex "TLS" "passing connection"
24355 .cindex "multiple SMTP deliveries"
24356 .cindex "TLS" "multiple message deliveries"
24357 For any host that matches this list, a TLS session which has
24358 been started will not be passed to a new delivery process for sending another
24359 message on the same session.
24360
24361 The traditional implementation closes down TLS and re-starts it in the new
24362 process, on the same open TCP connection, for each successive message
24363 sent.  If permitted by this option a pipe to to the new process is set up
24364 instead, and the original process maintains the TLS connection and proxies
24365 the SMTP connection from and to the new process and any subsequents.
24366 The new process has no access to TLS information, so cannot include it in
24367 logging.
24368
24369
24370
24371 .option hosts_override smtp boolean false
24372 If this option is set and the &%hosts%& option is also set, any hosts that are
24373 attached to the address are ignored, and instead the hosts specified by the
24374 &%hosts%& option are always used. This option does not apply to
24375 &%fallback_hosts%&.
24376
24377
24378 .option hosts_randomize smtp boolean false
24379 .cindex "randomized host list"
24380 .cindex "host" "list of; randomized"
24381 .cindex "fallback" "randomized hosts"
24382 If this option is set, and either the list of hosts is taken from the
24383 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
24384 were not obtained from MX records (this includes fallback hosts from the
24385 router), and were not randomized by the router, the order of trying the hosts
24386 is randomized each time the transport runs. Randomizing the order of a host
24387 list can be used to do crude load sharing.
24388
24389 When &%hosts_randomize%& is true, a host list may be split into groups whose
24390 order is separately randomized. This makes it possible to set up MX-like
24391 behaviour. The boundaries between groups are indicated by an item that is just
24392 &`+`& in the host list. For example:
24393 .code
24394 hosts = host1:host2:host3:+:host4:host5
24395 .endd
24396 The order of the first three hosts and the order of the last two hosts is
24397 randomized for each use, but the first three always end up before the last two.
24398 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24399
24400 .option hosts_require_auth smtp "host list&!!" unset
24401 .cindex "authentication" "required by client"
24402 This option provides a list of servers for which authentication must succeed
24403 before Exim will try to transfer a message. If authentication fails for
24404 servers which are not in this list, Exim tries to send unauthenticated. If
24405 authentication fails for one of these servers, delivery is deferred. This
24406 temporary error is detectable in the retry rules, so it can be turned into a
24407 hard failure if required. See also &%hosts_try_auth%&, and chapter
24408 &<<CHAPSMTPAUTH>>& for details of authentication.
24409
24410
24411 .option hosts_request_ocsp smtp "host list&!!" *
24412 .cindex "TLS" "requiring for certain servers"
24413 Exim will request a Certificate Status on a
24414 TLS session for any host that matches this list.
24415 &%tls_verify_certificates%& should also be set for the transport.
24416
24417 .option hosts_require_dane smtp "host list&!!" unset
24418 .cindex DANE "transport options"
24419 .cindex DANE "requiring for certain servers"
24420 If built with DANE support, Exim  will require that a DNSSEC-validated
24421 TLSA record is present for any host matching the list,
24422 and that a DANE-verified TLS connection is made.
24423 There will be no fallback to in-clear communication.
24424 See section &<<SECDANE>>&.
24425
24426 .option hosts_require_ocsp smtp "host list&!!" unset
24427 .cindex "TLS" "requiring for certain servers"
24428 Exim will request, and check for a valid Certificate Status being given, on a
24429 TLS session for any host that matches this list.
24430 &%tls_verify_certificates%& should also be set for the transport.
24431
24432 .option hosts_require_tls smtp "host list&!!" unset
24433 .cindex "TLS" "requiring for certain servers"
24434 Exim will insist on using a TLS session when delivering to any host that
24435 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24436 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24437 incoming messages, use an appropriate ACL.
24438
24439 .option hosts_try_auth smtp "host list&!!" unset
24440 .cindex "authentication" "optional in client"
24441 This option provides a list of servers to which, provided they announce
24442 authentication support, Exim will attempt to authenticate as a client when it
24443 connects. If authentication fails, Exim will try to transfer the message
24444 unauthenticated. See also &%hosts_require_auth%&, and chapter
24445 &<<CHAPSMTPAUTH>>& for details of authentication.
24446
24447 .option hosts_try_chunking smtp "host list&!!" *
24448 .cindex CHUNKING "enabling, in client"
24449 .cindex BDAT "SMTP command"
24450 .cindex "RFC 3030" "CHUNKING"
24451 This option provides a list of servers to which, provided they announce
24452 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24453 BDAT will not be used in conjunction with a transport filter.
24454
24455 .option hosts_try_dane smtp "host list&!!" unset
24456 .cindex DANE "transport options"
24457 .cindex DANE "attempting for certain servers"
24458 If built with DANE support, Exim  will lookup a
24459 TLSA record for any host matching the list.
24460 If found and verified by DNSSEC,
24461 a DANE-verified TLS connection is made to that host;
24462 there will be no fallback to in-clear communication.
24463 See section &<<SECDANE>>&.
24464
24465 .option hosts_try_fastopen smtp "host list&!!" unset
24466 .cindex "fast open, TCP" "enabling, in client"
24467 .cindex "TCP Fast Open" "enabling, in client"
24468 .cindex "RFC 7413" "TCP Fast Open"
24469 This option provides a list of servers to which, provided
24470 the facility is supported by this system, Exim will attempt to
24471 perform a TCP Fast Open.
24472 No data is sent on the SYN segment but, if the remote server also
24473 supports the facility, it can send its SMTP banner immediately after
24474 the SYN,ACK segment.  This can save up to one round-trip time.
24475
24476 The facility is only active for previously-contacted servers,
24477 as the initiator must present a cookie in the SYN segment.
24478
24479 On (at least some) current Linux distributions the facility must be enabled
24480 in the kernel by the sysadmin before the support is usable.
24481 There is no option for control of the server side; if the system supports
24482 it it is always enabled.  Note that lengthy operations in the connect ACL,
24483 such as DNSBL lookups, will still delay the emission of the SMTP banner.
24484
24485 .option hosts_try_prdr smtp "host list&!!" *
24486 .cindex "PRDR" "enabling, optional in client"
24487 This option provides a list of servers to which, provided they announce
24488 PRDR support, Exim will attempt to negotiate PRDR
24489 for multi-recipient messages.
24490 The option can usually be left as default.
24491
24492 .option interface smtp "string list&!!" unset
24493 .cindex "bind IP address"
24494 .cindex "IP address" "binding"
24495 .vindex "&$host$&"
24496 .vindex "&$host_address$&"
24497 This option specifies which interface to bind to when making an outgoing SMTP
24498 call. The value is an IP address, not an interface name such as
24499 &`eth0`&. Do not confuse this with the interface address that was used when a
24500 message was received, which is in &$received_ip_address$&, formerly known as
24501 &$interface_address$&. The name was changed to minimize confusion with the
24502 outgoing interface address. There is no variable that contains an outgoing
24503 interface address because, unless it is set by this option, its value is
24504 unknown.
24505
24506 During the expansion of the &%interface%& option the variables &$host$& and
24507 &$host_address$& refer to the host to which a connection is about to be made
24508 during the expansion of the string. Forced expansion failure, or an empty
24509 string result causes the option to be ignored. Otherwise, after expansion, the
24510 string must be a list of IP addresses, colon-separated by default, but the
24511 separator can be changed in the usual way. For example:
24512 .code
24513 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
24514 .endd
24515 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
24516 connection. If none of them are the correct type, the option is ignored. If
24517 &%interface%& is not set, or is ignored, the system's IP functions choose which
24518 interface to use if the host has more than one.
24519
24520
24521 .option keepalive smtp boolean true
24522 .cindex "keepalive" "on outgoing connection"
24523 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
24524 connections. When set, it causes the kernel to probe idle connections
24525 periodically, by sending packets with &"old"& sequence numbers. The other end
24526 of the connection should send a acknowledgment if the connection is still okay
24527 or a reset if the connection has been aborted. The reason for doing this is
24528 that it has the beneficial effect of freeing up certain types of connection
24529 that can get stuck when the remote host is disconnected without tidying up the
24530 TCP/IP call properly. The keepalive mechanism takes several hours to detect
24531 unreachable hosts.
24532
24533
24534 .option lmtp_ignore_quota smtp boolean false
24535 .cindex "LMTP" "ignoring quota errors"
24536 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
24537 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
24538 has advertised support for IGNOREQUOTA in its response to the LHLO command.
24539
24540 .option max_rcpt smtp integer 100
24541 .cindex "RCPT" "maximum number of outgoing"
24542 This option limits the number of RCPT commands that are sent in a single
24543 SMTP message transaction. Each set of addresses is treated independently, and
24544 so can cause parallel connections to the same host if &%remote_max_parallel%&
24545 permits this.
24546
24547
24548 .option multi_domain smtp boolean&!! true
24549 .vindex "&$domain$&"
24550 When this option is set, the &(smtp)& transport can handle a number of
24551 addresses containing a mixture of different domains provided they all resolve
24552 to the same list of hosts. Turning the option off restricts the transport to
24553 handling only one domain at a time. This is useful if you want to use
24554 &$domain$& in an expansion for the transport, because it is set only when there
24555 is a single domain involved in a remote delivery.
24556
24557 It is expanded per-address and can depend on any of
24558 &$address_data$&, &$domain_data$&, &$local_part_data$&,
24559 &$host$&, &$host_address$& and &$host_port$&.
24560
24561 .option port smtp string&!! "see below"
24562 .cindex "port" "sending TCP/IP"
24563 .cindex "TCP/IP" "setting outgoing port"
24564 This option specifies the TCP/IP port on the server to which Exim connects.
24565 &*Note:*& Do not confuse this with the port that was used when a message was
24566 received, which is in &$received_port$&, formerly known as &$interface_port$&.
24567 The name was changed to minimize confusion with the outgoing port. There is no
24568 variable that contains an outgoing port.
24569
24570 If the value of this option begins with a digit it is taken as a port number;
24571 otherwise it is looked up using &[getservbyname()]&. The default value is
24572 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
24573 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
24574 is deferred.
24575
24576
24577
24578 .option protocol smtp string smtp
24579 .cindex "LMTP" "over TCP/IP"
24580 .cindex "ssmtp protocol" "outbound"
24581 .cindex "TLS" "SSL-on-connect outbound"
24582 .vindex "&$port$&"
24583 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
24584 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
24585 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
24586 deliveries into closed message stores. Exim also has support for running LMTP
24587 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
24588
24589 If this option is set to &"smtps"&, the default value for the &%port%& option
24590 changes to &"smtps"&, and the transport initiates TLS immediately after
24591 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
24592 The Internet standards bodies strongly discourage use of this mode.
24593
24594
24595 .option retry_include_ip_address smtp boolean&!! true
24596 Exim normally includes both the host name and the IP address in the key it
24597 constructs for indexing retry data after a temporary delivery failure. This
24598 means that when one of several IP addresses for a host is failing, it gets
24599 tried periodically (controlled by the retry rules), but use of the other IP
24600 addresses is not affected.
24601
24602 However, in some dialup environments hosts are assigned a different IP address
24603 each time they connect. In this situation the use of the IP address as part of
24604 the retry key leads to undesirable behaviour. Setting this option false causes
24605 Exim to use only the host name.
24606 Since it is expanded it can be made to depend on the host or domain.
24607
24608
24609 .option serialize_hosts smtp "host list&!!" unset
24610 .cindex "serializing connections"
24611 .cindex "host" "serializing connections"
24612 Because Exim operates in a distributed manner, if several messages for the same
24613 host arrive at around the same time, more than one simultaneous connection to
24614 the remote host can occur. This is not usually a problem except when there is a
24615 slow link between the hosts. In that situation it may be helpful to restrict
24616 Exim to one connection at a time. This can be done by setting
24617 &%serialize_hosts%& to match the relevant hosts.
24618
24619 .cindex "hints database" "serializing deliveries to a host"
24620 Exim implements serialization by means of a hints database in which a record is
24621 written whenever a process connects to one of the restricted hosts. The record
24622 is deleted when the connection is completed. Obviously there is scope for
24623 records to get left lying around if there is a system or program crash. To
24624 guard against this, Exim ignores any records that are more than six hours old.
24625
24626 If you set up this kind of serialization, you should also arrange to delete the
24627 relevant hints database whenever your system reboots. The names of the files
24628 start with &_misc_& and they are kept in the &_spool/db_& directory. There
24629 may be one or two files, depending on the type of DBM in use. The same files
24630 are used for ETRN serialization.
24631
24632 See also the &%max_parallel%& generic transport option.
24633
24634
24635 .option size_addition smtp integer 1024
24636 .cindex "SMTP" "SIZE"
24637 .cindex "message" "size issue for transport filter"
24638 .cindex "size" "of message"
24639 .cindex "transport" "filter"
24640 .cindex "filter" "transport filter"
24641 If a remote SMTP server indicates that it supports the SIZE option of the
24642 MAIL command, Exim uses this to pass over the message size at the start of
24643 an SMTP transaction. It adds the value of &%size_addition%& to the value it
24644 sends, to allow for headers and other text that may be added during delivery by
24645 configuration options or in a transport filter. It may be necessary to increase
24646 this if a lot of text is added to messages.
24647
24648 Alternatively, if the value of &%size_addition%& is set negative, it disables
24649 the use of the SIZE option altogether.
24650
24651
24652 .option socks_proxy smtp string&!! unset
24653 .cindex proxy SOCKS
24654 This option enables use of SOCKS proxies for connections made by the
24655 transport.  For details see section &<<SECTproxySOCKS>>&.
24656
24657
24658 .option tls_certificate smtp string&!! unset
24659 .cindex "TLS" "client certificate, location of"
24660 .cindex "certificate" "client, location of"
24661 .vindex "&$host$&"
24662 .vindex "&$host_address$&"
24663 The value of this option must be the absolute path to a file which contains the
24664 client's certificate, for possible use when sending a message over an encrypted
24665 connection. The values of &$host$& and &$host_address$& are set to the name and
24666 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
24667 details of TLS.
24668
24669 &*Note*&: This option must be set if you want Exim to be able to use a TLS
24670 certificate when sending messages as a client. The global option of the same
24671 name specifies the certificate for Exim as a server; it is not automatically
24672 assumed that the same certificate should be used when Exim is operating as a
24673 client.
24674
24675
24676 .option tls_crl smtp string&!! unset
24677 .cindex "TLS" "client certificate revocation list"
24678 .cindex "certificate" "revocation list for client"
24679 This option specifies a certificate revocation list. The expanded value must
24680 be the name of a file that contains a CRL in PEM format.
24681
24682
24683 .option tls_dh_min_bits smtp integer 1024
24684 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
24685 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
24686 key agreement is negotiated, the server will provide a large prime number
24687 for use.  This option establishes the minimum acceptable size of that number.
24688 If the parameter offered by the server is too small, then the TLS handshake
24689 will fail.
24690
24691 Only supported when using GnuTLS.
24692
24693
24694 .option tls_privatekey smtp string&!! unset
24695 .cindex "TLS" "client private key, location of"
24696 .vindex "&$host$&"
24697 .vindex "&$host_address$&"
24698 The value of this option must be the absolute path to a file which contains the
24699 client's private key. This is used when sending a message over an encrypted
24700 connection using a client certificate. The values of &$host$& and
24701 &$host_address$& are set to the name and address of the server during the
24702 expansion. If this option is unset, or the expansion is forced to fail, or the
24703 result is an empty string, the private key is assumed to be in the same file as
24704 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
24705
24706
24707 .option tls_require_ciphers smtp string&!! unset
24708 .cindex "TLS" "requiring specific ciphers"
24709 .cindex "cipher" "requiring specific"
24710 .vindex "&$host$&"
24711 .vindex "&$host_address$&"
24712 The value of this option must be a list of permitted cipher suites, for use
24713 when setting up an outgoing encrypted connection. (There is a global option of
24714 the same name for controlling incoming connections.) The values of &$host$& and
24715 &$host_address$& are set to the name and address of the server during the
24716 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
24717 is used in different ways by OpenSSL and GnuTLS (see sections
24718 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
24719 ciphers is a preference order.
24720
24721
24722
24723 .option tls_sni smtp string&!! unset
24724 .cindex "TLS" "Server Name Indication"
24725 .vindex "&$tls_sni$&"
24726 If this option is set then it sets the $tls_out_sni variable and causes any
24727 TLS session to pass this value as the Server Name Indication extension to
24728 the remote side, which can be used by the remote side to select an appropriate
24729 certificate and private key for the session.
24730
24731 See &<<SECTtlssni>>& for more information.
24732
24733 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
24734 TLS extensions.
24735
24736
24737
24738
24739 .option tls_tempfail_tryclear smtp boolean true
24740 .cindex "4&'xx'& responses" "to STARTTLS"
24741 When the server host is not in &%hosts_require_tls%&, and there is a problem in
24742 setting up a TLS session, this option determines whether or not Exim should try
24743 to deliver the message unencrypted. If it is set false, delivery to the
24744 current host is deferred; if there are other hosts, they are tried. If this
24745 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
24746 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
24747 TLS negotiation fails, Exim closes the current connection (because it is in an
24748 unknown state), opens a new one to the same host, and then tries the delivery
24749 in clear.
24750
24751
24752 .option tls_try_verify_hosts smtp "host list&!!" *
24753 .cindex "TLS" "server certificate verification"
24754 .cindex "certificate" "verification of server"
24755 This option gives a list of hosts for which, on encrypted connections,
24756 certificate verification will be tried but need not succeed.
24757 The &%tls_verify_certificates%& option must also be set.
24758 Note that unless the host is in this list
24759 TLS connections will be denied to hosts using self-signed certificates
24760 when &%tls_verify_certificates%& is matched.
24761 The &$tls_out_certificate_verified$& variable is set when
24762 certificate verification succeeds.
24763
24764
24765 .option tls_verify_cert_hostnames smtp "host list&!!" *
24766 .cindex "TLS" "server certificate hostname verification"
24767 .cindex "certificate" "verification of server"
24768 This option give a list of hosts for which,
24769 while verifying the server certificate,
24770 checks will be included on the host name
24771 (note that this will generally be the result of a DNS MX lookup)
24772 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
24773 limited to being the initial component of a 3-or-more component FQDN.
24774
24775 There is no equivalent checking on client certificates.
24776
24777
24778 .option tls_verify_certificates smtp string&!! system
24779 .cindex "TLS" "server certificate verification"
24780 .cindex "certificate" "verification of server"
24781 .vindex "&$host$&"
24782 .vindex "&$host_address$&"
24783 The value of this option must be either the
24784 word "system"
24785 or the absolute path to
24786 a file or directory containing permitted certificates for servers,
24787 for use when setting up an encrypted connection.
24788
24789 The "system" value for the option will use a location compiled into the SSL library.
24790 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
24791 is taken as empty and an explicit location
24792 must be specified.
24793
24794 The use of a directory for the option value is not available for GnuTLS versions
24795 preceding 3.3.6 and a single file must be used.
24796
24797 With OpenSSL the certificates specified
24798 explicitly
24799 either by file or directory
24800 are added to those given by the system default location.
24801
24802 The values of &$host$& and
24803 &$host_address$& are set to the name and address of the server during the
24804 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
24805
24806 For back-compatibility,
24807 if neither tls_verify_hosts nor tls_try_verify_hosts are set
24808 (a single-colon empty list counts as being set)
24809 and certificate verification fails the TLS connection is closed.
24810
24811
24812 .option tls_verify_hosts smtp "host list&!!" unset
24813 .cindex "TLS" "server certificate verification"
24814 .cindex "certificate" "verification of server"
24815 This option gives a list of hosts for which, on encrypted connections,
24816 certificate verification must succeed.
24817 The &%tls_verify_certificates%& option must also be set.
24818 If both this option and &%tls_try_verify_hosts%& are unset
24819 operation is as if this option selected all hosts.
24820
24821 .new
24822 .option utf8_downconvert smtp integer!! unset
24823 .cindex utf8 "address downconversion"
24824 .cindex i18n "utf8 address downconversion"
24825 If built with internationalization support,
24826 this option controls conversion of UTF-8 in message addresses
24827 to a-label form.
24828 For details see section &<<SECTi18nMTA>>&.
24829 .wen
24830
24831
24832
24833
24834 .section "How the limits for the number of hosts to try are used" &&&
24835          "SECTvalhosmax"
24836 .cindex "host" "maximum number to try"
24837 .cindex "limit" "hosts; maximum number tried"
24838 There are two options that are concerned with the number of hosts that are
24839 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
24840 &%hosts_max_try_hardlimit%&.
24841
24842
24843 The &%hosts_max_try%& option limits the number of hosts that are tried
24844 for a single delivery. However, despite the term &"host"& in its name, the
24845 option actually applies to each IP address independently. In other words, a
24846 multihomed host is treated as several independent hosts, just as it is for
24847 retrying.
24848
24849 Many of the larger ISPs have multiple MX records which often point to
24850 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
24851 created as a result of routing one of these domains.
24852
24853 Trying every single IP address on such a long list does not seem sensible; if
24854 several at the top of the list fail, it is reasonable to assume there is some
24855 problem that is likely to affect all of them. Roughly speaking, the value of
24856 &%hosts_max_try%& is the maximum number that are tried before deferring the
24857 delivery. However, the logic cannot be quite that simple.
24858
24859 Firstly, IP addresses that are skipped because their retry times have not
24860 arrived do not count, and in addition, addresses that are past their retry
24861 limits are also not counted, even when they are tried. This means that when
24862 some IP addresses are past their retry limits, more than the value of
24863 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
24864 that all IP addresses are considered before timing out an email address (but
24865 see below for an exception).
24866
24867 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
24868 list to see if there is a subsequent host with a different (higher valued) MX.
24869 If there is, that host is considered next, and the current IP address is used
24870 but not counted. This behaviour helps in the case of a domain with a retry rule
24871 that hardly ever delays any hosts, as is now explained:
24872
24873 Consider the case of a long list of hosts with one MX value, and a few with a
24874 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
24875 hosts at the top of the list are tried at first. With the default retry rule,
24876 which specifies increasing retry times, the higher MX hosts are eventually
24877 tried when those at the top of the list are skipped because they have not
24878 reached their retry times.
24879
24880 However, it is common practice to put a fixed short retry time on domains for
24881 large ISPs, on the grounds that their servers are rarely down for very long.
24882 Unfortunately, these are exactly the domains that tend to resolve to long lists
24883 of hosts. The short retry time means that the lowest MX hosts are tried every
24884 time. The attempts may be in a different order because of random sorting, but
24885 without the special MX check, the higher MX hosts would never be tried until
24886 all the lower MX hosts had timed out (which might be several days), because
24887 there are always some lower MX hosts that have reached their retry times. With
24888 the special check, Exim considers at least one IP address from each MX value at
24889 every delivery attempt, even if the &%hosts_max_try%& limit has already been
24890 reached.
24891
24892 The above logic means that &%hosts_max_try%& is not a hard limit, and in
24893 particular, Exim normally eventually tries all the IP addresses before timing
24894 out an email address. When &%hosts_max_try%& was implemented, this seemed a
24895 reasonable thing to do. Recently, however, some lunatic DNS configurations have
24896 been set up with hundreds of IP addresses for some domains. It can
24897 take a very long time indeed for an address to time out in these cases.
24898
24899 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
24900 Exim never tries more than this number of IP addresses; if it hits this limit
24901 and they are all timed out, the email address is bounced, even though not all
24902 possible IP addresses have been tried.
24903 .ecindex IIDsmttra1
24904 .ecindex IIDsmttra2
24905
24906
24907
24908
24909
24910 . ////////////////////////////////////////////////////////////////////////////
24911 . ////////////////////////////////////////////////////////////////////////////
24912
24913 .chapter "Address rewriting" "CHAPrewrite"
24914 .scindex IIDaddrew "rewriting" "addresses"
24915 There are some circumstances in which Exim automatically rewrites domains in
24916 addresses. The two most common are when an address is given without a domain
24917 (referred to as an &"unqualified address"&) or when an address contains an
24918 abbreviated domain that is expanded by DNS lookup.
24919
24920 Unqualified envelope addresses are accepted only for locally submitted
24921 messages, or for messages that are received from hosts matching
24922 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
24923 appropriate. Unqualified addresses in header lines are qualified if they are in
24924 locally submitted messages, or messages from hosts that are permitted to send
24925 unqualified envelope addresses. Otherwise, unqualified addresses in header
24926 lines are neither qualified nor rewritten.
24927
24928 One situation in which Exim does &'not'& automatically rewrite a domain is
24929 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
24930 such a domain should be rewritten using the &"canonical"& name, and some MTAs
24931 do this. The new RFCs do not contain this suggestion.
24932
24933
24934 .section "Explicitly configured address rewriting" "SECID147"
24935 This chapter describes the rewriting rules that can be used in the
24936 main rewrite section of the configuration file, and also in the generic
24937 &%headers_rewrite%& option that can be set on any transport.
24938
24939 Some people believe that configured address rewriting is a Mortal Sin.
24940 Others believe that life is not possible without it. Exim provides the
24941 facility; you do not have to use it.
24942
24943 The main rewriting rules that appear in the &"rewrite"& section of the
24944 configuration file are applied to addresses in incoming messages, both envelope
24945 addresses and addresses in header lines. Each rule specifies the types of
24946 address to which it applies.
24947
24948 Whether or not addresses in header lines are rewritten depends on the origin of
24949 the headers and the type of rewriting. Global rewriting, that is, rewriting
24950 rules from the rewrite section of the configuration file, is applied only to
24951 those headers that were received with the message. Header lines that are added
24952 by ACLs or by a system filter or by individual routers or transports (which
24953 are specific to individual recipient addresses) are not rewritten by the global
24954 rules.
24955
24956 Rewriting at transport time, by means of the &%headers_rewrite%& option,
24957 applies all headers except those added by routers and transports. That is, as
24958 well as the headers that were received with the message, it also applies to
24959 headers that were added by an ACL or a system filter.
24960
24961
24962 In general, rewriting addresses from your own system or domain has some
24963 legitimacy. Rewriting other addresses should be done only with great care and
24964 in special circumstances. The author of Exim believes that rewriting should be
24965 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
24966 Although it can sometimes be used as a routing tool, this is very strongly
24967 discouraged.
24968
24969 There are two commonly encountered circumstances where rewriting is used, as
24970 illustrated by these examples:
24971
24972 .ilist
24973 The company whose domain is &'hitch.fict.example'& has a number of hosts that
24974 exchange mail with each other behind a firewall, but there is only a single
24975 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
24976 &'hitch.fict.example'& when sending mail off-site.
24977 .next
24978 A host rewrites the local parts of its own users so that, for example,
24979 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
24980 .endlist
24981
24982
24983
24984 .section "When does rewriting happen?" "SECID148"
24985 .cindex "rewriting" "timing of"
24986 .cindex "&ACL;" "rewriting addresses in"
24987 Configured address rewriting can take place at several different stages of a
24988 message's processing.
24989
24990 .vindex "&$sender_address$&"
24991 At the start of an ACL for MAIL, the sender address may have been rewritten
24992 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
24993 ordinary rewrite rules have yet been applied. If, however, the sender address
24994 is verified in the ACL, it is rewritten before verification, and remains
24995 rewritten thereafter. The subsequent value of &$sender_address$& is the
24996 rewritten address. This also applies if sender verification happens in a
24997 RCPT ACL. Otherwise, when the sender address is not verified, it is
24998 rewritten as soon as a message's header lines have been received.
24999
25000 .vindex "&$domain$&"
25001 .vindex "&$local_part$&"
25002 Similarly, at the start of an ACL for RCPT, the current recipient's address
25003 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25004 rewrite rules have yet been applied to it. However, the behaviour is different
25005 from the sender address when a recipient is verified. The address is rewritten
25006 for the verification, but the rewriting is not remembered at this stage. The
25007 value of &$local_part$& and &$domain$& after verification are always the same
25008 as they were before (that is, they contain the unrewritten &-- except for
25009 SMTP-time rewriting &-- address).
25010
25011 As soon as a message's header lines have been received, all the envelope
25012 recipient addresses are permanently rewritten, and rewriting is also applied to
25013 the addresses in the header lines (if configured). This happens before adding
25014 any header lines that were specified in MAIL or RCPT ACLs, and
25015 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25016 before the DATA ACL and &[local_scan()]& functions are run.
25017
25018 When an address is being routed, either for delivery or for verification,
25019 rewriting is applied immediately to child addresses that are generated by
25020 redirection, unless &%no_rewrite%& is set on the router.
25021
25022 .cindex "envelope sender" "rewriting at transport time"
25023 .cindex "rewriting" "at transport time"
25024 .cindex "header lines" "rewriting at transport time"
25025 At transport time, additional rewriting of addresses in header lines can be
25026 specified by setting the generic &%headers_rewrite%& option on a transport.
25027 This option contains rules that are identical in form to those in the rewrite
25028 section of the configuration file. They are applied to the original message
25029 header lines and any that were added by ACLs or a system filter. They are not
25030 applied to header lines that are added by routers or the transport.
25031
25032 The outgoing envelope sender can be rewritten by means of the &%return_path%&
25033 transport option. However, it is not possible to rewrite envelope recipients at
25034 transport time.
25035
25036
25037
25038
25039 .section "Testing the rewriting rules that apply on input" "SECID149"
25040 .cindex "rewriting" "testing"
25041 .cindex "testing" "rewriting"
25042 Exim's input rewriting configuration appears in a part of the run time
25043 configuration file headed by &"begin rewrite"&. It can be tested by the
25044 &%-brw%& command line option. This takes an address (which can be a full RFC
25045 2822 address) as its argument. The output is a list of how the address would be
25046 transformed by the rewriting rules for each of the different places it might
25047 appear in an incoming message, that is, for each different header and for the
25048 envelope sender and recipient fields. For example,
25049 .code
25050 exim -brw ph10@exim.workshop.example
25051 .endd
25052 might produce the output
25053 .code
25054 sender: Philip.Hazel@exim.workshop.example
25055 from: Philip.Hazel@exim.workshop.example
25056 to: ph10@exim.workshop.example
25057 cc: ph10@exim.workshop.example
25058 bcc: ph10@exim.workshop.example
25059 reply-to: Philip.Hazel@exim.workshop.example
25060 env-from: Philip.Hazel@exim.workshop.example
25061 env-to: ph10@exim.workshop.example
25062 .endd
25063 which shows that rewriting has been set up for that address when used in any of
25064 the source fields, but not when it appears as a recipient address. At the
25065 present time, there is no equivalent way of testing rewriting rules that are
25066 set for a particular transport.
25067
25068
25069 .section "Rewriting rules" "SECID150"
25070 .cindex "rewriting" "rules"
25071 The rewrite section of the configuration file consists of lines of rewriting
25072 rules in the form
25073 .display
25074 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
25075 .endd
25076 Rewriting rules that are specified for the &%headers_rewrite%& generic
25077 transport option are given as a colon-separated list. Each item in the list
25078 takes the same form as a line in the main rewriting configuration (except that
25079 any colons must be doubled, of course).
25080
25081 The formats of source patterns and replacement strings are described below.
25082 Each is terminated by white space, unless enclosed in double quotes, in which
25083 case normal quoting conventions apply inside the quotes. The flags are single
25084 characters which may appear in any order. Spaces and tabs between them are
25085 ignored.
25086
25087 For each address that could potentially be rewritten, the rules are scanned in
25088 order, and replacements for the address from earlier rules can themselves be
25089 replaced by later rules (but see the &"q"& and &"R"& flags).
25090
25091 The order in which addresses are rewritten is undefined, may change between
25092 releases, and must not be relied on, with one exception: when a message is
25093 received, the envelope sender is always rewritten first, before any header
25094 lines are rewritten. For example, the replacement string for a rewrite of an
25095 address in &'To:'& must not assume that the message's address in &'From:'& has
25096 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
25097 that the envelope sender has already been rewritten.
25098
25099 .vindex "&$domain$&"
25100 .vindex "&$local_part$&"
25101 The variables &$local_part$& and &$domain$& can be used in the replacement
25102 string to refer to the address that is being rewritten. Note that lookup-driven
25103 rewriting can be done by a rule of the form
25104 .code
25105 *@*   ${lookup ...
25106 .endd
25107 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
25108 refer to the address that is being rewritten.
25109
25110
25111 .section "Rewriting patterns" "SECID151"
25112 .cindex "rewriting" "patterns"
25113 .cindex "address list" "in a rewriting pattern"
25114 The source pattern in a rewriting rule is any item which may appear in an
25115 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
25116 single-item address list, which means that it is expanded before being tested
25117 against the address. As always, if you use a regular expression as a pattern,
25118 you must take care to escape dollar and backslash characters, or use the &`\N`&
25119 facility to suppress string expansion within the regular expression.
25120
25121 Domains in patterns should be given in lower case. Local parts in patterns are
25122 case-sensitive. If you want to do case-insensitive matching of local parts, you
25123 can use a regular expression that starts with &`^(?i)`&.
25124
25125 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
25126 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
25127 depending on the type of match which occurred. These can be used in the
25128 replacement string to insert portions of the incoming address. &$0$& always
25129 refers to the complete incoming address. When a regular expression is used, the
25130 numerical variables are set from its capturing subexpressions. For other types
25131 of pattern they are set as follows:
25132
25133 .ilist
25134 If a local part or domain starts with an asterisk, the numerical variables
25135 refer to the character strings matched by asterisks, with &$1$& associated with
25136 the first asterisk, and &$2$& with the second, if present. For example, if the
25137 pattern
25138 .code
25139 *queen@*.fict.example
25140 .endd
25141 is matched against the address &'hearts-queen@wonderland.fict.example'& then
25142 .code
25143 $0 = hearts-queen@wonderland.fict.example
25144 $1 = hearts-
25145 $2 = wonderland
25146 .endd
25147 Note that if the local part does not start with an asterisk, but the domain
25148 does, it is &$1$& that contains the wild part of the domain.
25149
25150 .next
25151 If the domain part of the pattern is a partial lookup, the wild and fixed parts
25152 of the domain are placed in the next available numerical variables. Suppose,
25153 for example, that the address &'foo@bar.baz.example'& is processed by a
25154 rewriting rule of the form
25155 .display
25156 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
25157 .endd
25158 and the key in the file that matches the domain is &`*.baz.example`&. Then
25159 .code
25160 $1 = foo
25161 $2 = bar
25162 $3 = baz.example
25163 .endd
25164 If the address &'foo@baz.example'& is looked up, this matches the same
25165 wildcard file entry, and in this case &$2$& is set to the empty string, but
25166 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
25167 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
25168 whole domain. For non-partial domain lookups, no numerical variables are set.
25169 .endlist
25170
25171
25172 .section "Rewriting replacements" "SECID152"
25173 .cindex "rewriting" "replacements"
25174 If the replacement string for a rule is a single asterisk, addresses that
25175 match the pattern and the flags are &'not'& rewritten, and no subsequent
25176 rewriting rules are scanned. For example,
25177 .code
25178 hatta@lookingglass.fict.example  *  f
25179 .endd
25180 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
25181 &'From:'& headers.
25182
25183 .vindex "&$domain$&"
25184 .vindex "&$local_part$&"
25185 If the replacement string is not a single asterisk, it is expanded, and must
25186 yield a fully qualified address. Within the expansion, the variables
25187 &$local_part$& and &$domain$& refer to the address that is being rewritten.
25188 Any letters they contain retain their original case &-- they are not lower
25189 cased. The numerical variables are set up according to the type of pattern that
25190 matched the address, as described above. If the expansion is forced to fail by
25191 the presence of &"fail"& in a conditional or lookup item, rewriting by the
25192 current rule is abandoned, but subsequent rules may take effect. Any other
25193 expansion failure causes the entire rewriting operation to be abandoned, and an
25194 entry written to the panic log.
25195
25196
25197
25198 .section "Rewriting flags" "SECID153"
25199 There are three different kinds of flag that may appear on rewriting rules:
25200
25201 .ilist
25202 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
25203 c, f, h, r, s, t.
25204 .next
25205 A flag that specifies rewriting at SMTP time: S.
25206 .next
25207 Flags that control the rewriting process: Q, q, R, w.
25208 .endlist
25209
25210 For rules that are part of the &%headers_rewrite%& generic transport option,
25211 E, F, T, and S are not permitted.
25212
25213
25214
25215 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
25216          "SECID154"
25217 .cindex "rewriting" "flags"
25218 If none of the following flag letters, nor the &"S"& flag (see section
25219 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
25220 and to both the sender and recipient fields of the envelope, whereas a
25221 transport-time rewriting rule just applies to all headers. Otherwise, the
25222 rewriting rule is skipped unless the relevant addresses are being processed.
25223 .display
25224 &`E`&       rewrite all envelope fields
25225 &`F`&       rewrite the envelope From field
25226 &`T`&       rewrite the envelope To field
25227 &`b`&       rewrite the &'Bcc:'& header
25228 &`c`&       rewrite the &'Cc:'& header
25229 &`f`&       rewrite the &'From:'& header
25230 &`h`&       rewrite all headers
25231 &`r`&       rewrite the &'Reply-To:'& header
25232 &`s`&       rewrite the &'Sender:'& header
25233 &`t`&       rewrite the &'To:'& header
25234 .endd
25235 "All headers" means all of the headers listed above that can be selected
25236 individually, plus their &'Resent-'& versions. It does not include
25237 other headers such as &'Subject:'& etc.
25238
25239 You should be particularly careful about rewriting &'Sender:'& headers, and
25240 restrict this to special known cases in your own domains.
25241
25242
25243 .section "The SMTP-time rewriting flag" "SECTrewriteS"
25244 .cindex "SMTP" "rewriting malformed addresses"
25245 .cindex "RCPT" "rewriting argument of"
25246 .cindex "MAIL" "rewriting argument of"
25247 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
25248 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
25249 before any other processing; even before syntax checking. The pattern is
25250 required to be a regular expression, and it is matched against the whole of the
25251 data for the command, including any surrounding angle brackets.
25252
25253 .vindex "&$domain$&"
25254 .vindex "&$local_part$&"
25255 This form of rewrite rule allows for the handling of addresses that are not
25256 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
25257 input). Because the input is not required to be a syntactically valid address,
25258 the variables &$local_part$& and &$domain$& are not available during the
25259 expansion of the replacement string. The result of rewriting replaces the
25260 original address in the MAIL or RCPT command.
25261
25262
25263 .section "Flags controlling the rewriting process" "SECID155"
25264 There are four flags which control the way the rewriting process works. These
25265 take effect only when a rule is invoked, that is, when the address is of the
25266 correct type (matches the flags) and matches the pattern:
25267
25268 .ilist
25269 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
25270 unqualified local part. It is qualified with &%qualify_recipient%&. In the
25271 absence of &"Q"& the rewritten address must always include a domain.
25272 .next
25273 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
25274 even if no rewriting actually takes place because of a &"fail"& in the
25275 expansion. The &"q"& flag is not effective if the address is of the wrong type
25276 (does not match the flags) or does not match the pattern.
25277 .next
25278 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
25279 address, up to ten times. It can be combined with the &"q"& flag, to stop
25280 rewriting once it fails to match (after at least one successful rewrite).
25281 .next
25282 .cindex "rewriting" "whole addresses"
25283 When an address in a header is rewritten, the rewriting normally applies only
25284 to the working part of the address, with any comments and RFC 2822 &"phrase"&
25285 left unchanged. For example, rewriting might change
25286 .code
25287 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
25288 .endd
25289 into
25290 .code
25291 From: Ford Prefect <prefectf@hitch.fict.example>
25292 .endd
25293 .cindex "RFC 2047"
25294 Sometimes there is a need to replace the whole address item, and this can be
25295 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
25296 causes an address in a header line to be rewritten, the entire address is
25297 replaced, not just the working part. The replacement must be a complete RFC
25298 2822 address, including the angle brackets if necessary. If text outside angle
25299 brackets contains a character whose value is greater than 126 or less than 32
25300 (except for tab), the text is encoded according to RFC 2047. The character set
25301 is taken from &%headers_charset%&, which gets its default at build time.
25302
25303 When the &"w"& flag is set on a rule that causes an envelope address to be
25304 rewritten, all but the working part of the replacement address is discarded.
25305 .endlist
25306
25307
25308 .section "Rewriting examples" "SECID156"
25309 Here is an example of the two common rewriting paradigms:
25310 .code
25311 *@*.hitch.fict.example  $1@hitch.fict.example
25312 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
25313                      {$value}fail}@hitch.fict.example bctfrF
25314 .endd
25315 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
25316 the string expansion to fail if the lookup does not succeed. In this context it
25317 has the effect of leaving the original address unchanged, but Exim goes on to
25318 consider subsequent rewriting rules, if any, because the &"q"& flag is not
25319 present in that rule. An alternative to &"fail"& would be to supply &$1$&
25320 explicitly, which would cause the rewritten address to be the same as before,
25321 at the cost of a small bit of processing. Not supplying either of these is an
25322 error, since the rewritten address would then contain no local part.
25323
25324 The first example above replaces the domain with a superior, more general
25325 domain. This may not be desirable for certain local parts. If the rule
25326 .code
25327 root@*.hitch.fict.example  *
25328 .endd
25329 were inserted before the first rule, rewriting would be suppressed for the
25330 local part &'root'& at any domain ending in &'hitch.fict.example'&.
25331
25332 Rewriting can be made conditional on a number of tests, by making use of
25333 &${if$& in the expansion item. For example, to apply a rewriting rule only to
25334 messages that originate outside the local host:
25335 .code
25336 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
25337                          {$1@hitch.fict.example}fail}"
25338 .endd
25339 The replacement string is quoted in this example because it contains white
25340 space.
25341
25342 .cindex "rewriting" "bang paths"
25343 .cindex "bang paths" "rewriting"
25344 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
25345 an address it treats it as an unqualified local part which it qualifies with
25346 the local qualification domain (if the source of the message is local or if the
25347 remote host is permitted to send unqualified addresses). Rewriting can
25348 sometimes be used to handle simple bang paths with a fixed number of
25349 components. For example, the rule
25350 .code
25351 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
25352 .endd
25353 rewrites a two-component bang path &'host.name!user'& as the domain address
25354 &'user@host.name'&. However, there is a security implication in using this as
25355 a global rewriting rule for envelope addresses. It can provide a backdoor
25356 method for using your system as a relay, because the incoming addresses appear
25357 to be local. If the bang path addresses are received via SMTP, it is safer to
25358 use the &"S"& flag to rewrite them as they are received, so that relay checking
25359 can be done on the rewritten addresses.
25360 .ecindex IIDaddrew
25361
25362
25363
25364
25365
25366 . ////////////////////////////////////////////////////////////////////////////
25367 . ////////////////////////////////////////////////////////////////////////////
25368
25369 .chapter "Retry configuration" "CHAPretry"
25370 .scindex IIDretconf1 "retry" "configuration, description of"
25371 .scindex IIDregconf2 "configuration file" "retry section"
25372 The &"retry"& section of the runtime configuration file contains a list of
25373 retry rules that control how often Exim tries to deliver messages that cannot
25374 be delivered at the first attempt. If there are no retry rules (the section is
25375 empty or not present), there are no retries. In this situation, temporary
25376 errors are treated as permanent. The default configuration contains a single,
25377 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
25378 line option can be used to test which retry rule will be used for a given
25379 address, domain and error.
25380
25381 The most common cause of retries is temporary failure to deliver to a remote
25382 host because the host is down, or inaccessible because of a network problem.
25383 Exim's retry processing in this case is applied on a per-host (strictly, per IP
25384 address) basis, not on a per-message basis. Thus, if one message has recently
25385 been delayed, delivery of a new message to the same host is not immediately
25386 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
25387 log selector is set, the message
25388 .cindex "retry" "time not reached"
25389 &"retry time not reached"& is written to the main log whenever a delivery is
25390 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
25391 the handling of errors during remote deliveries.
25392
25393 Retry processing applies to routing as well as to delivering, except as covered
25394 in the next paragraph. The retry rules do not distinguish between these
25395 actions. It is not possible, for example, to specify different behaviour for
25396 failures to route the domain &'snark.fict.example'& and failures to deliver to
25397 the host &'snark.fict.example'&. I didn't think anyone would ever need this
25398 added complication, so did not implement it. However, although they share the
25399 same retry rule, the actual retry times for routing and transporting a given
25400 domain are maintained independently.
25401
25402 When a delivery is not part of a queue run (typically an immediate delivery on
25403 receipt of a message), the routers are always run, and local deliveries are
25404 always attempted, even if retry times are set for them. This makes for better
25405 behaviour if one particular message is causing problems (for example, causing
25406 quota overflow, or provoking an error in a filter file). If such a delivery
25407 suffers a temporary failure, the retry data is updated as normal, and
25408 subsequent delivery attempts from queue runs occur only when the retry time for
25409 the local address is reached.
25410
25411 .section "Changing retry rules" "SECID157"
25412 If you change the retry rules in your configuration, you should consider
25413 whether or not to delete the retry data that is stored in Exim's spool area in
25414 files with names like &_db/retry_&. Deleting any of Exim's hints files is
25415 always safe; that is why they are called &"hints"&.
25416
25417 The hints retry data contains suggested retry times based on the previous
25418 rules. In the case of a long-running problem with a remote host, it might
25419 record the fact that the host has timed out. If your new rules increase the
25420 timeout time for such a host, you should definitely remove the old retry data
25421 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
25422 messages that it should now be retaining.
25423
25424
25425
25426 .section "Format of retry rules" "SECID158"
25427 .cindex "retry" "rules"
25428 Each retry rule occupies one line and consists of three or four parts,
25429 separated by white space: a pattern, an error name, an optional list of sender
25430 addresses, and a list of retry parameters. The pattern and sender lists must be
25431 enclosed in double quotes if they contain white space. The rules are searched
25432 in order until one is found where the pattern, error name, and sender list (if
25433 present) match the failing host or address, the error that occurred, and the
25434 message's sender, respectively.
25435
25436
25437 The pattern is any single item that may appear in an address list (see section
25438 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
25439 which means that it is expanded before being tested against the address that
25440 has been delayed. A negated address list item is permitted. Address
25441 list processing treats a plain domain name as if it were preceded by &"*@"&,
25442 which makes it possible for many retry rules to start with just a domain. For
25443 example,
25444 .code
25445 lookingglass.fict.example        *  F,24h,30m;
25446 .endd
25447 provides a rule for any address in the &'lookingglass.fict.example'& domain,
25448 whereas
25449 .code
25450 alice@lookingglass.fict.example  *  F,24h,30m;
25451 .endd
25452 applies only to temporary failures involving the local part &%alice%&.
25453 In practice, almost all rules start with a domain name pattern without a local
25454 part.
25455
25456 .cindex "regular expressions" "in retry rules"
25457 &*Warning*&: If you use a regular expression in a retry rule pattern, it
25458 must match a complete address, not just a domain, because that is how regular
25459 expressions work in address lists.
25460 .display
25461 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
25462 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
25463 .endd
25464
25465
25466 .section "Choosing which retry rule to use for address errors" "SECID159"
25467 When Exim is looking for a retry rule after a routing attempt has failed (for
25468 example, after a DNS timeout), each line in the retry configuration is tested
25469 against the complete address only if &%retry_use_local_part%& is set for the
25470 router. Otherwise, only the domain is used, except when matching against a
25471 regular expression, when the local part of the address is replaced with &"*"&.
25472 A domain on its own can match a domain pattern, or a pattern that starts with
25473 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
25474 &%check_local_user%& is true, and false for other routers.
25475
25476 Similarly, when Exim is looking for a retry rule after a local delivery has
25477 failed (for example, after a mailbox full error), each line in the retry
25478 configuration is tested against the complete address only if
25479 &%retry_use_local_part%& is set for the transport (it defaults true for all
25480 local transports).
25481
25482 .cindex "4&'xx'& responses" "retry rules for"
25483 However, when Exim is looking for a retry rule after a remote delivery attempt
25484 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
25485 whole address is always used as the key when searching the retry rules. The
25486 rule that is found is used to create a retry time for the combination of the
25487 failing address and the message's sender. It is the combination of sender and
25488 recipient that is delayed in subsequent queue runs until its retry time is
25489 reached. You can delay the recipient without regard to the sender by setting
25490 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
25491 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
25492 commands.
25493
25494
25495
25496 .section "Choosing which retry rule to use for host and message errors" &&&
25497          "SECID160"
25498 For a temporary error that is not related to an individual address (for
25499 example, a connection timeout), each line in the retry configuration is checked
25500 twice. First, the name of the remote host is used as a domain name (preceded by
25501 &"*@"& when matching a regular expression). If this does not match the line,
25502 the domain from the email address is tried in a similar fashion. For example,
25503 suppose the MX records for &'a.b.c.example'& are
25504 .code
25505 a.b.c.example  MX  5  x.y.z.example
25506                MX  6  p.q.r.example
25507                MX  7  m.n.o.example
25508 .endd
25509 and the retry rules are
25510 .code
25511 p.q.r.example    *      F,24h,30m;
25512 a.b.c.example    *      F,4d,45m;
25513 .endd
25514 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
25515 first rule matches neither the host nor the domain, so Exim looks at the second
25516 rule. This does not match the host, but it does match the domain, so it is used
25517 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
25518 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
25519 first retry rule is used, because it matches the host.
25520
25521 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
25522 first rule to determine retry times, but for all the other hosts for the domain
25523 &'a.b.c.example'&, the second rule is used. The second rule is also used if
25524 routing to &'a.b.c.example'& suffers a temporary failure.
25525
25526 &*Note*&: The host name is used when matching the patterns, not its IP address.
25527 However, if a message is routed directly to an IP address without the use of a
25528 host name, for example, if a &(manualroute)& router contains a setting such as:
25529 .code
25530 route_list = *.a.example  192.168.34.23
25531 .endd
25532 then the &"host name"& that is used when searching for a retry rule is the
25533 textual form of the IP address.
25534
25535 .section "Retry rules for specific errors" "SECID161"
25536 .cindex "retry" "specific errors; specifying"
25537 The second field in a retry rule is the name of a particular error, or an
25538 asterisk, which matches any error. The errors that can be tested for are:
25539
25540 .vlist
25541 .vitem &%auth_failed%&
25542 Authentication failed when trying to send to a host in the
25543 &%hosts_require_auth%& list in an &(smtp)& transport.
25544
25545 .vitem &%data_4xx%&
25546 A 4&'xx'& error was received for an outgoing DATA command, either immediately
25547 after the command, or after sending the message's data.
25548
25549 .vitem &%mail_4xx%&
25550 A 4&'xx'& error was received for an outgoing MAIL command.
25551
25552 .vitem &%rcpt_4xx%&
25553 A 4&'xx'& error was received for an outgoing RCPT command.
25554 .endlist
25555
25556 For the three 4&'xx'& errors, either the first or both of the x's can be given
25557 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
25558 recognize 452 errors given to RCPT commands for addresses in a certain domain,
25559 and have retries every ten minutes with a one-hour timeout, you could set up a
25560 retry rule of this form:
25561 .code
25562 the.domain.name  rcpt_452   F,1h,10m
25563 .endd
25564 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
25565 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
25566
25567 .vlist
25568 .vitem &%lost_connection%&
25569 A server unexpectedly closed the SMTP connection. There may, of course,
25570 legitimate reasons for this (host died, network died), but if it repeats a lot
25571 for the same host, it indicates something odd.
25572
25573 .vitem &%lookup%&
25574 A DNS lookup for a host failed.
25575 Note that a &%dnslookup%& router will need to have matched
25576 its &%fail_defer_domains%& option for this retry type to be usable.
25577 Also note that a &%manualroute%& router will probably need
25578 its &%host_find_failed%& option set to &%defer%&.
25579
25580 .vitem &%refused_MX%&
25581 A connection to a host obtained from an MX record was refused.
25582
25583 .vitem &%refused_A%&
25584 A connection to a host not obtained from an MX record was refused.
25585
25586 .vitem &%refused%&
25587 A connection was refused.
25588
25589 .vitem &%timeout_connect_MX%&
25590 A connection attempt to a host obtained from an MX record timed out.
25591
25592 .vitem &%timeout_connect_A%&
25593 A connection attempt to a host not obtained from an MX record timed out.
25594
25595 .vitem &%timeout_connect%&
25596 A connection attempt timed out.
25597
25598 .vitem &%timeout_MX%&
25599 There was a timeout while connecting or during an SMTP session with a host
25600 obtained from an MX record.
25601
25602 .vitem &%timeout_A%&
25603 There was a timeout while connecting or during an SMTP session with a host not
25604 obtained from an MX record.
25605
25606 .vitem &%timeout%&
25607 There was a timeout while connecting or during an SMTP session.
25608
25609 .vitem &%tls_required%&
25610 The server was required to use TLS (it matched &%hosts_require_tls%& in the
25611 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
25612 to STARTTLS, or there was a problem setting up the TLS connection.
25613
25614 .vitem &%quota%&
25615 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25616 transport.
25617
25618 .vitem &%quota_%&<&'time'&>
25619 .cindex "quota" "error testing in retry rule"
25620 .cindex "retry" "quota error testing"
25621 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25622 transport, and the mailbox has not been accessed for <&'time'&>. For example,
25623 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
25624 for four days.
25625 .endlist
25626
25627 .cindex "mailbox" "time of last read"
25628 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
25629 timeouts when the mailbox is full and is not being read by its owner. Ideally,
25630 it should be based on the last time that the user accessed the mailbox.
25631 However, it is not always possible to determine this. Exim uses the following
25632 heuristic rules:
25633
25634 .ilist
25635 If the mailbox is a single file, the time of last access (the &"atime"&) is
25636 used. As no new messages are being delivered (because the mailbox is over
25637 quota), Exim does not access the file, so this is the time of last user access.
25638 .next
25639 .cindex "maildir format" "time of last read"
25640 For a maildir delivery, the time of last modification of the &_new_&
25641 subdirectory is used. As the mailbox is over quota, no new files are created in
25642 the &_new_& subdirectory, because no new messages are being delivered. Any
25643 change to the &_new_& subdirectory is therefore assumed to be the result of an
25644 MUA moving a new message to the &_cur_& directory when it is first read. The
25645 time that is used is therefore the last time that the user read a new message.
25646 .next
25647 For other kinds of multi-file mailbox, the time of last access cannot be
25648 obtained, so a retry rule that uses this type of error field is never matched.
25649 .endlist
25650
25651 The quota errors apply both to system-enforced quotas and to Exim's own quota
25652 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
25653 when a local delivery is deferred because a partition is full (the ENOSPC
25654 error).
25655
25656
25657
25658 .section "Retry rules for specified senders" "SECID162"
25659 .cindex "retry" "rules; sender-specific"
25660 You can specify retry rules that apply only when the failing message has a
25661 specific sender. In particular, this can be used to define retry rules that
25662 apply only to bounce messages. The third item in a retry rule can be of this
25663 form:
25664 .display
25665 &`senders=`&<&'address list'&>
25666 .endd
25667 The retry timings themselves are then the fourth item. For example:
25668 .code
25669 *   rcpt_4xx   senders=:   F,1h,30m
25670 .endd
25671 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
25672 host. If the address list contains white space, it must be enclosed in quotes.
25673 For example:
25674 .code
25675 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
25676 .endd
25677 &*Warning*&: This facility can be unhelpful if it is used for host errors
25678 (which do not depend on the recipient). The reason is that the sender is used
25679 only to match the retry rule. Once the rule has been found for a host error,
25680 its contents are used to set a retry time for the host, and this will apply to
25681 all messages, not just those with specific senders.
25682
25683 When testing retry rules using &%-brt%&, you can supply a sender using the
25684 &%-f%& command line option, like this:
25685 .code
25686 exim -f "" -brt user@dom.ain
25687 .endd
25688 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
25689 list is never matched.
25690
25691
25692
25693
25694
25695 .section "Retry parameters" "SECID163"
25696 .cindex "retry" "parameters in rules"
25697 The third (or fourth, if a senders list is present) field in a retry rule is a
25698 sequence of retry parameter sets, separated by semicolons. Each set consists of
25699 .display
25700 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
25701 .endd
25702 The letter identifies the algorithm for computing a new retry time; the cutoff
25703 time is the time beyond which this algorithm no longer applies, and the
25704 arguments vary the algorithm's action. The cutoff time is measured from the
25705 time that the first failure for the domain (combined with the local part if
25706 relevant) was detected, not from the time the message was received.
25707
25708 .cindex "retry" "algorithms"
25709 .cindex "retry" "fixed intervals"
25710 .cindex "retry" "increasing intervals"
25711 .cindex "retry" "random intervals"
25712 The available algorithms are:
25713
25714 .ilist
25715 &'F'&: retry at fixed intervals. There is a single time parameter specifying
25716 the interval.
25717 .next
25718 &'G'&: retry at geometrically increasing intervals. The first argument
25719 specifies a starting value for the interval, and the second a multiplier, which
25720 is used to increase the size of the interval at each retry.
25721 .next
25722 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
25723 retry, the previous interval is multiplied by the factor in order to get a
25724 maximum for the next interval. The minimum interval is the first argument of
25725 the parameter, and an actual interval is chosen randomly between them. Such a
25726 rule has been found to be helpful in cluster configurations when all the
25727 members of the cluster restart at once, and may therefore synchronize their
25728 queue processing times.
25729 .endlist
25730
25731 When computing the next retry time, the algorithm definitions are scanned in
25732 order until one whose cutoff time has not yet passed is reached. This is then
25733 used to compute a new retry time that is later than the current time. In the
25734 case of fixed interval retries, this simply means adding the interval to the
25735 current time. For geometrically increasing intervals, retry intervals are
25736 computed from the rule's parameters until one that is greater than the previous
25737 interval is found. The main configuration variable
25738 .cindex "limit" "retry interval"
25739 .cindex "retry" "interval, maximum"
25740 .oindex "&%retry_interval_max%&"
25741 &%retry_interval_max%& limits the maximum interval between retries. It
25742 cannot be set greater than &`24h`&, which is its default value.
25743
25744 A single remote domain may have a number of hosts associated with it, and each
25745 host may have more than one IP address. Retry algorithms are selected on the
25746 basis of the domain name, but are applied to each IP address independently. If,
25747 for example, a host has two IP addresses and one is unusable, Exim will
25748 generate retry times for it and will not try to use it until its next retry
25749 time comes. Thus the good IP address is likely to be tried first most of the
25750 time.
25751
25752 .cindex "hints database" "use for retrying"
25753 Retry times are hints rather than promises. Exim does not make any attempt to
25754 run deliveries exactly at the computed times. Instead, a queue runner process
25755 starts delivery processes for delayed messages periodically, and these attempt
25756 new deliveries only for those addresses that have passed their next retry time.
25757 If a new message arrives for a deferred address, an immediate delivery attempt
25758 occurs only if the address has passed its retry time. In the absence of new
25759 messages, the minimum time between retries is the interval between queue runner
25760 processes. There is not much point in setting retry times of five minutes if
25761 your queue runners happen only once an hour, unless there are a significant
25762 number of incoming messages (which might be the case on a system that is
25763 sending everything to a smart host, for example).
25764
25765 The data in the retry hints database can be inspected by using the
25766 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
25767 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
25768 &'exinext'& utility script can be used to find out what the next retry times
25769 are for the hosts associated with a particular mail domain, and also for local
25770 deliveries that have been deferred.
25771
25772
25773 .section "Retry rule examples" "SECID164"
25774 Here are some example retry rules:
25775 .code
25776 alice@wonderland.fict.example quota_5d  F,7d,3h
25777 wonderland.fict.example       quota_5d
25778 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
25779 lookingglass.fict.example     *         F,24h,30m;
25780 *                 refused_A   F,2h,20m;
25781 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
25782 .endd
25783 The first rule sets up special handling for mail to
25784 &'alice@wonderland.fict.example'& when there is an over-quota error and the
25785 mailbox has not been read for at least 5 days. Retries continue every three
25786 hours for 7 days. The second rule handles over-quota errors for all other local
25787 parts at &'wonderland.fict.example'&; the absence of a local part has the same
25788 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
25789 fail are bounced immediately if the mailbox has not been read for at least 5
25790 days.
25791
25792 The third rule handles all other errors at &'wonderland.fict.example'&; retries
25793 happen every 15 minutes for an hour, then with geometrically increasing
25794 intervals until two days have passed since a delivery first failed. After the
25795 first hour there is a delay of one hour, then two hours, then four hours, and
25796 so on (this is a rather extreme example).
25797
25798 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
25799 They happen every 30 minutes for 24 hours only. The remaining two rules handle
25800 all other domains, with special action for connection refusal from hosts that
25801 were not obtained from an MX record.
25802
25803 The final rule in a retry configuration should always have asterisks in the
25804 first two fields so as to provide a general catch-all for any addresses that do
25805 not have their own special handling. This example tries every 15 minutes for 2
25806 hours, then with intervals starting at one hour and increasing by a factor of
25807 1.5 up to 16 hours, then every 8 hours up to 5 days.
25808
25809
25810
25811 .section "Timeout of retry data" "SECID165"
25812 .cindex "timeout" "of retry data"
25813 .oindex "&%retry_data_expire%&"
25814 .cindex "hints database" "data expiry"
25815 .cindex "retry" "timeout of data"
25816 Exim timestamps the data that it writes to its retry hints database. When it
25817 consults the data during a delivery it ignores any that is older than the value
25818 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
25819 been tried for 7 days, Exim will try to deliver to it immediately a message
25820 arrives, and if that fails, it will calculate a retry time as if it were
25821 failing for the first time.
25822
25823 This improves the behaviour for messages routed to rarely-used hosts such as MX
25824 backups. If such a host was down at one time, and happens to be down again when
25825 Exim tries a month later, using the old retry data would imply that it had been
25826 down all the time, which is not a justified assumption.
25827
25828 If a host really is permanently dead, this behaviour causes a burst of retries
25829 every now and again, but only if messages routed to it are rare. If there is a
25830 message at least once every 7 days the retry data never expires.
25831
25832
25833
25834
25835 .section "Long-term failures" "SECID166"
25836 .cindex "delivery failure, long-term"
25837 .cindex "retry" "after long-term failure"
25838 Special processing happens when an email address has been failing for so long
25839 that the cutoff time for the last algorithm is reached. For example, using the
25840 default retry rule:
25841 .code
25842 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
25843 .endd
25844 the cutoff time is four days. Reaching the retry cutoff is independent of how
25845 long any specific message has been failing; it is the length of continuous
25846 failure for the recipient address that counts.
25847
25848 When the cutoff time is reached for a local delivery, or for all the IP
25849 addresses associated with a remote delivery, a subsequent delivery failure
25850 causes Exim to give up on the address, and a bounce message is generated.
25851 In order to cater for new messages that use the failing address, a next retry
25852 time is still computed from the final algorithm, and is used as follows:
25853
25854 For local deliveries, one delivery attempt is always made for any subsequent
25855 messages. If this delivery fails, the address fails immediately. The
25856 post-cutoff retry time is not used.
25857
25858 If the delivery is remote, there are two possibilities, controlled by the
25859 .oindex "&%delay_after_cutoff%&"
25860 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
25861 default. Until the post-cutoff retry time for one of the IP addresses is
25862 reached, the failing email address is bounced immediately, without a delivery
25863 attempt taking place. After that time, one new delivery attempt is made to
25864 those IP addresses that are past their retry times, and if that still fails,
25865 the address is bounced and new retry times are computed.
25866
25867 In other words, when all the hosts for a given email address have been failing
25868 for a long time, Exim bounces rather then defers until one of the hosts' retry
25869 times is reached. Then it tries once, and bounces if that attempt fails. This
25870 behaviour ensures that few resources are wasted in repeatedly trying to deliver
25871 to a broken destination, but if the host does recover, Exim will eventually
25872 notice.
25873
25874 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25875 addresses are past their final cutoff time, Exim tries to deliver to those IP
25876 addresses that have not been tried since the message arrived. If there are
25877 no suitable IP addresses, or if they all fail, the address is bounced. In other
25878 words, it does not delay when a new message arrives, but tries the expired
25879 addresses immediately, unless they have been tried since the message arrived.
25880 If there is a continuous stream of messages for the failing domains, setting
25881 &%delay_after_cutoff%& false means that there will be many more attempts to
25882 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
25883 true.
25884
25885 .section "Deliveries that work intermittently" "SECID167"
25886 .cindex "retry" "intermittently working deliveries"
25887 Some additional logic is needed to cope with cases where a host is
25888 intermittently available, or when a message has some attribute that prevents
25889 its delivery when others to the same address get through. In this situation,
25890 because some messages are successfully delivered, the &"retry clock"& for the
25891 host or address keeps getting reset by the successful deliveries, and so
25892 failing messages remain on the queue for ever because the cutoff time is never
25893 reached.
25894
25895 Two exceptional actions are applied to prevent this happening. The first
25896 applies to errors that are related to a message rather than a remote host.
25897 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
25898 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
25899 commands, and quota failures. For this type of error, if a message's arrival
25900 time is earlier than the &"first failed"& time for the error, the earlier time
25901 is used when scanning the retry rules to decide when to try next and when to
25902 time out the address.
25903
25904 The exceptional second action applies in all cases. If a message has been on
25905 the queue for longer than the cutoff time of any applicable retry rule for a
25906 given address, a delivery is attempted for that address, even if it is not yet
25907 time, and if this delivery fails, the address is timed out. A new retry time is
25908 not computed in this case, so that other messages for the same address are
25909 considered immediately.
25910 .ecindex IIDretconf1
25911 .ecindex IIDregconf2
25912
25913
25914
25915
25916
25917
25918 . ////////////////////////////////////////////////////////////////////////////
25919 . ////////////////////////////////////////////////////////////////////////////
25920
25921 .chapter "SMTP authentication" "CHAPSMTPAUTH"
25922 .scindex IIDauthconf1 "SMTP" "authentication configuration"
25923 .scindex IIDauthconf2 "authentication"
25924 The &"authenticators"& section of Exim's run time configuration is concerned
25925 with SMTP authentication. This facility is an extension to the SMTP protocol,
25926 described in RFC 2554, which allows a client SMTP host to authenticate itself
25927 to a server. This is a common way for a server to recognize clients that are
25928 permitted to use it as a relay. SMTP authentication is not of relevance to the
25929 transfer of mail between servers that have no managerial connection with each
25930 other.
25931
25932 .cindex "AUTH" "description of"
25933 Very briefly, the way SMTP authentication works is as follows:
25934
25935 .ilist
25936 The server advertises a number of authentication &'mechanisms'& in response to
25937 the client's EHLO command.
25938 .next
25939 The client issues an AUTH command, naming a specific mechanism. The command
25940 may, optionally, contain some authentication data.
25941 .next
25942 The server may issue one or more &'challenges'&, to which the client must send
25943 appropriate responses. In simple authentication mechanisms, the challenges are
25944 just prompts for user names and passwords. The server does not have to issue
25945 any challenges &-- in some mechanisms the relevant data may all be transmitted
25946 with the AUTH command.
25947 .next
25948 The server either accepts or denies authentication.
25949 .next
25950 If authentication succeeds, the client may optionally make use of the AUTH
25951 option on the MAIL command to pass an authenticated sender in subsequent
25952 mail transactions. Authentication lasts for the remainder of the SMTP
25953 connection.
25954 .next
25955 If authentication fails, the client may give up, or it may try a different
25956 authentication mechanism, or it may try transferring mail over the
25957 unauthenticated connection.
25958 .endlist
25959
25960 If you are setting up a client, and want to know which authentication
25961 mechanisms the server supports, you can use Telnet to connect to port 25 (the
25962 SMTP port) on the server, and issue an EHLO command. The response to this
25963 includes the list of supported mechanisms. For example:
25964 .display
25965 &`$ `&&*&`telnet server.example 25`&*&
25966 &`Trying 192.168.34.25...`&
25967 &`Connected to server.example.`&
25968 &`Escape character is &#x0027;^]&#x0027;.`&
25969 &`220 server.example ESMTP Exim 4.20 ...`&
25970 &*&`ehlo client.example`&*&
25971 &`250-server.example Hello client.example [10.8.4.5]`&
25972 &`250-SIZE 52428800`&
25973 &`250-PIPELINING`&
25974 &`250-AUTH PLAIN`&
25975 &`250 HELP`&
25976 .endd
25977 The second-last line of this example output shows that the server supports
25978 authentication using the PLAIN mechanism. In Exim, the different authentication
25979 mechanisms are configured by specifying &'authenticator'& drivers. Like the
25980 routers and transports, which authenticators are included in the binary is
25981 controlled by build-time definitions. The following are currently available,
25982 included by setting
25983 .code
25984 AUTH_CRAM_MD5=yes
25985 AUTH_CYRUS_SASL=yes
25986 AUTH_DOVECOT=yes
25987 AUTH_GSASL=yes
25988 AUTH_HEIMDAL_GSSAPI=yes
25989 AUTH_PLAINTEXT=yes
25990 AUTH_SPA=yes
25991 AUTH_TLS=yes
25992 .endd
25993 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
25994 authentication mechanism (RFC 2195), and the second provides an interface to
25995 the Cyrus SASL authentication library.
25996 The third is an interface to Dovecot's authentication system, delegating the
25997 work via a socket interface.
25998 The fourth provides an interface to the GNU SASL authentication library, which
25999 provides mechanisms but typically not data sources.
26000 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26001 supporting setting a server keytab.
26002 The sixth can be configured to support
26003 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26004 not formally documented, but used by several MUAs. The seventh authenticator
26005 supports Microsoft's &'Secure Password Authentication'& mechanism.
26006 The eighth is an Exim authenticator but not an SMTP one;
26007 instead it can use information from a TLS negotiation.
26008
26009 The authenticators are configured using the same syntax as other drivers (see
26010 section &<<SECTfordricon>>&). If no authenticators are required, no
26011 authentication section need be present in the configuration file. Each
26012 authenticator can in principle have both server and client functions. When Exim
26013 is receiving SMTP mail, it is acting as a server; when it is sending out
26014 messages over SMTP, it is acting as a client. Authenticator configuration
26015 options are provided for use in both these circumstances.
26016
26017 To make it clear which options apply to which situation, the prefixes
26018 &%server_%& and &%client_%& are used on option names that are specific to
26019 either the server or the client function, respectively. Server and client
26020 functions are disabled if none of their options are set. If an authenticator is
26021 to be used for both server and client functions, a single definition, using
26022 both sets of options, is required. For example:
26023 .code
26024 cram:
26025   driver = cram_md5
26026   public_name = CRAM-MD5
26027   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
26028   client_name = ph10
26029   client_secret = secret2
26030 .endd
26031 The &%server_%& option is used when Exim is acting as a server, and the
26032 &%client_%& options when it is acting as a client.
26033
26034 Descriptions of the individual authenticators are given in subsequent chapters.
26035 The remainder of this chapter covers the generic options for the
26036 authenticators, followed by general discussion of the way authentication works
26037 in Exim.
26038
26039 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
26040 per-mechanism basis.  Please read carefully to determine which variables hold
26041 account labels such as usercodes and which hold passwords or other
26042 authenticating data.
26043
26044 Note that some mechanisms support two different identifiers for accounts: the
26045 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
26046 and &'authz'& are commonly encountered.  The American spelling is standard here.
26047 Conceptually, authentication data such as passwords are tied to the identifier
26048 used to authenticate; servers may have rules to permit one user to act as a
26049 second user, so that after login the session is treated as though that second
26050 user had logged in.  That second user is the &'authorization id'&.  A robust
26051 configuration might confirm that the &'authz'& field is empty or matches the
26052 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
26053 as verified data, the &'authz'& as an unverified request which the server might
26054 choose to honour.
26055
26056 A &'realm'& is a text string, typically a domain name, presented by a server
26057 to a client to help it select an account and credentials to use.  In some
26058 mechanisms, the client and server provably agree on the realm, but clients
26059 typically can not treat the realm as secure data to be blindly trusted.
26060
26061
26062
26063 .section "Generic options for authenticators" "SECID168"
26064 .cindex "authentication" "generic options"
26065 .cindex "options" "generic; for authenticators"
26066
26067 .option client_condition authenticators string&!! unset
26068 When Exim is authenticating as a client, it skips any authenticator whose
26069 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
26070 used, for example, to skip plain text authenticators when the connection is not
26071 encrypted by a setting such as:
26072 .code
26073 client_condition = ${if !eq{$tls_out_cipher}{}}
26074 .endd
26075
26076
26077 .option client_set_id authenticators string&!! unset
26078 When client authentication succeeds, this condition is expanded; the
26079 result is used in the log lines for outbound messages.
26080 Typically it will be the user name used for authentication.
26081
26082
26083 .option driver authenticators string unset
26084 This option must always be set. It specifies which of the available
26085 authenticators is to be used.
26086
26087
26088 .option public_name authenticators string unset
26089 This option specifies the name of the authentication mechanism that the driver
26090 implements, and by which it is known to the outside world. These names should
26091 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
26092 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
26093 defaults to the driver's instance name.
26094
26095
26096 .option server_advertise_condition authenticators string&!! unset
26097 When a server is about to advertise an authentication mechanism, the condition
26098 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
26099 mechanism is not advertised.
26100 If the expansion fails, the mechanism is not advertised. If the failure was not
26101 forced, and was not caused by a lookup defer, the incident is logged.
26102 See section &<<SECTauthexiser>>& below for further discussion.
26103
26104
26105 .option server_condition authenticators string&!! unset
26106 This option must be set for a &%plaintext%& server authenticator, where it
26107 is used directly to control authentication. See section &<<SECTplainserver>>&
26108 for details.
26109
26110 For the &(gsasl)& authenticator, this option is required for various
26111 mechanisms; see chapter &<<CHAPgsasl>>& for details.
26112
26113 For the other authenticators, &%server_condition%& can be used as an additional
26114 authentication or authorization mechanism that is applied after the other
26115 authenticator conditions succeed. If it is set, it is expanded when the
26116 authenticator would otherwise return a success code. If the expansion is forced
26117 to fail, authentication fails. Any other expansion failure causes a temporary
26118 error code to be returned. If the result of a successful expansion is an empty
26119 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26120 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
26121 other result, a temporary error code is returned, with the expanded string as
26122 the error text.
26123
26124
26125 .option server_debug_print authenticators string&!! unset
26126 If this option is set and authentication debugging is enabled (see the &%-d%&
26127 command line option), the string is expanded and included in the debugging
26128 output when the authenticator is run as a server. This can help with checking
26129 out the values of variables.
26130 If expansion of the string fails, the error message is written to the debugging
26131 output, and Exim carries on processing.
26132
26133
26134 .option server_set_id authenticators string&!! unset
26135 .vindex "&$authenticated_id$&"
26136 When an Exim server successfully authenticates a client, this string is
26137 expanded using data from the authentication, and preserved for any incoming
26138 messages in the variable &$authenticated_id$&. It is also included in the log
26139 lines for incoming messages. For example, a user/password authenticator
26140 configuration might preserve the user name that was used to authenticate, and
26141 refer to it subsequently during delivery of the message.
26142 If expansion fails, the option is ignored.
26143
26144
26145 .option server_mail_auth_condition authenticators string&!! unset
26146 This option allows a server to discard authenticated sender addresses supplied
26147 as part of MAIL commands in SMTP connections that are authenticated by the
26148 driver on which &%server_mail_auth_condition%& is set. The option is not used
26149 as part of the authentication process; instead its (unexpanded) value is
26150 remembered for later use.
26151 How it is used is described in the following section.
26152
26153
26154
26155
26156
26157 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
26158 .cindex "authentication" "sender; authenticated"
26159 .cindex "AUTH" "on MAIL command"
26160 When a client supplied an AUTH= item on a MAIL command, Exim applies
26161 the following checks before accepting it as the authenticated sender of the
26162 message:
26163
26164 .ilist
26165 If the connection is not using extended SMTP (that is, HELO was used rather
26166 than EHLO), the use of AUTH= is a syntax error.
26167 .next
26168 If the value of the AUTH= parameter is &"<>"&, it is ignored.
26169 .next
26170 .vindex "&$authenticated_sender$&"
26171 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
26172 running, the value of &$authenticated_sender$& is set to the value obtained
26173 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
26174 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
26175 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
26176 given for the MAIL command.
26177 .next
26178 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
26179 is accepted and placed in &$authenticated_sender$& only if the client has
26180 authenticated.
26181 .next
26182 If the AUTH= value was accepted by either of the two previous rules, and
26183 the client has authenticated, and the authenticator has a setting for the
26184 &%server_mail_auth_condition%&, the condition is checked at this point. The
26185 valued that was saved from the authenticator is expanded. If the expansion
26186 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
26187 &$authenticated_sender$& is deleted. If the expansion yields any other value,
26188 the value of &$authenticated_sender$& is retained and passed on with the
26189 message.
26190 .endlist
26191
26192
26193 When &$authenticated_sender$& is set for a message, it is passed on to other
26194 hosts to which Exim authenticates as a client. Do not confuse this value with
26195 &$authenticated_id$&, which is a string obtained from the authentication
26196 process, and which is not usually a complete email address.
26197
26198 .vindex "&$sender_address$&"
26199 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
26200 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
26201 therefore make use of &$authenticated_sender$&. The converse is not true: the
26202 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
26203 ACL is run.
26204
26205
26206
26207 .section "Authentication on an Exim server" "SECTauthexiser"
26208 .cindex "authentication" "on an Exim server"
26209 When Exim receives an EHLO command, it advertises the public names of those
26210 authenticators that are configured as servers, subject to the following
26211 conditions:
26212
26213 .ilist
26214 The client host must match &%auth_advertise_hosts%& (default *).
26215 .next
26216 It the &%server_advertise_condition%& option is set, its expansion must not
26217 yield the empty string, &"0"&, &"no"&, or &"false"&.
26218 .endlist
26219
26220 The order in which the authenticators are defined controls the order in which
26221 the mechanisms are advertised.
26222
26223 Some mail clients (for example, some versions of Netscape) require the user to
26224 provide a name and password for authentication whenever AUTH is advertised,
26225 even though authentication may not in fact be needed (for example, Exim may be
26226 set up to allow unconditional relaying from the client by an IP address check).
26227 You can make such clients more friendly by not advertising AUTH to them.
26228 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
26229 that runs for RCPT) to relay without authentication, you should set
26230 .code
26231 auth_advertise_hosts = ! 10.9.8.0/24
26232 .endd
26233 so that no authentication mechanisms are advertised to them.
26234
26235 The &%server_advertise_condition%& controls the advertisement of individual
26236 authentication mechanisms. For example, it can be used to restrict the
26237 advertisement of a particular mechanism to encrypted connections, by a setting
26238 such as:
26239 .code
26240 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
26241 .endd
26242 .vindex "&$tls_in_cipher$&"
26243 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
26244 yields &"yes"&, which allows the advertisement to happen.
26245
26246 When an Exim server receives an AUTH command from a client, it rejects it
26247 immediately if AUTH was not advertised in response to an earlier EHLO
26248 command. This is the case if
26249
26250 .ilist
26251 The client host does not match &%auth_advertise_hosts%&; or
26252 .next
26253 No authenticators are configured with server options; or
26254 .next
26255 Expansion of &%server_advertise_condition%& blocked the advertising of all the
26256 server authenticators.
26257 .endlist
26258
26259
26260 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
26261 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
26262 AUTH is accepted from any client host.
26263
26264 If AUTH is not rejected by the ACL, Exim searches its configuration for a
26265 server authentication mechanism that was advertised in response to EHLO and
26266 that matches the one named in the AUTH command. If it finds one, it runs
26267 the appropriate authentication protocol, and authentication either succeeds or
26268 fails. If there is no matching advertised mechanism, the AUTH command is
26269 rejected with a 504 error.
26270
26271 .vindex "&$received_protocol$&"
26272 .vindex "&$sender_host_authenticated$&"
26273 When a message is received from an authenticated host, the value of
26274 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
26275 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
26276 public name) of the authenticator driver that successfully authenticated the
26277 client from which the message was received. This variable is empty if there was
26278 no successful authentication.
26279
26280 .cindex authentication "expansion item"
26281 Successful authentication sets up information used by the
26282 &$authresults$& expansion item.
26283
26284
26285
26286
26287 .section "Testing server authentication" "SECID169"
26288 .cindex "authentication" "testing a server"
26289 .cindex "AUTH" "testing a server"
26290 .cindex "base64 encoding" "creating authentication test data"
26291 Exim's &%-bh%& option can be useful for testing server authentication
26292 configurations. The data for the AUTH command has to be sent using base64
26293 encoding. A quick way to produce such data for testing is the following Perl
26294 script:
26295 .code
26296 use MIME::Base64;
26297 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
26298 .endd
26299 .cindex "binary zero" "in authentication data"
26300 This interprets its argument as a Perl string, and then encodes it. The
26301 interpretation as a Perl string allows binary zeros, which are required for
26302 some kinds of authentication, to be included in the data. For example, a
26303 command line to run this script on such data might be
26304 .code
26305 encode '\0user\0password'
26306 .endd
26307 Note the use of single quotes to prevent the shell interpreting the
26308 backslashes, so that they can be interpreted by Perl to specify characters
26309 whose code value is zero.
26310
26311 &*Warning 1*&: If either of the user or password strings starts with an octal
26312 digit, you must use three zeros instead of one after the leading backslash. If
26313 you do not, the octal digit that starts your string will be incorrectly
26314 interpreted as part of the code for the first character.
26315
26316 &*Warning 2*&: If there are characters in the strings that Perl interprets
26317 specially, you must use a Perl escape to prevent them being misinterpreted. For
26318 example, a command such as
26319 .code
26320 encode '\0user@domain.com\0pas$$word'
26321 .endd
26322 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
26323
26324 If you have the &%mimencode%& command installed, another way to do produce
26325 base64-encoded strings is to run the command
26326 .code
26327 echo -e -n `\0user\0password' | mimencode
26328 .endd
26329 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
26330 in the argument, and the &%-n%& option specifies no newline at the end of its
26331 output. However, not all versions of &%echo%& recognize these options, so you
26332 should check your version before relying on this suggestion.
26333
26334
26335
26336 .section "Authentication by an Exim client" "SECID170"
26337 .cindex "authentication" "on an Exim client"
26338 The &(smtp)& transport has two options called &%hosts_require_auth%& and
26339 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
26340 announces support for authentication, and the host matches an entry in either
26341 of these options, Exim (as a client) tries to authenticate as follows:
26342
26343 .ilist
26344 For each authenticator that is configured as a client, in the order in which
26345 they are defined in the configuration, it searches the authentication
26346 mechanisms announced by the server for one whose name matches the public name
26347 of the authenticator.
26348 .next
26349 .vindex "&$host$&"
26350 .vindex "&$host_address$&"
26351 When it finds one that matches, it runs the authenticator's client code. The
26352 variables &$host$& and &$host_address$& are available for any string expansions
26353 that the client might do. They are set to the server's name and IP address. If
26354 any expansion is forced to fail, the authentication attempt is abandoned, and
26355 Exim moves on to the next authenticator. Otherwise an expansion failure causes
26356 delivery to be deferred.
26357 .next
26358 If the result of the authentication attempt is a temporary error or a timeout,
26359 Exim abandons trying to send the message to the host for the moment. It will
26360 try again later. If there are any backup hosts available, they are tried in the
26361 usual way.
26362 .next
26363 If the response to authentication is a permanent error (5&'xx'& code), Exim
26364 carries on searching the list of authenticators and tries another one if
26365 possible. If all authentication attempts give permanent errors, or if there are
26366 no attempts because no mechanisms match (or option expansions force failure),
26367 what happens depends on whether the host matches &%hosts_require_auth%& or
26368 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
26369 delivery is deferred. The error can be detected in the retry rules, and thereby
26370 turned into a permanent error if you wish. In the second case, Exim tries to
26371 deliver the message unauthenticated.
26372 .endlist
26373
26374 Note that the hostlist test for whether to do authentication can be
26375 confused if name-IP lookups change between the time the peer is decided
26376 upon and the time that the transport runs.  For example, with a manualroute
26377 router given a host name, and with DNS "round-robin" used by that name: if
26378 the local resolver cache times out between the router and the transport
26379 running, the transport may get an IP for the name for its authentication
26380 check which does not match the connection peer IP.
26381 No authentication will then be done, despite the names being identical.
26382
26383 For such cases use a separate transport which always authenticates.
26384
26385 .cindex "AUTH" "on MAIL command"
26386 When Exim has authenticated itself to a remote server, it adds the AUTH
26387 parameter to the MAIL commands it sends, if it has an authenticated sender for
26388 the message. If the message came from a remote host, the authenticated sender
26389 is the one that was receiving on an incoming MAIL command, provided that the
26390 incoming connection was authenticated and the &%server_mail_auth%& condition
26391 allowed the authenticated sender to be retained. If a local process calls Exim
26392 to send a message, the sender address that is built from the login name and
26393 &%qualify_domain%& is treated as authenticated. However, if the
26394 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
26395 the authenticated sender that was received with the message.
26396 .ecindex IIDauthconf1
26397 .ecindex IIDauthconf2
26398
26399
26400
26401
26402
26403
26404 . ////////////////////////////////////////////////////////////////////////////
26405 . ////////////////////////////////////////////////////////////////////////////
26406
26407 .chapter "The plaintext authenticator" "CHAPplaintext"
26408 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
26409 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
26410 The &(plaintext)& authenticator can be configured to support the PLAIN and
26411 LOGIN authentication mechanisms, both of which transfer authentication data as
26412 plain (unencrypted) text (though base64 encoded). The use of plain text is a
26413 security risk; you are strongly advised to insist on the use of SMTP encryption
26414 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
26415 use unencrypted plain text, you should not use the same passwords for SMTP
26416 connections as you do for login accounts.
26417
26418 .section "Plaintext options" "SECID171"
26419 .cindex "options" "&(plaintext)& authenticator (server)"
26420 When configured as a server, &(plaintext)& uses the following options:
26421
26422 .option server_condition authenticators string&!! unset
26423 This is actually a global authentication option, but it must be set in order to
26424 configure the &(plaintext)& driver as a server. Its use is described below.
26425
26426 .option server_prompts plaintext string&!! unset
26427 The contents of this option, after expansion, must be a colon-separated list of
26428 prompt strings. If expansion fails, a temporary authentication rejection is
26429 given.
26430
26431 .section "Using plaintext in a server" "SECTplainserver"
26432 .cindex "AUTH" "in &(plaintext)& authenticator"
26433 .cindex "binary zero" "in &(plaintext)& authenticator"
26434 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
26435         "in &(plaintext)& authenticator"
26436 .vindex "&$auth1$&, &$auth2$&, etc"
26437 .cindex "base64 encoding" "in &(plaintext)& authenticator"
26438
26439 When running as a server, &(plaintext)& performs the authentication test by
26440 expanding a string. The data sent by the client with the AUTH command, or in
26441 response to subsequent prompts, is base64 encoded, and so may contain any byte
26442 values when decoded. If any data is supplied with the command, it is treated as
26443 a list of strings, separated by NULs (binary zeros), the first three of which
26444 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
26445 (neither LOGIN nor PLAIN uses more than three strings).
26446
26447 For compatibility with previous releases of Exim, the values are also placed in
26448 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
26449 variables for this purpose is now deprecated, as it can lead to confusion in
26450 string expansions that also use them for other things.
26451
26452 If there are more strings in &%server_prompts%& than the number of strings
26453 supplied with the AUTH command, the remaining prompts are used to obtain more
26454 data. Each response from the client may be a list of NUL-separated strings.
26455
26456 .vindex "&$authenticated_id$&"
26457 Once a sufficient number of data strings have been received,
26458 &%server_condition%& is expanded. If the expansion is forced to fail,
26459 authentication fails. Any other expansion failure causes a temporary error code
26460 to be returned. If the result of a successful expansion is an empty string,
26461 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26462 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
26463 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
26464 For any other result, a temporary error code is returned, with the expanded
26465 string as the error text
26466
26467 &*Warning*&: If you use a lookup in the expansion to find the user's
26468 password, be sure to make the authentication fail if the user is unknown.
26469 There are good and bad examples at the end of the next section.
26470
26471
26472
26473 .section "The PLAIN authentication mechanism" "SECID172"
26474 .cindex "PLAIN authentication mechanism"
26475 .cindex "authentication" "PLAIN mechanism"
26476 .cindex "binary zero" "in &(plaintext)& authenticator"
26477 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
26478 sent as one item of data (that is, one combined string containing two NUL
26479 separators). The data is sent either as part of the AUTH command, or
26480 subsequently in response to an empty prompt from the server.
26481
26482 The second and third strings are a user name and a corresponding password.
26483 Using a single fixed user name and password as an example, this could be
26484 configured as follows:
26485 .code
26486 fixed_plain:
26487   driver = plaintext
26488   public_name = PLAIN
26489   server_prompts = :
26490   server_condition = \
26491     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
26492   server_set_id = $auth2
26493 .endd
26494 Note that the default result strings from &%if%& (&"true"& or an empty string)
26495 are exactly what we want here, so they need not be specified. Obviously, if the
26496 password contains expansion-significant characters such as dollar, backslash,
26497 or closing brace, they have to be escaped.
26498
26499 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
26500 the end of a string list are ignored). If all the data comes as part of the
26501 AUTH command, as is commonly the case, the prompt is not used. This
26502 authenticator is advertised in the response to EHLO as
26503 .code
26504 250-AUTH PLAIN
26505 .endd
26506 and a client host can authenticate itself by sending the command
26507 .code
26508 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
26509 .endd
26510 As this contains three strings (more than the number of prompts), no further
26511 data is required from the client. Alternatively, the client may just send
26512 .code
26513 AUTH PLAIN
26514 .endd
26515 to initiate authentication, in which case the server replies with an empty
26516 prompt. The client must respond with the combined data string.
26517
26518 The data string is base64 encoded, as required by the RFC. This example,
26519 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
26520 represents a zero byte. This is split up into three strings, the first of which
26521 is empty. The &%server_condition%& option in the authenticator checks that the
26522 second two are &`username`& and &`mysecret`& respectively.
26523
26524 Having just one fixed user name and password, as in this example, is not very
26525 realistic, though for a small organization with only a handful of
26526 authenticating clients it could make sense.
26527
26528 A more sophisticated instance of this authenticator could use the user name in
26529 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
26530 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
26531 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
26532 This is an incorrect example:
26533 .code
26534 server_condition = \
26535   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
26536 .endd
26537 The expansion uses the user name (&$auth2$&) as the key to look up a password,
26538 which it then compares to the supplied password (&$auth3$&). Why is this example
26539 incorrect? It works fine for existing users, but consider what happens if a
26540 non-existent user name is given. The lookup fails, but as no success/failure
26541 strings are given for the lookup, it yields an empty string. Thus, to defeat
26542 the authentication, all a client has to do is to supply a non-existent user
26543 name and an empty password. The correct way of writing this test is:
26544 .code
26545 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
26546   {${if eq{$value}{$auth3}}} {false}}
26547 .endd
26548 In this case, if the lookup succeeds, the result is checked; if the lookup
26549 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
26550 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
26551 always fails if its second argument is empty. However, the second way of
26552 writing the test makes the logic clearer.
26553
26554
26555 .section "The LOGIN authentication mechanism" "SECID173"
26556 .cindex "LOGIN authentication mechanism"
26557 .cindex "authentication" "LOGIN mechanism"
26558 The LOGIN authentication mechanism is not documented in any RFC, but is in use
26559 in a number of programs. No data is sent with the AUTH command. Instead, a
26560 user name and password are supplied separately, in response to prompts. The
26561 plaintext authenticator can be configured to support this as in this example:
26562 .code
26563 fixed_login:
26564   driver = plaintext
26565   public_name = LOGIN
26566   server_prompts = User Name : Password
26567   server_condition = \
26568     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
26569   server_set_id = $auth1
26570 .endd
26571 Because of the way plaintext operates, this authenticator accepts data supplied
26572 with the AUTH command (in contravention of the specification of LOGIN), but
26573 if the client does not supply it (as is the case for LOGIN clients), the prompt
26574 strings are used to obtain two data items.
26575
26576 Some clients are very particular about the precise text of the prompts. For
26577 example, Outlook Express is reported to recognize only &"Username:"& and
26578 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
26579 strings. It uses the &%ldapauth%& expansion condition to check the user
26580 name and password by binding to an LDAP server:
26581 .code
26582 login:
26583   driver = plaintext
26584   public_name = LOGIN
26585   server_prompts = Username:: : Password::
26586   server_condition = ${if and{{ \
26587     !eq{}{$auth1} }{ \
26588     ldapauth{\
26589       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
26590       pass=${quote:$auth2} \
26591       ldap://ldap.example.org/} }} }
26592   server_set_id = uid=$auth1,ou=people,o=example.org
26593 .endd
26594 We have to check that the username is not empty before using it, because LDAP
26595 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
26596 operator to correctly quote the DN for authentication. However, the basic
26597 &%quote%& operator, rather than any of the LDAP quoting operators, is the
26598 correct one to use for the password, because quoting is needed only to make
26599 the password conform to the Exim syntax. At the LDAP level, the password is an
26600 uninterpreted string.
26601
26602
26603 .section "Support for different kinds of authentication" "SECID174"
26604 A number of string expansion features are provided for the purpose of
26605 interfacing to different ways of user authentication. These include checking
26606 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
26607 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
26608 &<<SECTexpcond>>&.
26609
26610
26611
26612
26613 .section "Using plaintext in a client" "SECID175"
26614 .cindex "options" "&(plaintext)& authenticator (client)"
26615 The &(plaintext)& authenticator has two client options:
26616
26617 .option client_ignore_invalid_base64 plaintext boolean false
26618 If the client receives a server prompt that is not a valid base64 string,
26619 authentication is abandoned by default. However, if this option is set true,
26620 the error in the challenge is ignored and the client sends the response as
26621 usual.
26622
26623 .option client_send plaintext string&!! unset
26624 The string is a colon-separated list of authentication data strings. Each
26625 string is independently expanded before being sent to the server. The first
26626 string is sent with the AUTH command; any more strings are sent in response
26627 to prompts from the server. Before each string is expanded, the value of the
26628 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
26629 with &$auth1$& for the first prompt. Up to three prompts are stored in this
26630 way. Thus, the prompt that is received in response to sending the first string
26631 (with the AUTH command) can be used in the expansion of the second string, and
26632 so on. If an invalid base64 string is received when
26633 &%client_ignore_invalid_base64%& is set, an empty string is put in the
26634 &$auth$&<&'n'&> variable.
26635
26636 &*Note*&: You cannot use expansion to create multiple strings, because
26637 splitting takes priority and happens first.
26638
26639 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
26640 the data, further processing is applied to each string before it is sent. If
26641 there are any single circumflex characters in the string, they are converted to
26642 NULs. Should an actual circumflex be required as data, it must be doubled in
26643 the string.
26644
26645 This is an example of a client configuration that implements the PLAIN
26646 authentication mechanism with a fixed user name and password:
26647 .code
26648 fixed_plain:
26649   driver = plaintext
26650   public_name = PLAIN
26651   client_send = ^username^mysecret
26652 .endd
26653 The lack of colons means that the entire text is sent with the AUTH
26654 command, with the circumflex characters converted to NULs. A similar example
26655 that uses the LOGIN mechanism is:
26656 .code
26657 fixed_login:
26658   driver = plaintext
26659   public_name = LOGIN
26660   client_send = : username : mysecret
26661 .endd
26662 The initial colon means that the first string is empty, so no data is sent with
26663 the AUTH command itself. The remaining strings are sent in response to
26664 prompts.
26665 .ecindex IIDplaiauth1
26666 .ecindex IIDplaiauth2
26667
26668
26669
26670
26671 . ////////////////////////////////////////////////////////////////////////////
26672 . ////////////////////////////////////////////////////////////////////////////
26673
26674 .chapter "The cram_md5 authenticator" "CHID9"
26675 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
26676 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
26677 .cindex "CRAM-MD5 authentication mechanism"
26678 .cindex "authentication" "CRAM-MD5 mechanism"
26679 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
26680 sends a challenge string to the client, and the response consists of a user
26681 name and the CRAM-MD5 digest of the challenge string combined with a secret
26682 string (password) which is known to both server and client. Thus, the secret
26683 is not sent over the network as plain text, which makes this authenticator more
26684 secure than &(plaintext)&. However, the downside is that the secret has to be
26685 available in plain text at either end.
26686
26687
26688 .section "Using cram_md5 as a server" "SECID176"
26689 .cindex "options" "&(cram_md5)& authenticator (server)"
26690 This authenticator has one server option, which must be set to configure the
26691 authenticator as a server:
26692
26693 .option server_secret cram_md5 string&!! unset
26694 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
26695 When the server receives the client's response, the user name is placed in
26696 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
26697 obtain the password for that user. The server then computes the CRAM-MD5 digest
26698 that the client should have sent, and checks that it received the correct
26699 string. If the expansion of &%server_secret%& is forced to fail, authentication
26700 fails. If the expansion fails for some other reason, a temporary error code is
26701 returned to the client.
26702
26703 For compatibility with previous releases of Exim, the user name is also placed
26704 in &$1$&. However, the use of this variables for this purpose is now
26705 deprecated, as it can lead to confusion in string expansions that also use
26706 numeric variables for other things.
26707
26708 For example, the following authenticator checks that the user name given by the
26709 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
26710 user name, authentication fails.
26711 .code
26712 fixed_cram:
26713   driver = cram_md5
26714   public_name = CRAM-MD5
26715   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
26716   server_set_id = $auth1
26717 .endd
26718 .vindex "&$authenticated_id$&"
26719 If authentication succeeds, the setting of &%server_set_id%& preserves the user
26720 name in &$authenticated_id$&. A more typical configuration might look up the
26721 secret string in a file, using the user name as the key. For example:
26722 .code
26723 lookup_cram:
26724   driver = cram_md5
26725   public_name = CRAM-MD5
26726   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
26727                   {$value}fail}
26728   server_set_id = $auth1
26729 .endd
26730 Note that this expansion explicitly forces failure if the lookup fails
26731 because &$auth1$& contains an unknown user name.
26732
26733 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
26734 using the relevant libraries, you need to know the realm to specify in the
26735 lookup and then ask for the &"userPassword"& attribute for that user in that
26736 realm, with:
26737 .code
26738 cyrusless_crammd5:
26739   driver = cram_md5
26740   public_name = CRAM-MD5
26741   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
26742                   dbmjz{/etc/sasldb2}{$value}fail}
26743   server_set_id = $auth1
26744 .endd
26745
26746 .section "Using cram_md5 as a client" "SECID177"
26747 .cindex "options" "&(cram_md5)& authenticator (client)"
26748 When used as a client, the &(cram_md5)& authenticator has two options:
26749
26750
26751
26752 .option client_name cram_md5 string&!! "the primary host name"
26753 This string is expanded, and the result used as the user name data when
26754 computing the response to the server's challenge.
26755
26756
26757 .option client_secret cram_md5 string&!! unset
26758 This option must be set for the authenticator to work as a client. Its value is
26759 expanded and the result used as the secret string when computing the response.
26760
26761
26762 .vindex "&$host$&"
26763 .vindex "&$host_address$&"
26764 Different user names and secrets can be used for different servers by referring
26765 to &$host$& or &$host_address$& in the options. Forced failure of either
26766 expansion string is treated as an indication that this authenticator is not
26767 prepared to handle this case. Exim moves on to the next configured client
26768 authenticator. Any other expansion failure causes Exim to give up trying to
26769 send the message to the current server.
26770
26771 A simple example configuration of a &(cram_md5)& authenticator, using fixed
26772 strings, is:
26773 .code
26774 fixed_cram:
26775   driver = cram_md5
26776   public_name = CRAM-MD5
26777   client_name = ph10
26778   client_secret = secret
26779 .endd
26780 .ecindex IIDcramauth1
26781 .ecindex IIDcramauth2
26782
26783
26784
26785 . ////////////////////////////////////////////////////////////////////////////
26786 . ////////////////////////////////////////////////////////////////////////////
26787
26788 .chapter "The cyrus_sasl authenticator" "CHID10"
26789 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
26790 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
26791 .cindex "Cyrus" "SASL library"
26792 .cindex "Kerberos"
26793 The code for this authenticator was provided by Matthew Byng-Maddick while
26794 at A L Digital Ltd.
26795
26796 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
26797 library implementation of the RFC 2222 (&"Simple Authentication and Security
26798 Layer"&). This library supports a number of authentication mechanisms,
26799 including PLAIN and LOGIN, but also several others that Exim does not support
26800 directly. In particular, there is support for Kerberos authentication.
26801
26802 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
26803 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
26804 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
26805 name of the driver to determine which mechanism to support.
26806
26807 Where access to some kind of secret file is required, for example in GSSAPI
26808 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
26809 user, and that the Cyrus SASL library has no way of escalating privileges
26810 by default. You may also find you need to set environment variables,
26811 depending on the driver you are using.
26812
26813 The application name provided by Exim is &"exim"&, so various SASL options may
26814 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
26815 Kerberos, note that because of limitations in the GSSAPI interface,
26816 changing the server keytab might need to be communicated down to the Kerberos
26817 layer independently. The mechanism for doing so is dependent upon the Kerberos
26818 implementation.
26819
26820 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
26821 may be set to point to an alternative keytab file. Exim will pass this
26822 variable through from its own inherited environment when started as root or the
26823 Exim user. The keytab file needs to be readable by the Exim user.
26824 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
26825 environment variable.  In practice, for those releases, the Cyrus authenticator
26826 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
26827 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
26828
26829
26830 .section "Using cyrus_sasl as a server" "SECID178"
26831 The &(cyrus_sasl)& authenticator has four private options. It puts the username
26832 (on a successful authentication) into &$auth1$&. For compatibility with
26833 previous releases of Exim, the username is also placed in &$1$&. However, the
26834 use of this variable for this purpose is now deprecated, as it can lead to
26835 confusion in string expansions that also use numeric variables for other
26836 things.
26837
26838
26839 .option server_hostname cyrus_sasl string&!! "see below"
26840 This option selects the hostname that is used when communicating with the
26841 library. The default value is &`$primary_hostname`&. It is up to the underlying
26842 SASL plug-in what it does with this data.
26843
26844
26845 .option server_mech cyrus_sasl string "see below"
26846 This option selects the authentication mechanism this driver should use. The
26847 default is the value of the generic &%public_name%& option. This option allows
26848 you to use a different underlying mechanism from the advertised name. For
26849 example:
26850 .code
26851 sasl:
26852   driver = cyrus_sasl
26853   public_name = X-ANYTHING
26854   server_mech = CRAM-MD5
26855   server_set_id = $auth1
26856 .endd
26857
26858 .option server_realm cyrus_sasl string&!! unset
26859 This specifies the SASL realm that the server claims to be in.
26860
26861
26862 .option server_service cyrus_sasl string &`smtp`&
26863 This is the SASL service that the server claims to implement.
26864
26865
26866 For straightforward cases, you do not need to set any of the authenticator's
26867 private options. All you need to do is to specify an appropriate mechanism as
26868 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
26869 PLAIN, you could have two authenticators as follows:
26870 .code
26871 sasl_cram_md5:
26872   driver = cyrus_sasl
26873   public_name = CRAM-MD5
26874   server_set_id = $auth1
26875
26876 sasl_plain:
26877   driver = cyrus_sasl
26878   public_name = PLAIN
26879   server_set_id = $auth2
26880 .endd
26881 Cyrus SASL does implement the LOGIN authentication method, even though it is
26882 not a standard method. It is disabled by default in the source distribution,
26883 but it is present in many binary distributions.
26884 .ecindex IIDcyrauth1
26885 .ecindex IIDcyrauth2
26886
26887
26888
26889
26890 . ////////////////////////////////////////////////////////////////////////////
26891 . ////////////////////////////////////////////////////////////////////////////
26892 .chapter "The dovecot authenticator" "CHAPdovecot"
26893 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
26894 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
26895 This authenticator is an interface to the authentication facility of the
26896 Dovecot POP/IMAP server, which can support a number of authentication methods.
26897 Note that Dovecot must be configured to use auth-client not auth-userdb.
26898 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
26899 to use the same mechanisms for SMTP authentication. This is a server
26900 authenticator only. There is only one option:
26901
26902 .option server_socket dovecot string unset
26903
26904 This option must specify the UNIX socket that is the interface to Dovecot
26905 authentication. The &%public_name%& option must specify an authentication
26906 mechanism that Dovecot is configured to support. You can have several
26907 authenticators for different mechanisms. For example:
26908 .code
26909 dovecot_plain:
26910   driver = dovecot
26911   public_name = PLAIN
26912   server_socket = /var/run/dovecot/auth-client
26913   server_set_id = $auth1
26914
26915 dovecot_ntlm:
26916   driver = dovecot
26917   public_name = NTLM
26918   server_socket = /var/run/dovecot/auth-client
26919   server_set_id = $auth1
26920 .endd
26921 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
26922 &$received_ip_address$& (that is, the connection is local), the &"secured"&
26923 option is passed in the Dovecot authentication command. If, for a TLS
26924 connection, a client certificate has been verified, the &"valid-client-cert"&
26925 option is passed. When authentication succeeds, the identity of the user
26926 who authenticated is placed in &$auth1$&.
26927 .ecindex IIDdcotauth1
26928 .ecindex IIDdcotauth2
26929
26930
26931 . ////////////////////////////////////////////////////////////////////////////
26932 . ////////////////////////////////////////////////////////////////////////////
26933 .chapter "The gsasl authenticator" "CHAPgsasl"
26934 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
26935 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
26936 .cindex "authentication" "GNU SASL"
26937 .cindex "authentication" "SASL"
26938 .cindex "authentication" "EXTERNAL"
26939 .cindex "authentication" "ANONYMOUS"
26940 .cindex "authentication" "PLAIN"
26941 .cindex "authentication" "LOGIN"
26942 .cindex "authentication" "DIGEST-MD5"
26943 .cindex "authentication" "CRAM-MD5"
26944 .cindex "authentication" "SCRAM-SHA-1"
26945 The &(gsasl)& authenticator provides server integration for the GNU SASL
26946 library and the mechanisms it provides.  This is new as of the 4.80 release
26947 and there are a few areas where the library does not let Exim smoothly
26948 scale to handle future authentication mechanisms, so no guarantee can be
26949 made that any particular new authentication mechanism will be supported
26950 without code changes in Exim.
26951
26952
26953 .option server_channelbinding gsasl boolean false
26954 Do not set this true without consulting a cryptographic engineer.
26955
26956 Some authentication mechanisms are able to use external context at both ends
26957 of the session to bind the authentication to that context, and fail the
26958 authentication process if that context differs.  Specifically, some TLS
26959 ciphersuites can provide identifying information about the cryptographic
26960 context.
26961
26962 This should have meant that certificate identity and verification becomes a
26963 non-issue, as a man-in-the-middle attack will cause the correct client and
26964 server to see different identifiers and authentication will fail.
26965
26966 This is currently only supported when using the GnuTLS library.  This is
26967 only usable by mechanisms which support "channel binding"; at time of
26968 writing, that's the SCRAM family.
26969
26970 This defaults off to ensure smooth upgrade across Exim releases, in case
26971 this option causes some clients to start failing.  Some future release
26972 of Exim might have switched the default to be true.
26973
26974 However, Channel Binding in TLS has proven to be broken in current versions.
26975 Do not plan to rely upon this feature for security, ever, without consulting
26976 with a subject matter expert (a cryptographic engineer).
26977
26978
26979 .option server_hostname gsasl string&!! "see below"
26980 This option selects the hostname that is used when communicating with the
26981 library. The default value is &`$primary_hostname`&.
26982 Some mechanisms will use this data.
26983
26984
26985 .option server_mech gsasl string "see below"
26986 This option selects the authentication mechanism this driver should use. The
26987 default is the value of the generic &%public_name%& option. This option allows
26988 you to use a different underlying mechanism from the advertised name. For
26989 example:
26990 .code
26991 sasl:
26992   driver = gsasl
26993   public_name = X-ANYTHING
26994   server_mech = CRAM-MD5
26995   server_set_id = $auth1
26996 .endd
26997
26998
26999 .option server_password gsasl string&!! unset
27000 Various mechanisms need access to the cleartext password on the server, so
27001 that proof-of-possession can be demonstrated on the wire, without sending
27002 the password itself.
27003
27004 The data available for lookup varies per mechanism.
27005 In all cases, &$auth1$& is set to the &'authentication id'&.
27006 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
27007 if available, else the empty string.
27008 The &$auth3$& variable will always be the &'realm'& if available,
27009 else the empty string.
27010
27011 A forced failure will cause authentication to defer.
27012
27013 If using this option, it may make sense to set the &%server_condition%&
27014 option to be simply "true".
27015
27016
27017 .option server_realm gsasl string&!! unset
27018 This specifies the SASL realm that the server claims to be in.
27019 Some mechanisms will use this data.
27020
27021
27022 .option server_scram_iter gsasl string&!! unset
27023 This option provides data for the SCRAM family of mechanisms.
27024 &$auth1$& is not available at evaluation time.
27025 (This may change, as we receive feedback on use)
27026
27027
27028 .option server_scram_salt gsasl string&!! unset
27029 This option provides data for the SCRAM family of mechanisms.
27030 &$auth1$& is not available at evaluation time.
27031 (This may change, as we receive feedback on use)
27032
27033
27034 .option server_service gsasl string &`smtp`&
27035 This is the SASL service that the server claims to implement.
27036 Some mechanisms will use this data.
27037
27038
27039 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
27040 .vindex "&$auth1$&, &$auth2$&, etc"
27041 These may be set when evaluating specific options, as detailed above.
27042 They will also be set when evaluating &%server_condition%&.
27043
27044 Unless otherwise stated below, the &(gsasl)& integration will use the following
27045 meanings for these variables:
27046
27047 .ilist
27048 .vindex "&$auth1$&"
27049 &$auth1$&: the &'authentication id'&
27050 .next
27051 .vindex "&$auth2$&"
27052 &$auth2$&: the &'authorization id'&
27053 .next
27054 .vindex "&$auth3$&"
27055 &$auth3$&: the &'realm'&
27056 .endlist
27057
27058 On a per-mechanism basis:
27059
27060 .ilist
27061 .cindex "authentication" "EXTERNAL"
27062 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
27063 the &%server_condition%& option must be present.
27064 .next
27065 .cindex "authentication" "ANONYMOUS"
27066 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
27067 the &%server_condition%& option must be present.
27068 .next
27069 .cindex "authentication" "GSSAPI"
27070 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
27071 &$auth2$& will be set to the &'authorization id'&,
27072 the &%server_condition%& option must be present.
27073 .endlist
27074
27075 An &'anonymous token'& is something passed along as an unauthenticated
27076 identifier; this is analogous to FTP anonymous authentication passing an
27077 email address, or software-identifier@, as the "password".
27078
27079
27080 An example showing the password having the realm specified in the callback
27081 and demonstrating a Cyrus SASL to GSASL migration approach is:
27082 .code
27083 gsasl_cyrusless_crammd5:
27084   driver = gsasl
27085   public_name = CRAM-MD5
27086   server_realm = imap.example.org
27087   server_password = ${lookup{$auth1:$auth3:userPassword}\
27088                     dbmjz{/etc/sasldb2}{$value}fail}
27089   server_set_id = ${quote:$auth1}
27090   server_condition = yes
27091 .endd
27092
27093
27094 . ////////////////////////////////////////////////////////////////////////////
27095 . ////////////////////////////////////////////////////////////////////////////
27096
27097 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
27098 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
27099 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
27100 .cindex "authentication" "GSSAPI"
27101 .cindex "authentication" "Kerberos"
27102 The &(heimdal_gssapi)& authenticator provides server integration for the
27103 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
27104 reliably.
27105
27106 .option server_hostname heimdal_gssapi string&!! "see below"
27107 This option selects the hostname that is used, with &%server_service%&,
27108 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
27109 identifier.  The default value is &`$primary_hostname`&.
27110
27111 .option server_keytab heimdal_gssapi string&!! unset
27112 If set, then Heimdal will not use the system default keytab (typically
27113 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
27114 The value should be a pathname, with no &"file:"& prefix.
27115
27116 .option server_service heimdal_gssapi string&!! "smtp"
27117 This option specifies the service identifier used, in conjunction with
27118 &%server_hostname%&, for building the identifier for finding credentials
27119 from the keytab.
27120
27121
27122 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
27123 Beware that these variables will typically include a realm, thus will appear
27124 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
27125 not verified, so a malicious client can set it to anything.
27126
27127 The &$auth1$& field should be safely trustable as a value from the Key
27128 Distribution Center.  Note that these are not quite email addresses.
27129 Each identifier is for a role, and so the left-hand-side may include a
27130 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
27131
27132 .vindex "&$auth1$&, &$auth2$&, etc"
27133 .ilist
27134 .vindex "&$auth1$&"
27135 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
27136 .next
27137 .vindex "&$auth2$&"
27138 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
27139 authentication.  If that was empty, this will also be set to the
27140 GSS Display Name.
27141 .endlist
27142
27143
27144 . ////////////////////////////////////////////////////////////////////////////
27145 . ////////////////////////////////////////////////////////////////////////////
27146
27147 .chapter "The spa authenticator" "CHAPspa"
27148 .scindex IIDspaauth1 "&(spa)& authenticator"
27149 .scindex IIDspaauth2 "authenticators" "&(spa)&"
27150 .cindex "authentication" "Microsoft Secure Password"
27151 .cindex "authentication" "NTLM"
27152 .cindex "Microsoft Secure Password Authentication"
27153 .cindex "NTLM authentication"
27154 The &(spa)& authenticator provides client support for Microsoft's &'Secure
27155 Password Authentication'& mechanism,
27156 which is also sometimes known as NTLM (NT LanMan). The code for client side of
27157 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
27158 taken from the Samba project (&url(https://www.samba.org/)). The code for the
27159 server side was subsequently contributed by Tom Kistner. The mechanism works as
27160 follows:
27161
27162 .ilist
27163 After the AUTH command has been accepted, the client sends an SPA
27164 authentication request based on the user name and optional domain.
27165 .next
27166 The server sends back a challenge.
27167 .next
27168 The client builds a challenge response which makes use of the user's password
27169 and sends it to the server, which then accepts or rejects it.
27170 .endlist
27171
27172 Encryption is used to protect the password in transit.
27173
27174
27175
27176 .section "Using spa as a server" "SECID179"
27177 .cindex "options" "&(spa)& authenticator (server)"
27178 The &(spa)& authenticator has just one server option:
27179
27180 .option server_password spa string&!! unset
27181 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
27182 This option is expanded, and the result must be the cleartext password for the
27183 authenticating user, whose name is at this point in &$auth1$&. For
27184 compatibility with previous releases of Exim, the user name is also placed in
27185 &$1$&. However, the use of this variable for this purpose is now deprecated, as
27186 it can lead to confusion in string expansions that also use numeric variables
27187 for other things. For example:
27188 .code
27189 spa:
27190   driver = spa
27191   public_name = NTLM
27192   server_password = \
27193     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
27194 .endd
27195 If the expansion is forced to fail, authentication fails. Any other expansion
27196 failure causes a temporary error code to be returned.
27197
27198
27199
27200
27201
27202 .section "Using spa as a client" "SECID180"
27203 .cindex "options" "&(spa)& authenticator (client)"
27204 The &(spa)& authenticator has the following client options:
27205
27206
27207
27208 .option client_domain spa string&!! unset
27209 This option specifies an optional domain for the authentication.
27210
27211
27212 .option client_password spa string&!! unset
27213 This option specifies the user's password, and must be set.
27214
27215
27216 .option client_username spa string&!! unset
27217 This option specifies the user name, and must be set. Here is an example of a
27218 configuration of this authenticator for use with the mail servers at
27219 &'msn.com'&:
27220 .code
27221 msn:
27222   driver = spa
27223   public_name = MSN
27224   client_username = msn/msn_username
27225   client_password = msn_plaintext_password
27226   client_domain = DOMAIN_OR_UNSET
27227 .endd
27228 .ecindex IIDspaauth1
27229 .ecindex IIDspaauth2
27230
27231
27232
27233
27234
27235 . ////////////////////////////////////////////////////////////////////////////
27236 . ////////////////////////////////////////////////////////////////////////////
27237
27238 .chapter "The tls authenticator" "CHAPtlsauth"
27239 .scindex IIDtlsauth1 "&(tls)& authenticator"
27240 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
27241 .cindex "authentication" "Client Certificate"
27242 .cindex "authentication" "X509"
27243 .cindex "Certificate-based authentication"
27244 The &(tls)& authenticator provides server support for
27245 authentication based on client certificates.
27246
27247 It is not an SMTP authentication mechanism and is not
27248 advertised by the server as part of the SMTP EHLO response.
27249 It is an Exim authenticator in the sense that it affects
27250 the protocol element of the log line, can be tested for
27251 by the &%authenticated%& ACL condition, and can set
27252 the &$authenticated_id$& variable.
27253
27254 The client must present a verifiable certificate,
27255 for which it must have been requested via the
27256 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27257 (see &<<CHAPTLS>>&).
27258
27259 If an authenticator of this type is configured it is
27260 run before any SMTP-level communication is done,
27261 and can authenticate the connection.
27262 If it does, SMTP authentication is not offered.
27263
27264 A maximum of one authenticator of this type may be present.
27265
27266
27267 .cindex "options" "&(tls)& authenticator (server)"
27268 The &(tls)& authenticator has three server options:
27269
27270 .option server_param1 tls string&!! unset
27271 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
27272 This option is expanded after the TLS negotiation and
27273 the result is placed in &$auth1$&.
27274 If the expansion is forced to fail, authentication fails. Any other expansion
27275 failure causes a temporary error code to be returned.
27276
27277 .option server_param2 tls string&!! unset
27278 .option server_param3 tls string&!! unset
27279 As above, for &$auth2$& and &$auth3$&.
27280
27281 &%server_param1%& may also be spelled &%server_param%&.
27282
27283
27284 Example:
27285 .code
27286 tls:
27287   driver = tls
27288   server_param1 =     ${certextract {subj_altname,mail,>:} \
27289                                     {$tls_in_peercert}}
27290   server_condition =  ${if forany {$auth1} \
27291                             {!= {0} \
27292                                 {${lookup ldap{ldap:///\
27293                          mailname=${quote_ldap_dn:${lc:$item}},\
27294                          ou=users,LDAP_DC?mailid} {$value}{0} \
27295                        }    }   } }
27296   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
27297 .endd
27298 This accepts a client certificate that is verifiable against any
27299 of your configured trust-anchors
27300 (which usually means the full set of public CAs)
27301 and which has a SAN with a good account name.
27302 Note that the client cert is on the wire in-clear, including the SAN,
27303 whereas a plaintext SMTP AUTH done inside TLS is not.
27304
27305 . An alternative might use
27306 . .code
27307 .   server_param1 = ${sha256:$tls_in_peercert}
27308 . .endd
27309 . to require one of a set of specific certs that define a given account
27310 . (the verification is still required, but mostly irrelevant).
27311 . This would help for per-device use.
27312 .
27313 . However, for the future we really need support for checking a
27314 . user cert in LDAP - which probably wants a base-64 DER.
27315
27316 .ecindex IIDtlsauth1
27317 .ecindex IIDtlsauth2
27318
27319
27320 Note that because authentication is traditionally an SMTP operation,
27321 the &%authenticated%& ACL condition cannot be used in
27322 a connect- or helo-ACL.
27323
27324
27325
27326 . ////////////////////////////////////////////////////////////////////////////
27327 . ////////////////////////////////////////////////////////////////////////////
27328
27329 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
27330          "Encrypted SMTP connections"
27331 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
27332 .scindex IIDencsmtp2 "SMTP" "encryption"
27333 .cindex "TLS" "on SMTP connection"
27334 .cindex "OpenSSL"
27335 .cindex "GnuTLS"
27336 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
27337 Sockets Layer), is implemented by making use of the OpenSSL library or the
27338 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
27339 cryptographic code in the Exim distribution itself for implementing TLS. In
27340 order to use this feature you must install OpenSSL or GnuTLS, and then build a
27341 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
27342 You also need to understand the basic concepts of encryption at a managerial
27343 level, and in particular, the way that public keys, private keys, and
27344 certificates are used.
27345
27346 RFC 3207 defines how SMTP connections can make use of encryption. Once a
27347 connection is established, the client issues a STARTTLS command. If the
27348 server accepts this, the client and the server negotiate an encryption
27349 mechanism. If the negotiation succeeds, the data that subsequently passes
27350 between them is encrypted.
27351
27352 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
27353 and if so, what cipher suite is in use, whether the client supplied a
27354 certificate, and whether or not that certificate was verified. This makes it
27355 possible for an Exim server to deny or accept certain commands based on the
27356 encryption state.
27357
27358 &*Warning*&: Certain types of firewall and certain anti-virus products can
27359 disrupt TLS connections. You need to turn off SMTP scanning for these products
27360 in order to get TLS to work.
27361
27362
27363
27364 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
27365          "SECID284"
27366 .cindex "submissions protocol"
27367 .cindex "ssmtp protocol"
27368 .cindex "smtps protocol"
27369 .cindex "SMTP" "submissions protocol"
27370 .cindex "SMTP" "ssmtp protocol"
27371 .cindex "SMTP" "smtps protocol"
27372 The history of port numbers for TLS in SMTP is a little messy and has been
27373 contentious.  As of RFC 8314, the common practice of using the historically
27374 allocated port 465 for "email submission but with TLS immediately upon connect
27375 instead of using STARTTLS" is officially blessed by the IETF, and recommended
27376 by them in preference to STARTTLS.
27377
27378 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
27379 clarity emerged over the dual roles of SMTP, for MX delivery and Email
27380 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
27381
27382 This approach was, for a while, officially abandoned when encrypted SMTP was
27383 standardized, but many clients kept using it, even as the TCP port number was
27384 reassigned for other use.
27385 Thus you may encounter guidance claiming that you shouldn't enable use of
27386 this port.
27387 In practice, a number of mail-clients have only ever supported submissions,
27388 not submission with STARTTLS upgrade.
27389 Ideally, offer both submission (587) and submissions (465) service.
27390
27391 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
27392 global option. Its value must be a list of port numbers;
27393 the most common use is expected to be:
27394 .code
27395 tls_on_connect_ports = 465
27396 .endd
27397 The port numbers specified by this option apply to all SMTP connections, both
27398 via the daemon and via &'inetd'&. You still need to specify all the ports that
27399 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
27400 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
27401 an extra port &-- rather, it specifies different behaviour on a port that is
27402 defined elsewhere.
27403
27404 There is also a &%-tls-on-connect%& command line option. This overrides
27405 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
27406
27407
27408
27409
27410
27411
27412 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
27413 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
27414 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
27415 followed later, when the first versions of GnuTLS were released. To build Exim
27416 to use GnuTLS, you need to set
27417 .code
27418 USE_GNUTLS=yes
27419 .endd
27420 in Local/Makefile, in addition to
27421 .code
27422 SUPPORT_TLS=yes
27423 .endd
27424 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
27425 include files and libraries for GnuTLS can be found.
27426
27427 There are some differences in usage when using GnuTLS instead of OpenSSL:
27428
27429 .ilist
27430 The &%tls_verify_certificates%& option
27431 cannot be the path of a directory
27432 for GnuTLS versions before 3.3.6
27433 (for later versions, or OpenSSL, it can be either).
27434 .next
27435 The default value for &%tls_dhparam%& differs for historical reasons.
27436 .next
27437 .vindex "&$tls_in_peerdn$&"
27438 .vindex "&$tls_out_peerdn$&"
27439 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
27440 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
27441 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
27442 .next
27443 OpenSSL identifies cipher suites using hyphens as separators, for example:
27444 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
27445 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
27446 in a cipher list. To make life simpler, Exim changes underscores to hyphens
27447 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
27448 to handle its own older variants) when processing lists of cipher suites in the
27449 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
27450 option).
27451 .next
27452 The &%tls_require_ciphers%& options operate differently, as described in the
27453 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
27454 .next
27455 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
27456 When using OpenSSL, this option is ignored.
27457 (If an API is found to let OpenSSL be configured in this way,
27458 let the Exim Maintainers know and we'll likely use it).
27459 .next
27460 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
27461 main option, it must be ordered to match the &%tls_certificate%& list.
27462 .next
27463 Some other recently added features may only be available in one or the other.
27464 This should be documented with the feature.  If the documentation does not
27465 explicitly state that the feature is infeasible in the other TLS
27466 implementation, then patches are welcome.
27467 .endlist
27468
27469
27470 .section "GnuTLS parameter computation" "SECTgnutlsparam"
27471 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
27472 an explicit path; if the latter, then the text about generation still applies,
27473 but not the chosen filename.
27474 By default, as of Exim 4.80 a hard-coded D-H prime is used.
27475 See the documentation of &%tls_dhparam%& for more information.
27476
27477 GnuTLS uses D-H parameters that may take a substantial amount of time
27478 to compute. It is unreasonable to re-compute them for every TLS session.
27479 Therefore, Exim keeps this data in a file in its spool directory, called
27480 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
27481 of bits requested.
27482 The file is owned by the Exim user and is readable only by
27483 its owner. Every Exim process that start up GnuTLS reads the D-H
27484 parameters from this file. If the file does not exist, the first Exim process
27485 that needs it computes the data and writes it to a temporary file which is
27486 renamed once it is complete. It does not matter if several Exim processes do
27487 this simultaneously (apart from wasting a few resources). Once a file is in
27488 place, new Exim processes immediately start using it.
27489
27490 For maximum security, the parameters that are stored in this file should be
27491 recalculated periodically, the frequency depending on your paranoia level.
27492 If you are avoiding using the fixed D-H primes published in RFCs, then you
27493 are concerned about some advanced attacks and will wish to do this; if you do
27494 not regenerate then you might as well stick to the standard primes.
27495
27496 Arranging this is easy in principle; just delete the file when you want new
27497 values to be computed. However, there may be a problem. The calculation of new
27498 parameters needs random numbers, and these are obtained from &_/dev/random_&.
27499 If the system is not very active, &_/dev/random_& may delay returning data
27500 until enough randomness (entropy) is available. This may cause Exim to hang for
27501 a substantial amount of time, causing timeouts on incoming connections.
27502
27503 The solution is to generate the parameters externally to Exim. They are stored
27504 in &_gnutls-params-N_& in PEM format, which means that they can be
27505 generated externally using the &(certtool)& command that is part of GnuTLS.
27506
27507 To replace the parameters with new ones, instead of deleting the file
27508 and letting Exim re-create it, you can generate new parameters using
27509 &(certtool)& and, when this has been done, replace Exim's cache file by
27510 renaming. The relevant commands are something like this:
27511 .code
27512 # ls
27513 [ look for file; assume gnutls-params-2236 is the most recent ]
27514 # rm -f new-params
27515 # touch new-params
27516 # chown exim:exim new-params
27517 # chmod 0600 new-params
27518 # certtool --generate-dh-params --bits 2236 >>new-params
27519 # openssl dhparam -noout -text -in new-params | head
27520 [ check the first line, make sure it's not more than 2236;
27521   if it is, then go back to the start ("rm") and repeat
27522   until the size generated is at most the size requested ]
27523 # chmod 0400 new-params
27524 # mv new-params gnutls-params-2236
27525 .endd
27526 If Exim never has to generate the parameters itself, the possibility of
27527 stalling is removed.
27528
27529 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
27530 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
27531 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
27532 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
27533 and Exim does so.  This attempt to remove Exim from TLS policy decisions
27534 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
27535 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
27536 which applies to all D-H usage, client or server.  If the value returned by
27537 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
27538 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
27539 limit, which is still much higher than Exim historically used.
27540
27541 The filename and bits used will change as the GnuTLS maintainers change the
27542 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
27543 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
27544 2432 bits, while NSS is limited to 2236 bits.
27545
27546 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
27547 increase the chance of the generated prime actually being within acceptable
27548 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
27549 procedure above.  There is no sane procedure available to Exim to double-check
27550 the size of the generated prime, so it might still be too large.
27551
27552
27553 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
27554 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
27555 .oindex "&%tls_require_ciphers%&" "OpenSSL"
27556 There is a function in the OpenSSL library that can be passed a list of cipher
27557 suites before the cipher negotiation takes place. This specifies which ciphers
27558 .new
27559 are acceptable for TLS versions prior to 1.3.
27560 .wen
27561 The list is colon separated and may contain names like
27562 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
27563 directly to this function call.
27564 Many systems will install the OpenSSL manual-pages, so you may have
27565 &'ciphers(1)'& available to you.
27566 The following quotation from the OpenSSL
27567 documentation specifies what forms of item are allowed in the cipher string:
27568
27569 .ilist
27570 It can consist of a single cipher suite such as RC4-SHA.
27571 .next
27572 It can represent a list of cipher suites containing a certain algorithm,
27573 or cipher suites of a certain type. For example SHA1 represents all
27574 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
27575 SSL v3 algorithms.
27576 .next
27577 Lists of cipher suites can be combined in a single cipher string using
27578 the + character. This is used as a logical and operation. For example
27579 SHA1+DES represents all cipher suites containing the SHA1 and the DES
27580 algorithms.
27581 .endlist
27582
27583 Each cipher string can be optionally preceded by one of the characters &`!`&,
27584 &`-`& or &`+`&.
27585 .ilist
27586 If &`!`& is used, the ciphers are permanently deleted from the list. The
27587 ciphers deleted can never reappear in the list even if they are explicitly
27588 stated.
27589 .next
27590 If &`-`& is used, the ciphers are deleted from the list, but some or all
27591 of the ciphers can be added again by later options.
27592 .next
27593 If &`+`& is used, the ciphers are moved to the end of the list. This
27594 option does not add any new ciphers; it just moves matching existing ones.
27595 .endlist
27596
27597 If none of these characters is present, the string is interpreted as
27598 a list of ciphers to be appended to the current preference list. If the list
27599 includes any ciphers already present they will be ignored: that is, they will
27600 not be moved to the end of the list.
27601 .endlist
27602
27603 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
27604 string:
27605 .code
27606 # note single-quotes to get ! past any shell history expansion
27607 $ openssl ciphers 'HIGH:!MD5:!SHA1'
27608 .endd
27609
27610 This example will let the library defaults be permitted on the MX port, where
27611 there's probably no identity verification anyway, but ups the ante on the
27612 submission ports where the administrator might have some influence on the
27613 choice of clients used:
27614 .code
27615 # OpenSSL variant; see man ciphers(1)
27616 tls_require_ciphers = ${if =={$received_port}{25}\
27617                            {DEFAULT}\
27618                            {HIGH:!MD5:!SHA1}}
27619 .endd
27620
27621 This example will prefer ECDSA-authenticated ciphers over RSA ones:
27622 .code
27623 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
27624 .endd
27625
27626 .new
27627 For TLS version 1.3 the control available is less fine-grained
27628 and Exim does not provide access to it at present.
27629 The value of the &%tls_require_ciphers%& option is ignored when
27630 TLS version 1.3 is negotiated.
27631
27632 As of writing the library default cipher suite list for TLSv1.3 is
27633 .code
27634 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
27635 .endd
27636 .wen
27637
27638
27639 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
27640          "SECTreqciphgnu"
27641 .cindex "GnuTLS" "specifying parameters for"
27642 .cindex "TLS" "specifying ciphers (GnuTLS)"
27643 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
27644 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
27645 .cindex "TLS" "specifying protocols (GnuTLS)"
27646 .cindex "TLS" "specifying priority string (GnuTLS)"
27647 .oindex "&%tls_require_ciphers%&" "GnuTLS"
27648 The GnuTLS library allows the caller to provide a "priority string", documented
27649 as part of the &[gnutls_priority_init]& function.  This is very similar to the
27650 ciphersuite specification in OpenSSL.
27651
27652 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
27653 and controls both protocols and ciphers.
27654
27655 The &%tls_require_ciphers%& option is available both as an global option,
27656 controlling how Exim behaves as a server, and also as an option of the
27657 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
27658 the value is string expanded.  The resulting string is not an Exim list and
27659 the string is given to the GnuTLS library, so that Exim does not need to be
27660 aware of future feature enhancements of GnuTLS.
27661
27662 Documentation of the strings accepted may be found in the GnuTLS manual, under
27663 "Priority strings".  This is online as
27664 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
27665 but beware that this relates to GnuTLS 3, which may be newer than the version
27666 installed on your system.  If you are using GnuTLS 3,
27667 then the example code
27668 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
27669 on that site can be used to test a given string.
27670
27671 For example:
27672 .code
27673 # Disable older versions of protocols
27674 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
27675 .endd
27676
27677 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
27678 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
27679 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
27680
27681 This example will let the library defaults be permitted on the MX port, where
27682 there's probably no identity verification anyway, and lowers security further
27683 by increasing compatibility; but this ups the ante on the submission ports
27684 where the administrator might have some influence on the choice of clients
27685 used:
27686 .code
27687 # GnuTLS variant
27688 tls_require_ciphers = ${if =={$received_port}{25}\
27689                            {NORMAL:%COMPAT}\
27690                            {SECURE128}}
27691 .endd
27692
27693
27694 .section "Configuring an Exim server to use TLS" "SECID182"
27695 .cindex "TLS" "configuring an Exim server"
27696 When Exim has been built with TLS support, it advertises the availability of
27697 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
27698 but not to any others. The default value of this option is *, which means
27699 that STARTTLS is always advertised.  Set it to blank to never advertise;
27700 this is reasonable for systems that want to use TLS only as a client.
27701
27702 If STARTTLS is to be used you
27703 need to set some other options in order to make TLS available.
27704
27705 If a client issues a STARTTLS command and there is some configuration
27706 problem in the server, the command is rejected with a 454 error. If the client
27707 persists in trying to issue SMTP commands, all except QUIT are rejected
27708 with the error
27709 .code
27710 554 Security failure
27711 .endd
27712 If a STARTTLS command is issued within an existing TLS session, it is
27713 rejected with a 554 error code.
27714
27715 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
27716 must be set to match some hosts. The default is * which matches all hosts.
27717
27718 If this is all you do, TLS encryption will be enabled but not authentication -
27719 meaning that the peer has no assurance it is actually you he is talking to.
27720 You gain protection from a passive sniffer listening on the wire but not
27721 from someone able to intercept the communication.
27722
27723 Further protection requires some further configuration at the server end.
27724
27725 To make TLS work you need to set, in the server,
27726 .code
27727 tls_certificate = /some/file/name
27728 tls_privatekey = /some/file/name
27729 .endd
27730 These options are, in fact, expanded strings, so you can make them depend on
27731 the identity of the client that is connected if you wish. The first file
27732 contains the server's X509 certificate, and the second contains the private key
27733 that goes with it. These files need to be
27734 PEM format and readable by the Exim user, and must
27735 always be given as full path names.
27736 The key must not be password-protected.
27737 They can be the same file if both the
27738 certificate and the key are contained within it. If &%tls_privatekey%& is not
27739 set, or if its expansion is forced to fail or results in an empty string, this
27740 is assumed to be the case. The certificate file may also contain intermediate
27741 certificates that need to be sent to the client to enable it to authenticate
27742 the server's certificate.
27743
27744 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
27745 colon-separated lists of file paths.  Ciphers using given authentication
27746 algorithms require the presence of a suitable certificate to supply the
27747 public-key.  The server selects among the certificates to present to the
27748 client depending on the selected cipher, hence the priority ordering for
27749 ciphers will affect which certificate is used.
27750
27751 If you do not understand about certificates and keys, please try to find a
27752 source of this background information, which is not Exim-specific. (There are a
27753 few comments below in section &<<SECTcerandall>>&.)
27754
27755 &*Note*&: These options do not apply when Exim is operating as a client &--
27756 they apply only in the case of a server. If you need to use a certificate in an
27757 Exim client, you must set the options of the same names in an &(smtp)&
27758 transport.
27759
27760 With just these options, an Exim server will be able to use TLS. It does not
27761 require the client to have a certificate (but see below for how to insist on
27762 this). There is one other option that may be needed in other situations. If
27763 .code
27764 tls_dhparam = /some/file/name
27765 .endd
27766 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
27767 with the parameters contained in the file.
27768 Set this to &`none`& to disable use of DH entirely, by making no prime
27769 available:
27770 .code
27771 tls_dhparam = none
27772 .endd
27773 This may also be set to a string identifying a standard prime to be used for
27774 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
27775 used is &`ike23`&.  There are a few standard primes available, see the
27776 documentation for &%tls_dhparam%& for the complete list.
27777
27778 See the command
27779 .code
27780 openssl dhparam
27781 .endd
27782 for a way of generating file data.
27783
27784 The strings supplied for these three options are expanded every time a client
27785 host connects. It is therefore possible to use different certificates and keys
27786 for different hosts, if you so wish, by making use of the client's IP address
27787 in &$sender_host_address$& to control the expansion. If a string expansion is
27788 forced to fail, Exim behaves as if the option is not set.
27789
27790 .cindex "cipher" "logging"
27791 .cindex "log" "TLS cipher"
27792 .vindex "&$tls_in_cipher$&"
27793 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
27794 an incoming TLS connection. It is included in the &'Received:'& header of an
27795 incoming message (by default &-- you can, of course, change this), and it is
27796 also included in the log line that records a message's arrival, keyed by
27797 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
27798 condition can be used to test for specific cipher suites in ACLs.
27799
27800 Once TLS has been established, the ACLs that run for subsequent SMTP commands
27801 can check the name of the cipher suite and vary their actions accordingly. The
27802 cipher suite names vary, depending on which TLS library is being used. For
27803 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
27804 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
27805 documentation for more details.
27806
27807 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
27808 (again depending on the &%tls_cipher%& log selector).
27809
27810
27811 .section "Requesting and verifying client certificates" "SECID183"
27812 .cindex "certificate" "verification of client"
27813 .cindex "TLS" "client certificate verification"
27814 If you want an Exim server to request a certificate when negotiating a TLS
27815 session with a client, you must set either &%tls_verify_hosts%& or
27816 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
27817 apply to all TLS connections. For any host that matches one of these options,
27818 Exim requests a certificate as part of the setup of the TLS session. The
27819 contents of the certificate are verified by comparing it with a list of
27820 expected trust-anchors or certificates.
27821 These may be the system default set (depending on library version),
27822 an explicit file or,
27823 depending on library version, a directory, identified by
27824 &%tls_verify_certificates%&.
27825
27826 A file can contain multiple certificates, concatenated end to end. If a
27827 directory is used
27828 (OpenSSL only),
27829 each certificate must be in a separate file, with a name (or a symbolic link)
27830 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
27831 certificate. You can compute the relevant hash by running the command
27832 .code
27833 openssl x509 -hash -noout -in /cert/file
27834 .endd
27835 where &_/cert/file_& contains a single certificate.
27836
27837 There is no checking of names of the client against the certificate
27838 Subject Name or Subject Alternate Names.
27839
27840 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
27841 what happens if the client does not supply a certificate, or if the certificate
27842 does not match any of the certificates in the collection named by
27843 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
27844 attempt to set up a TLS session is aborted, and the incoming connection is
27845 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
27846 session continues. ACLs that run for subsequent SMTP commands can detect the
27847 fact that no certificate was verified, and vary their actions accordingly. For
27848 example, you can insist on a certificate before accepting a message for
27849 relaying, but not when the message is destined for local delivery.
27850
27851 .vindex "&$tls_in_peerdn$&"
27852 When a client supplies a certificate (whether it verifies or not), the value of
27853 the Distinguished Name of the certificate is made available in the variable
27854 &$tls_in_peerdn$& during subsequent processing of the message.
27855
27856 .cindex "log" "distinguished name"
27857 Because it is often a long text string, it is not included in the log line or
27858 &'Received:'& header by default. You can arrange for it to be logged, keyed by
27859 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
27860 &%received_header_text%& to change the &'Received:'& header. When no
27861 certificate is supplied, &$tls_in_peerdn$& is empty.
27862
27863
27864 .section "Revoked certificates" "SECID184"
27865 .cindex "TLS" "revoked certificates"
27866 .cindex "revocation list"
27867 .cindex "certificate" "revocation list"
27868 .cindex "OCSP" "stapling"
27869 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
27870 certificates are revoked. If you have such a list, you can pass it to an Exim
27871 server using the global option called &%tls_crl%& and to an Exim client using
27872 an identically named option for the &(smtp)& transport. In each case, the value
27873 of the option is expanded and must then be the name of a file that contains a
27874 CRL in PEM format.
27875 The downside is that clients have to periodically re-download a potentially huge
27876 file from every certificate authority they know of.
27877
27878 The way with most moving parts at query time is Online Certificate
27879 Status Protocol (OCSP), where the client verifies the certificate
27880 against an OCSP server run by the CA.  This lets the CA track all
27881 usage of the certs.  It requires running software with access to the
27882 private key of the CA, to sign the responses to the OCSP queries.  OCSP
27883 is based on HTTP and can be proxied accordingly.
27884
27885 The only widespread OCSP server implementation (known to this writer)
27886 comes as part of OpenSSL and aborts on an invalid request, such as
27887 connecting to the port and then disconnecting.  This requires
27888 re-entering the passphrase each time some random client does this.
27889
27890 The third way is OCSP Stapling; in this, the server using a certificate
27891 issued by the CA periodically requests an OCSP proof of validity from
27892 the OCSP server, then serves it up inline as part of the TLS
27893 negotiation.   This approach adds no extra round trips, does not let the
27894 CA track users, scales well with number of certs issued by the CA and is
27895 resilient to temporary OCSP server failures, as long as the server
27896 starts retrying to fetch an OCSP proof some time before its current
27897 proof expires.  The downside is that it requires server support.
27898
27899 Unless Exim is built with the support disabled,
27900 or with GnuTLS earlier than version 3.3.16 / 3.4.8
27901 support for OCSP stapling is included.
27902
27903 There is a global option called &%tls_ocsp_file%&.
27904 The file specified therein is expected to be in DER format, and contain
27905 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
27906 option will be re-expanded for SNI, if the &%tls_certificate%& option
27907 contains &`tls_in_sni`&, as per other TLS options.
27908
27909 Exim does not at this time implement any support for fetching a new OCSP
27910 proof.  The burden is on the administrator to handle this, outside of
27911 Exim.  The file specified should be replaced atomically, so that the
27912 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
27913 on each connection, so a new file will be handled transparently on the
27914 next connection.
27915
27916 When built with OpenSSL Exim will check for a valid next update timestamp
27917 in the OCSP proof; if not present, or if the proof has expired, it will be
27918 ignored.
27919
27920 For the client to be able to verify the stapled OCSP the server must
27921 also supply, in its stapled information, any intermediate
27922 certificates for the chain leading to the OCSP proof from the signer
27923 of the server certificate.  There may be zero or one such. These
27924 intermediate certificates should be added to the server OCSP stapling
27925 file named by &%tls_ocsp_file%&.
27926
27927 Note that the proof only covers the terminal server certificate,
27928 not any of the chain from CA to it.
27929
27930 There is no current way to staple a proof for a client certificate.
27931
27932 .code
27933   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
27934   OCSP server is supplied.  The server URL may be included in the
27935   server certificate, if the CA is helpful.
27936
27937   One failure mode seen was the OCSP Signer cert expiring before the end
27938   of validity of the OCSP proof. The checking done by Exim/OpenSSL
27939   noted this as invalid overall, but the re-fetch script did not.
27940 .endd
27941
27942
27943
27944
27945 .section "Configuring an Exim client to use TLS" "SECID185"
27946 .cindex "cipher" "logging"
27947 .cindex "log" "TLS cipher"
27948 .cindex "log" "distinguished name"
27949 .cindex "TLS" "configuring an Exim client"
27950 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
27951 deliveries as well as to incoming, the latter one causing logging of the
27952 server certificate's DN. The remaining client configuration for TLS is all
27953 within the &(smtp)& transport.
27954
27955 It is not necessary to set any options to have TLS work in the &(smtp)&
27956 transport. If Exim is built with TLS support, and TLS is advertised by a
27957 server, the &(smtp)& transport always tries to start a TLS session. However,
27958 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
27959 transport) to a list of server hosts for which TLS should not be used.
27960
27961 If you do not want Exim to attempt to send messages unencrypted when an attempt
27962 to set up an encrypted connection fails in any way, you can set
27963 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
27964 those hosts, delivery is always deferred if an encrypted connection cannot be
27965 set up. If there are any other hosts for the address, they are tried in the
27966 usual way.
27967
27968 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
27969 the message unencrypted. It always does this if the response to STARTTLS is
27970 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
27971 session after a success response code, what happens is controlled by the
27972 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
27973 delivery to this host is deferred, and other hosts (if available) are tried. If
27974 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
27975 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
27976 negotiation fails, Exim closes the current connection (because it is in an
27977 unknown state), opens a new one to the same host, and then tries the delivery
27978 unencrypted.
27979
27980 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
27981 transport provide the client with a certificate, which is passed to the server
27982 if it requests it. If the server is Exim, it will request a certificate only if
27983 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
27984
27985 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
27986 specifies a collection of expected server certificates.
27987 These may be
27988 the system default set (depending on library version),
27989 a file,
27990 or (depending on library version) a directory.
27991 The client verifies the server's certificate
27992 against this collection, taking into account any revoked certificates that are
27993 in the list defined by &%tls_crl%&.
27994 Failure to verify fails the TLS connection unless either of the
27995 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
27996
27997 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
27998 certificate verification to the listed servers.  Verification either must
27999 or need not succeed respectively.
28000
28001 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
28002 checks are made: that the host name (the one in the DNS A record)
28003 is valid for the certificate.
28004 The option defaults to always checking.
28005
28006 The &(smtp)& transport has two OCSP-related options:
28007 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
28008 is requested and required for the connection to proceed.  The default
28009 value is empty.
28010 &%hosts_request_ocsp%&; a host-list for which (additionally)
28011 a Certificate Status is requested (but not necessarily verified).  The default
28012 value is "*" meaning that requests are made unless configured
28013 otherwise.
28014
28015 The host(s) should also be in &%hosts_require_tls%&, and
28016 &%tls_verify_certificates%& configured for the transport,
28017 for OCSP to be relevant.
28018
28019 If
28020 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
28021 list of permitted cipher suites. If either of these checks fails, delivery to
28022 the current host is abandoned, and the &(smtp)& transport tries to deliver to
28023 alternative hosts, if any.
28024
28025  &*Note*&:
28026 These options must be set in the &(smtp)& transport for Exim to use TLS when it
28027 is operating as a client. Exim does not assume that a server certificate (set
28028 by the global options of the same name) should also be used when operating as a
28029 client.
28030
28031 .vindex "&$host$&"
28032 .vindex "&$host_address$&"
28033 All the TLS options in the &(smtp)& transport are expanded before use, with
28034 &$host$& and &$host_address$& containing the name and address of the server to
28035 which the client is connected. Forced failure of an expansion causes Exim to
28036 behave as if the relevant option were unset.
28037
28038 .vindex &$tls_out_bits$&
28039 .vindex &$tls_out_cipher$&
28040 .vindex &$tls_out_peerdn$&
28041 .vindex &$tls_out_sni$&
28042 Before an SMTP connection is established, the
28043 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
28044 variables are emptied. (Until the first connection, they contain the values
28045 that were set when the message was received.) If STARTTLS is subsequently
28046 successfully obeyed, these variables are set to the relevant values for the
28047 outgoing connection.
28048
28049
28050
28051 .section "Use of TLS Server Name Indication" "SECTtlssni"
28052 .cindex "TLS" "Server Name Indication"
28053 .vindex "&$tls_in_sni$&"
28054 .oindex "&%tls_in_sni%&"
28055 With TLS1.0 or above, there is an extension mechanism by which extra
28056 information can be included at various points in the protocol.  One of these
28057 extensions, documented in RFC 6066 (and before that RFC 4366) is
28058 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
28059 client in the initial handshake, so that the server can examine the servername
28060 within and possibly choose to use different certificates and keys (and more)
28061 for this session.
28062
28063 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
28064 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
28065 address.
28066
28067 With SMTP to MX, there are the same problems here as in choosing the identity
28068 against which to validate a certificate: you can't rely on insecure DNS to
28069 provide the identity which you then cryptographically verify.  So this will
28070 be of limited use in that environment.
28071
28072 With SMTP to Submission, there is a well-defined hostname which clients are
28073 connecting to and can validate certificates against.  Thus clients &*can*&
28074 choose to include this information in the TLS negotiation.  If this becomes
28075 wide-spread, then hosters can choose to present different certificates to
28076 different clients.  Or even negotiate different cipher suites.
28077
28078 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
28079 if not empty, will be sent on a TLS session as part of the handshake.  There's
28080 nothing more to it.  Choosing a sensible value not derived insecurely is the
28081 only point of caution.  The &$tls_out_sni$& variable will be set to this string
28082 for the lifetime of the client connection (including during authentication).
28083
28084 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
28085 received from a client.
28086 It can be logged with the &%log_selector%& item &`+tls_sni`&.
28087
28088 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
28089 option (prior to expansion) then the following options will be re-expanded
28090 during TLS session handshake, to permit alternative values to be chosen:
28091
28092 .ilist
28093 &%tls_certificate%&
28094 .next
28095 &%tls_crl%&
28096 .next
28097 &%tls_privatekey%&
28098 .next
28099 &%tls_verify_certificates%&
28100 .next
28101 &%tls_ocsp_file%&
28102 .endlist
28103
28104 Great care should be taken to deal with matters of case, various injection
28105 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
28106 can always be referenced; it is important to remember that &$tls_in_sni$& is
28107 arbitrary unverified data provided prior to authentication.
28108 Further, the initial certificate is loaded before SNI is arrived, so
28109 an expansion for &%tls_certificate%& must have a default which is used
28110 when &$tls_in_sni$& is empty.
28111
28112 The Exim developers are proceeding cautiously and so far no other TLS options
28113 are re-expanded.
28114
28115 When Exim is built against OpenSSL, OpenSSL must have been built with support
28116 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
28117 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
28118 see &`-servername`& in the output, then OpenSSL has support.
28119
28120 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
28121 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
28122 built, then you have SNI support).
28123
28124
28125
28126 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
28127          "SECTmulmessam"
28128 .cindex "multiple SMTP deliveries with TLS"
28129 .cindex "TLS" "multiple message deliveries"
28130 Exim sends multiple messages down the same TCP/IP connection by starting up
28131 an entirely new delivery process for each message, passing the socket from
28132 one process to the next. This implementation does not fit well with the use
28133 of TLS, because there is quite a lot of state information associated with a TLS
28134 connection, not just a socket identification. Passing all the state information
28135 to a new process is not feasible. Consequently, for sending using TLS Exim
28136 starts an additional proxy process for handling the encryption, piping the
28137 unencrypted data stream from and to the delivery processes.
28138
28139 An older mode of operation can be enabled on a per-host basis by the
28140 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
28141 this list the proxy process described above is not used; instead Exim
28142 shuts down an existing TLS session being run by the delivery process
28143 before passing the socket to a new process. The new process may then
28144 try to start a new TLS session, and if successful, may try to re-authenticate
28145 if AUTH is in use, before sending the next message.
28146
28147 The RFC is not clear as to whether or not an SMTP session continues in clear
28148 after TLS has been shut down, or whether TLS may be restarted again later, as
28149 just described. However, if the server is Exim, this shutdown and
28150 reinitialization works. It is not known which (if any) other servers operate
28151 successfully if the client closes a TLS session and continues with unencrypted
28152 SMTP, but there are certainly some that do not work. For such servers, Exim
28153 should not pass the socket to another process, because the failure of the
28154 subsequent attempt to use it would cause Exim to record a temporary host error,
28155 and delay other deliveries to that host.
28156
28157 To test for this case, Exim sends an EHLO command to the server after
28158 closing down the TLS session. If this fails in any way, the connection is
28159 closed instead of being passed to a new delivery process, but no retry
28160 information is recorded.
28161
28162 There is also a manual override; you can set &%hosts_nopass_tls%& on the
28163 &(smtp)& transport to match those hosts for which Exim should not pass
28164 connections to new processes if TLS has been used.
28165
28166
28167
28168
28169 .section "Certificates and all that" "SECTcerandall"
28170 .cindex "certificate" "references to discussion"
28171 In order to understand fully how TLS works, you need to know about
28172 certificates, certificate signing, and certificate authorities.
28173 This is a large topic and an introductory guide is unsuitable for the Exim
28174 reference manual, so instead we provide pointers to existing documentation.
28175
28176 The Apache web-server was for a long time the canonical guide, so their
28177 documentation is a good place to start; their SSL module's Introduction
28178 document is currently at
28179 .display
28180 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
28181 .endd
28182 and their FAQ is at
28183 .display
28184 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
28185 .endd
28186
28187 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
28188 0-201-61598-3) in 2001, contains both introductory and more in-depth
28189 descriptions.
28190 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
28191 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
28192 Ivan is the author of the popular TLS testing tools at
28193 &url(https://www.ssllabs.com/).
28194
28195
28196 .section "Certificate chains" "SECID186"
28197 The file named by &%tls_certificate%& may contain more than one
28198 certificate. This is useful in the case where the certificate that is being
28199 sent is validated by an intermediate certificate which the other end does
28200 not have. Multiple certificates must be in the correct order in the file.
28201 First the host's certificate itself, then the first intermediate
28202 certificate to validate the issuer of the host certificate, then the next
28203 intermediate certificate to validate the issuer of the first intermediate
28204 certificate, and so on, until finally (optionally) the root certificate.
28205 The root certificate must already be trusted by the recipient for
28206 validation to succeed, of course, but if it's not preinstalled, sending the
28207 root certificate along with the rest makes it available for the user to
28208 install if the receiving end is a client MUA that can interact with a user.
28209
28210 Note that certificates using MD5 are unlikely to work on today's Internet;
28211 even if your libraries allow loading them for use in Exim when acting as a
28212 server, increasingly clients will not accept such certificates.  The error
28213 diagnostics in such a case can be frustratingly vague.
28214
28215
28216
28217 .section "Self-signed certificates" "SECID187"
28218 .cindex "certificate" "self-signed"
28219 You can create a self-signed certificate using the &'req'& command provided
28220 with OpenSSL, like this:
28221 . ==== Do not shorten the duration here without reading and considering
28222 . ==== the text below.  Please leave it at 9999 days.
28223 .code
28224 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
28225             -days 9999 -nodes
28226 .endd
28227 &_file1_& and &_file2_& can be the same file; the key and the certificate are
28228 delimited and so can be identified independently. The &%-days%& option
28229 specifies a period for which the certificate is valid. The &%-nodes%& option is
28230 important: if you do not set it, the key is encrypted with a passphrase
28231 that you are prompted for, and any use that is made of the key causes more
28232 prompting for the passphrase. This is not helpful if you are going to use
28233 this certificate and key in an MTA, where prompting is not possible.
28234
28235 . ==== I expect to still be working 26 years from now.  The less technical
28236 . ==== debt I create, in terms of storing up trouble for my later years, the
28237 . ==== happier I will be then.  We really have reached the point where we
28238 . ==== should start, at the very least, provoking thought and making folks
28239 . ==== pause before proceeding, instead of leaving all the fixes until two
28240 . ==== years before 2^31 seconds after the 1970 Unix epoch.
28241 . ==== -pdp, 2012
28242 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
28243 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
28244 the above command might produce a date in the past.  Think carefully about
28245 the lifetime of the systems you're deploying, and either reduce the duration
28246 of the certificate or reconsider your platform deployment.  (At time of
28247 writing, reducing the duration is the most likely choice, but the inexorable
28248 progression of time takes us steadily towards an era where this will not
28249 be a sensible resolution).
28250
28251 A self-signed certificate made in this way is sufficient for testing, and
28252 may be adequate for all your requirements if you are mainly interested in
28253 encrypting transfers, and not in secure identification.
28254
28255 However, many clients require that the certificate presented by the server be a
28256 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
28257 certificate. In this situation, the self-signed certificate described above
28258 must be installed on the client host as a trusted root &'certification
28259 authority'& (CA), and the certificate used by Exim must be a user certificate
28260 signed with that self-signed certificate.
28261
28262 For information on creating self-signed CA certificates and using them to sign
28263 user certificates, see the &'General implementation overview'& chapter of the
28264 Open-source PKI book, available online at
28265 &url(https://sourceforge.net/projects/ospkibook/).
28266 .ecindex IIDencsmtp1
28267 .ecindex IIDencsmtp2
28268
28269
28270
28271 .section DANE "SECDANE"
28272 .cindex DANE
28273 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
28274 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
28275 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
28276 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
28277 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
28278 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
28279
28280 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
28281 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
28282 by (a) is thought to be smaller than that of the set of root CAs.
28283
28284 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
28285 fail to pass on a server's STARTTLS.
28286
28287 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
28288 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
28289 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
28290
28291 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
28292 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
28293 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
28294 DNSSEC.
28295 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
28296 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
28297
28298 There are no changes to Exim specific to server-side operation of DANE.
28299 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
28300 in &_Local/Makefile_&.
28301 If it has been included, the macro "_HAVE_DANE" will be defined.
28302
28303 The TLSA record for the server may have "certificate usage" of DANE-TA(2) or DANE-EE(3).
28304 These are the "Trust Anchor" and "End Entity" variants.
28305 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
28306 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
28307 this is appropriate for a single system, using a self-signed certificate.
28308 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
28309 well-known one.
28310 A private CA at simplest is just a self-signed certificate (with certain
28311 attributes) which is used to sign server certificates, but running one securely
28312 does require careful arrangement.
28313 With DANE-TA, as implemented in Exim and commonly in other MTAs,
28314 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
28315 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
28316 all of which point to a single TLSA record.
28317 DANE-TA and DANE-EE can both be used together.
28318
28319 .new
28320 Our recommendation is to use DANE with a certificate from a public CA,
28321 because this enables a variety of strategies for remote clients to verify
28322 your certificate.
28323 You can then publish information both via DANE and another technology,
28324 "MTA-STS", described below.
28325
28326 When you use DANE-TA to publish trust anchor information, you ask entities
28327 outside your administrative control to trust the Certificate Authority for
28328 connections to you.
28329 If using a private CA then you should expect others to still apply the
28330 technical criteria they'd use for a public CA to your certificates.
28331 In particular, you should probably try to follow current best practices for CA
28332 operation around hash algorithms and key sizes.
28333 Do not expect other organizations to lower their security expectations just
28334 because a particular profile might be reasonable for your own internal use.
28335
28336 When this text was last updated, this in practice means to avoid use of SHA-1
28337 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
28338 than 4096, for interoperability); to use keyUsage fields correctly; to use
28339 random serial numbers.
28340 The list of requirements is subject to change as best practices evolve.
28341 If you're not already using a private CA, or it doesn't meet these
28342 requirements, then we encourage you to avoid all these issues and use a public
28343 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
28344 .wen
28345
28346 The TLSA record should have a Selector field of SPKI(1) and a Matching Type field of SHA2-512(2).
28347
28348 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
28349 is useful for quickly generating TLSA records; and commands like
28350
28351 .code
28352   openssl x509 -in -pubkey -noout <certificate.pem \
28353   | openssl rsa -outform der -pubin 2>/dev/null \
28354   | openssl sha512 \
28355   | awk '{print $2}'
28356 .endd
28357
28358 are workable for 4th-field hashes.
28359
28360 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
28361
28362 .new
28363 The Certificate issued by the CA published in the DANE-TA model should be
28364 issued using a strong hash algorithm.
28365 Exim, and importantly various other MTAs sending to you, will not
28366 re-enable hash algorithms which have been disabled by default in TLS
28367 libraries.
28368 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
28369 interoperability (and probably the maximum too, in 2018).
28370 .wen
28371
28372 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
28373 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
28374 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
28375
28376 .code
28377   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
28378                                  {= {4}{$tls_out_tlsa_usage}} } \
28379                          {*}{}}
28380 .endd
28381
28382 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
28383 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
28384 found. If the definition of &%hosts_request_ocsp%& includes the
28385 string "tls_out_tlsa_usage", they are re-expanded in time to
28386 control the OCSP request.
28387
28388 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
28389 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
28390
28391
28392 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
28393 and &%dane_require_tls_ciphers%&.
28394 The require variant will result in failure if the target host is not DNSSEC-secured.
28395
28396 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
28397
28398 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
28399 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
28400 will be required for the host.  If it does not, the host will not
28401 be used; there is no fallback to non-DANE or non-TLS.
28402
28403 If DANE is requested and usable, then the TLS cipher list configuration
28404 prefers to use the option &%dane_require_tls_ciphers%& and falls
28405 back to &%tls_require_ciphers%& only if that is unset.
28406 This lets you configure "decent crypto" for DANE and "better than nothing
28407 crypto" as the default.  Note though that while GnuTLS lets the string control
28408 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
28409 limited to ciphersuite constraints.
28410
28411 If DANE is requested and useable (see above) the following transport options are ignored:
28412 .code
28413   hosts_require_tls
28414   tls_verify_hosts
28415   tls_try_verify_hosts
28416   tls_verify_certificates
28417   tls_crl
28418   tls_verify_cert_hostnames
28419 .endd
28420
28421 If DANE is not usable, whether requested or not, and CA-anchored
28422 verification evaluation is wanted, the above variables should be set appropriately.
28423
28424 Currently the &%dnssec_request_domains%& must be active and &%dnssec_require_domains%& is ignored.
28425
28426 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
28427
28428 There is a new variable &$tls_out_dane$& which will have "yes" if
28429 verification succeeded using DANE and "no" otherwise (only useful
28430 in combination with events; see &<<CHAPevents>>&),
28431 and a new variable &$tls_out_tlsa_usage$& (detailed above).
28432
28433 .cindex DANE reporting
28434 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
28435 to achieve DANE-verified connection, if one was either requested and offered, or
28436 required.  This is intended to support TLS-reporting as defined in
28437 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
28438 The &$event_data$& will be one of the Result Types defined in
28439 Section 4.3 of that document.
28440
28441 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
28442
28443 DANE is specified in published RFCs and decouples certificate authority trust
28444 selection from a "race to the bottom" of "you must trust everything for mail
28445 to get through".  There is an alternative technology called MTA-STS, which
28446 instead publishes MX trust anchor information on an HTTPS website.  At the
28447 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
28448 Exim has no support for MTA-STS as a client, but Exim mail server operators
28449 can choose to publish information describing their TLS configuration using
28450 MTA-STS to let those clients who do use that protocol derive trust
28451 information.
28452
28453 The MTA-STS design requires a certificate from a public Certificate Authority
28454 which is recognized by clients sending to you.
28455 That selection of which CAs are trusted by others is outside your control.
28456
28457 The most interoperable course of action is probably to use
28458 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
28459 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
28460 records for DANE clients (such as Exim and Postfix) and to publish anchor
28461 information for MTA-STS as well.  This is what is done for the &'exim.org'&
28462 domain itself (with caveats around occasionally broken MTA-STS because of
28463 incompatible specification changes prior to reaching RFC status).
28464
28465
28466
28467 . ////////////////////////////////////////////////////////////////////////////
28468 . ////////////////////////////////////////////////////////////////////////////
28469
28470 .chapter "Access control lists" "CHAPACL"
28471 .scindex IIDacl "&ACL;" "description"
28472 .cindex "control of incoming mail"
28473 .cindex "message" "controlling incoming"
28474 .cindex "policy control" "access control lists"
28475 Access Control Lists (ACLs) are defined in a separate section of the run time
28476 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
28477 name, terminated by a colon. Here is a complete ACL section that contains just
28478 one very small ACL:
28479 .code
28480 begin acl
28481 small_acl:
28482   accept   hosts = one.host.only
28483 .endd
28484 You can have as many lists as you like in the ACL section, and the order in
28485 which they appear does not matter. The lists are self-terminating.
28486
28487 The majority of ACLs are used to control Exim's behaviour when it receives
28488 certain SMTP commands. This applies both to incoming TCP/IP connections, and
28489 when a local process submits a message using SMTP by specifying the &%-bs%&
28490 option. The most common use is for controlling which recipients are accepted
28491 in incoming messages. In addition, you can define an ACL that is used to check
28492 local non-SMTP messages. The default configuration file contains an example of
28493 a realistic ACL for checking RCPT commands. This is discussed in chapter
28494 &<<CHAPdefconfil>>&.
28495
28496
28497 .section "Testing ACLs" "SECID188"
28498 The &%-bh%& command line option provides a way of testing your ACL
28499 configuration locally by running a fake SMTP session with which you interact.
28500
28501
28502 .section "Specifying when ACLs are used" "SECID189"
28503 .cindex "&ACL;" "options for specifying"
28504 In order to cause an ACL to be used, you have to name it in one of the relevant
28505 options in the main part of the configuration. These options are:
28506 .cindex "AUTH" "ACL for"
28507 .cindex "DATA" "ACLs for"
28508 .cindex "ETRN" "ACL for"
28509 .cindex "EXPN" "ACL for"
28510 .cindex "HELO" "ACL for"
28511 .cindex "EHLO" "ACL for"
28512 .cindex "DKIM" "ACL for"
28513 .cindex "MAIL" "ACL for"
28514 .cindex "QUIT, ACL for"
28515 .cindex "RCPT" "ACL for"
28516 .cindex "STARTTLS, ACL for"
28517 .cindex "VRFY" "ACL for"
28518 .cindex "SMTP" "connection, ACL for"
28519 .cindex "non-SMTP messages" "ACLs for"
28520 .cindex "MIME content scanning" "ACL for"
28521 .cindex "PRDR" "ACL for"
28522
28523 .table2 140pt
28524 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
28525 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
28526 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
28527 .irow &%acl_smtp_auth%&        "ACL for AUTH"
28528 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
28529 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
28530 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
28531 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
28532 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
28533 .irow &%acl_smtp_expn%&        "ACL for EXPN"
28534 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
28535 .irow &%acl_smtp_mail%&        "ACL for MAIL"
28536 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
28537 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
28538 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
28539 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
28540 .irow &%acl_smtp_quit%&        "ACL for QUIT"
28541 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
28542 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
28543 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
28544 .endtable
28545
28546 For example, if you set
28547 .code
28548 acl_smtp_rcpt = small_acl
28549 .endd
28550 the little ACL defined above is used whenever Exim receives a RCPT command
28551 in an SMTP dialogue. The majority of policy tests on incoming messages can be
28552 done when RCPT commands arrive. A rejection of RCPT should cause the
28553 sending MTA to give up on the recipient address contained in the RCPT
28554 command, whereas rejection at other times may cause the client MTA to keep on
28555 trying to deliver the message. It is therefore recommended that you do as much
28556 testing as possible at RCPT time.
28557
28558
28559 .section "The non-SMTP ACLs" "SECID190"
28560 .cindex "non-SMTP messages" "ACLs for"
28561 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
28562 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
28563 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
28564 the state of the SMTP connection such as encryption and authentication) are not
28565 relevant and are forbidden in these ACLs. However, the sender and recipients
28566 are known, so the &%senders%& and &%sender_domains%& conditions and the
28567 &$sender_address$& and &$recipients$& variables can be used. Variables such as
28568 &$authenticated_sender$& are also available. You can specify added header lines
28569 in any of these ACLs.
28570
28571 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
28572 non-SMTP message, before any of the message has been read. (This is the
28573 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
28574 batched SMTP input, it runs after the DATA command has been reached. The
28575 result of this ACL is ignored; it cannot be used to reject a message. If you
28576 really need to, you could set a value in an ACL variable here and reject based
28577 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
28578 controls, and in particular, it can be used to set
28579 .code
28580 control = suppress_local_fixups
28581 .endd
28582 This cannot be used in the other non-SMTP ACLs because by the time they are
28583 run, it is too late.
28584
28585 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
28586 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
28587
28588 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
28589 kind of rejection is treated as permanent, because there is no way of sending a
28590 temporary error for these kinds of message.
28591
28592
28593 .section "The SMTP connect ACL" "SECID191"
28594 .cindex "SMTP" "connection, ACL for"
28595 .oindex &%smtp_banner%&
28596 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
28597 session, after the test specified by &%host_reject_connection%& (which is now
28598 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
28599 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
28600 the message override the banner message that is otherwise specified by the
28601 &%smtp_banner%& option.
28602
28603
28604 .section "The EHLO/HELO ACL" "SECID192"
28605 .cindex "EHLO" "ACL for"
28606 .cindex "HELO" "ACL for"
28607 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
28608 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
28609 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
28610 Note that a client may issue more than one EHLO or HELO command in an SMTP
28611 session, and indeed is required to issue a new EHLO or HELO after successfully
28612 setting up encryption following a STARTTLS command.
28613
28614 Note also that a deny neither forces the client to go away nor means that
28615 mail will be refused on the connection.  Consider checking for
28616 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
28617
28618 If the command is accepted by an &%accept%& verb that has a &%message%&
28619 modifier, the message may not contain more than one line (it will be truncated
28620 at the first newline and a panic logged if it does). Such a message cannot
28621 affect the EHLO options that are listed on the second and subsequent lines of
28622 an EHLO response.
28623
28624
28625 .section "The DATA ACLs" "SECID193"
28626 .cindex "DATA" "ACLs for"
28627 Two ACLs are associated with the DATA command, because it is two-stage
28628 command, with two responses being sent to the client.
28629 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
28630 is obeyed. This gives you control after all the RCPT commands, but before
28631 the message itself is received. It offers the opportunity to give a negative
28632 response to the DATA command before the data is transmitted. Header lines
28633 added by MAIL or RCPT ACLs are not visible at this time, but any that
28634 are defined here are visible when the &%acl_smtp_data%& ACL is run.
28635
28636 You cannot test the contents of the message, for example, to verify addresses
28637 in the headers, at RCPT time or when the DATA command is received. Such
28638 tests have to appear in the ACL that is run after the message itself has been
28639 received, before the final response to the DATA command is sent. This is
28640 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
28641 associated with the DATA command.
28642
28643 .cindex CHUNKING "BDAT command"
28644 .cindex BDAT "SMTP command"
28645 .cindex "RFC 3030" CHUNKING
28646 If CHUNKING was advertised and a BDAT command sequence is received,
28647 the &%acl_smtp_predata%& ACL is not run.
28648 . XXX why not?  It should be possible, for the first BDAT.
28649 The &%acl_smtp_data%& is run after the last BDAT command and all of
28650 the data specified is received.
28651
28652 For both of these ACLs, it is not possible to reject individual recipients. An
28653 error response rejects the entire message. Unfortunately, it is known that some
28654 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
28655 before or after the data) correctly &-- they keep the message on their queues
28656 and try again later, but that is their problem, though it does waste some of
28657 your resources.
28658
28659 The &%acl_smtp_data%& ACL is run after
28660 the &%acl_smtp_data_prdr%&,
28661 the &%acl_smtp_dkim%&
28662 and the &%acl_smtp_mime%& ACLs.
28663
28664 .section "The SMTP DKIM ACL" "SECTDKIMACL"
28665 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
28666 enabled (which is the default).
28667
28668 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
28669 received, and is executed for each DKIM signature found in a message.  If not
28670 otherwise specified, the default action is to accept.
28671
28672 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
28673
28674 For details on the operation of DKIM, see section &<<SECDKIM>>&.
28675
28676
28677 .section "The SMTP MIME ACL" "SECID194"
28678 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
28679 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
28680
28681 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
28682
28683
28684 .section "The SMTP PRDR ACL" "SECTPRDRACL"
28685 .cindex "PRDR" "ACL for"
28686 .oindex "&%prdr_enable%&"
28687 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
28688 with PRDR support enabled (which is the default).
28689 It becomes active only when the PRDR feature is negotiated between
28690 client and server for a message, and more than one recipient
28691 has been accepted.
28692
28693 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
28694 has been received, and is executed once for each recipient of the message
28695 with &$local_part$& and &$domain$& valid.
28696 The test may accept, defer or deny for individual recipients.
28697 The &%acl_smtp_data%& will still be called after this ACL and
28698 can reject the message overall, even if this ACL has accepted it
28699 for some or all recipients.
28700
28701 PRDR may be used to support per-user content filtering.  Without it
28702 one must defer any recipient after the first that has a different
28703 content-filter configuration.  With PRDR, the RCPT-time check
28704 .cindex "PRDR" "variable for"
28705 for this can be disabled when the variable &$prdr_requested$&
28706 is &"yes"&.
28707 Any required difference in behaviour of the main DATA-time
28708 ACL should however depend on the PRDR-time ACL having run, as Exim
28709 will avoid doing so in some situations (e.g.  single-recipient mails).
28710
28711 See also the &%prdr_enable%& global option
28712 and the &%hosts_try_prdr%& smtp transport option.
28713
28714 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
28715 If the ACL is not defined, processing completes as if
28716 the feature was not requested by the client.
28717
28718 .section "The QUIT ACL" "SECTQUITACL"
28719 .cindex "QUIT, ACL for"
28720 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
28721 does not affect the response code to QUIT, which is always 221. Thus, the ACL
28722 does not in fact control any access.
28723 For this reason, it may only accept
28724 or warn as its final result.
28725
28726 This ACL can be used for tasks such as custom logging at the end of an SMTP
28727 session. For example, you can use ACL variables in other ACLs to count
28728 messages, recipients, etc., and log the totals at QUIT time using one or
28729 more &%logwrite%& modifiers on a &%warn%& verb.
28730
28731 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
28732 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
28733
28734 You do not need to have a final &%accept%&, but if you do, you can use a
28735 &%message%& modifier to specify custom text that is sent as part of the 221
28736 response to QUIT.
28737
28738 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
28739 failure (for example, failure to open a log file, or when Exim is bombing out
28740 because it has detected an unrecoverable error), all SMTP commands from the
28741 client are given temporary error responses until QUIT is received or the
28742 connection is closed. In these special cases, the QUIT ACL does not run.
28743
28744
28745 .section "The not-QUIT ACL" "SECTNOTQUITACL"
28746 .vindex &$acl_smtp_notquit$&
28747 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
28748 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
28749 trouble, such as being unable to write to its log files, this ACL is not run,
28750 because it might try to do things (such as write to log files) that make the
28751 situation even worse.
28752
28753 Like the QUIT ACL, this ACL is provided to make it possible to do customized
28754 logging or to gather statistics, and its outcome is ignored. The &%delay%&
28755 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
28756 and &%warn%&.
28757
28758 .vindex &$smtp_notquit_reason$&
28759 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
28760 to a string that indicates the reason for the termination of the SMTP
28761 connection. The possible values are:
28762 .table2
28763 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
28764 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
28765 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
28766 .irow &`connection-lost`&          "The SMTP connection has been lost"
28767 .irow &`data-timeout`&             "Timeout while reading message data"
28768 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
28769 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
28770 .irow &`signal-exit`&              "SIGTERM or SIGINT"
28771 .irow &`synchronization-error`&    "SMTP synchronization error"
28772 .irow &`tls-failed`&               "TLS failed to start"
28773 .endtable
28774 In most cases when an SMTP connection is closed without having received QUIT,
28775 Exim sends an SMTP response message before actually closing the connection.
28776 With the exception of the &`acl-drop`& case, the default message can be
28777 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
28778 &%drop%& verb in another ACL, it is the message from the other ACL that is
28779 used.
28780
28781
28782 .section "Finding an ACL to use" "SECID195"
28783 .cindex "&ACL;" "finding which to use"
28784 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
28785 you can use different ACLs in different circumstances. For example,
28786 .code
28787 acl_smtp_rcpt = ${if ={25}{$interface_port} \
28788                      {acl_check_rcpt} {acl_check_rcpt_submit} }
28789 .endd
28790 In the default configuration file there are some example settings for
28791 providing an RFC 4409 message &"submission"& service on port 587 and
28792 an RFC 8314 &"submissions"& service on port 465. You can use a string
28793 expansion like this to choose an ACL for MUAs on these ports which is
28794 more appropriate for this purpose than the default ACL on port 25.
28795
28796 The expanded string does not have to be the name of an ACL in the
28797 configuration file; there are other possibilities. Having expanded the
28798 string, Exim searches for an ACL as follows:
28799
28800 .ilist
28801 If the string begins with a slash, Exim uses it as a file name, and reads its
28802 contents as an ACL. The lines are processed in the same way as lines in the
28803 Exim configuration file. In particular, continuation lines are supported, blank
28804 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
28805 If the file does not exist or cannot be read, an error occurs (typically
28806 causing a temporary failure of whatever caused the ACL to be run). For example:
28807 .code
28808 acl_smtp_data = /etc/acls/\
28809   ${lookup{$sender_host_address}lsearch\
28810   {/etc/acllist}{$value}{default}}
28811 .endd
28812 This looks up an ACL file to use on the basis of the host's IP address, falling
28813 back to a default if the lookup fails. If an ACL is successfully read from a
28814 file, it is retained in memory for the duration of the Exim process, so that it
28815 can be re-used without having to re-read the file.
28816 .next
28817 If the string does not start with a slash, and does not contain any spaces,
28818 Exim searches the ACL section of the configuration for an ACL whose name
28819 matches the string.
28820 .next
28821 If no named ACL is found, or if the string contains spaces, Exim parses
28822 the string as an inline ACL. This can save typing in cases where you just
28823 want to have something like
28824 .code
28825 acl_smtp_vrfy = accept
28826 .endd
28827 in order to allow free use of the VRFY command. Such a string may contain
28828 newlines; it is processed in the same way as an ACL that is read from a file.
28829 .endlist
28830
28831
28832
28833
28834 .section "ACL return codes" "SECID196"
28835 .cindex "&ACL;" "return codes"
28836 Except for the QUIT ACL, which does not affect the SMTP return code (see
28837 section &<<SECTQUITACL>>& above), the result of running an ACL is either
28838 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
28839 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
28840 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
28841 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
28842 This also causes a 4&'xx'& return code.
28843
28844 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
28845 &"deny"&, because there is no mechanism for passing temporary errors to the
28846 submitters of non-SMTP messages.
28847
28848
28849 ACLs that are relevant to message reception may also return &"discard"&. This
28850 has the effect of &"accept"&, but causes either the entire message or an
28851 individual recipient address to be discarded. In other words, it is a
28852 blackholing facility. Use it with care.
28853
28854 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
28855 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
28856 RCPT ACL is to discard just the one recipient address. If there are no
28857 recipients left when the message's data is received, the DATA ACL is not
28858 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
28859 remaining recipients. The &"discard"& return is not permitted for the
28860 &%acl_smtp_predata%& ACL.
28861
28862 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
28863 is done on the address and the result determines the SMTP response.
28864
28865
28866 .cindex "&[local_scan()]& function" "when all recipients discarded"
28867 The &[local_scan()]& function is always run, even if there are no remaining
28868 recipients; it may create new recipients.
28869
28870
28871
28872 .section "Unset ACL options" "SECID197"
28873 .cindex "&ACL;" "unset options"
28874 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
28875 all the same. &*Note*&: These defaults apply only when the relevant ACL is
28876 not defined at all. For any defined ACL, the default action when control
28877 reaches the end of the ACL statements is &"deny"&.
28878
28879 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
28880 these two are ACLs that are used only for their side effects. They cannot be
28881 used to accept or reject anything.
28882
28883 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
28884 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
28885 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
28886 when the ACL is not defined is &"accept"&.
28887
28888 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
28889 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
28890 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
28891 messages over an SMTP connection. For an example, see the ACL in the default
28892 configuration file.
28893
28894
28895
28896
28897 .section "Data for message ACLs" "SECID198"
28898 .cindex "&ACL;" "data for message ACL"
28899 .vindex &$domain$&
28900 .vindex &$local_part$&
28901 .vindex &$sender_address$&
28902 .vindex &$sender_host_address$&
28903 .vindex &$smtp_command$&
28904 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
28905 that contain information about the host and the message's sender (for example,
28906 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
28907 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
28908 &$local_part$& are set from the argument address. The entire SMTP command
28909 is available in &$smtp_command$&.
28910
28911 When an ACL for the AUTH parameter of MAIL is running, the variables that
28912 contain information about the host are set, but &$sender_address$& is not yet
28913 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
28914 how it is used.
28915
28916 .vindex "&$message_size$&"
28917 The &$message_size$& variable is set to the value of the SIZE parameter on
28918 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
28919 that parameter is not given. The value is updated to the true message size by
28920 the time the final DATA ACL is run (after the message data has been
28921 received).
28922
28923 .vindex "&$rcpt_count$&"
28924 .vindex "&$recipients_count$&"
28925 The &$rcpt_count$& variable increases by one for each RCPT command received.
28926 The &$recipients_count$& variable increases by one each time a RCPT command is
28927 accepted, so while an ACL for RCPT is being processed, it contains the number
28928 of previously accepted recipients. At DATA time (for both the DATA ACLs),
28929 &$rcpt_count$& contains the total number of RCPT commands, and
28930 &$recipients_count$& contains the total number of accepted recipients.
28931
28932
28933
28934
28935
28936 .section "Data for non-message ACLs" "SECTdatfornon"
28937 .cindex "&ACL;" "data for non-message ACL"
28938 .vindex &$smtp_command_argument$&
28939 .vindex &$smtp_command$&
28940 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
28941 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
28942 and the entire SMTP command is available in &$smtp_command$&.
28943 These variables can be tested using a &%condition%& condition. For example,
28944 here is an ACL for use with AUTH, which insists that either the session is
28945 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
28946 does not permit authentication methods that use cleartext passwords on
28947 unencrypted connections.
28948 .code
28949 acl_check_auth:
28950   accept encrypted = *
28951   accept condition = ${if eq{${uc:$smtp_command_argument}}\
28952                      {CRAM-MD5}}
28953   deny   message   = TLS encryption or CRAM-MD5 required
28954 .endd
28955 (Another way of applying this restriction is to arrange for the authenticators
28956 that use cleartext passwords not to be advertised when the connection is not
28957 encrypted. You can use the generic &%server_advertise_condition%& authenticator
28958 option to do this.)
28959
28960
28961
28962 .section "Format of an ACL" "SECID199"
28963 .cindex "&ACL;" "format of"
28964 .cindex "&ACL;" "verbs, definition of"
28965 An individual ACL consists of a number of statements. Each statement starts
28966 with a verb, optionally followed by a number of conditions and &"modifiers"&.
28967 Modifiers can change the way the verb operates, define error and log messages,
28968 set variables, insert delays, and vary the processing of accepted messages.
28969
28970 If all the conditions are met, the verb is obeyed. The same condition may be
28971 used (with different arguments) more than once in the same statement. This
28972 provides a means of specifying an &"and"& conjunction between conditions. For
28973 example:
28974 .code
28975 deny  dnslists = list1.example
28976       dnslists = list2.example
28977 .endd
28978 If there are no conditions, the verb is always obeyed. Exim stops evaluating
28979 the conditions and modifiers when it reaches a condition that fails. What
28980 happens then depends on the verb (and in one case, on a special modifier). Not
28981 all the conditions make sense at every testing point. For example, you cannot
28982 test a sender address in the ACL that is run for a VRFY command.
28983
28984
28985 .section "ACL verbs" "SECID200"
28986 The ACL verbs are as follows:
28987
28988 .ilist
28989 .cindex "&%accept%& ACL verb"
28990 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
28991 of the conditions are not met, what happens depends on whether &%endpass%&
28992 appears among the conditions (for syntax see below). If the failing condition
28993 is before &%endpass%&, control is passed to the next ACL statement; if it is
28994 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
28995 check a RCPT command:
28996 .code
28997 accept domains = +local_domains
28998        endpass
28999        verify = recipient
29000 .endd
29001 If the recipient domain does not match the &%domains%& condition, control
29002 passes to the next statement. If it does match, the recipient is verified, and
29003 the command is accepted if verification succeeds. However, if verification
29004 fails, the ACL yields &"deny"&, because the failing condition is after
29005 &%endpass%&.
29006
29007 The &%endpass%& feature has turned out to be confusing to many people, so its
29008 use is not recommended nowadays. It is always possible to rewrite an ACL so
29009 that &%endpass%& is not needed, and it is no longer used in the default
29010 configuration.
29011
29012 .cindex "&%message%& ACL modifier" "with &%accept%&"
29013 If a &%message%& modifier appears on an &%accept%& statement, its action
29014 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
29015 (when an &%accept%& verb either accepts or passes control to the next
29016 statement), &%message%& can be used to vary the message that is sent when an
29017 SMTP command is accepted. For example, in a RCPT ACL you could have:
29018 .display
29019 &`accept  `&<&'some conditions'&>
29020 &`        message = OK, I will allow you through today`&
29021 .endd
29022 You can specify an SMTP response code, optionally followed by an &"extended
29023 response code"& at the start of the message, but the first digit must be the
29024 same as would be sent by default, which is 2 for an &%accept%& verb.
29025
29026 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
29027 an error message that is used when access is denied. This behaviour is retained
29028 for backward compatibility, but current &"best practice"& is to avoid the use
29029 of &%endpass%&.
29030
29031
29032 .next
29033 .cindex "&%defer%& ACL verb"
29034 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
29035 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
29036 &%defer%& is the same as &%deny%&, because there is no way of sending a
29037 temporary error. For a RCPT command, &%defer%& is much the same as using a
29038 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
29039 be used in any ACL, and even for a recipient it might be a simpler approach.
29040
29041
29042 .next
29043 .cindex "&%deny%& ACL verb"
29044 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
29045 the conditions are not met, control is passed to the next ACL statement. For
29046 example,
29047 .code
29048 deny dnslists = blackholes.mail-abuse.org
29049 .endd
29050 rejects commands from hosts that are on a DNS black list.
29051
29052
29053 .next
29054 .cindex "&%discard%& ACL verb"
29055 &%discard%&: This verb behaves like &%accept%&, except that it returns
29056 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
29057 that are concerned with receiving messages. When all the conditions are true,
29058 the sending entity receives a &"success"& response. However, &%discard%& causes
29059 recipients to be discarded. If it is used in an ACL for RCPT, just the one
29060 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
29061 message's recipients are discarded. Recipients that are discarded before DATA
29062 do not appear in the log line when the &%received_recipients%& log selector is set.
29063
29064 If the &%log_message%& modifier is set when &%discard%& operates,
29065 its contents are added to the line that is automatically written to the log.
29066 The &%message%& modifier operates exactly as it does for &%accept%&.
29067
29068
29069 .next
29070 .cindex "&%drop%& ACL verb"
29071 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
29072 forcibly closed after the 5&'xx'& error message has been sent. For example:
29073 .code
29074 drop   message   = I don't take more than 20 RCPTs
29075        condition = ${if > {$rcpt_count}{20}}
29076 .endd
29077 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
29078 The connection is always dropped after sending a 550 response.
29079
29080 .next
29081 .cindex "&%require%& ACL verb"
29082 &%require%&: If all the conditions are met, control is passed to the next ACL
29083 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
29084 example, when checking a RCPT command,
29085 .code
29086 require message = Sender did not verify
29087         verify  = sender
29088 .endd
29089 passes control to subsequent statements only if the message's sender can be
29090 verified. Otherwise, it rejects the command. Note the positioning of the
29091 &%message%& modifier, before the &%verify%& condition. The reason for this is
29092 discussed in section &<<SECTcondmodproc>>&.
29093
29094 .next
29095 .cindex "&%warn%& ACL verb"
29096 &%warn%&: If all the conditions are true, a line specified by the
29097 &%log_message%& modifier is written to Exim's main log. Control always passes
29098 to the next ACL statement. If any condition is false, the log line is not
29099 written. If an identical log line is requested several times in the same
29100 message, only one copy is actually written to the log. If you want to force
29101 duplicates to be written, use the &%logwrite%& modifier instead.
29102
29103 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
29104 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
29105 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
29106 first failing condition. There is more about adding header lines in section
29107 &<<SECTaddheadacl>>&.
29108
29109 If any condition on a &%warn%& statement cannot be completed (that is, there is
29110 some sort of defer), the log line specified by &%log_message%& is not written.
29111 This does not include the case of a forced failure from a lookup, which
29112 is considered to be a successful completion. After a defer, no further
29113 conditions or modifiers in the &%warn%& statement are processed. The incident
29114 is logged, and the ACL continues to be processed, from the next statement
29115 onwards.
29116
29117
29118 .vindex "&$acl_verify_message$&"
29119 When one of the &%warn%& conditions is an address verification that fails, the
29120 text of the verification failure message is in &$acl_verify_message$&. If you
29121 want this logged, you must set it up explicitly. For example:
29122 .code
29123 warn   !verify = sender
29124        log_message = sender verify failed: $acl_verify_message
29125 .endd
29126 .endlist
29127
29128 At the end of each ACL there is an implicit unconditional &%deny%&.
29129
29130 As you can see from the examples above, the conditions and modifiers are
29131 written one to a line, with the first one on the same line as the verb, and
29132 subsequent ones on following lines. If you have a very long condition, you can
29133 continue it onto several physical lines by the usual backslash continuation
29134 mechanism. It is conventional to align the conditions vertically.
29135
29136
29137
29138 .section "ACL variables" "SECTaclvariables"
29139 .cindex "&ACL;" "variables"
29140 There are some special variables that can be set during ACL processing. They
29141 can be used to pass information between different ACLs, different invocations
29142 of the same ACL in the same SMTP connection, and between ACLs and the routers,
29143 transports, and filters that are used to deliver a message. The names of these
29144 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
29145 an underscore, but the remainder of the name can be any sequence of
29146 alphanumeric characters and underscores that you choose. There is no limit on
29147 the number of ACL variables. The two sets act as follows:
29148 .ilist
29149 The values of those variables whose names begin with &$acl_c$& persist
29150 throughout an SMTP connection. They are never reset. Thus, a value that is set
29151 while receiving one message is still available when receiving the next message
29152 on the same SMTP connection.
29153 .next
29154 The values of those variables whose names begin with &$acl_m$& persist only
29155 while a message is being received. They are reset afterwards. They are also
29156 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
29157 .endlist
29158
29159 When a message is accepted, the current values of all the ACL variables are
29160 preserved with the message and are subsequently made available at delivery
29161 time. The ACL variables are set by a modifier called &%set%&. For example:
29162 .code
29163 accept hosts = whatever
29164        set acl_m4 = some value
29165 accept authenticated = *
29166        set acl_c_auth = yes
29167 .endd
29168 &*Note*&: A leading dollar sign is not used when naming a variable that is to
29169 be set. If you want to set a variable without taking any action, you can use a
29170 &%warn%& verb without any other modifiers or conditions.
29171
29172 .oindex &%strict_acl_vars%&
29173 What happens if a syntactically valid but undefined ACL variable is
29174 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
29175 false (the default), an empty string is substituted; if it is true, an
29176 error is generated.
29177
29178 Versions of Exim before 4.64 have a limited set of numbered variables, but
29179 their names are compatible, so there is no problem with upgrading.
29180
29181
29182 .section "Condition and modifier processing" "SECTcondmodproc"
29183 .cindex "&ACL;" "conditions; processing"
29184 .cindex "&ACL;" "modifiers; processing"
29185 An exclamation mark preceding a condition negates its result. For example:
29186 .code
29187 deny   domains = *.dom.example
29188       !verify  = recipient
29189 .endd
29190 causes the ACL to return &"deny"& if the recipient domain ends in
29191 &'dom.example'& and the recipient address cannot be verified. Sometimes
29192 negation can be used on the right-hand side of a condition. For example, these
29193 two statements are equivalent:
29194 .code
29195 deny  hosts = !192.168.3.4
29196 deny !hosts =  192.168.3.4
29197 .endd
29198 However, for many conditions (&%verify%& being a good example), only left-hand
29199 side negation of the whole condition is possible.
29200
29201 The arguments of conditions and modifiers are expanded. A forced failure
29202 of an expansion causes a condition to be ignored, that is, it behaves as if the
29203 condition is true. Consider these two statements:
29204 .code
29205 accept  senders = ${lookup{$host_name}lsearch\
29206                   {/some/file}{$value}fail}
29207 accept  senders = ${lookup{$host_name}lsearch\
29208                   {/some/file}{$value}{}}
29209 .endd
29210 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
29211 the returned list is searched, but if the lookup fails the behaviour is
29212 different in the two cases. The &%fail%& in the first statement causes the
29213 condition to be ignored, leaving no further conditions. The &%accept%& verb
29214 therefore succeeds. The second statement, however, generates an empty list when
29215 the lookup fails. No sender can match an empty list, so the condition fails,
29216 and therefore the &%accept%& also fails.
29217
29218 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
29219 specify actions that are taken as the conditions for a statement are checked;
29220 others specify text for messages that are used when access is denied or a
29221 warning is generated. The &%control%& modifier affects the way an incoming
29222 message is handled.
29223
29224 The positioning of the modifiers in an ACL statement is important, because the
29225 processing of a verb ceases as soon as its outcome is known. Only those
29226 modifiers that have already been encountered will take effect. For example,
29227 consider this use of the &%message%& modifier:
29228 .code
29229 require message = Can't verify sender
29230         verify  = sender
29231         message = Can't verify recipient
29232         verify  = recipient
29233         message = This message cannot be used
29234 .endd
29235 If sender verification fails, Exim knows that the result of the statement is
29236 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
29237 so its text is used as the error message. If sender verification succeeds, but
29238 recipient verification fails, the second message is used. If recipient
29239 verification succeeds, the third message becomes &"current"&, but is never used
29240 because there are no more conditions to cause failure.
29241
29242 For the &%deny%& verb, on the other hand, it is always the last &%message%&
29243 modifier that is used, because all the conditions must be true for rejection to
29244 happen. Specifying more than one &%message%& modifier does not make sense, and
29245 the message can even be specified after all the conditions. For example:
29246 .code
29247 deny   hosts = ...
29248       !senders = *@my.domain.example
29249        message = Invalid sender from client host
29250 .endd
29251 The &"deny"& result does not happen until the end of the statement is reached,
29252 by which time Exim has set up the message.
29253
29254
29255
29256 .section "ACL modifiers" "SECTACLmodi"
29257 .cindex "&ACL;" "modifiers; list of"
29258 The ACL modifiers are as follows:
29259
29260 .vlist
29261 .vitem &*add_header*&&~=&~<&'text'&>
29262 This modifier specifies one or more header lines that are to be added to an
29263 incoming message, assuming, of course, that the message is ultimately
29264 accepted. For details, see section &<<SECTaddheadacl>>&.
29265
29266 .vitem &*continue*&&~=&~<&'text'&>
29267 .cindex "&%continue%& ACL modifier"
29268 .cindex "database" "updating in ACL"
29269 This modifier does nothing of itself, and processing of the ACL always
29270 continues with the next condition or modifier. The value of &%continue%& is in
29271 the side effects of expanding its argument. Typically this could be used to
29272 update a database. It is really just a syntactic tidiness, to avoid having to
29273 write rather ugly lines like this:
29274 .display
29275 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
29276 .endd
29277 Instead, all you need is
29278 .display
29279 &`continue = `&<&'some expansion'&>
29280 .endd
29281
29282 .vitem &*control*&&~=&~<&'text'&>
29283 .cindex "&%control%& ACL modifier"
29284 This modifier affects the subsequent processing of the SMTP connection or of an
29285 incoming message that is accepted. The effect of the first type of control
29286 lasts for the duration of the connection, whereas the effect of the second type
29287 lasts only until the current message has been received. The message-specific
29288 controls always apply to the whole message, not to individual recipients,
29289 even if the &%control%& modifier appears in a RCPT ACL.
29290
29291 As there are now quite a few controls that can be applied, they are described
29292 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
29293 in several different ways. For example:
29294
29295 . ==== As this is a nested list, any displays it contains must be indented
29296 . ==== as otherwise they are too far to the left. That comment applies only
29297 . ==== when xmlto and fop are used; formatting with sdop gets it right either
29298 . ==== way.
29299
29300 .ilist
29301 It can be at the end of an &%accept%& statement:
29302 .code
29303     accept  ...some conditions
29304             control = queue_only
29305 .endd
29306 In this case, the control is applied when this statement yields &"accept"&, in
29307 other words, when the conditions are all true.
29308
29309 .next
29310 It can be in the middle of an &%accept%& statement:
29311 .code
29312     accept  ...some conditions...
29313             control = queue_only
29314             ...some more conditions...
29315 .endd
29316 If the first set of conditions are true, the control is applied, even if the
29317 statement does not accept because one of the second set of conditions is false.
29318 In this case, some subsequent statement must yield &"accept"& for the control
29319 to be relevant.
29320
29321 .next
29322 It can be used with &%warn%& to apply the control, leaving the
29323 decision about accepting or denying to a subsequent verb. For
29324 example:
29325 .code
29326     warn    ...some conditions...
29327             control = freeze
29328     accept  ...
29329 .endd
29330 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
29331 &%logwrite%&, so it does not add anything to the message and does not write a
29332 log entry.
29333
29334 .next
29335 If you want to apply a control unconditionally, you can use it with a
29336 &%require%& verb. For example:
29337 .code
29338     require  control = no_multiline_responses
29339 .endd
29340 .endlist
29341
29342 .vitem &*delay*&&~=&~<&'time'&>
29343 .cindex "&%delay%& ACL modifier"
29344 .oindex "&%-bh%&"
29345 This modifier may appear in any ACL except notquit. It causes Exim to wait for
29346 the time interval before proceeding. However, when testing Exim using the
29347 &%-bh%& option, the delay is not actually imposed (an appropriate message is
29348 output instead). The time is given in the usual Exim notation, and the delay
29349 happens as soon as the modifier is processed. In an SMTP session, pending
29350 output is flushed before the delay is imposed.
29351
29352 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
29353 example:
29354 .code
29355 deny    ...some conditions...
29356         delay = 30s
29357 .endd
29358 The delay happens if all the conditions are true, before the statement returns
29359 &"deny"&. Compare this with:
29360 .code
29361 deny    delay = 30s
29362         ...some conditions...
29363 .endd
29364 which waits for 30s before processing the conditions. The &%delay%& modifier
29365 can also be used with &%warn%& and together with &%control%&:
29366 .code
29367 warn    ...some conditions...
29368         delay = 2m
29369         control = freeze
29370 accept  ...
29371 .endd
29372
29373 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
29374 responses to several commands are no longer buffered and sent in one packet (as
29375 they would normally be) because all output is flushed before imposing the
29376 delay. This optimization is disabled so that a number of small delays do not
29377 appear to the client as one large aggregated delay that might provoke an
29378 unwanted timeout. You can, however, disable output flushing for &%delay%& by
29379 using a &%control%& modifier to set &%no_delay_flush%&.
29380
29381
29382 .vitem &*endpass*&
29383 .cindex "&%endpass%& ACL modifier"
29384 This modifier, which has no argument, is recognized only in &%accept%& and
29385 &%discard%& statements. It marks the boundary between the conditions whose
29386 failure causes control to pass to the next statement, and the conditions whose
29387 failure causes the ACL to return &"deny"&. This concept has proved to be
29388 confusing to some people, so the use of &%endpass%& is no longer recommended as
29389 &"best practice"&. See the description of &%accept%& above for more details.
29390
29391
29392 .vitem &*log_message*&&~=&~<&'text'&>
29393 .cindex "&%log_message%& ACL modifier"
29394 This modifier sets up a message that is used as part of the log message if the
29395 ACL denies access or a &%warn%& statement's conditions are true. For example:
29396 .code
29397 require log_message = wrong cipher suite $tls_in_cipher
29398         encrypted   = DES-CBC3-SHA
29399 .endd
29400 &%log_message%& is also used when recipients are discarded by &%discard%&. For
29401 example:
29402 .display
29403 &`discard `&<&'some conditions'&>
29404 &`        log_message = Discarded $local_part@$domain because...`&
29405 .endd
29406 When access is denied, &%log_message%& adds to any underlying error message
29407 that may exist because of a condition failure. For example, while verifying a
29408 recipient address, a &':fail:'& redirection might have already set up a
29409 message.
29410
29411 The message may be defined before the conditions to which it applies, because
29412 the string expansion does not happen until Exim decides that access is to be
29413 denied. This means that any variables that are set by the condition are
29414 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
29415 variables are set after a DNS black list lookup succeeds. If the expansion of
29416 &%log_message%& fails, or if the result is an empty string, the modifier is
29417 ignored.
29418
29419 .vindex "&$acl_verify_message$&"
29420 If you want to use a &%warn%& statement to log the result of an address
29421 verification, you can use &$acl_verify_message$& to include the verification
29422 error message.
29423
29424 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
29425 the start of the logged message. If the same warning log message is requested
29426 more than once while receiving  a single email message, only one copy is
29427 actually logged. If you want to log multiple copies, use &%logwrite%& instead
29428 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
29429 is logged for a successful &%warn%& statement.
29430
29431 If &%log_message%& is not present and there is no underlying error message (for
29432 example, from the failure of address verification), but &%message%& is present,
29433 the &%message%& text is used for logging rejections. However, if any text for
29434 logging contains newlines, only the first line is logged. In the absence of
29435 both &%log_message%& and &%message%&, a default built-in message is used for
29436 logging rejections.
29437
29438
29439 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
29440 .cindex "&%log_reject_target%& ACL modifier"
29441 .cindex "logging in ACL" "specifying which log"
29442 This modifier makes it possible to specify which logs are used for messages
29443 about ACL rejections. Its argument is a colon-separated list of words that can
29444 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
29445 may be empty, in which case a rejection is not logged at all. For example, this
29446 ACL fragment writes no logging information when access is denied:
29447 .display
29448 &`deny `&<&'some conditions'&>
29449 &`     log_reject_target =`&
29450 .endd
29451 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
29452 permanent and temporary rejections. Its effect lasts for the rest of the
29453 current ACL.
29454
29455
29456 .vitem &*logwrite*&&~=&~<&'text'&>
29457 .cindex "&%logwrite%& ACL modifier"
29458 .cindex "logging in ACL" "immediate"
29459 This modifier writes a message to a log file as soon as it is encountered when
29460 processing an ACL. (Compare &%log_message%&, which, except in the case of
29461 &%warn%& and &%discard%&, is used only if the ACL statement denies
29462 access.) The &%logwrite%& modifier can be used to log special incidents in
29463 ACLs. For example:
29464 .display
29465 &`accept `&<&'some special conditions'&>
29466 &`       control  = freeze`&
29467 &`       logwrite = froze message because ...`&
29468 .endd
29469 By default, the message is written to the main log. However, it may begin
29470 with a colon, followed by a comma-separated list of log names, and then
29471 another colon, to specify exactly which logs are to be written. For
29472 example:
29473 .code
29474 logwrite = :main,reject: text for main and reject logs
29475 logwrite = :panic: text for panic log only
29476 .endd
29477
29478
29479 .vitem &*message*&&~=&~<&'text'&>
29480 .cindex "&%message%& ACL modifier"
29481 This modifier sets up a text string that is expanded and used as a response
29482 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
29483 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
29484 there is some complication if &%endpass%& is involved; see the description of
29485 &%accept%& for details.)
29486
29487 The expansion of the message happens at the time Exim decides that the ACL is
29488 to end, not at the time it processes &%message%&. If the expansion fails, or
29489 generates an empty string, the modifier is ignored. Here is an example where
29490 &%message%& must be specified first, because the ACL ends with a rejection if
29491 the &%hosts%& condition fails:
29492 .code
29493 require  message = Host not recognized
29494          hosts = 10.0.0.0/8
29495 .endd
29496 (Once a condition has failed, no further conditions or modifiers are
29497 processed.)
29498
29499 .cindex "SMTP" "error codes"
29500 .oindex "&%smtp_banner%&
29501 For ACLs that are triggered by SMTP commands, the message is returned as part
29502 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
29503 is meaningful only for SMTP, as no message is returned when a non-SMTP message
29504 is accepted. In the case of the connect ACL, accepting with a message modifier
29505 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
29506 accept message may not contain more than one line (otherwise it will be
29507 truncated at the first newline and a panic logged), and it cannot affect the
29508 EHLO options.
29509
29510 When SMTP is involved, the message may begin with an overriding response code,
29511 consisting of three digits optionally followed by an &"extended response code"&
29512 of the form &'n.n.n'&, each code being followed by a space. For example:
29513 .code
29514 deny  message = 599 1.2.3 Host not welcome
29515       hosts = 192.168.34.0/24
29516 .endd
29517 The first digit of the supplied response code must be the same as would be sent
29518 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
29519 access, but for the predata ACL, note that the default success code is 354, not
29520 2&'xx'&.
29521
29522 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
29523 the message modifier cannot override the 221 response code.
29524
29525 The text in a &%message%& modifier is literal; any quotes are taken as
29526 literals, but because the string is expanded, backslash escapes are processed
29527 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
29528 response.
29529
29530 .vindex "&$acl_verify_message$&"
29531 For ACLs that are called by an &%acl =%& ACL condition, the message is
29532 stored in &$acl_verify_message$&, from which the calling ACL may use it.
29533
29534 If &%message%& is used on a statement that verifies an address, the message
29535 specified overrides any message that is generated by the verification process.
29536 However, the original message is available in the variable
29537 &$acl_verify_message$&, so you can incorporate it into your message if you
29538 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
29539 routers to be passed back as part of the SMTP response, you should either not
29540 use a &%message%& modifier, or make use of &$acl_verify_message$&.
29541
29542 For compatibility with previous releases of Exim, a &%message%& modifier that
29543 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
29544 modifier, but this usage is now deprecated. However, &%message%& acts only when
29545 all the conditions are true, wherever it appears in an ACL command, whereas
29546 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
29547 &%warn%& in an ACL that is not concerned with receiving a message, it has no
29548 effect.
29549
29550
29551 .vitem &*queue*&&~=&~<&'text'&>
29552 .cindex "&%queue%& ACL modifier"
29553 .cindex "named queues" "selecting in ACL"
29554 This modifier specifies the use of a named queue for spool files
29555 for the message.
29556 It can only be used before the message is received (i.e. not in
29557 the DATA ACL).
29558 This could be used, for example, for known high-volume burst sources
29559 of traffic, or for quarantine of messages.
29560 Separate queue-runner processes will be needed for named queues.
29561 If the text after expansion is empty, the default queue is used.
29562
29563
29564 .vitem &*remove_header*&&~=&~<&'text'&>
29565 This modifier specifies one or more header names in a colon-separated list
29566  that are to be removed from an incoming message, assuming, of course, that
29567 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
29568
29569
29570 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
29571 .cindex "&%set%& ACL modifier"
29572 This modifier puts a value into one of the ACL variables (see section
29573 &<<SECTaclvariables>>&).
29574
29575
29576 .vitem &*udpsend*&&~=&~<&'parameters'&>
29577 .cindex "UDP communications"
29578 This modifier sends a UDP packet, for purposes such as statistics
29579 collection or behaviour monitoring. The parameters are expanded, and
29580 the result of the expansion must be a colon-separated list consisting
29581 of a destination server, port number, and the packet contents. The
29582 server can be specified as a host name or IPv4 or IPv6 address. The
29583 separator can be changed with the usual angle bracket syntax. For
29584 example, you might want to collect information on which hosts connect
29585 when:
29586 .code
29587 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
29588              $tod_zulu $sender_host_address
29589 .endd
29590 .endlist
29591
29592
29593
29594
29595 .section "Use of the control modifier" "SECTcontrols"
29596 .cindex "&%control%& ACL modifier"
29597 The &%control%& modifier supports the following settings:
29598
29599 .vlist
29600 .vitem &*control&~=&~allow_auth_unadvertised*&
29601 This modifier allows a client host to use the SMTP AUTH command even when it
29602 has not been advertised in response to EHLO. Furthermore, because there are
29603 apparently some really broken clients that do this, Exim will accept AUTH after
29604 HELO (rather than EHLO) when this control is set. It should be used only if you
29605 really need it, and you should limit its use to those broken clients that do
29606 not work without it. For example:
29607 .code
29608 warn hosts   = 192.168.34.25
29609      control = allow_auth_unadvertised
29610 .endd
29611 Normally, when an Exim server receives an AUTH command, it checks the name of
29612 the authentication mechanism that is given in the command to ensure that it
29613 matches an advertised mechanism. When this control is set, the check that a
29614 mechanism has been advertised is bypassed. Any configured mechanism can be used
29615 by the client. This control is permitted only in the connection and HELO ACLs.
29616
29617
29618 .vitem &*control&~=&~caseful_local_part*& &&&
29619        &*control&~=&~caselower_local_part*&
29620 .cindex "&ACL;" "case of local part in"
29621 .cindex "case of local parts"
29622 .vindex "&$local_part$&"
29623 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
29624 (that is, during RCPT processing). By default, the contents of &$local_part$&
29625 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
29626 any uppercase letters in the original local part are restored in &$local_part$&
29627 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
29628 is encountered.
29629
29630 These controls affect only the current recipient. Moreover, they apply only to
29631 local part handling that takes place directly in the ACL (for example, as a key
29632 in lookups). If a test to verify the recipient is obeyed, the case-related
29633 handling of the local part during the verification is controlled by the router
29634 configuration (see the &%caseful_local_part%& generic router option).
29635
29636 This facility could be used, for example, to add a spam score to local parts
29637 containing upper case letters. For example, using &$acl_m4$& to accumulate the
29638 spam score:
29639 .code
29640 warn  control = caseful_local_part
29641       set acl_m4 = ${eval:\
29642                      $acl_m4 + \
29643                      ${if match{$local_part}{[A-Z]}{1}{0}}\
29644                     }
29645       control = caselower_local_part
29646 .endd
29647 Notice that we put back the lower cased version afterwards, assuming that
29648 is what is wanted for subsequent tests.
29649
29650
29651 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
29652 .cindex "&ACL;" "cutthrough routing"
29653 .cindex "cutthrough" "requesting"
29654 This option requests delivery be attempted while the item is being received.
29655
29656 The option is usable in the RCPT ACL.
29657 If enabled for a message received via smtp and routed to an smtp transport,
29658 and only one transport, interface, destination host and port combination
29659 is used for all recipients of the message,
29660 then the delivery connection is made while the receiving connection is open
29661 and data is copied from one to the other.
29662
29663 An attempt to set this option for any recipient but the first
29664 for a mail will be quietly ignored.
29665 If a recipient-verify callout
29666 (with use_sender)
29667 connection is subsequently
29668 requested in the same ACL it is held open and used for
29669 any subsequent recipients and the data,
29670 otherwise one is made after the initial RCPT ACL completes.
29671
29672 Note that routers are used in verify mode,
29673 and cannot depend on content of received headers.
29674 Note also that headers cannot be
29675 modified by any of the post-data ACLs (DATA, MIME and DKIM).
29676 Headers may be modified by routers (subject to the above) and transports.
29677 The &'Received-By:'& header is generated as soon as the body reception starts,
29678 rather than the traditional time after the full message is received;
29679 this will affect the timestamp.
29680
29681 All the usual ACLs are called; if one results in the message being
29682 rejected, all effort spent in delivery (including the costs on
29683 the ultimate destination) will be wasted.
29684 Note that in the case of data-time ACLs this includes the entire
29685 message body.
29686
29687 Cutthrough delivery is not supported via transport-filters or when DKIM signing
29688 of outgoing messages is done, because it sends data to the ultimate destination
29689 before the entire message has been received from the source.
29690 It is not supported for messages received with the SMTP PRDR
29691 or CHUNKING
29692 options in use.
29693
29694 Should the ultimate destination system positively accept or reject the mail,
29695 a corresponding indication is given to the source system and nothing is queued.
29696 If the item is successfully delivered in cutthrough mode
29697 the delivery log lines are tagged with ">>" rather than "=>" and appear
29698 before the acceptance "<=" line.
29699
29700 If there is a temporary error the item is queued for later delivery in the
29701 usual fashion.
29702 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
29703 to the control; the default value is &"spool"& and the alternate value
29704 &"pass"& copies an SMTP defer response from the target back to the initiator
29705 and does not queue the message.
29706 Note that this is independent of any recipient verify conditions in the ACL.
29707
29708 Delivery in this mode avoids the generation of a bounce mail to a
29709 (possibly faked)
29710 sender when the destination system is doing content-scan based rejection.
29711
29712
29713 .vitem &*control&~=&~debug/*&<&'options'&>
29714 .cindex "&ACL;" "enabling debug logging"
29715 .cindex "debugging" "enabling from an ACL"
29716 This control turns on debug logging, almost as though Exim had been invoked
29717 with &`-d`&, with the output going to a new logfile in the usual logs directory,
29718 by default called &'debuglog'&.
29719 The filename can be adjusted with the &'tag'& option, which
29720 may access any variables already defined.  The logging may be adjusted with
29721 the &'opts'& option, which takes the same values as the &`-d`& command-line
29722 option.
29723 Logging started this way may be stopped, and the file removed,
29724 with the &'kill'& option.
29725 Some examples (which depend on variables that don't exist in all
29726 contexts):
29727 .code
29728       control = debug
29729       control = debug/tag=.$sender_host_address
29730       control = debug/opts=+expand+acl
29731       control = debug/tag=.$message_exim_id/opts=+expand
29732       control = debug/kill
29733 .endd
29734
29735
29736 .vitem &*control&~=&~dkim_disable_verify*&
29737 .cindex "disable DKIM verify"
29738 .cindex "DKIM" "disable verify"
29739 This control turns off DKIM verification processing entirely.  For details on
29740 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
29741
29742
29743 .vitem &*control&~=&~dscp/*&<&'value'&>
29744 .cindex "&ACL;" "setting DSCP value"
29745 .cindex "DSCP" "inbound"
29746 This option causes the DSCP value associated with the socket for the inbound
29747 connection to be adjusted to a given value, given as one of a number of fixed
29748 strings or to numeric value.
29749 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
29750 Common values include &`throughput`&, &`mincost`&, and on newer systems
29751 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
29752
29753 The outbound packets from Exim will be marked with this value in the header
29754 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
29755 that these values will have any effect, not be stripped by networking
29756 equipment, or do much of anything without cooperation with your Network
29757 Engineer and those of all network operators between the source and destination.
29758
29759
29760 .vitem &*control&~=&~enforce_sync*& &&&
29761        &*control&~=&~no_enforce_sync*&
29762 .cindex "SMTP" "synchronization checking"
29763 .cindex "synchronization checking in SMTP"
29764 These controls make it possible to be selective about when SMTP synchronization
29765 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
29766 state of the switch (it is true by default). See the description of this option
29767 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
29768
29769 The effect of these two controls lasts for the remainder of the SMTP
29770 connection. They can appear in any ACL except the one for the non-SMTP
29771 messages. The most straightforward place to put them is in the ACL defined by
29772 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
29773 before the first synchronization check. The expected use is to turn off the
29774 synchronization checks for badly-behaved hosts that you nevertheless need to
29775 work with.
29776
29777
29778 .vitem &*control&~=&~fakedefer/*&<&'message'&>
29779 .cindex "fake defer"
29780 .cindex "defer, fake"
29781 This control works in exactly the same way as &%fakereject%& (described below)
29782 except that it causes an SMTP 450 response after the message data instead of a
29783 550 response. You must take care when using &%fakedefer%& because it causes the
29784 messages to be duplicated when the sender retries. Therefore, you should not
29785 use &%fakedefer%& if the message is to be delivered normally.
29786
29787 .vitem &*control&~=&~fakereject/*&<&'message'&>
29788 .cindex "fake rejection"
29789 .cindex "rejection, fake"
29790 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
29791 words, only when an SMTP message is being received. If Exim accepts the
29792 message, instead the final 250 response, a 550 rejection message is sent.
29793 However, Exim proceeds to deliver the message as normal. The control applies
29794 only to the current message, not to any subsequent ones that may be received in
29795 the same SMTP connection.
29796
29797 The text for the 550 response is taken from the &%control%& modifier. If no
29798 message is supplied, the following is used:
29799 .code
29800 550-Your message has been rejected but is being
29801 550-kept for evaluation.
29802 550-If it was a legitimate message, it may still be
29803 550 delivered to the target recipient(s).
29804 .endd
29805 This facility should be used with extreme caution.
29806
29807 .vitem &*control&~=&~freeze*&
29808 .cindex "frozen messages" "forcing in ACL"
29809 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29810 other words, only when a message is being received. If the message is accepted,
29811 it is placed on Exim's queue and frozen. The control applies only to the
29812 current message, not to any subsequent ones that may be received in the same
29813 SMTP connection.
29814
29815 This modifier can optionally be followed by &`/no_tell`&. If the global option
29816 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
29817 is told about the freezing), provided all the &*control=freeze*& modifiers that
29818 are obeyed for the current message have the &`/no_tell`& option.
29819
29820 .vitem &*control&~=&~no_delay_flush*&
29821 .cindex "SMTP" "output flushing, disabling for delay"
29822 Exim normally flushes SMTP output before implementing a delay in an ACL, to
29823 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29824 use. This control, as long as it is encountered before the &%delay%& modifier,
29825 disables such output flushing.
29826
29827 .vitem &*control&~=&~no_callout_flush*&
29828 .cindex "SMTP" "output flushing, disabling for callout"
29829 Exim normally flushes SMTP output before performing a callout in an ACL, to
29830 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29831 use. This control, as long as it is encountered before the &%verify%& condition
29832 that causes the callout, disables such output flushing.
29833
29834 .vitem &*control&~=&~no_mbox_unspool*&
29835 This control is available when Exim is compiled with the content scanning
29836 extension. Content scanning may require a copy of the current message, or parts
29837 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
29838 or spam scanner. Normally, such copies are deleted when they are no longer
29839 needed. If this control is set, the copies are not deleted. The control applies
29840 only to the current message, not to any subsequent ones that may be received in
29841 the same SMTP connection. It is provided for debugging purposes and is unlikely
29842 to be useful in production.
29843
29844 .vitem &*control&~=&~no_multiline_responses*&
29845 .cindex "multiline responses, suppressing"
29846 This control is permitted for any ACL except the one for non-SMTP messages.
29847 It seems that there are broken clients in use that cannot handle multiline
29848 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
29849
29850 If this control is set, multiline SMTP responses from ACL rejections are
29851 suppressed. One way of doing this would have been to put out these responses as
29852 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
29853 (&"use multiline responses for more"& it says &-- ha!), and some of the
29854 responses might get close to that. So this facility, which is after all only a
29855 sop to broken clients, is implemented by doing two very easy things:
29856
29857 .ilist
29858 Extra information that is normally output as part of a rejection caused by
29859 sender verification failure is omitted. Only the final line (typically &"sender
29860 verification failed"&) is sent.
29861 .next
29862 If a &%message%& modifier supplies a multiline response, only the first
29863 line is output.
29864 .endlist
29865
29866 The setting of the switch can, of course, be made conditional on the
29867 calling host. Its effect lasts until the end of the SMTP connection.
29868
29869 .vitem &*control&~=&~no_pipelining*&
29870 .cindex "PIPELINING" "suppressing advertising"
29871 This control turns off the advertising of the PIPELINING extension to SMTP in
29872 the current session. To be useful, it must be obeyed before Exim sends its
29873 response to an EHLO command. Therefore, it should normally appear in an ACL
29874 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
29875 &%pipelining_advertise_hosts%&.
29876
29877 .vitem &*control&~=&~queue_only*&
29878 .oindex "&%queue_only%&"
29879 .cindex "queueing incoming messages"
29880 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29881 other words, only when a message is being received. If the message is accepted,
29882 it is placed on Exim's queue and left there for delivery by a subsequent queue
29883 runner. No immediate delivery process is started. In other words, it has the
29884 effect as the &%queue_only%& global option. However, the control applies only
29885 to the current message, not to any subsequent ones that may be received in the
29886 same SMTP connection.
29887
29888 .vitem &*control&~=&~submission/*&<&'options'&>
29889 .cindex "message" "submission"
29890 .cindex "submission mode"
29891 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
29892 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
29893 the current message is a submission from a local MUA. In this case, Exim
29894 operates in &"submission mode"&, and applies certain fixups to the message if
29895 necessary. For example, it adds a &'Date:'& header line if one is not present.
29896 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
29897 late (the message has already been created).
29898
29899 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
29900 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
29901 submission mode; the available options for this control are described there.
29902 The control applies only to the current message, not to any subsequent ones
29903 that may be received in the same SMTP connection.
29904
29905 .vitem &*control&~=&~suppress_local_fixups*&
29906 .cindex "submission fixups, suppressing"
29907 This control applies to locally submitted (non TCP/IP) messages, and is the
29908 complement of &`control = submission`&. It disables the fixups that are
29909 normally applied to locally-submitted messages. Specifically:
29910
29911 .ilist
29912 Any &'Sender:'& header line is left alone (in this respect, it is a
29913 dynamic version of &%local_sender_retain%&).
29914 .next
29915 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
29916 .next
29917 There is no check that &'From:'& corresponds to the actual sender.
29918 .endlist ilist
29919
29920 This control may be useful when a remotely-originated message is accepted,
29921 passed to some scanning program, and then re-submitted for delivery. It can be
29922 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29923 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
29924 data is read.
29925
29926 &*Note:*& This control applies only to the current message, not to any others
29927 that are being submitted at the same time using &%-bs%& or &%-bS%&.
29928
29929 .vitem &*control&~=&~utf8_downconvert*&
29930 This control enables conversion of UTF-8 in message addresses
29931 to a-label form.
29932 For details see section &<<SECTi18nMTA>>&.
29933 .endlist vlist
29934
29935
29936 .section "Summary of message fixup control" "SECTsummesfix"
29937 All four possibilities for message fixups can be specified:
29938
29939 .ilist
29940 Locally submitted, fixups applied: the default.
29941 .next
29942 Locally submitted, no fixups applied: use
29943 &`control = suppress_local_fixups`&.
29944 .next
29945 Remotely submitted, no fixups applied: the default.
29946 .next
29947 Remotely submitted, fixups applied: use &`control = submission`&.
29948 .endlist
29949
29950
29951
29952 .section "Adding header lines in ACLs" "SECTaddheadacl"
29953 .cindex "header lines" "adding in an ACL"
29954 .cindex "header lines" "position of added lines"
29955 .cindex "&%add_header%& ACL modifier"
29956 The &%add_header%& modifier can be used to add one or more extra header lines
29957 to an incoming message, as in this example:
29958 .code
29959 warn dnslists = sbl.spamhaus.org : \
29960                 dialup.mail-abuse.org
29961      add_header = X-blacklisted-at: $dnslist_domain
29962 .endd
29963 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29964 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29965 receiving a message). The message must ultimately be accepted for
29966 &%add_header%& to have any significant effect. You can use &%add_header%& with
29967 any ACL verb, including &%deny%& (though this is potentially useful only in a
29968 RCPT ACL).
29969
29970 Headers will not be added to the message if the modifier is used in
29971 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29972
29973 Leading and trailing newlines are removed from
29974 the data for the &%add_header%& modifier; if it then
29975 contains one or more newlines that
29976 are not followed by a space or a tab, it is assumed to contain multiple header
29977 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
29978 front of any line that is not a valid header line.
29979
29980 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29981 They are added to the message before processing the DATA and MIME ACLs.
29982 However, if an identical header line is requested more than once, only one copy
29983 is actually added to the message. Further header lines may be accumulated
29984 during the DATA and MIME ACLs, after which they are added to the message, again
29985 with duplicates suppressed. Thus, it is possible to add two identical header
29986 lines to an SMTP message, but only if one is added before DATA and one after.
29987 In the case of non-SMTP messages, new headers are accumulated during the
29988 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
29989 message is rejected after DATA or by the non-SMTP ACL, all added header lines
29990 are included in the entry that is written to the reject log.
29991
29992 .cindex "header lines" "added; visibility of"
29993 Header lines are not visible in string expansions
29994 of message headers
29995 until they are added to the
29996 message. It follows that header lines defined in the MAIL, RCPT, and predata
29997 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
29998 header lines that are added by the DATA or MIME ACLs are not visible in those
29999 ACLs. Because of this restriction, you cannot use header lines as a way of
30000 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
30001 this, you can use ACL variables, as described in section
30002 &<<SECTaclvariables>>&.
30003
30004 The list of headers yet to be added is given by the &%$headers_added%& variable.
30005
30006 The &%add_header%& modifier acts immediately as it is encountered during the
30007 processing of an ACL. Notice the difference between these two cases:
30008 .display
30009 &`accept add_header = ADDED: some text`&
30010 &`       `&<&'some condition'&>
30011
30012 &`accept `&<&'some condition'&>
30013 &`       add_header = ADDED: some text`&
30014 .endd
30015 In the first case, the header line is always added, whether or not the
30016 condition is true. In the second case, the header line is added only if the
30017 condition is true. Multiple occurrences of &%add_header%& may occur in the same
30018 ACL statement. All those that are encountered before a condition fails are
30019 honoured.
30020
30021 .cindex "&%warn%& ACL verb"
30022 For compatibility with previous versions of Exim, a &%message%& modifier for a
30023 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
30024 effect only if all the conditions are true, even if it appears before some of
30025 them. Furthermore, only the last occurrence of &%message%& is honoured. This
30026 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
30027 are present on a &%warn%& verb, both are processed according to their
30028 specifications.
30029
30030 By default, new header lines are added to a message at the end of the existing
30031 header lines. However, you can specify that any particular header line should
30032 be added right at the start (before all the &'Received:'& lines), immediately
30033 after the first block of &'Received:'& lines, or immediately before any line
30034 that is not a &'Received:'& or &'Resent-something:'& header.
30035
30036 This is done by specifying &":at_start:"&, &":after_received:"&, or
30037 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
30038 header line, respectively. (Header text cannot start with a colon, as there has
30039 to be a header name first.) For example:
30040 .code
30041 warn add_header = \
30042        :after_received:X-My-Header: something or other...
30043 .endd
30044 If more than one header line is supplied in a single &%add_header%& modifier,
30045 each one is treated independently and can therefore be placed differently. If
30046 you add more than one line at the start, or after the Received: block, they end
30047 up in reverse order.
30048
30049 &*Warning*&: This facility currently applies only to header lines that are
30050 added in an ACL. It does NOT work for header lines that are added in a
30051 system filter or in a router or transport.
30052
30053
30054
30055 .section "Removing header lines in ACLs" "SECTremoveheadacl"
30056 .cindex "header lines" "removing in an ACL"
30057 .cindex "header lines" "position of removed lines"
30058 .cindex "&%remove_header%& ACL modifier"
30059 The &%remove_header%& modifier can be used to remove one or more header lines
30060 from an incoming message, as in this example:
30061 .code
30062 warn   message        = Remove internal headers
30063        remove_header  = x-route-mail1 : x-route-mail2
30064 .endd
30065 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30066 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30067 receiving a message). The message must ultimately be accepted for
30068 &%remove_header%& to have any significant effect. You can use &%remove_header%&
30069 with any ACL verb, including &%deny%&, though this is really not useful for
30070 any verb that doesn't result in a delivered message.
30071
30072 Headers will not be removed from the message if the modifier is used in
30073 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30074
30075 More than one header can be removed at the same time by using a colon separated
30076 list of header names. The header matching is case insensitive. Wildcards are
30077 not permitted, nor is list expansion performed, so you cannot use hostlists to
30078 create a list of headers, however both connection and message variable expansion
30079 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
30080 .code
30081 warn   hosts           = +internal_hosts
30082        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
30083 warn   message         = Remove internal headers
30084        remove_header   = $acl_c_ihdrs
30085 .endd
30086 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
30087 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
30088 If multiple header lines match, all are removed.
30089 There is no harm in attempting to remove the same header twice nor in removing
30090 a non-existent header. Further header lines to be removed may be accumulated
30091 during the DATA and MIME ACLs, after which they are removed from the message,
30092 if present. In the case of non-SMTP messages, headers to be removed are
30093 accumulated during the non-SMTP ACLs, and are removed from the message after
30094 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
30095 ACL, there really is no effect because there is no logging of what headers
30096 would have been removed.
30097
30098 .cindex "header lines" "removed; visibility of"
30099 Header lines are not visible in string expansions until the DATA phase when it
30100 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
30101 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
30102 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
30103 this restriction, you cannot use header lines as a way of controlling data
30104 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
30105 you should instead use ACL variables, as described in section
30106 &<<SECTaclvariables>>&.
30107
30108 The &%remove_header%& modifier acts immediately as it is encountered during the
30109 processing of an ACL. Notice the difference between these two cases:
30110 .display
30111 &`accept remove_header = X-Internal`&
30112 &`       `&<&'some condition'&>
30113
30114 &`accept `&<&'some condition'&>
30115 &`       remove_header = X-Internal`&
30116 .endd
30117 In the first case, the header line is always removed, whether or not the
30118 condition is true. In the second case, the header line is removed only if the
30119 condition is true. Multiple occurrences of &%remove_header%& may occur in the
30120 same ACL statement. All those that are encountered before a condition fails
30121 are honoured.
30122
30123 &*Warning*&: This facility currently applies only to header lines that are
30124 present during ACL processing. It does NOT remove header lines that are added
30125 in a system filter or in a router or transport.
30126
30127
30128
30129
30130 .section "ACL conditions" "SECTaclconditions"
30131 .cindex "&ACL;" "conditions; list of"
30132 Some of the conditions listed in this section are available only when Exim is
30133 compiled with the content-scanning extension. They are included here briefly
30134 for completeness. More detailed descriptions can be found in the discussion on
30135 content scanning in chapter &<<CHAPexiscan>>&.
30136
30137 Not all conditions are relevant in all circumstances. For example, testing
30138 senders and recipients does not make sense in an ACL that is being run as the
30139 result of the arrival of an ETRN command, and checks on message headers can be
30140 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
30141 can use the same condition (with different parameters) more than once in the
30142 same ACL statement. This provides a way of specifying an &"and"& conjunction.
30143 The conditions are as follows:
30144
30145
30146 .vlist
30147 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
30148 .cindex "&ACL;" "nested"
30149 .cindex "&ACL;" "indirect"
30150 .cindex "&ACL;" "arguments"
30151 .cindex "&%acl%& ACL condition"
30152 The possible values of the argument are the same as for the
30153 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
30154 &"accept"& the condition is true; if it returns &"deny"& the condition is
30155 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
30156 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
30157 condition false. This means that further processing of the &%warn%& verb
30158 ceases, but processing of the ACL continues.
30159
30160 If the argument is a named ACL, up to nine space-separated optional values
30161 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
30162 and $acl_narg is set to the count of values.
30163 Previous values of these variables are restored after the call returns.
30164 The name and values are expanded separately.
30165 Note that spaces in complex expansions which are used as arguments
30166 will act as argument separators.
30167
30168 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
30169 the connection is dropped. If it returns &"discard"&, the verb must be
30170 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
30171 conditions are tested.
30172
30173 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
30174 loops. This condition allows you to use different ACLs in different
30175 circumstances. For example, different ACLs can be used to handle RCPT commands
30176 for different local users or different local domains.
30177
30178 .vitem &*authenticated&~=&~*&<&'string&~list'&>
30179 .cindex "&%authenticated%& ACL condition"
30180 .cindex "authentication" "ACL checking"
30181 .cindex "&ACL;" "testing for authentication"
30182 If the SMTP connection is not authenticated, the condition is false. Otherwise,
30183 the name of the authenticator is tested against the list. To test for
30184 authentication by any authenticator, you can set
30185 .code
30186 authenticated = *
30187 .endd
30188
30189 .vitem &*condition&~=&~*&<&'string'&>
30190 .cindex "&%condition%& ACL condition"
30191 .cindex "customizing" "ACL condition"
30192 .cindex "&ACL;" "customized test"
30193 .cindex "&ACL;" "testing, customized"
30194 This feature allows you to make up custom conditions. If the result of
30195 expanding the string is an empty string, the number zero, or one of the strings
30196 &"no"& or &"false"&, the condition is false. If the result is any non-zero
30197 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
30198 any other value, some error is assumed to have occurred, and the ACL returns
30199 &"defer"&. However, if the expansion is forced to fail, the condition is
30200 ignored. The effect is to treat it as true, whether it is positive or
30201 negative.
30202
30203 .vitem &*decode&~=&~*&<&'location'&>
30204 .cindex "&%decode%& ACL condition"
30205 This condition is available only when Exim is compiled with the
30206 content-scanning extension, and it is allowed only in the ACL defined by
30207 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
30208 If all goes well, the condition is true. It is false only if there are
30209 problems such as a syntax error or a memory shortage. For more details, see
30210 chapter &<<CHAPexiscan>>&.
30211
30212 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
30213 .cindex "&%dnslists%& ACL condition"
30214 .cindex "DNS list" "in ACL"
30215 .cindex "black list (DNS)"
30216 .cindex "&ACL;" "testing a DNS list"
30217 This condition checks for entries in DNS black lists. These are also known as
30218 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
30219 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
30220 different variants of this condition to describe briefly here. See sections
30221 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
30222
30223 .vitem &*domains&~=&~*&<&'domain&~list'&>
30224 .cindex "&%domains%& ACL condition"
30225 .cindex "domain" "ACL checking"
30226 .cindex "&ACL;" "testing a recipient domain"
30227 .vindex "&$domain_data$&"
30228 This condition is relevant only after a RCPT command. It checks that the domain
30229 of the recipient address is in the domain list. If percent-hack processing is
30230 enabled, it is done before this test is done. If the check succeeds with a
30231 lookup, the result of the lookup is placed in &$domain_data$& until the next
30232 &%domains%& test.
30233
30234 &*Note carefully*& (because many people seem to fall foul of this): you cannot
30235 use &%domains%& in a DATA ACL.
30236
30237
30238 .vitem &*encrypted&~=&~*&<&'string&~list'&>
30239 .cindex "&%encrypted%& ACL condition"
30240 .cindex "encryption" "checking in an ACL"
30241 .cindex "&ACL;" "testing for encryption"
30242 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
30243 name of the cipher suite in use is tested against the list. To test for
30244 encryption without testing for any specific cipher suite(s), set
30245 .code
30246 encrypted = *
30247 .endd
30248
30249
30250 .vitem &*hosts&~=&~*&<&'host&~list'&>
30251 .cindex "&%hosts%& ACL condition"
30252 .cindex "host" "ACL checking"
30253 .cindex "&ACL;" "testing the client host"
30254 This condition tests that the calling host matches the host list. If you have
30255 name lookups or wildcarded host names and IP addresses in the same host list,
30256 you should normally put the IP addresses first. For example, you could have:
30257 .code
30258 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
30259 .endd
30260 The lookup in this example uses the host name for its key. This is implied by
30261 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
30262 and it wouldn't matter which way round you had these two items.)
30263
30264 The reason for the problem with host names lies in the left-to-right way that
30265 Exim processes lists. It can test IP addresses without doing any DNS lookups,
30266 but when it reaches an item that requires a host name, it fails if it cannot
30267 find a host name to compare with the pattern. If the above list is given in the
30268 opposite order, the &%accept%& statement fails for a host whose name cannot be
30269 found, even if its IP address is 10.9.8.7.
30270
30271 If you really do want to do the name check first, and still recognize the IP
30272 address even if the name lookup fails, you can rewrite the ACL like this:
30273 .code
30274 accept hosts = dbm;/etc/friendly/hosts
30275 accept hosts = 10.9.8.7
30276 .endd
30277 The default action on failing to find the host name is to assume that the host
30278 is not in the list, so the first &%accept%& statement fails. The second
30279 statement can then check the IP address.
30280
30281 .vindex "&$host_data$&"
30282 If a &%hosts%& condition is satisfied by means of a lookup, the result
30283 of the lookup is made available in the &$host_data$& variable. This
30284 allows you, for example, to set up a statement like this:
30285 .code
30286 deny  hosts = net-lsearch;/some/file
30287 message = $host_data
30288 .endd
30289 which gives a custom error message for each denied host.
30290
30291 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
30292 .cindex "&%local_parts%& ACL condition"
30293 .cindex "local part" "ACL checking"
30294 .cindex "&ACL;" "testing a local part"
30295 .vindex "&$local_part_data$&"
30296 This condition is relevant only after a RCPT command. It checks that the local
30297 part of the recipient address is in the list. If percent-hack processing is
30298 enabled, it is done before this test. If the check succeeds with a lookup, the
30299 result of the lookup is placed in &$local_part_data$&, which remains set until
30300 the next &%local_parts%& test.
30301
30302 .vitem &*malware&~=&~*&<&'option'&>
30303 .cindex "&%malware%& ACL condition"
30304 .cindex "&ACL;" "virus scanning"
30305 .cindex "&ACL;" "scanning for viruses"
30306 This condition is available only when Exim is compiled with the
30307 content-scanning extension. It causes the incoming message to be scanned for
30308 viruses. For details, see chapter &<<CHAPexiscan>>&.
30309
30310 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30311 .cindex "&%mime_regex%& ACL condition"
30312 .cindex "&ACL;" "testing by regex matching"
30313 This condition is available only when Exim is compiled with the
30314 content-scanning extension, and it is allowed only in the ACL defined by
30315 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
30316 with any of the regular expressions. For details, see chapter
30317 &<<CHAPexiscan>>&.
30318
30319 .vitem &*ratelimit&~=&~*&<&'parameters'&>
30320 .cindex "rate limiting"
30321 This condition can be used to limit the rate at which a user or host submits
30322 messages. Details are given in section &<<SECTratelimiting>>&.
30323
30324 .vitem &*recipients&~=&~*&<&'address&~list'&>
30325 .cindex "&%recipients%& ACL condition"
30326 .cindex "recipient" "ACL checking"
30327 .cindex "&ACL;" "testing a recipient"
30328 This condition is relevant only after a RCPT command. It checks the entire
30329 recipient address against a list of recipients.
30330
30331 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30332 .cindex "&%regex%& ACL condition"
30333 .cindex "&ACL;" "testing by regex matching"
30334 This condition is available only when Exim is compiled with the
30335 content-scanning extension, and is available only in the DATA, MIME, and
30336 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
30337 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
30338
30339 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
30340 .cindex "&%sender_domains%& ACL condition"
30341 .cindex "sender" "ACL checking"
30342 .cindex "&ACL;" "testing a sender domain"
30343 .vindex "&$domain$&"
30344 .vindex "&$sender_address_domain$&"
30345 This condition tests the domain of the sender of the message against the given
30346 domain list. &*Note*&: The domain of the sender address is in
30347 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
30348 of this condition. This is an exception to the general rule for testing domain
30349 lists. It is done this way so that, if this condition is used in an ACL for a
30350 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
30351 influence the sender checking.
30352
30353 &*Warning*&: It is a bad idea to use this condition on its own as a control on
30354 relaying, because sender addresses are easily, and commonly, forged.
30355
30356 .vitem &*senders&~=&~*&<&'address&~list'&>
30357 .cindex "&%senders%& ACL condition"
30358 .cindex "sender" "ACL checking"
30359 .cindex "&ACL;" "testing a sender"
30360 This condition tests the sender of the message against the given list. To test
30361 for a bounce message, which has an empty sender, set
30362 .code
30363 senders = :
30364 .endd
30365 &*Warning*&: It is a bad idea to use this condition on its own as a control on
30366 relaying, because sender addresses are easily, and commonly, forged.
30367
30368 .vitem &*spam&~=&~*&<&'username'&>
30369 .cindex "&%spam%& ACL condition"
30370 .cindex "&ACL;" "scanning for spam"
30371 This condition is available only when Exim is compiled with the
30372 content-scanning extension. It causes the incoming message to be scanned by
30373 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
30374
30375 .vitem &*verify&~=&~certificate*&
30376 .cindex "&%verify%& ACL condition"
30377 .cindex "TLS" "client certificate verification"
30378 .cindex "certificate" "verification of client"
30379 .cindex "&ACL;" "certificate verification"
30380 .cindex "&ACL;" "testing a TLS certificate"
30381 This condition is true in an SMTP session if the session is encrypted, and a
30382 certificate was received from the client, and the certificate was verified. The
30383 server requests a certificate only if the client matches &%tls_verify_hosts%&
30384 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
30385
30386 .vitem &*verify&~=&~csa*&
30387 .cindex "CSA verification"
30388 This condition checks whether the sending host (the client) is authorized to
30389 send email. Details of how this works are given in section
30390 &<<SECTverifyCSA>>&.
30391
30392 .vitem &*verify&~=&~header_names_ascii*&
30393 .cindex "&%verify%& ACL condition"
30394 .cindex "&ACL;" "verifying header names only ASCII"
30395 .cindex "header lines" "verifying header names only ASCII"
30396 .cindex "verifying" "header names only ASCII"
30397 This condition is relevant only in an ACL that is run after a message has been
30398 received, that is, in an ACL specified by &%acl_smtp_data%& or
30399 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
30400 there are no non-ASCII characters, also excluding control characters.  The
30401 allowable characters are decimal ASCII values 33 through 126.
30402
30403 Exim itself will handle headers with non-ASCII characters, but it can cause
30404 problems for downstream applications, so this option will allow their
30405 detection and rejection in the DATA ACL's.
30406
30407 .vitem &*verify&~=&~header_sender/*&<&'options'&>
30408 .cindex "&%verify%& ACL condition"
30409 .cindex "&ACL;" "verifying sender in the header"
30410 .cindex "header lines" "verifying the sender in"
30411 .cindex "sender" "verifying in header"
30412 .cindex "verifying" "sender in header"
30413 This condition is relevant only in an ACL that is run after a message has been
30414 received, that is, in an ACL specified by &%acl_smtp_data%& or
30415 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
30416 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
30417 is loosely thought of as a &"sender"& address (hence the name of the test).
30418 However, an address that appears in one of these headers need not be an address
30419 that accepts bounce messages; only sender addresses in envelopes are required
30420 to accept bounces. Therefore, if you use the callout option on this check, you
30421 might want to arrange for a non-empty address in the MAIL command.
30422
30423 Details of address verification and the options are given later, starting at
30424 section &<<SECTaddressverification>>& (callouts are described in section
30425 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
30426 condition to restrict it to bounce messages only:
30427 .code
30428 deny    senders = :
30429         message = A valid sender header is required for bounces
30430        !verify  = header_sender
30431 .endd
30432
30433 .vitem &*verify&~=&~header_syntax*&
30434 .cindex "&%verify%& ACL condition"
30435 .cindex "&ACL;" "verifying header syntax"
30436 .cindex "header lines" "verifying syntax"
30437 .cindex "verifying" "header syntax"
30438 This condition is relevant only in an ACL that is run after a message has been
30439 received, that is, in an ACL specified by &%acl_smtp_data%& or
30440 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
30441 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
30442 and &'Bcc:'&), returning true if there are no problems.
30443 Unqualified addresses (local parts without domains) are
30444 permitted only in locally generated messages and from hosts that match
30445 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
30446 appropriate.
30447
30448 Note that this condition is a syntax check only. However, a common spamming
30449 ploy used to be to send syntactically invalid headers such as
30450 .code
30451 To: @
30452 .endd
30453 and this condition can be used to reject such messages, though they are not as
30454 common as they used to be.
30455
30456 .vitem &*verify&~=&~helo*&
30457 .cindex "&%verify%& ACL condition"
30458 .cindex "&ACL;" "verifying HELO/EHLO"
30459 .cindex "HELO" "verifying"
30460 .cindex "EHLO" "verifying"
30461 .cindex "verifying" "EHLO"
30462 .cindex "verifying" "HELO"
30463 This condition is true if a HELO or EHLO command has been received from the
30464 client host, and its contents have been verified. If there has been no previous
30465 attempt to verify the HELO/EHLO contents, it is carried out when this
30466 condition is encountered. See the description of the &%helo_verify_hosts%& and
30467 &%helo_try_verify_hosts%& options for details of how to request verification
30468 independently of this condition.
30469
30470 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
30471 option), this condition is always true.
30472
30473
30474 .vitem &*verify&~=&~not_blind*&
30475 .cindex "verifying" "not blind"
30476 .cindex "bcc recipients, verifying none"
30477 This condition checks that there are no blind (bcc) recipients in the message.
30478 Every envelope recipient must appear either in a &'To:'& header line or in a
30479 &'Cc:'& header line for this condition to be true. Local parts are checked
30480 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
30481 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
30482 used only in a DATA or non-SMTP ACL.
30483
30484 There are, of course, many legitimate messages that make use of blind (bcc)
30485 recipients. This check should not be used on its own for blocking messages.
30486
30487
30488 .vitem &*verify&~=&~recipient/*&<&'options'&>
30489 .cindex "&%verify%& ACL condition"
30490 .cindex "&ACL;" "verifying recipient"
30491 .cindex "recipient" "verifying"
30492 .cindex "verifying" "recipient"
30493 .vindex "&$address_data$&"
30494 This condition is relevant only after a RCPT command. It verifies the current
30495 recipient. Details of address verification are given later, starting at section
30496 &<<SECTaddressverification>>&. After a recipient has been verified, the value
30497 of &$address_data$& is the last value that was set while routing the address.
30498 This applies even if the verification fails. When an address that is being
30499 verified is redirected to a single address, verification continues with the new
30500 address, and in that case, the subsequent value of &$address_data$& is the
30501 value for the child address.
30502
30503 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
30504 .cindex "&%verify%& ACL condition"
30505 .cindex "&ACL;" "verifying host reverse lookup"
30506 .cindex "host" "verifying reverse lookup"
30507 This condition ensures that a verified host name has been looked up from the IP
30508 address of the client host. (This may have happened already if the host name
30509 was needed for checking a host list, or if the host matched &%host_lookup%&.)
30510 Verification ensures that the host name obtained from a reverse DNS lookup, or
30511 one of its aliases, does, when it is itself looked up in the DNS, yield the
30512 original IP address.
30513
30514 There is one possible option, &`defer_ok`&.  If this is present and a
30515 DNS operation returns a temporary error, the verify condition succeeds.
30516
30517 If this condition is used for a locally generated message (that is, when there
30518 is no client host involved), it always succeeds.
30519
30520 .vitem &*verify&~=&~sender/*&<&'options'&>
30521 .cindex "&%verify%& ACL condition"
30522 .cindex "&ACL;" "verifying sender"
30523 .cindex "sender" "verifying"
30524 .cindex "verifying" "sender"
30525 This condition is relevant only after a MAIL or RCPT command, or after a
30526 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
30527 the message's sender is empty (that is, this is a bounce message), the
30528 condition is true. Otherwise, the sender address is verified.
30529
30530 .vindex "&$address_data$&"
30531 .vindex "&$sender_address_data$&"
30532 If there is data in the &$address_data$& variable at the end of routing, its
30533 value is placed in &$sender_address_data$& at the end of verification. This
30534 value can be used in subsequent conditions and modifiers in the same ACL
30535 statement. It does not persist after the end of the current statement. If you
30536 want to preserve the value for longer, you can save it in an ACL variable.
30537
30538 Details of verification are given later, starting at section
30539 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
30540 to avoid doing it more than once per message.
30541
30542 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
30543 .cindex "&%verify%& ACL condition"
30544 This is a variation of the previous option, in which a modified address is
30545 verified as a sender.
30546
30547 Note that '/' is legal in local-parts; if the address may have such
30548 (eg. is generated from the received message)
30549 they must be protected from the options parsing by doubling:
30550 .code
30551 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
30552 .endd
30553 .endlist
30554
30555
30556
30557 .section "Using DNS lists" "SECTmorednslists"
30558 .cindex "DNS list" "in ACL"
30559 .cindex "black list (DNS)"
30560 .cindex "&ACL;" "testing a DNS list"
30561 In its simplest form, the &%dnslists%& condition tests whether the calling host
30562 is on at least one of a number of DNS lists by looking up the inverted IP
30563 address in one or more DNS domains. (Note that DNS list domains are not mail
30564 domains, so the &`+`& syntax for named lists doesn't work - it is used for
30565 special options instead.) For example, if the calling host's IP
30566 address is 192.168.62.43, and the ACL statement is
30567 .code
30568 deny dnslists = blackholes.mail-abuse.org : \
30569                 dialups.mail-abuse.org
30570 .endd
30571 the following records are looked up:
30572 .code
30573 43.62.168.192.blackholes.mail-abuse.org
30574 43.62.168.192.dialups.mail-abuse.org
30575 .endd
30576 As soon as Exim finds an existing DNS record, processing of the list stops.
30577 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
30578 to test that a host is on more than one list (an &"and"& conjunction), you can
30579 use two separate conditions:
30580 .code
30581 deny dnslists = blackholes.mail-abuse.org
30582      dnslists = dialups.mail-abuse.org
30583 .endd
30584 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
30585 behaves as if the host does not match the list item, that is, as if the DNS
30586 record does not exist. If there are further items in the DNS list, they are
30587 processed.
30588
30589 This is usually the required action when &%dnslists%& is used with &%deny%&
30590 (which is the most common usage), because it prevents a DNS failure from
30591 blocking mail. However, you can change this behaviour by putting one of the
30592 following special items in the list:
30593 .display
30594 &`+include_unknown `&   behave as if the item is on the list
30595 &`+exclude_unknown `&   behave as if the item is not on the list (default)
30596 &`+defer_unknown   `&   give a temporary error
30597 .endd
30598 .cindex "&`+include_unknown`&"
30599 .cindex "&`+exclude_unknown`&"
30600 .cindex "&`+defer_unknown`&"
30601 Each of these applies to any subsequent items on the list. For example:
30602 .code
30603 deny dnslists = +defer_unknown : foo.bar.example
30604 .endd
30605 Testing the list of domains stops as soon as a match is found. If you want to
30606 warn for one list and block for another, you can use two different statements:
30607 .code
30608 deny  dnslists = blackholes.mail-abuse.org
30609 warn  message  = X-Warn: sending host is on dialups list
30610       dnslists = dialups.mail-abuse.org
30611 .endd
30612 .cindex caching "of dns lookup"
30613 .cindex DNS TTL
30614 DNS list lookups are cached by Exim for the duration of the SMTP session
30615 (but limited by the DNS return TTL value),
30616 so a lookup based on the IP address is done at most once for any incoming
30617 connection (assuming long-enough TTL).
30618 Exim does not share information between multiple incoming
30619 connections (but your local name server cache should be active).
30620
30621 There are a number of DNS lists to choose from, some commercial, some free,
30622 or free for small deployments.  An overview can be found at
30623 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
30624
30625
30626
30627 .section "Specifying the IP address for a DNS list lookup" "SECID201"
30628 .cindex "DNS list" "keyed by explicit IP address"
30629 By default, the IP address that is used in a DNS list lookup is the IP address
30630 of the calling host. However, you can specify another IP address by listing it
30631 after the domain name, introduced by a slash. For example:
30632 .code
30633 deny dnslists = black.list.tld/192.168.1.2
30634 .endd
30635 This feature is not very helpful with explicit IP addresses; it is intended for
30636 use with IP addresses that are looked up, for example, the IP addresses of the
30637 MX hosts or nameservers of an email sender address. For an example, see section
30638 &<<SECTmulkeyfor>>& below.
30639
30640
30641
30642
30643 .section "DNS lists keyed on domain names" "SECID202"
30644 .cindex "DNS list" "keyed by domain name"
30645 There are some lists that are keyed on domain names rather than inverted IP
30646 addresses.  No reversing of components is used
30647 with these lists. You can change the name that is looked up in a DNS list by
30648 listing it after the domain name, introduced by a slash. For example,
30649 .code
30650 deny  message  = Sender's domain is listed at $dnslist_domain
30651       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
30652 .endd
30653 This particular example is useful only in ACLs that are obeyed after the
30654 RCPT or DATA commands, when a sender address is available. If (for
30655 example) the message's sender is &'user@tld.example'& the name that is looked
30656 up by this example is
30657 .code
30658 tld.example.dsn.rfc-ignorant.org
30659 .endd
30660 A single &%dnslists%& condition can contain entries for both names and IP
30661 addresses. For example:
30662 .code
30663 deny dnslists = sbl.spamhaus.org : \
30664                 dsn.rfc-ignorant.org/$sender_address_domain
30665 .endd
30666 The first item checks the sending host's IP address; the second checks a domain
30667 name. The whole condition is true if either of the DNS lookups succeeds.
30668
30669
30670
30671
30672 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
30673 .cindex "DNS list" "multiple keys for"
30674 The syntax described above for looking up explicitly-defined values (either
30675 names or IP addresses) in a DNS blacklist is a simplification. After the domain
30676 name for the DNS list, what follows the slash can in fact be a list of items.
30677 As with all lists in Exim, the default separator is a colon. However, because
30678 this is a sublist within the list of DNS blacklist domains, it is necessary
30679 either to double the separators like this:
30680 .code
30681 dnslists = black.list.tld/name.1::name.2
30682 .endd
30683 or to change the separator character, like this:
30684 .code
30685 dnslists = black.list.tld/<;name.1;name.2
30686 .endd
30687 If an item in the list is an IP address, it is inverted before the DNS
30688 blacklist domain is appended. If it is not an IP address, no inversion
30689 occurs. Consider this condition:
30690 .code
30691 dnslists = black.list.tld/<;192.168.1.2;a.domain
30692 .endd
30693 The DNS lookups that occur are:
30694 .code
30695 2.1.168.192.black.list.tld
30696 a.domain.black.list.tld
30697 .endd
30698 Once a DNS record has been found (that matches a specific IP return
30699 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
30700 are done. If there is a temporary DNS error, the rest of the sublist of domains
30701 or IP addresses is tried. A temporary error for the whole dnslists item occurs
30702 only if no other DNS lookup in this sublist succeeds. In other words, a
30703 successful lookup for any of the items in the sublist overrides a temporary
30704 error for a previous item.
30705
30706 The ability to supply a list of items after the slash is in some sense just a
30707 syntactic convenience. These two examples have the same effect:
30708 .code
30709 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
30710 dnslists = black.list.tld/a.domain::b.domain
30711 .endd
30712 However, when the data for the list is obtained from a lookup, the second form
30713 is usually much more convenient. Consider this example:
30714 .code
30715 deny message  = The mail servers for the domain \
30716                 $sender_address_domain \
30717                 are listed at $dnslist_domain ($dnslist_value); \
30718                 see $dnslist_text.
30719      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
30720                                    ${lookup dnsdb {>|mxh=\
30721                                    $sender_address_domain} }} }
30722 .endd
30723 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
30724 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
30725 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
30726 of expanding the condition might be something like this:
30727 .code
30728 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
30729 .endd
30730 Thus, this example checks whether or not the IP addresses of the sender
30731 domain's mail servers are on the Spamhaus black list.
30732
30733 The key that was used for a successful DNS list lookup is put into the variable
30734 &$dnslist_matched$& (see section &<<SECID204>>&).
30735
30736
30737
30738
30739 .section "Data returned by DNS lists" "SECID203"
30740 .cindex "DNS list" "data returned from"
30741 DNS lists are constructed using address records in the DNS. The original RBL
30742 just used the address 127.0.0.1 on the right hand side of each record, but the
30743 RBL+ list and some other lists use a number of values with different meanings.
30744 The values used on the RBL+ list are:
30745 .display
30746 127.1.0.1  RBL
30747 127.1.0.2  DUL
30748 127.1.0.3  DUL and RBL
30749 127.1.0.4  RSS
30750 127.1.0.5  RSS and RBL
30751 127.1.0.6  RSS and DUL
30752 127.1.0.7  RSS and DUL and RBL
30753 .endd
30754 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
30755 different values. Some DNS lists may return more than one address record;
30756 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
30757
30758
30759 .section "Variables set from DNS lists" "SECID204"
30760 .cindex "expansion" "variables, set from DNS list"
30761 .cindex "DNS list" "variables set from"
30762 .vindex "&$dnslist_domain$&"
30763 .vindex "&$dnslist_matched$&"
30764 .vindex "&$dnslist_text$&"
30765 .vindex "&$dnslist_value$&"
30766 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
30767 the name of the overall domain that matched (for example,
30768 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
30769 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
30770 the DNS record. When the key is an IP address, it is not reversed in
30771 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
30772 cases, for example:
30773 .code
30774 deny dnslists = spamhaus.example
30775 .endd
30776 the key is also available in another variable (in this case,
30777 &$sender_host_address$&). In more complicated cases, however, this is not true.
30778 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
30779 might generate a dnslists lookup like this:
30780 .code
30781 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
30782 .endd
30783 If this condition succeeds, the value in &$dnslist_matched$& might be
30784 &`192.168.6.7`& (for example).
30785
30786 If more than one address record is returned by the DNS lookup, all the IP
30787 addresses are included in &$dnslist_value$&, separated by commas and spaces.
30788 The variable &$dnslist_text$& contains the contents of any associated TXT
30789 record. For lists such as RBL+ the TXT record for a merged entry is often not
30790 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
30791 information.
30792
30793 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
30794 &-- although these appear before the condition in the ACL, they are not
30795 expanded until after it has failed. For example:
30796 .code
30797 deny    hosts = !+local_networks
30798         message = $sender_host_address is listed \
30799                   at $dnslist_domain
30800         dnslists = rbl-plus.mail-abuse.example
30801 .endd
30802
30803
30804
30805 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
30806 .cindex "DNS list" "matching specific returned data"
30807 You can add an equals sign and an IP address after a &%dnslists%& domain name
30808 in order to restrict its action to DNS records with a matching right hand side.
30809 For example,
30810 .code
30811 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
30812 .endd
30813 rejects only those hosts that yield 127.0.0.2. Without this additional data,
30814 any address record is considered to be a match. For the moment, we assume
30815 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
30816 describes how multiple records are handled.
30817
30818 More than one IP address may be given for checking, using a comma as a
30819 separator. These are alternatives &-- if any one of them matches, the
30820 &%dnslists%& condition is true. For example:
30821 .code
30822 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30823 .endd
30824 If you want to specify a constraining address list and also specify names or IP
30825 addresses to be looked up, the constraining address list must be specified
30826 first. For example:
30827 .code
30828 deny dnslists = dsn.rfc-ignorant.org\
30829                 =127.0.0.2/$sender_address_domain
30830 .endd
30831
30832 If the character &`&&`& is used instead of &`=`&, the comparison for each
30833 listed IP address is done by a bitwise &"and"& instead of by an equality test.
30834 In other words, the listed addresses are used as bit masks. The comparison is
30835 true if all the bits in the mask are present in the address that is being
30836 tested. For example:
30837 .code
30838 dnslists = a.b.c&0.0.0.3
30839 .endd
30840 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
30841 want to test whether one bit or another bit is present (as opposed to both
30842 being present), you must use multiple values. For example:
30843 .code
30844 dnslists = a.b.c&0.0.0.1,0.0.0.2
30845 .endd
30846 matches if the final component of the address is an odd number or two times
30847 an odd number.
30848
30849
30850
30851 .section "Negated DNS matching conditions" "SECID205"
30852 You can supply a negative list of IP addresses as part of a &%dnslists%&
30853 condition. Whereas
30854 .code
30855 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30856 .endd
30857 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30858 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
30859 .code
30860 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
30861 .endd
30862 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30863 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
30864 words, the result of the test is inverted if an exclamation mark appears before
30865 the &`=`& (or the &`&&`&) sign.
30866
30867 &*Note*&: This kind of negation is not the same as negation in a domain,
30868 host, or address list (which is why the syntax is different).
30869
30870 If you are using just one list, the negation syntax does not gain you much. The
30871 previous example is precisely equivalent to
30872 .code
30873 deny  dnslists = a.b.c
30874      !dnslists = a.b.c=127.0.0.2,127.0.0.3
30875 .endd
30876 However, if you are using multiple lists, the negation syntax is clearer.
30877 Consider this example:
30878 .code
30879 deny  dnslists = sbl.spamhaus.org : \
30880                  list.dsbl.org : \
30881                  dnsbl.njabl.org!=127.0.0.3 : \
30882                  relays.ordb.org
30883 .endd
30884 Using only positive lists, this would have to be:
30885 .code
30886 deny  dnslists = sbl.spamhaus.org : \
30887                  list.dsbl.org
30888 deny  dnslists = dnsbl.njabl.org
30889      !dnslists = dnsbl.njabl.org=127.0.0.3
30890 deny  dnslists = relays.ordb.org
30891 .endd
30892 which is less clear, and harder to maintain.
30893
30894
30895
30896
30897 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
30898 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
30899 thereby providing more than one IP address. When an item in a &%dnslists%& list
30900 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
30901 the match to specific results from the DNS lookup, there are two ways in which
30902 the checking can be handled. For example, consider the condition:
30903 .code
30904 dnslists = a.b.c=127.0.0.1
30905 .endd
30906 What happens if the DNS lookup for the incoming IP address yields both
30907 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
30908 condition true because at least one given value was found, or is it false
30909 because at least one of the found values was not listed? And how does this
30910 affect negated conditions? Both possibilities are provided for with the help of
30911 additional separators &`==`& and &`=&&`&.
30912
30913 .ilist
30914 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
30915 IP addresses matches one of the listed addresses. For the example above, the
30916 condition is true because 127.0.0.1 matches.
30917 .next
30918 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
30919 looked up IP addresses matches one of the listed addresses. If the condition is
30920 changed to:
30921 .code
30922 dnslists = a.b.c==127.0.0.1
30923 .endd
30924 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30925 false because 127.0.0.2 is not listed. You would need to have:
30926 .code
30927 dnslists = a.b.c==127.0.0.1,127.0.0.2
30928 .endd
30929 for the condition to be true.
30930 .endlist
30931
30932 When &`!`& is used to negate IP address matching, it inverts the result, giving
30933 the precise opposite of the behaviour above. Thus:
30934 .ilist
30935 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
30936 addresses matches one of the listed addresses. Consider:
30937 .code
30938 dnslists = a.b.c!&0.0.0.1
30939 .endd
30940 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30941 false because 127.0.0.1 matches.
30942 .next
30943 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
30944 looked up IP address that does not match. Consider:
30945 .code
30946 dnslists = a.b.c!=&0.0.0.1
30947 .endd
30948 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30949 true, because 127.0.0.2 does not match. You would need to have:
30950 .code
30951 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
30952 .endd
30953 for the condition to be false.
30954 .endlist
30955 When the DNS lookup yields only a single IP address, there is no difference
30956 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
30957
30958
30959
30960
30961 .section "Detailed information from merged DNS lists" "SECTmordetinf"
30962 .cindex "DNS list" "information from merged"
30963 When the facility for restricting the matching IP values in a DNS list is used,
30964 the text from the TXT record that is set in &$dnslist_text$& may not reflect
30965 the true reason for rejection. This happens when lists are merged and the IP
30966 address in the A record is used to distinguish them; unfortunately there is
30967 only one TXT record. One way round this is not to use merged lists, but that
30968 can be inefficient because it requires multiple DNS lookups where one would do
30969 in the vast majority of cases when the host of interest is not on any of the
30970 lists.
30971
30972 A less inefficient way of solving this problem is available. If
30973 two domain names, comma-separated, are given, the second is used first to
30974 do an initial check, making use of any IP value restrictions that are set.
30975 If there is a match, the first domain is used, without any IP value
30976 restrictions, to get the TXT record. As a byproduct of this, there is also
30977 a check that the IP being tested is indeed on the first list. The first
30978 domain is the one that is put in &$dnslist_domain$&. For example:
30979 .code
30980 deny message  = \
30981          rejected because $sender_host_address is blacklisted \
30982          at $dnslist_domain\n$dnslist_text
30983        dnslists = \
30984          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
30985          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30986 .endd
30987 For the first blacklist item, this starts by doing a lookup in
30988 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
30989 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
30990 value, and as long as something is found, it looks for the corresponding TXT
30991 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
30992 The second blacklist item is processed similarly.
30993
30994 If you are interested in more than one merged list, the same list must be
30995 given several times, but because the results of the DNS lookups are cached,
30996 the DNS calls themselves are not repeated. For example:
30997 .code
30998 deny dnslists = \
30999          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
31000          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
31001          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
31002          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31003 .endd
31004 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
31005 values matches (or if no record is found), this is the only lookup that is
31006 done. Only if there is a match is one of the more specific lists consulted.
31007
31008
31009
31010 .section "DNS lists and IPv6" "SECTmorednslistslast"
31011 .cindex "IPv6" "DNS black lists"
31012 .cindex "DNS list" "IPv6 usage"
31013 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
31014 nibble by nibble. For example, if the calling host's IP address is
31015 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
31016 .code
31017 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
31018   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
31019 .endd
31020 (split over two lines here to fit on the page). Unfortunately, some of the DNS
31021 lists contain wildcard records, intended for IPv4, that interact badly with
31022 IPv6. For example, the DNS entry
31023 .code
31024 *.3.some.list.example.    A    127.0.0.1
31025 .endd
31026 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
31027 Unfortunately, it also matches the entire 3::/4 IPv6 network.
31028
31029 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
31030 &%condition%& condition, as in this example:
31031 .code
31032 deny   condition = ${if isip4{$sender_host_address}}
31033        dnslists  = some.list.example
31034 .endd
31035
31036 If an explicit key is being used for a DNS lookup and it may be an IPv6
31037 address you should specify alternate list separators for both the outer
31038 (DNS list name) list and inner (lookup keys) list:
31039 .code
31040        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
31041 .endd
31042
31043 .section "Rate limiting incoming messages" "SECTratelimiting"
31044 .cindex "rate limiting" "client sending"
31045 .cindex "limiting client sending rates"
31046 .oindex "&%smtp_ratelimit_*%&"
31047 The &%ratelimit%& ACL condition can be used to measure and control the rate at
31048 which clients can send email. This is more powerful than the
31049 &%smtp_ratelimit_*%& options, because those options control the rate of
31050 commands in a single SMTP session only, whereas the &%ratelimit%& condition
31051 works across all connections (concurrent and sequential) from the same client
31052 host. The syntax of the &%ratelimit%& condition is:
31053 .display
31054 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
31055 .endd
31056 If the average client sending rate is less than &'m'& messages per time
31057 period &'p'& then the condition is false; otherwise it is true.
31058
31059 As a side-effect, the &%ratelimit%& condition sets the expansion variable
31060 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
31061 configured value of &'m'&, and &$sender_rate_period$& to the configured value
31062 of &'p'&.
31063
31064 The parameter &'p'& is the smoothing time constant, in the form of an Exim
31065 time interval, for example, &`8h`& for eight hours. A larger time constant
31066 means that it takes Exim longer to forget a client's past behaviour. The
31067 parameter &'m'& is the maximum number of messages that a client is permitted to
31068 send in each time interval. It also specifies the number of messages permitted
31069 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
31070 constant, you can allow a client to send more messages in a burst without
31071 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
31072 both small, messages must be sent at an even rate.
31073
31074 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
31075 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
31076 when deploying the &%ratelimit%& ACL condition. The script prints usage
31077 instructions when it is run with no arguments.
31078
31079 The key is used to look up the data for calculating the client's average
31080 sending rate. This data is stored in Exim's spool directory, alongside the
31081 retry and other hints databases. The default key is &$sender_host_address$&,
31082 which means Exim computes the sending rate of each client host IP address.
31083 By changing the key you can change how Exim identifies clients for the purpose
31084 of ratelimiting. For example, to limit the sending rate of each authenticated
31085 user, independent of the computer they are sending from, set the key to
31086 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
31087 example, &$authenticated_id$& is only meaningful if the client has
31088 authenticated (which you can check with the &%authenticated%& ACL condition).
31089
31090 The lookup key does not have to identify clients: If you want to limit the
31091 rate at which a recipient receives messages, you can use the key
31092 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
31093 ACL.
31094
31095 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
31096 specifies what Exim measures the rate of, for example messages or recipients
31097 or bytes. You can adjust the measurement using the &%unique=%& and/or
31098 &%count=%& options. You can also control when Exim updates the recorded rate
31099 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
31100 separated by a slash, like the other parameters. They may appear in any order.
31101
31102 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
31103 any options that alter the meaning of the stored data. The limit &'m'& is not
31104 stored, so you can alter the configured maximum rate and Exim will still
31105 remember clients' past behaviour. If you change the &%per_*%& mode or add or
31106 remove the &%unique=%& option, the lookup key changes so Exim will forget past
31107 behaviour. The lookup key is not affected by changes to the update mode and
31108 the &%count=%& option.
31109
31110
31111 .section "Ratelimit options for what is being measured" "ratoptmea"
31112 .cindex "rate limiting" "per_* options"
31113 The &%per_conn%& option limits the client's connection rate. It is not
31114 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
31115 &%acl_not_smtp_start%& ACLs.
31116
31117 The &%per_mail%& option limits the client's rate of sending messages. This is
31118 the default if none of the &%per_*%& options is specified. It can be used in
31119 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
31120 &%acl_smtp_data%&, or &%acl_not_smtp%&.
31121
31122 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
31123 the same ACLs as the &%per_mail%& option, though it is best to use this option
31124 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
31125 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
31126 in its MAIL command, which may be inaccurate or completely missing. You can
31127 follow the limit &'m'& in the configuration with K, M, or G to specify limits
31128 in kilobytes, megabytes, or gigabytes, respectively.
31129
31130 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
31131 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31132 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
31133 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
31134 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
31135 in either case the rate limiting engine will see a message with many
31136 recipients as a large high-speed burst.
31137
31138 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
31139 number of different recipients that the client has sent messages to in the
31140 last time period. That is, if the client repeatedly sends messages to the same
31141 recipient, its measured rate is not increased. This option can only be used in
31142 &%acl_smtp_rcpt%&.
31143
31144 The &%per_cmd%& option causes Exim to recompute the rate every time the
31145 condition is processed. This can be used to limit the rate of any SMTP
31146 command. If it is used in multiple ACLs it can limit the aggregate rate of
31147 multiple different commands.
31148
31149 The &%count=%& option can be used to alter how much Exim adds to the client's
31150 measured rate. For example, the &%per_byte%& option is equivalent to
31151 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
31152 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
31153 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
31154
31155 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
31156
31157
31158 .section "Ratelimit update modes" "ratoptupd"
31159 .cindex "rate limiting" "reading data without updating"
31160 You can specify one of three options with the &%ratelimit%& condition to
31161 control when its database is updated. This section describes the &%readonly%&
31162 mode, and the next section describes the &%strict%& and &%leaky%& modes.
31163
31164 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
31165 previously-computed rate to check against the limit.
31166
31167 For example, you can test the client's sending rate and deny it access (when
31168 it is too fast) in the connect ACL. If the client passes this check then it
31169 can go on to send a message, in which case its recorded rate will be updated
31170 in the MAIL ACL. Subsequent connections from the same client will check this
31171 new rate.
31172 .code
31173 acl_check_connect:
31174  deny ratelimit = 100 / 5m / readonly
31175     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
31176                   (max $sender_rate_limit)
31177 # ...
31178 acl_check_mail:
31179  warn ratelimit = 100 / 5m / strict
31180     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
31181                   (max $sender_rate_limit)
31182 .endd
31183
31184 If Exim encounters multiple &%ratelimit%& conditions with the same key when
31185 processing a message then it may increase the client's measured rate more than
31186 it should. For example, this will happen if you check the &%per_rcpt%& option
31187 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
31188 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
31189 multiple update problems by using the &%readonly%& option on later ratelimit
31190 checks.
31191
31192 The &%per_*%& options described above do not make sense in some ACLs. If you
31193 use a &%per_*%& option in an ACL where it is not normally permitted then the
31194 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
31195 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
31196 next section) so you must specify the &%readonly%& option explicitly.
31197
31198
31199 .section "Ratelimit options for handling fast clients" "ratoptfast"
31200 .cindex "rate limiting" "strict and leaky modes"
31201 If a client's average rate is greater than the maximum, the rate limiting
31202 engine can react in two possible ways, depending on the presence of the
31203 &%strict%& or &%leaky%& update modes. This is independent of the other
31204 counter-measures (such as rejecting the message) that may be specified by the
31205 rest of the ACL.
31206
31207 The &%leaky%& (default) option means that the client's recorded rate is not
31208 updated if it is above the limit. The effect of this is that Exim measures the
31209 client's average rate of successfully sent email,
31210 .new
31211 up to the given limit.
31212 This is appropriate if the countermeasure when the condition is true
31213 consists of refusing the message, and
31214 is generally the better choice if you have clients that retry automatically.
31215 If the action when true is anything more complex then this option is
31216 likely not what is wanted.
31217 .wen
31218
31219 The &%strict%& option means that the client's recorded rate is always
31220 updated. The effect of this is that Exim measures the client's average rate
31221 of attempts to send email, which can be much higher than the maximum it is
31222 actually allowed. If the client is over the limit it may be subjected to
31223 counter-measures by the ACL. It must slow down and allow sufficient time to
31224 pass that its computed rate falls below the maximum before it can send email
31225 again. The time (the number of smoothing periods) it must wait and not
31226 attempt to send mail can be calculated with this formula:
31227 .code
31228         ln(peakrate/maxrate)
31229 .endd
31230
31231
31232 .section "Limiting the rate of different events" "ratoptuniq"
31233 .cindex "rate limiting" "counting unique events"
31234 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
31235 rate of different events. For example, the &%per_addr%& option uses this
31236 mechanism to count the number of different recipients that the client has
31237 sent messages to in the last time period; it is equivalent to
31238 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
31239 measure the rate that a client uses different sender addresses with the
31240 options &`per_mail/unique=$sender_address`&.
31241
31242 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
31243 has seen for that key. The whole set is thrown away when it is older than the
31244 rate smoothing period &'p'&, so each different event is counted at most once
31245 per period. In the &%leaky%& update mode, an event that causes the client to
31246 go over the limit is not added to the set, in the same way that the client's
31247 recorded rate is not updated in the same situation.
31248
31249 When you combine the &%unique=%& and &%readonly%& options, the specific
31250 &%unique=%& value is ignored, and Exim just retrieves the client's stored
31251 rate.
31252
31253 The &%unique=%& mechanism needs more space in the ratelimit database than the
31254 other &%ratelimit%& options in order to store the event set. The number of
31255 unique values is potentially as large as the rate limit, so the extra space
31256 required increases with larger limits.
31257
31258 The uniqueification is not perfect: there is a small probability that Exim
31259 will think a new event has happened before. If the sender's rate is less than
31260 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
31261 the measured rate can go above the limit, in which case Exim may under-count
31262 events by a significant margin. Fortunately, if the rate is high enough (2.7
31263 times the limit) that the false positive rate goes above 9%, then Exim will
31264 throw away the over-full event set before the measured rate falls below the
31265 limit. Therefore the only harm should be that exceptionally high sending rates
31266 are logged incorrectly; any countermeasures you configure will be as effective
31267 as intended.
31268
31269
31270 .section "Using rate limiting" "useratlim"
31271 Exim's other ACL facilities are used to define what counter-measures are taken
31272 when the rate limit is exceeded. This might be anything from logging a warning
31273 (for example, while measuring existing sending rates in order to define
31274 policy), through time delays to slow down fast senders, up to rejecting the
31275 message. For example:
31276 .code
31277 # Log all senders' rates
31278 warn ratelimit = 0 / 1h / strict
31279      log_message = Sender rate $sender_rate / $sender_rate_period
31280
31281 # Slow down fast senders; note the need to truncate $sender_rate
31282 # at the decimal point.
31283 warn ratelimit = 100 / 1h / per_rcpt / strict
31284      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
31285                    $sender_rate_limit }s
31286
31287 # Keep authenticated users under control
31288 deny authenticated = *
31289      ratelimit = 100 / 1d / strict / $authenticated_id
31290
31291 # System-wide rate limit
31292 defer message = Sorry, too busy. Try again later.
31293      ratelimit = 10 / 1s / $primary_hostname
31294
31295 # Restrict incoming rate from each host, with a default
31296 # set using a macro and special cases looked up in a table.
31297 defer message = Sender rate exceeds $sender_rate_limit \
31298                messages per $sender_rate_period
31299      ratelimit = ${lookup {$sender_host_address} \
31300                    cdb {DB/ratelimits.cdb} \
31301                    {$value} {RATELIMIT} }
31302 .endd
31303 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
31304 especially with the &%per_rcpt%& option, you may suffer from a performance
31305 bottleneck caused by locking on the ratelimit hints database. Apart from
31306 making your ACLs less complicated, you can reduce the problem by using a
31307 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
31308 this means that Exim will lose its hints data after a reboot (including retry
31309 hints, the callout cache, and ratelimit data).
31310
31311
31312
31313 .section "Address verification" "SECTaddressverification"
31314 .cindex "verifying address" "options for"
31315 .cindex "policy control" "address verification"
31316 Several of the &%verify%& conditions described in section
31317 &<<SECTaclconditions>>& cause addresses to be verified. Section
31318 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
31319 The verification conditions can be followed by options that modify the
31320 verification process. The options are separated from the keyword and from each
31321 other by slashes, and some of them contain parameters. For example:
31322 .code
31323 verify = sender/callout
31324 verify = recipient/defer_ok/callout=10s,defer_ok
31325 .endd
31326 The first stage of address verification, which always happens, is to run the
31327 address through the routers, in &"verify mode"&. Routers can detect the
31328 difference between verification and routing for delivery, and their actions can
31329 be varied by a number of generic options such as &%verify%& and &%verify_only%&
31330 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
31331 The available options are as follows:
31332
31333 .ilist
31334 If the &%callout%& option is specified, successful routing to one or more
31335 remote hosts is followed by a &"callout"& to those hosts as an additional
31336 check. Callouts and their sub-options are discussed in the next section.
31337 .next
31338 If there is a defer error while doing verification routing, the ACL
31339 normally returns &"defer"&. However, if you include &%defer_ok%& in the
31340 options, the condition is forced to be true instead. Note that this is a main
31341 verification option as well as a suboption for callouts.
31342 .next
31343 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
31344 discusses the reporting of sender address verification failures.
31345 .next
31346 The &%success_on_redirect%& option causes verification always to succeed
31347 immediately after a successful redirection. By default, if a redirection
31348 generates just one address, that address is also verified. See further
31349 discussion in section &<<SECTredirwhilveri>>&.
31350 .endlist
31351
31352 .cindex "verifying address" "differentiating failures"
31353 .vindex "&$recipient_verify_failure$&"
31354 .vindex "&$sender_verify_failure$&"
31355 .vindex "&$acl_verify_message$&"
31356 After an address verification failure, &$acl_verify_message$& contains the
31357 error message that is associated with the failure. It can be preserved by
31358 coding like this:
31359 .code
31360 warn  !verify = sender
31361        set acl_m0 = $acl_verify_message
31362 .endd
31363 If you are writing your own custom rejection message or log message when
31364 denying access, you can use this variable to include information about the
31365 verification failure.
31366
31367 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
31368 appropriate) contains one of the following words:
31369
31370 .ilist
31371 &%qualify%&: The address was unqualified (no domain), and the message
31372 was neither local nor came from an exempted host.
31373 .next
31374 &%route%&: Routing failed.
31375 .next
31376 &%mail%&: Routing succeeded, and a callout was attempted; rejection
31377 occurred at or before the MAIL command (that is, on initial
31378 connection, HELO, or MAIL).
31379 .next
31380 &%recipient%&: The RCPT command in a callout was rejected.
31381 .next
31382 &%postmaster%&: The postmaster check in a callout was rejected.
31383 .endlist
31384
31385 The main use of these variables is expected to be to distinguish between
31386 rejections of MAIL and rejections of RCPT in callouts.
31387
31388 .new
31389 The above variables may also be set after a &*successful*&
31390 address verification to:
31391
31392 .ilist
31393 &%random%&: A random local-part callout succeeded
31394 .endlist
31395 .wen
31396
31397
31398
31399
31400 .section "Callout verification" "SECTcallver"
31401 .cindex "verifying address" "by callout"
31402 .cindex "callout" "verification"
31403 .cindex "SMTP" "callout verification"
31404 For non-local addresses, routing verifies the domain, but is unable to do any
31405 checking of the local part. There are situations where some means of verifying
31406 the local part is desirable. One way this can be done is to make an SMTP
31407 &'callback'& to a delivery host for the sender address or a &'callforward'& to
31408 a subsequent host for a recipient address, to see if the host accepts the
31409 address. We use the term &'callout'& to cover both cases. Note that for a
31410 sender address, the callback is not to the client host that is trying to
31411 deliver the message, but to one of the hosts that accepts incoming mail for the
31412 sender's domain.
31413
31414 Exim does not do callouts by default. If you want them to happen, you must
31415 request them by setting appropriate options on the &%verify%& condition, as
31416 described below. This facility should be used with care, because it can add a
31417 lot of resource usage to the cost of verifying an address. However, Exim does
31418 cache the results of callouts, which helps to reduce the cost. Details of
31419 caching are in section &<<SECTcallvercache>>&.
31420
31421 Recipient callouts are usually used only between hosts that are controlled by
31422 the same administration. For example, a corporate gateway host could use
31423 callouts to check for valid recipients on an internal mailserver. A successful
31424 callout does not guarantee that a real delivery to the address would succeed;
31425 on the other hand, a failing callout does guarantee that a delivery would fail.
31426
31427 If the &%callout%& option is present on a condition that verifies an address, a
31428 second stage of verification occurs if the address is successfully routed to
31429 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
31430 &(manualroute)& router, where the router specifies the hosts. However, if a
31431 router that does not set up hosts routes to an &(smtp)& transport with a
31432 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
31433 &%hosts_override%& set, its hosts are always used, whether or not the router
31434 supplies a host list.
31435 Callouts are only supported on &(smtp)& transports.
31436
31437 The port that is used is taken from the transport, if it is specified and is a
31438 remote transport. (For routers that do verification only, no transport need be
31439 specified.) Otherwise, the default SMTP port is used. If a remote transport
31440 specifies an outgoing interface, this is used; otherwise the interface is not
31441 specified. Likewise, the text that is used for the HELO command is taken from
31442 the transport's &%helo_data%& option; if there is no transport, the value of
31443 &$smtp_active_hostname$& is used.
31444
31445 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
31446 test whether a bounce message could be delivered to the sender address. The
31447 following SMTP commands are sent:
31448 .display
31449 &`HELO `&<&'local host name'&>
31450 &`MAIL FROM:<>`&
31451 &`RCPT TO:`&<&'the address to be tested'&>
31452 &`QUIT`&
31453 .endd
31454 LHLO is used instead of HELO if the transport's &%protocol%& option is
31455 set to &"lmtp"&.
31456
31457 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
31458 settings.
31459
31460 A recipient callout check is similar. By default, it also uses an empty address
31461 for the sender. This default is chosen because most hosts do not make use of
31462 the sender address when verifying a recipient. Using the same address means
31463 that a single cache entry can be used for each recipient. Some sites, however,
31464 do make use of the sender address when verifying. These are catered for by the
31465 &%use_sender%& and &%use_postmaster%& options, described in the next section.
31466
31467 If the response to the RCPT command is a 2&'xx'& code, the verification
31468 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
31469 Exim tries the next host, if any. If there is a problem with all the remote
31470 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
31471 &%callout%& option is given, in which case the condition is forced to succeed.
31472
31473 .cindex "SMTP" "output flushing, disabling for callout"
31474 A callout may take a little time. For this reason, Exim normally flushes SMTP
31475 output before performing a callout in an ACL, to avoid unexpected timeouts in
31476 clients when the SMTP PIPELINING extension is in use. The flushing can be
31477 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
31478
31479
31480
31481
31482 .section "Additional parameters for callouts" "CALLaddparcall"
31483 .cindex "callout" "additional parameters for"
31484 The &%callout%& option can be followed by an equals sign and a number of
31485 optional parameters, separated by commas. For example:
31486 .code
31487 verify = recipient/callout=10s,defer_ok
31488 .endd
31489 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
31490 separate verify options, is retained for backwards compatibility, but is now
31491 deprecated. The additional parameters for &%callout%& are as follows:
31492
31493
31494 .vlist
31495 .vitem <&'a&~time&~interval'&>
31496 .cindex "callout" "timeout, specifying"
31497 This specifies the timeout that applies for the callout attempt to each host.
31498 For example:
31499 .code
31500 verify = sender/callout=5s
31501 .endd
31502 The default is 30 seconds. The timeout is used for each response from the
31503 remote host. It is also used for the initial connection, unless overridden by
31504 the &%connect%& parameter.
31505
31506
31507 .vitem &*connect&~=&~*&<&'time&~interval'&>
31508 .cindex "callout" "connection timeout, specifying"
31509 This parameter makes it possible to set a different (usually smaller) timeout
31510 for making the SMTP connection. For example:
31511 .code
31512 verify = sender/callout=5s,connect=1s
31513 .endd
31514 If not specified, this timeout defaults to the general timeout value.
31515
31516 .vitem &*defer_ok*&
31517 .cindex "callout" "defer, action on"
31518 When this parameter is present, failure to contact any host, or any other kind
31519 of temporary error, is treated as success by the ACL. However, the cache is not
31520 updated in this circumstance.
31521
31522 .vitem &*fullpostmaster*&
31523 .cindex "callout" "full postmaster check"
31524 This operates like the &%postmaster%& option (see below), but if the check for
31525 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
31526 accordance with the specification in RFC 2821. The RFC states that the
31527 unqualified address &'postmaster'& should be accepted.
31528
31529
31530 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
31531 .cindex "callout" "sender when verifying header"
31532 When verifying addresses in header lines using the &%header_sender%&
31533 verification option, Exim behaves by default as if the addresses are envelope
31534 sender addresses from a message. Callout verification therefore tests to see
31535 whether a bounce message could be delivered, by using an empty address in the
31536 MAIL command. However, it is arguable that these addresses might never be used
31537 as envelope senders, and could therefore justifiably reject bounce messages
31538 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
31539 address to use in the MAIL command. For example:
31540 .code
31541 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
31542 .endd
31543 This parameter is available only for the &%header_sender%& verification option.
31544
31545
31546 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
31547 .cindex "callout" "overall timeout, specifying"
31548 This parameter sets an overall timeout for performing a callout verification.
31549 For example:
31550 .code
31551 verify = sender/callout=5s,maxwait=30s
31552 .endd
31553 This timeout defaults to four times the callout timeout for individual SMTP
31554 commands. The overall timeout applies when there is more than one host that can
31555 be tried. The timeout is checked before trying the next host. This prevents
31556 very long delays if there are a large number of hosts and all are timing out
31557 (for example, when network connections are timing out).
31558
31559
31560 .vitem &*no_cache*&
31561 .cindex "callout" "cache, suppressing"
31562 .cindex "caching callout, suppressing"
31563 When this parameter is given, the callout cache is neither read nor updated.
31564
31565 .vitem &*postmaster*&
31566 .cindex "callout" "postmaster; checking"
31567 When this parameter is set, a successful callout check is followed by a similar
31568 check for the local part &'postmaster'& at the same domain. If this address is
31569 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
31570 the postmaster check is recorded in a cache record; if it is a failure, this is
31571 used to fail subsequent callouts for the domain without a connection being
31572 made, until the cache record expires.
31573
31574 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
31575 The postmaster check uses an empty sender in the MAIL command by default.
31576 You can use this parameter to do a postmaster check using a different address.
31577 For example:
31578 .code
31579 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
31580 .endd
31581 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
31582 one overrides. The &%postmaster%& parameter is equivalent to this example:
31583 .code
31584 require  verify = sender/callout=postmaster_mailfrom=
31585 .endd
31586 &*Warning*&: The caching arrangements for postmaster checking do not take
31587 account of the sender address. It is assumed that either the empty address or
31588 a fixed non-empty address will be used. All that Exim remembers is that the
31589 postmaster check for the domain succeeded or failed.
31590
31591
31592 .vitem &*random*&
31593 .cindex "callout" "&""random""& check"
31594 When this parameter is set, before doing the normal callout check, Exim does a
31595 check for a &"random"& local part at the same domain. The local part is not
31596 really random &-- it is defined by the expansion of the option
31597 &%callout_random_local_part%&, which defaults to
31598 .code
31599 $primary_hostname-$tod_epoch-testing
31600 .endd
31601 The idea here is to try to determine whether the remote host accepts all local
31602 parts without checking. If it does, there is no point in doing callouts for
31603 specific local parts. If the &"random"& check succeeds, the result is saved in
31604 a cache record, and used to force the current and subsequent callout checks to
31605 succeed without a connection being made, until the cache record expires.
31606
31607 .vitem &*use_postmaster*&
31608 .cindex "callout" "sender for recipient check"
31609 This parameter applies to recipient callouts only. For example:
31610 .code
31611 deny  !verify = recipient/callout=use_postmaster
31612 .endd
31613 .vindex "&$qualify_domain$&"
31614 It causes a non-empty postmaster address to be used in the MAIL command when
31615 performing the callout for the recipient, and also for a &"random"& check if
31616 that is configured. The local part of the address is &`postmaster`& and the
31617 domain is the contents of &$qualify_domain$&.
31618
31619 .vitem &*use_sender*&
31620 This option applies to recipient callouts only. For example:
31621 .code
31622 require  verify = recipient/callout=use_sender
31623 .endd
31624 It causes the message's actual sender address to be used in the MAIL
31625 command when performing the callout, instead of an empty address. There is no
31626 need to use this option unless you know that the called hosts make use of the
31627 sender when checking recipients. If used indiscriminately, it reduces the
31628 usefulness of callout caching.
31629
31630 .vitem &*hold*&
31631 This option applies to recipient callouts only. For example:
31632 .code
31633 require  verify = recipient/callout=use_sender,hold
31634 .endd
31635 It causes the connection to be held open and used for any further recipients
31636 and for eventual delivery (should that be done quickly).
31637 Doing this saves on TCP and SMTP startup costs, and TLS costs also
31638 when that is used for the connections.
31639 The advantage is only gained if there are no callout cache hits
31640 (which could be enforced by the no_cache option),
31641 if the use_sender option is used,
31642 if neither the random nor the use_postmaster option is used,
31643 and if no other callouts intervene.
31644 .endlist
31645
31646 If you use any of the parameters that set a non-empty sender for the MAIL
31647 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
31648 &%use_sender%&), you should think about possible loops. Recipient checking is
31649 usually done between two hosts that are under the same management, and the host
31650 that receives the callouts is not normally configured to do callouts itself.
31651 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
31652 these circumstances.
31653
31654 However, if you use a non-empty sender address for a callout to an arbitrary
31655 host, there is the likelihood that the remote host will itself initiate a
31656 callout check back to your host. As it is checking what appears to be a message
31657 sender, it is likely to use an empty address in MAIL, thus avoiding a
31658 callout loop. However, to be on the safe side it would be best to set up your
31659 own ACLs so that they do not do sender verification checks when the recipient
31660 is the address you use for header sender or postmaster callout checking.
31661
31662 Another issue to think about when using non-empty senders for callouts is
31663 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
31664 by the sender/recipient combination; thus, for any given recipient, many more
31665 actual callouts are performed than when an empty sender or postmaster is used.
31666
31667
31668
31669
31670 .section "Callout caching" "SECTcallvercache"
31671 .cindex "hints database" "callout cache"
31672 .cindex "callout" "cache, description of"
31673 .cindex "caching" "callout"
31674 Exim caches the results of callouts in order to reduce the amount of resources
31675 used, unless you specify the &%no_cache%& parameter with the &%callout%&
31676 option. A hints database called &"callout"& is used for the cache. Two
31677 different record types are used: one records the result of a callout check for
31678 a specific address, and the other records information that applies to the
31679 entire domain (for example, that it accepts the local part &'postmaster'&).
31680
31681 When an original callout fails, a detailed SMTP error message is given about
31682 the failure. However, for subsequent failures use the cache data, this message
31683 is not available.
31684
31685 The expiry times for negative and positive address cache records are
31686 independent, and can be set by the global options &%callout_negative_expire%&
31687 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
31688
31689 If a host gives a negative response to an SMTP connection, or rejects any
31690 commands up to and including
31691 .code
31692 MAIL FROM:<>
31693 .endd
31694 (but not including the MAIL command with a non-empty address),
31695 any callout attempt is bound to fail. Exim remembers such failures in a
31696 domain cache record, which it uses to fail callouts for the domain without
31697 making new connections, until the domain record times out. There are two
31698 separate expiry times for domain cache records:
31699 &%callout_domain_negative_expire%& (default 3h) and
31700 &%callout_domain_positive_expire%& (default 7d).
31701
31702 Domain records expire when the negative expiry time is reached if callouts
31703 cannot be made for the domain, or if the postmaster check failed.
31704 Otherwise, they expire when the positive expiry time is reached. This
31705 ensures that, for example, a host that stops accepting &"random"& local parts
31706 will eventually be noticed.
31707
31708 The callout caching mechanism is based on the domain of the address that is
31709 being tested. If the domain routes to several hosts, it is assumed that their
31710 behaviour will be the same.
31711
31712
31713
31714 .section "Sender address verification reporting" "SECTsenaddver"
31715 .cindex "verifying" "suppressing error details"
31716 See section &<<SECTaddressverification>>& for a general discussion of
31717 verification. When sender verification fails in an ACL, the details of the
31718 failure are given as additional output lines before the 550 response to the
31719 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
31720 you might see:
31721 .code
31722 MAIL FROM:<xyz@abc.example>
31723 250 OK
31724 RCPT TO:<pqr@def.example>
31725 550-Verification failed for <xyz@abc.example>
31726 550-Called:   192.168.34.43
31727 550-Sent:     RCPT TO:<xyz@abc.example>
31728 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
31729 550 Sender verification failed
31730 .endd
31731 If more than one RCPT command fails in the same way, the details are given
31732 only for the first of them. However, some administrators do not want to send
31733 out this much information. You can suppress the details by adding
31734 &`/no_details`& to the ACL statement that requests sender verification. For
31735 example:
31736 .code
31737 verify = sender/no_details
31738 .endd
31739
31740 .section "Redirection while verifying" "SECTredirwhilveri"
31741 .cindex "verifying" "redirection while"
31742 .cindex "address redirection" "while verifying"
31743 A dilemma arises when a local address is redirected by aliasing or forwarding
31744 during verification: should the generated addresses themselves be verified,
31745 or should the successful expansion of the original address be enough to verify
31746 it? By default, Exim takes the following pragmatic approach:
31747
31748 .ilist
31749 When an incoming address is redirected to just one child address, verification
31750 continues with the child address, and if that fails to verify, the original
31751 verification also fails.
31752 .next
31753 When an incoming address is redirected to more than one child address,
31754 verification does not continue. A success result is returned.
31755 .endlist
31756
31757 This seems the most reasonable behaviour for the common use of aliasing as a
31758 way of redirecting different local parts to the same mailbox. It means, for
31759 example, that a pair of alias entries of the form
31760 .code
31761 A.Wol:   aw123
31762 aw123:   :fail: Gone away, no forwarding address
31763 .endd
31764 work as expected, with both local parts causing verification failure. When a
31765 redirection generates more than one address, the behaviour is more like a
31766 mailing list, where the existence of the alias itself is sufficient for
31767 verification to succeed.
31768
31769 It is possible, however, to change the default behaviour so that all successful
31770 redirections count as successful verifications, however many new addresses are
31771 generated. This is specified by the &%success_on_redirect%& verification
31772 option. For example:
31773 .code
31774 require verify = recipient/success_on_redirect/callout=10s
31775 .endd
31776 In this example, verification succeeds if a router generates a new address, and
31777 the callout does not occur, because no address was routed to a remote host.
31778
31779 When verification is being tested via the &%-bv%& option, the treatment of
31780 redirections is as just described, unless the &%-v%& or any debugging option is
31781 also specified. In that case, full verification is done for every generated
31782 address and a report is output for each of them.
31783
31784
31785
31786 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
31787 .cindex "CSA" "verifying"
31788 Client SMTP Authorization is a system that allows a site to advertise
31789 which machines are and are not permitted to send email. This is done by placing
31790 special SRV records in the DNS; these are looked up using the client's HELO
31791 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
31792 Authorization checks in Exim are performed by the ACL condition:
31793 .code
31794 verify = csa
31795 .endd
31796 This fails if the client is not authorized. If there is a DNS problem, or if no
31797 valid CSA SRV record is found, or if the client is authorized, the condition
31798 succeeds. These three cases can be distinguished using the expansion variable
31799 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
31800 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
31801 be likely to cause problems for legitimate email.
31802
31803 The error messages produced by the CSA code include slightly more
31804 detail. If &$csa_status$& is &"defer"&, this may be because of problems
31805 looking up the CSA SRV record, or problems looking up the CSA target
31806 address record. There are four reasons for &$csa_status$& being &"fail"&:
31807
31808 .ilist
31809 The client's host name is explicitly not authorized.
31810 .next
31811 The client's IP address does not match any of the CSA target IP addresses.
31812 .next
31813 The client's host name is authorized but it has no valid target IP addresses
31814 (for example, the target's addresses are IPv6 and the client is using IPv4).
31815 .next
31816 The client's host name has no CSA SRV record but a parent domain has asserted
31817 that all subdomains must be explicitly authorized.
31818 .endlist
31819
31820 The &%csa%& verification condition can take an argument which is the domain to
31821 use for the DNS query. The default is:
31822 .code
31823 verify = csa/$sender_helo_name
31824 .endd
31825 This implementation includes an extension to CSA. If the query domain
31826 is an address literal such as [192.0.2.95], or if it is a bare IP
31827 address, Exim searches for CSA SRV records in the reverse DNS as if
31828 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
31829 meaningful to say:
31830 .code
31831 verify = csa/$sender_host_address
31832 .endd
31833 In fact, this is the check that Exim performs if the client does not say HELO.
31834 This extension can be turned off by setting the main configuration option
31835 &%dns_csa_use_reverse%& to be false.
31836
31837 If a CSA SRV record is not found for the domain itself, a search
31838 is performed through its parent domains for a record which might be
31839 making assertions about subdomains. The maximum depth of this search is limited
31840 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
31841 default. Exim does not look for CSA SRV records in a top level domain, so the
31842 default settings handle HELO domains as long as seven
31843 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
31844 of legitimate HELO domains.
31845
31846 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
31847 direct SRV lookups, this is not sufficient because of the extra parent domain
31848 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
31849 addresses into lookups in the reverse DNS space. The result of a successful
31850 lookup such as:
31851 .code
31852 ${lookup dnsdb {csa=$sender_helo_name}}
31853 .endd
31854 has two space-separated fields: an authorization code and a target host name.
31855 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
31856 authorization required but absent, or &"?"& for unknown.
31857
31858
31859
31860
31861 .section "Bounce address tag validation" "SECTverifyPRVS"
31862 .cindex "BATV, verifying"
31863 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
31864 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
31865 Genuine incoming bounce messages should therefore always be addressed to
31866 recipients that have a valid tag. This scheme is a way of detecting unwanted
31867 bounce messages caused by sender address forgeries (often called &"collateral
31868 spam"&), because the recipients of such messages do not include valid tags.
31869
31870 There are two expansion items to help with the implementation of the BATV
31871 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
31872 the original envelope sender address by using a simple key to add a hash of the
31873 address and some time-based randomizing information. The &%prvs%& expansion
31874 item creates a signed address, and the &%prvscheck%& expansion item checks one.
31875 The syntax of these expansion items is described in section
31876 &<<SECTexpansionitems>>&.
31877 The validity period on signed addresses is seven days.
31878
31879 As an example, suppose the secret per-address keys are stored in an MySQL
31880 database. A query to look up the key for an address could be defined as a macro
31881 like this:
31882 .code
31883 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
31884                 WHERE sender='${quote_mysql:$prvscheck_address}'\
31885                 }{$value}}
31886 .endd
31887 Suppose also that the senders who make use of BATV are defined by an address
31888 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
31889 use this:
31890 .code
31891 # Bounces: drop unsigned addresses for BATV senders
31892 deny message = This address does not send an unsigned reverse path
31893      senders = :
31894      recipients = +batv_senders
31895
31896 # Bounces: In case of prvs-signed address, check signature.
31897 deny message = Invalid reverse path signature.
31898      senders = :
31899      condition  = ${prvscheck {$local_part@$domain}\
31900                   {PRVSCHECK_SQL}{1}}
31901      !condition = $prvscheck_result
31902 .endd
31903 The first statement rejects recipients for bounce messages that are addressed
31904 to plain BATV sender addresses, because it is known that BATV senders do not
31905 send out messages with plain sender addresses. The second statement rejects
31906 recipients that are prvs-signed, but with invalid signatures (either because
31907 the key is wrong, or the signature has timed out).
31908
31909 A non-prvs-signed address is not rejected by the second statement, because the
31910 &%prvscheck%& expansion yields an empty string if its first argument is not a
31911 prvs-signed address, thus causing the &%condition%& condition to be false. If
31912 the first argument is a syntactically valid prvs-signed address, the yield is
31913 the third string (in this case &"1"&), whether or not the cryptographic and
31914 timeout checks succeed. The &$prvscheck_result$& variable contains the result
31915 of the checks (empty for failure, &"1"& for success).
31916
31917 There is one more issue you must consider when implementing prvs-signing:
31918 you have to ensure that the routers accept prvs-signed addresses and
31919 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
31920 router to remove the signature with a configuration along these lines:
31921 .code
31922 batv_redirect:
31923   driver = redirect
31924   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
31925 .endd
31926 This works because, if the third argument of &%prvscheck%& is empty, the result
31927 of the expansion of a prvs-signed address is the decoded value of the original
31928 address. This router should probably be the first of your routers that handles
31929 local addresses.
31930
31931 To create BATV-signed addresses in the first place, a transport of this form
31932 can be used:
31933 .code
31934 external_smtp_batv:
31935   driver = smtp
31936   return_path = ${prvs {$return_path} \
31937                        {${lookup mysql{SELECT \
31938                        secret FROM batv_prvs WHERE \
31939                        sender='${quote_mysql:$sender_address}'} \
31940                        {$value}fail}}}
31941 .endd
31942 If no key can be found for the existing return path, no signing takes place.
31943
31944
31945
31946 .section "Using an ACL to control relaying" "SECTrelaycontrol"
31947 .cindex "&ACL;" "relay control"
31948 .cindex "relaying" "control by ACL"
31949 .cindex "policy control" "relay control"
31950 An MTA is said to &'relay'& a message if it receives it from some host and
31951 delivers it directly to another host as a result of a remote address contained
31952 within it. Redirecting a local address via an alias or forward file and then
31953 passing the message on to another host is not relaying,
31954 .cindex "&""percent hack""&"
31955 but a redirection as a result of the &"percent hack"& is.
31956
31957 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
31958 A host which is acting as a gateway or an MX backup is concerned with incoming
31959 relaying from arbitrary hosts to a specific set of domains. On the other hand,
31960 a host which is acting as a smart host for a number of clients is concerned
31961 with outgoing relaying from those clients to the Internet at large. Often the
31962 same host is fulfilling both functions,
31963 . ///
31964 . as illustrated in the diagram below,
31965 . ///
31966 but in principle these two kinds of relaying are entirely independent. What is
31967 not wanted is the transmission of mail from arbitrary remote hosts through your
31968 system to arbitrary domains.
31969
31970
31971 You can implement relay control by means of suitable statements in the ACL that
31972 runs for each RCPT command. For convenience, it is often easiest to use
31973 Exim's named list facility to define the domains and hosts involved. For
31974 example, suppose you want to do the following:
31975
31976 .ilist
31977 Deliver a number of domains to mailboxes on the local host (or process them
31978 locally in some other way). Let's say these are &'my.dom1.example'& and
31979 &'my.dom2.example'&.
31980 .next
31981 Relay mail for a number of other domains for which you are the secondary MX.
31982 These might be &'friend1.example'& and &'friend2.example'&.
31983 .next
31984 Relay mail from the hosts on your local LAN, to whatever domains are involved.
31985 Suppose your LAN is 192.168.45.0/24.
31986 .endlist
31987
31988
31989 In the main part of the configuration, you put the following definitions:
31990 .code
31991 domainlist local_domains    = my.dom1.example : my.dom2.example
31992 domainlist relay_to_domains = friend1.example : friend2.example
31993 hostlist   relay_from_hosts = 192.168.45.0/24
31994 .endd
31995 Now you can use these definitions in the ACL that is run for every RCPT
31996 command:
31997 .code
31998 acl_check_rcpt:
31999   accept domains = +local_domains : +relay_to_domains
32000   accept hosts   = +relay_from_hosts
32001 .endd
32002 The first statement accepts any RCPT command that contains an address in
32003 the local or relay domains. For any other domain, control passes to the second
32004 statement, which accepts the command only if it comes from one of the relay
32005 hosts. In practice, you will probably want to make your ACL more sophisticated
32006 than this, for example, by including sender and recipient verification. The
32007 default configuration includes a more comprehensive example, which is described
32008 in chapter &<<CHAPdefconfil>>&.
32009
32010
32011
32012 .section "Checking a relay configuration" "SECTcheralcon"
32013 .cindex "relaying" "checking control of"
32014 You can check the relay characteristics of your configuration in the same way
32015 that you can test any ACL behaviour for an incoming SMTP connection, by using
32016 the &%-bh%& option to run a fake SMTP session with which you interact.
32017 .ecindex IIDacl
32018
32019
32020
32021 . ////////////////////////////////////////////////////////////////////////////
32022 . ////////////////////////////////////////////////////////////////////////////
32023
32024 .chapter "Content scanning at ACL time" "CHAPexiscan"
32025 .scindex IIDcosca "content scanning" "at ACL time"
32026 The extension of Exim to include content scanning at ACL time, formerly known
32027 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
32028 was integrated into the main source for Exim release 4.50, and Tom continues to
32029 maintain it. Most of the wording of this chapter is taken from Tom's
32030 specification.
32031
32032 It is also possible to scan the content of messages at other times. The
32033 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
32034 scanning after all the ACLs have run. A transport filter can be used to scan
32035 messages at delivery time (see the &%transport_filter%& option, described in
32036 chapter &<<CHAPtransportgeneric>>&).
32037
32038 If you want to include the ACL-time content-scanning features when you compile
32039 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
32040 &_Local/Makefile_&. When you do that, the Exim binary is built with:
32041
32042 .ilist
32043 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
32044 for all MIME parts for SMTP and non-SMTP messages, respectively.
32045 .next
32046 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
32047 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
32048 run at the end of message reception (the &%acl_smtp_data%& ACL).
32049 .next
32050 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
32051 of messages, or parts of messages, for debugging purposes.
32052 .next
32053 Additional expansion variables that are set in the new ACL and by the new
32054 conditions.
32055 .next
32056 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
32057 .endlist
32058
32059 Content-scanning is continually evolving, and new features are still being
32060 added. While such features are still unstable and liable to incompatible
32061 changes, they are made available in Exim by setting options whose names begin
32062 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
32063 this manual. You can find out about them by reading the file called
32064 &_doc/experimental.txt_&.
32065
32066 All the content-scanning facilities work on a MBOX copy of the message that is
32067 temporarily created in a file called:
32068 .display
32069 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
32070 .endd
32071 The &_.eml_& extension is a friendly hint to virus scanners that they can
32072 expect an MBOX-like structure inside that file. The file is created when the
32073 first content scanning facility is called. Subsequent calls to content
32074 scanning conditions open the same file again. The directory is recursively
32075 removed when the &%acl_smtp_data%& ACL has finished running, unless
32076 .code
32077 control = no_mbox_unspool
32078 .endd
32079 has been encountered. When the MIME ACL decodes files, they are put into the
32080 same directory by default.
32081
32082
32083
32084 .section "Scanning for viruses" "SECTscanvirus"
32085 .cindex "virus scanning"
32086 .cindex "content scanning" "for viruses"
32087 .cindex "content scanning" "the &%malware%& condition"
32088 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
32089 It supports a &"generic"& interface to scanners called via the shell, and
32090 specialized interfaces for &"daemon"& type virus scanners, which are resident
32091 in memory and thus are much faster.
32092
32093 A timeout of 2 minutes is applied to a scanner call (by default);
32094 if it expires then a defer action is taken.
32095
32096 .oindex "&%av_scanner%&"
32097 You can set the &%av_scanner%& option in the main part of the configuration
32098 to specify which scanner to use, together with any additional options that
32099 are needed. The basic syntax is as follows:
32100 .display
32101 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
32102 .endd
32103 If you do not set &%av_scanner%&, it defaults to
32104 .code
32105 av_scanner = sophie:/var/run/sophie
32106 .endd
32107 If the value of &%av_scanner%& starts with a dollar character, it is expanded
32108 before use.
32109 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
32110 The following scanner types are supported in this release,
32111 though individual ones can be included or not at build time:
32112
32113 .vlist
32114 .vitem &%avast%&
32115 .cindex "virus scanners" "avast"
32116 This is the scanner daemon of Avast. It has been tested with Avast Core
32117 Security (currently at version 2.2.0).
32118 You can get a trial version at &url(https://www.avast.com) or for Linux
32119 at &url(https://www.avast.com/linux-server-antivirus).
32120 This scanner type takes one option,
32121 which can be either a full path to a UNIX socket,
32122 or host and port specifiers separated by white space.
32123 The host may be a name or an IP address; the port is either a
32124 single number or a pair of numbers with a dash between.
32125 A list of options may follow. These options are interpreted on the
32126 Exim's side of the malware scanner, or are given on separate lines to
32127 the daemon as options before the main scan command.
32128
32129 .cindex &`pass_unscanned`& "avast"
32130 If &`pass_unscanned`&
32131 is set, any files the Avast scanner can't scan (e.g.
32132 decompression bombs, or invalid archives) are considered clean. Use with
32133 care.
32134
32135 For example:
32136 .code
32137 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
32138 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
32139 av_scanner = avast:192.168.2.22 5036
32140 .endd
32141 If you omit the argument, the default path
32142 &_/var/run/avast/scan.sock_&
32143 is used.
32144 If you use a remote host,
32145 you need to make Exim's spool directory available to it,
32146 as the scanner is passed a file path, not file contents.
32147 For information about available commands and their options you may use
32148 .code
32149 $ socat UNIX:/var/run/avast/scan.sock STDIO:
32150     FLAGS
32151     SENSITIVITY
32152     PACK
32153 .endd
32154
32155 If the scanner returns a temporary failure (e.g. license issues, or
32156 permission problems), the message is deferred and a paniclog entry is
32157 written.  The usual &`defer_ok`& option is available.
32158
32159 .vitem &%aveserver%&
32160 .cindex "virus scanners" "Kaspersky"
32161 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
32162 at &url(https://www.kaspersky.com/). This scanner type takes one option,
32163 which is the path to the daemon's UNIX socket. The default is shown in this
32164 example:
32165 .code
32166 av_scanner = aveserver:/var/run/aveserver
32167 .endd
32168
32169
32170 .vitem &%clamd%&
32171 .cindex "virus scanners" "clamd"
32172 This daemon-type scanner is GPL and free. You can get it at
32173 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
32174 unpack MIME containers, so it used to be recommended to unpack MIME attachments
32175 in the MIME ACL. This is no longer believed to be necessary.
32176
32177 The options are a list of server specifiers, which may be
32178 a UNIX socket specification,
32179 a TCP socket specification,
32180 or a (global) option.
32181
32182 A socket specification consists of a space-separated list.
32183 For a Unix socket the first element is a full path for the socket,
32184 for a TCP socket the first element is the IP address
32185 and the second a port number,
32186 Any further elements are per-server (non-global) options.
32187 These per-server options are supported:
32188 .code
32189 retry=<timespec>        Retry on connect fail
32190 .endd
32191
32192 The &`retry`& option specifies a time after which a single retry for
32193 a failed connect is made.  The default is to not retry.
32194
32195 If a Unix socket file is specified, only one server is supported.
32196
32197 Examples:
32198 .code
32199 av_scanner = clamd:/opt/clamd/socket
32200 av_scanner = clamd:192.0.2.3 1234
32201 av_scanner = clamd:192.0.2.3 1234:local
32202 av_scanner = clamd:192.0.2.3 1234 retry=10s
32203 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
32204 .endd
32205 If the value of av_scanner points to a UNIX socket file or contains the
32206 &`local`&
32207 option, then the ClamAV interface will pass a filename containing the data
32208 to be scanned, which should normally result in less I/O happening and be
32209 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
32210 Exim does not assume that there is a common filesystem with the remote host.
32211
32212 The final example shows that multiple TCP targets can be specified.  Exim will
32213 randomly use one for each incoming email (i.e. it load balances them).  Note
32214 that only TCP targets may be used if specifying a list of scanners; a UNIX
32215 socket cannot be mixed in with TCP targets.  If one of the servers becomes
32216 unavailable, Exim will try the remaining one(s) until it finds one that works.
32217 When a clamd server becomes unreachable, Exim will log a message.  Exim does
32218 not keep track of scanner state between multiple messages, and the scanner
32219 selection is random, so the message will get logged in the mainlog for each
32220 email that the down scanner gets chosen first (message wrapped to be readable):
32221 .code
32222 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
32223    clamd: connection to localhost, port 3310 failed
32224    (Connection refused)
32225 .endd
32226
32227 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
32228 contributing the code for this scanner.
32229
32230 .vitem &%cmdline%&
32231 .cindex "virus scanners" "command line interface"
32232 This is the keyword for the generic command line scanner interface. It can be
32233 used to attach virus scanners that are invoked from the shell. This scanner
32234 type takes 3 mandatory options:
32235
32236 .olist
32237 The full path and name of the scanner binary, with all command line options,
32238 and a placeholder (&`%s`&) for the directory to scan.
32239
32240 .next
32241 A regular expression to match against the STDOUT and STDERR output of the
32242 virus scanner. If the expression matches, a virus was found. You must make
32243 absolutely sure that this expression matches on &"virus found"&. This is called
32244 the &"trigger"& expression.
32245
32246 .next
32247 Another regular expression, containing exactly one pair of parentheses, to
32248 match the name of the virus found in the scanners output. This is called the
32249 &"name"& expression.
32250 .endlist olist
32251
32252 For example, Sophos Sweep reports a virus on a line like this:
32253 .code
32254 Virus 'W32/Magistr-B' found in file ./those.bat
32255 .endd
32256 For the trigger expression, we can match the phrase &"found in file"&. For the
32257 name expression, we want to extract the W32/Magistr-B string, so we can match
32258 for the single quotes left and right of it. Altogether, this makes the
32259 configuration setting:
32260 .code
32261 av_scanner = cmdline:\
32262              /path/to/sweep -ss -all -rec -archive %s:\
32263              found in file:'(.+)'
32264 .endd
32265 .vitem &%drweb%&
32266 .cindex "virus scanners" "DrWeb"
32267 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
32268 takes one option,
32269 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 For example:
32274 .code
32275 av_scanner = drweb:/var/run/drwebd.sock
32276 av_scanner = drweb:192.168.2.20 31337
32277 .endd
32278 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
32279 is used. Thanks to Alex Miller for contributing the code for this scanner.
32280
32281 .vitem &%f-protd%&
32282 .cindex "virus scanners" "f-protd"
32283 The f-protd scanner is accessed via HTTP over TCP.
32284 One argument is taken, being a space-separated hostname and port number
32285 (or port-range).
32286 For example:
32287 .code
32288 av_scanner = f-protd:localhost 10200-10204
32289 .endd
32290 If you omit the argument, the default values shown above are used.
32291
32292 .vitem &%f-prot6d%&
32293 .cindex "virus scanners" "f-prot6d"
32294 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
32295 One argument is taken, being a space-separated hostname and port number.
32296 For example:
32297 .code
32298 av_scanner = f-prot6d:localhost 10200
32299 .endd
32300 If you omit the argument, the default values show above are used.
32301
32302 .vitem &%fsecure%&
32303 .cindex "virus scanners" "F-Secure"
32304 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
32305 argument which is the path to a UNIX socket. For example:
32306 .code
32307 av_scanner = fsecure:/path/to/.fsav
32308 .endd
32309 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
32310 Thelmen for contributing the code for this scanner.
32311
32312 .vitem &%kavdaemon%&
32313 .cindex "virus scanners" "Kaspersky"
32314 This is the scanner daemon of Kaspersky Version 4. This version of the
32315 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
32316 scanner type takes one option, which is the path to the daemon's UNIX socket.
32317 For example:
32318 .code
32319 av_scanner = kavdaemon:/opt/AVP/AvpCtl
32320 .endd
32321 The default path is &_/var/run/AvpCtl_&.
32322
32323 .vitem &%mksd%&
32324 .cindex "virus scanners" "mksd"
32325 This was a daemon type scanner that is aimed mainly at Polish users,
32326 though some documentation was available in English.
32327 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
32328 and this appears to be a candidate for removal from Exim, unless
32329 we are informed of other virus scanners which use the same protocol
32330 to integrate.
32331 The only option for this scanner type is
32332 the maximum number of processes used simultaneously to scan the attachments,
32333 provided that mksd has
32334 been run with at least the same number of child processes. For example:
32335 .code
32336 av_scanner = mksd:2
32337 .endd
32338 You can safely omit this option (the default value is 1).
32339
32340 .vitem &%sock%&
32341 .cindex "virus scanners" "simple socket-connected"
32342 This is a general-purpose way of talking to simple scanner daemons
32343 running on the local machine.
32344 There are four options:
32345 an address (which may be an IP address and port, or the path of a Unix socket),
32346 a commandline to send (may include a single %s which will be replaced with
32347 the path to the mail file to be scanned),
32348 an RE to trigger on from the returned data,
32349 and an RE to extract malware_name from the returned data.
32350 For example:
32351 .code
32352 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
32353 .endd
32354 Note that surrounding whitespace is stripped from each option, meaning
32355 there is no way to specify a trailing newline.
32356 The socket specifier and both regular-expressions are required.
32357 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
32358 specify an empty element to get this.
32359
32360 .vitem &%sophie%&
32361 .cindex "virus scanners" "Sophos and Sophie"
32362 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
32363 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
32364 for this scanner type is the path to the UNIX socket that Sophie uses for
32365 client communication. For example:
32366 .code
32367 av_scanner = sophie:/tmp/sophie
32368 .endd
32369 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
32370 the option.
32371 .endlist
32372
32373 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
32374 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
32375 ACL.
32376
32377 The &%av_scanner%& option is expanded each time &%malware%& is called. This
32378 makes it possible to use different scanners. See further below for an example.
32379 The &%malware%& condition caches its results, so when you use it multiple times
32380 for the same message, the actual scanning process is only carried out once.
32381 However, using expandable items in &%av_scanner%& disables this caching, in
32382 which case each use of the &%malware%& condition causes a new scan of the
32383 message.
32384
32385 The &%malware%& condition takes a right-hand argument that is expanded before
32386 use and taken as a list, slash-separated by default.
32387 The first element can then be one of
32388
32389 .ilist
32390 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
32391 The condition succeeds if a virus was found, and fail otherwise. This is the
32392 recommended usage.
32393 .next
32394 &"false"& or &"0"& or an empty string, in which case no scanning is done and
32395 the condition fails immediately.
32396 .next
32397 A regular expression, in which case the message is scanned for viruses. The
32398 condition succeeds if a virus is found and its name matches the regular
32399 expression. This allows you to take special actions on certain types of virus.
32400 Note that &"/"& characters in the RE must be doubled due to the list-processing,
32401 unless the separator is changed (in the usual way).
32402 .endlist
32403
32404 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
32405 messages even if there is a problem with the virus scanner.
32406 Otherwise, such a problem causes the ACL to defer.
32407
32408 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
32409 specify a non-default timeout.  The default is two minutes.
32410 For example:
32411 .code
32412 malware = * / defer_ok / tmo=10s
32413 .endd
32414 A timeout causes the ACL to defer.
32415
32416 .vindex "&$callout_address$&"
32417 When a connection is made to the scanner the expansion variable &$callout_address$&
32418 is set to record the actual address used.
32419
32420 .vindex "&$malware_name$&"
32421 When a virus is found, the condition sets up an expansion variable called
32422 &$malware_name$& that contains the name of the virus. You can use it in a
32423 &%message%& modifier that specifies the error returned to the sender, and/or in
32424 logging data.
32425
32426 Beware the interaction of Exim's &%message_size_limit%& with any size limits
32427 imposed by your anti-virus scanner.
32428
32429 Here is a very simple scanning example:
32430 .code
32431 deny message = This message contains malware ($malware_name)
32432      malware = *
32433 .endd
32434 The next example accepts messages when there is a problem with the scanner:
32435 .code
32436 deny message = This message contains malware ($malware_name)
32437      malware = */defer_ok
32438 .endd
32439 The next example shows how to use an ACL variable to scan with both sophie and
32440 aveserver. It assumes you have set:
32441 .code
32442 av_scanner = $acl_m0
32443 .endd
32444 in the main Exim configuration.
32445 .code
32446 deny message = This message contains malware ($malware_name)
32447      set acl_m0 = sophie
32448      malware = *
32449
32450 deny message = This message contains malware ($malware_name)
32451      set acl_m0 = aveserver
32452      malware = *
32453 .endd
32454
32455
32456 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
32457 .cindex "content scanning" "for spam"
32458 .cindex "spam scanning"
32459 .cindex "SpamAssassin"
32460 .cindex "Rspamd"
32461 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
32462 score and a report for the message.
32463 Support is also provided for Rspamd.
32464
32465 For more information about installation and configuration of SpamAssassin or
32466 Rspamd refer to their respective websites at
32467 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
32468
32469 SpamAssassin can be installed with CPAN by running:
32470 .code
32471 perl -MCPAN -e 'install Mail::SpamAssassin'
32472 .endd
32473 SpamAssassin has its own set of configuration files. Please review its
32474 documentation to see how you can tweak it. The default installation should work
32475 nicely, however.
32476
32477 .oindex "&%spamd_address%&"
32478 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
32479 intend to use an instance running on the local host you do not need to set
32480 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
32481 you must set the &%spamd_address%& option in the global part of the Exim
32482 configuration as follows (example):
32483 .code
32484 spamd_address = 192.168.99.45 387
32485 .endd
32486 The SpamAssassin protocol relies on a TCP half-close from the client.
32487 If your SpamAssassin client side is running a Linux system with an
32488 iptables firewall, consider setting
32489 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
32490 timeout, Exim uses when waiting for a response from the SpamAssassin
32491 server (currently defaulting to 120s).  With a lower value the Linux
32492 connection tracking may consider your half-closed connection as dead too
32493 soon.
32494
32495
32496 To use Rspamd (which by default listens on all local addresses
32497 on TCP port 11333)
32498 you should add &%variant=rspamd%& after the address/port pair, for example:
32499 .code
32500 spamd_address = 127.0.0.1 11333 variant=rspamd
32501 .endd
32502
32503 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
32504 sockets. If you want to us these, supply &%spamd_address%& with an absolute
32505 file name instead of an address/port pair:
32506 .code
32507 spamd_address = /var/run/spamd_socket
32508 .endd
32509 You can have multiple &%spamd%& servers to improve scalability. These can
32510 reside on other hardware reachable over the network. To specify multiple
32511 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
32512 option, separated with colons (the separator can be changed in the usual way):
32513 .code
32514 spamd_address = 192.168.2.10 783 : \
32515                 192.168.2.11 783 : \
32516                 192.168.2.12 783
32517 .endd
32518 Up to 32 &%spamd%& servers are supported.
32519 When a server fails to respond to the connection attempt, all other
32520 servers are tried until one succeeds. If no server responds, the &%spam%&
32521 condition defers.
32522
32523 Unix and TCP socket specifications may be mixed in any order.
32524 Each element of the list is a list itself, space-separated by default
32525 and changeable in the usual way; take care to not double the separator.
32526
32527 For TCP socket specifications a host name or IP (v4 or v6, but
32528 subject to list-separator quoting rules) address can be used,
32529 and the port can be one or a dash-separated pair.
32530 In the latter case, the range is tried in strict order.
32531
32532 Elements after the first for Unix sockets, or second for TCP socket,
32533 are options.
32534 The supported options are:
32535 .code
32536 pri=<priority>      Selection priority
32537 weight=<value>      Selection bias
32538 time=<start>-<end>  Use only between these times of day
32539 retry=<timespec>    Retry on connect fail
32540 tmo=<timespec>      Connection time limit
32541 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
32542 .endd
32543
32544 The &`pri`& option specifies a priority for the server within the list,
32545 higher values being tried first.
32546 The default priority is 1.
32547
32548 The &`weight`& option specifies a selection bias.
32549 Within a priority set
32550 servers are queried in a random fashion, weighted by this value.
32551 The default value for selection bias is 1.
32552
32553 Time specifications for the &`time`& option are <hour>.<minute>.<second>
32554 in the local time zone; each element being one or more digits.
32555 Either the seconds or both minutes and seconds, plus the leading &`.`&
32556 characters, may be omitted and will be taken as zero.
32557
32558 Timeout specifications for the &`retry`& and &`tmo`& options
32559 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
32560
32561 The &`tmo`& option specifies an overall timeout for communication.
32562 The default value is two minutes.
32563
32564 The &`retry`& option specifies a time after which a single retry for
32565 a failed connect is made.
32566 The default is to not retry.
32567
32568 The &%spamd_address%& variable is expanded before use if it starts with
32569 a dollar sign. In this case, the expansion may return a string that is
32570 used as the list so that multiple spamd servers can be the result of an
32571 expansion.
32572
32573 .vindex "&$callout_address$&"
32574 When a connection is made to the server the expansion variable &$callout_address$&
32575 is set to record the actual address used.
32576
32577 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
32578 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
32579 .code
32580 deny message = This message was classified as SPAM
32581      spam = joe
32582 .endd
32583 The right-hand side of the &%spam%& condition specifies a name. This is
32584 relevant if you have set up multiple SpamAssassin profiles. If you do not want
32585 to scan using a specific profile, but rather use the SpamAssassin system-wide
32586 default profile, you can scan for an unknown name, or simply use &"nobody"&.
32587 Rspamd does not use this setting. However, you must put something on the
32588 right-hand side.
32589
32590 The name allows you to use per-domain or per-user antispam profiles in
32591 principle, but this is not straightforward in practice, because a message may
32592 have multiple recipients, not necessarily all in the same domain. Because the
32593 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
32594 read the contents of the message, the variables &$local_part$& and &$domain$&
32595 are not set.
32596 Careful enforcement of single-recipient messages
32597 (e.g. by responding with defer in the recipient ACL for all recipients
32598 after the first),
32599 or the use of PRDR,
32600 .cindex "PRDR" "use for per-user SpamAssassin profiles"
32601 are needed to use this feature.
32602
32603 The right-hand side of the &%spam%& condition is expanded before being used, so
32604 you can put lookups or conditions there. When the right-hand side evaluates to
32605 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
32606
32607
32608 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
32609 large ones may cause significant performance degradation. As most spam messages
32610 are quite small, it is recommended that you do not scan the big ones. For
32611 example:
32612 .code
32613 deny message = This message was classified as SPAM
32614      condition = ${if < {$message_size}{10K}}
32615      spam = nobody
32616 .endd
32617
32618 The &%spam%& condition returns true if the threshold specified in the user's
32619 SpamAssassin profile has been matched or exceeded. If you want to use the
32620 &%spam%& condition for its side effects (see the variables below), you can make
32621 it always return &"true"& by appending &`:true`& to the username.
32622
32623 .cindex "spam scanning" "returned variables"
32624 When the &%spam%& condition is run, it sets up a number of expansion
32625 variables.
32626 Except for &$spam_report$&,
32627 these variables are saved with the received message so are
32628 available for use at delivery time.
32629
32630 .vlist
32631 .vitem &$spam_score$&
32632 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
32633 for inclusion in log or reject messages.
32634
32635 .vitem &$spam_score_int$&
32636 The spam score of the message, multiplied by ten, as an integer value. For
32637 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
32638 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
32639 The integer value is useful for numeric comparisons in conditions.
32640
32641 .vitem &$spam_bar$&
32642 A string consisting of a number of &"+"& or &"-"& characters, representing the
32643 integer part of the spam score value. A spam score of 4.4 would have a
32644 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
32645 headers, since MUAs can match on such strings. The maximum length of the
32646 spam bar is 50 characters.
32647
32648 .vitem &$spam_report$&
32649 A multiline text table, containing the full SpamAssassin report for the
32650 message. Useful for inclusion in headers or reject messages.
32651 This variable is only usable in a DATA-time ACL.
32652 Beware that SpamAssassin may return non-ASCII characters, especially
32653 when running in country-specific locales, which are not legal
32654 unencoded in headers.
32655
32656 .vitem &$spam_action$&
32657 For SpamAssassin either 'reject' or 'no action' depending on the
32658 spam score versus threshold.
32659 For Rspamd, the recommended action.
32660
32661 .endlist
32662
32663 The &%spam%& condition caches its results unless expansion in
32664 spamd_address was used. If you call it again with the same user name, it
32665 does not scan again, but rather returns the same values as before.
32666
32667 The &%spam%& condition returns DEFER if there is any error while running
32668 the message through SpamAssassin or if the expansion of spamd_address
32669 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
32670 statement block), append &`/defer_ok`& to the right-hand side of the
32671 spam condition, like this:
32672 .code
32673 deny message = This message was classified as SPAM
32674      spam    = joe/defer_ok
32675 .endd
32676 This causes messages to be accepted even if there is a problem with &%spamd%&.
32677
32678 Here is a longer, commented example of the use of the &%spam%&
32679 condition:
32680 .code
32681 # put headers in all messages (no matter if spam or not)
32682 warn  spam = nobody:true
32683       add_header = X-Spam-Score: $spam_score ($spam_bar)
32684       add_header = X-Spam-Report: $spam_report
32685
32686 # add second subject line with *SPAM* marker when message
32687 # is over threshold
32688 warn  spam = nobody
32689       add_header = Subject: *SPAM* $h_Subject:
32690
32691 # reject spam at high scores (> 12)
32692 deny  message = This message scored $spam_score spam points.
32693       spam = nobody:true
32694       condition = ${if >{$spam_score_int}{120}{1}{0}}
32695 .endd
32696
32697
32698
32699 .section "Scanning MIME parts" "SECTscanmimepart"
32700 .cindex "content scanning" "MIME parts"
32701 .cindex "MIME content scanning"
32702 .oindex "&%acl_smtp_mime%&"
32703 .oindex "&%acl_not_smtp_mime%&"
32704 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
32705 each MIME part of an SMTP message, including multipart types, in the sequence
32706 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
32707 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
32708 options may both refer to the same ACL if you want the same processing in both
32709 cases.
32710
32711 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
32712 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
32713 the case of a non-SMTP message. However, a MIME ACL is called only if the
32714 message contains a &'Content-Type:'& header line. When a call to a MIME
32715 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
32716 result code is sent to the client. In the case of an SMTP message, the
32717 &%acl_smtp_data%& ACL is not called when this happens.
32718
32719 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
32720 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
32721 condition to match against the raw MIME part. You can also use the
32722 &%mime_regex%& condition to match against the decoded MIME part (see section
32723 &<<SECTscanregex>>&).
32724
32725 At the start of a MIME ACL, a number of variables are set from the header
32726 information for the relevant MIME part. These are described below. The contents
32727 of the MIME part are not by default decoded into a disk file except for MIME
32728 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
32729 part into a disk file, you can use the &%decode%& condition. The general
32730 syntax is:
32731 .display
32732 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
32733 .endd
32734 The right hand side is expanded before use. After expansion,
32735 the value can be:
32736
32737 .olist
32738 &"0"& or &"false"&, in which case no decoding is done.
32739 .next
32740 The string &"default"&. In that case, the file is put in the temporary
32741 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
32742 a sequential file name consisting of the message id and a sequence number. The
32743 full path and name is available in &$mime_decoded_filename$& after decoding.
32744 .next
32745 A full path name starting with a slash. If the full name is an existing
32746 directory, it is used as a replacement for the default directory. The filename
32747 is then sequentially assigned. If the path does not exist, it is used as
32748 the full path and file name.
32749 .next
32750 If the string does not start with a slash, it is used as the
32751 filename, and the default path is then used.
32752 .endlist
32753 The &%decode%& condition normally succeeds. It is only false for syntax
32754 errors or unusual circumstances such as memory shortages. You can easily decode
32755 a file with its original, proposed filename using
32756 .code
32757 decode = $mime_filename
32758 .endd
32759 However, you should keep in mind that &$mime_filename$& might contain
32760 anything. If you place files outside of the default path, they are not
32761 automatically unlinked.
32762
32763 For RFC822 attachments (these are messages attached to messages, with a
32764 content-type of &"message/rfc822"&), the ACL is called again in the same manner
32765 as for the primary message, only that the &$mime_is_rfc822$& expansion
32766 variable is set (see below). Attached messages are always decoded to disk
32767 before being checked, and the files are unlinked once the check is done.
32768
32769 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
32770 used to match regular expressions against raw and decoded MIME parts,
32771 respectively. They are described in section &<<SECTscanregex>>&.
32772
32773 .cindex "MIME content scanning" "returned variables"
32774 The following list describes all expansion variables that are
32775 available in the MIME ACL:
32776
32777 .vlist
32778 .vitem &$mime_boundary$&
32779 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
32780 have a boundary string, which is stored in this variable. If the current part
32781 has no boundary parameter in the &'Content-Type:'& header, this variable
32782 contains the empty string.
32783
32784 .vitem &$mime_charset$&
32785 This variable contains the character set identifier, if one was found in the
32786 &'Content-Type:'& header. Examples for charset identifiers are:
32787 .code
32788 us-ascii
32789 gb2312 (Chinese)
32790 iso-8859-1
32791 .endd
32792 Please note that this value is not normalized, so you should do matches
32793 case-insensitively.
32794
32795 .vitem &$mime_content_description$&
32796 This variable contains the normalized content of the &'Content-Description:'&
32797 header. It can contain a human-readable description of the parts content. Some
32798 implementations repeat the filename for attachments here, but they are usually
32799 only used for display purposes.
32800
32801 .vitem &$mime_content_disposition$&
32802 This variable contains the normalized content of the &'Content-Disposition:'&
32803 header. You can expect strings like &"attachment"& or &"inline"& here.
32804
32805 .vitem &$mime_content_id$&
32806 This variable contains the normalized content of the &'Content-ID:'& header.
32807 This is a unique ID that can be used to reference a part from another part.
32808
32809 .vitem &$mime_content_size$&
32810 This variable is set only after the &%decode%& modifier (see above) has been
32811 successfully run. It contains the size of the decoded part in kilobytes. The
32812 size is always rounded up to full kilobytes, so only a completely empty part
32813 has a &$mime_content_size$& of zero.
32814
32815 .vitem &$mime_content_transfer_encoding$&
32816 This variable contains the normalized content of the
32817 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
32818 type. Typical values are &"base64"& and &"quoted-printable"&.
32819
32820 .vitem &$mime_content_type$&
32821 If the MIME part has a &'Content-Type:'& header, this variable contains its
32822 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
32823 are some examples of popular MIME types, as they may appear in this variable:
32824 .code
32825 text/plain
32826 text/html
32827 application/octet-stream
32828 image/jpeg
32829 audio/midi
32830 .endd
32831 If the MIME part has no &'Content-Type:'& header, this variable contains the
32832 empty string.
32833
32834 .vitem &$mime_decoded_filename$&
32835 This variable is set only after the &%decode%& modifier (see above) has been
32836 successfully run. It contains the full path and file name of the file
32837 containing the decoded data.
32838 .endlist
32839
32840 .cindex "RFC 2047"
32841 .vlist
32842 .vitem &$mime_filename$&
32843 This is perhaps the most important of the MIME variables. It contains a
32844 proposed filename for an attachment, if one was found in either the
32845 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
32846 RFC2047
32847 or RFC2231
32848 decoded, but no additional sanity checks are done.
32849  If no filename was
32850 found, this variable contains the empty string.
32851
32852 .vitem &$mime_is_coverletter$&
32853 This variable attempts to differentiate the &"cover letter"& of an e-mail from
32854 attached data. It can be used to clamp down on flashy or unnecessarily encoded
32855 content in the cover letter, while not restricting attachments at all.
32856
32857 The variable contains 1 (true) for a MIME part believed to be part of the
32858 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
32859 follows:
32860
32861 .olist
32862 The outermost MIME part of a message is always a cover letter.
32863
32864 .next
32865 If a multipart/alternative or multipart/related MIME part is a cover letter,
32866 so are all MIME subparts within that multipart.
32867
32868 .next
32869 If any other multipart is a cover letter, the first subpart is a cover letter,
32870 and the rest are attachments.
32871
32872 .next
32873 All parts contained within an attachment multipart are attachments.
32874 .endlist olist
32875
32876 As an example, the following will ban &"HTML mail"& (including that sent with
32877 alternative plain text), while allowing HTML files to be attached. HTML
32878 coverletter mail attached to non-HTML coverletter mail will also be allowed:
32879 .code
32880 deny message = HTML mail is not accepted here
32881 !condition = $mime_is_rfc822
32882 condition = $mime_is_coverletter
32883 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
32884 .endd
32885 .vitem &$mime_is_multipart$&
32886 This variable has the value 1 (true) when the current part has the main type
32887 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
32888 Since multipart entities only serve as containers for other parts, you may not
32889 want to carry out specific actions on them.
32890
32891 .vitem &$mime_is_rfc822$&
32892 This variable has the value 1 (true) if the current part is not a part of the
32893 checked message itself, but part of an attached message. Attached message
32894 decoding is fully recursive.
32895
32896 .vitem &$mime_part_count$&
32897 This variable is a counter that is raised for each processed MIME part. It
32898 starts at zero for the very first part (which is usually a multipart). The
32899 counter is per-message, so it is reset when processing RFC822 attachments (see
32900 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
32901 complete, so you can use it in the DATA ACL to determine the number of MIME
32902 parts of a message. For non-MIME messages, this variable contains the value -1.
32903 .endlist
32904
32905
32906
32907 .section "Scanning with regular expressions" "SECTscanregex"
32908 .cindex "content scanning" "with regular expressions"
32909 .cindex "regular expressions" "content scanning with"
32910 You can specify your own custom regular expression matches on the full body of
32911 the message, or on individual MIME parts.
32912
32913 The &%regex%& condition takes one or more regular expressions as arguments and
32914 matches them against the full message (when called in the DATA ACL) or a raw
32915 MIME part (when called in the MIME ACL). The &%regex%& condition matches
32916 linewise, with a maximum line length of 32K characters. That means you cannot
32917 have multiline matches with the &%regex%& condition.
32918
32919 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
32920 to 32K of decoded content (the whole content at once, not linewise). If the
32921 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
32922 is decoded automatically when &%mime_regex%& is executed (using default path
32923 and filename values). If the decoded data is larger than  32K, only the first
32924 32K characters are checked.
32925
32926 The regular expressions are passed as a colon-separated list. To include a
32927 literal colon, you must double it. Since the whole right-hand side string is
32928 expanded before being used, you must also escape dollar signs and backslashes
32929 with more backslashes, or use the &`\N`& facility to disable expansion.
32930 Here is a simple example that contains two regular expressions:
32931 .code
32932 deny message = contains blacklisted regex ($regex_match_string)
32933      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
32934 .endd
32935 The conditions returns true if any one of the regular expressions matches. The
32936 &$regex_match_string$& expansion variable is then set up and contains the
32937 matching regular expression.
32938 The expansion variables &$regex1$& &$regex2$& etc
32939 are set to any substrings captured by the regular expression.
32940
32941 &*Warning*&: With large messages, these conditions can be fairly
32942 CPU-intensive.
32943
32944 .ecindex IIDcosca
32945
32946
32947
32948
32949 . ////////////////////////////////////////////////////////////////////////////
32950 . ////////////////////////////////////////////////////////////////////////////
32951
32952 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
32953          "Local scan function"
32954 .scindex IIDlosca "&[local_scan()]& function" "description of"
32955 .cindex "customizing" "input scan using C function"
32956 .cindex "policy control" "by local scan function"
32957 In these days of email worms, viruses, and ever-increasing spam, some sites
32958 want to apply a lot of checking to messages before accepting them.
32959
32960 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
32961 passing messages to external virus and spam scanning software. You can also do
32962 a certain amount in Exim itself through string expansions and the &%condition%&
32963 condition in the ACL that runs after the SMTP DATA command or the ACL for
32964 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
32965
32966 To allow for further customization to a site's own requirements, there is the
32967 possibility of linking Exim with a private message scanning function, written
32968 in C. If you want to run code that is written in something other than C, you
32969 can of course use a little C stub to call it.
32970
32971 The local scan function is run once for every incoming message, at the point
32972 when Exim is just about to accept the message.
32973 It can therefore be used to control non-SMTP messages from local processes as
32974 well as messages arriving via SMTP.
32975
32976 Exim applies a timeout to calls of the local scan function, and there is an
32977 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
32978 Zero means &"no timeout"&.
32979 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
32980 before calling the local scan function, so that the most common types of crash
32981 are caught. If the timeout is exceeded or one of those signals is caught, the
32982 incoming message is rejected with a temporary error if it is an SMTP message.
32983 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
32984 code. The incident is logged on the main and reject logs.
32985
32986
32987
32988 .section "Building Exim to use a local scan function" "SECID207"
32989 .cindex "&[local_scan()]& function" "building Exim to use"
32990 To make use of the local scan function feature, you must tell Exim where your
32991 function is before building Exim, by setting
32992 .new
32993 both HAVE_LOCAL_SCAN and
32994 .wen
32995 LOCAL_SCAN_SOURCE in your
32996 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
32997 directory, so you might set
32998 .code
32999 HAVE_LOCAL_SCAN=yes
33000 LOCAL_SCAN_SOURCE=Local/local_scan.c
33001 .endd
33002 for example. The function must be called &[local_scan()]&. It is called by
33003 Exim after it has received a message, when the success return code is about to
33004 be sent. This is after all the ACLs have been run. The return code from your
33005 function controls whether the message is actually accepted or not. There is a
33006 commented template function (that just accepts the message) in the file
33007 _src/local_scan.c_.
33008
33009 If you want to make use of Exim's run time configuration file to set options
33010 for your &[local_scan()]& function, you must also set
33011 .code
33012 LOCAL_SCAN_HAS_OPTIONS=yes
33013 .endd
33014 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
33015
33016
33017
33018
33019 .section "API for local_scan()" "SECTapiforloc"
33020 .cindex "&[local_scan()]& function" "API description"
33021 You must include this line near the start of your code:
33022 .code
33023 #include "local_scan.h"
33024 .endd
33025 This header file defines a number of variables and other values, and the
33026 prototype for the function itself. Exim is coded to use unsigned char values
33027 almost exclusively, and one of the things this header defines is a shorthand
33028 for &`unsigned char`& called &`uschar`&.
33029 It also contains the following macro definitions, to simplify casting character
33030 strings and pointers to character strings:
33031 .code
33032 #define CS   (char *)
33033 #define CCS  (const char *)
33034 #define CSS  (char **)
33035 #define US   (unsigned char *)
33036 #define CUS  (const unsigned char *)
33037 #define USS  (unsigned char **)
33038 .endd
33039 The function prototype for &[local_scan()]& is:
33040 .code
33041 extern int local_scan(int fd, uschar **return_text);
33042 .endd
33043 The arguments are as follows:
33044
33045 .ilist
33046 &%fd%& is a file descriptor for the file that contains the body of the message
33047 (the -D file). The file is open for reading and writing, but updating it is not
33048 recommended. &*Warning*&: You must &'not'& close this file descriptor.
33049
33050 The descriptor is positioned at character 19 of the file, which is the first
33051 character of the body itself, because the first 19 characters are the message
33052 id followed by &`-D`& and a newline. If you rewind the file, you should use the
33053 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
33054 case this changes in some future version.
33055 .next
33056 &%return_text%& is an address which you can use to return a pointer to a text
33057 string at the end of the function. The value it points to on entry is NULL.
33058 .endlist
33059
33060 The function must return an &%int%& value which is one of the following macros:
33061
33062 .vlist
33063 .vitem &`LOCAL_SCAN_ACCEPT`&
33064 .vindex "&$local_scan_data$&"
33065 The message is accepted. If you pass back a string of text, it is saved with
33066 the message, and made available in the variable &$local_scan_data$&. No
33067 newlines are permitted (if there are any, they are turned into spaces) and the
33068 maximum length of text is 1000 characters.
33069
33070 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
33071 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33072 queued without immediate delivery, and is frozen.
33073
33074 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
33075 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33076 queued without immediate delivery.
33077
33078 .vitem &`LOCAL_SCAN_REJECT`&
33079 The message is rejected; the returned text is used as an error message which is
33080 passed back to the sender and which is also logged. Newlines are permitted &--
33081 they cause a multiline response for SMTP rejections, but are converted to
33082 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
33083 used.
33084
33085 .vitem &`LOCAL_SCAN_TEMPREJECT`&
33086 The message is temporarily rejected; the returned text is used as an error
33087 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
33088 problem"& is used.
33089
33090 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
33091 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
33092 message is not written to the reject log. It has the effect of unsetting the
33093 &%rejected_header%& log selector for just this rejection. If
33094 &%rejected_header%& is already unset (see the discussion of the
33095 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
33096 same as LOCAL_SCAN_REJECT.
33097
33098 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
33099 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
33100 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
33101 .endlist
33102
33103 If the message is not being received by interactive SMTP, rejections are
33104 reported by writing to &%stderr%& or by sending an email, as configured by the
33105 &%-oe%& command line options.
33106
33107
33108
33109 .section "Configuration options for local_scan()" "SECTconoptloc"
33110 .cindex "&[local_scan()]& function" "configuration options"
33111 It is possible to have option settings in the main configuration file
33112 that set values in static variables in the &[local_scan()]& module. If you
33113 want to do this, you must have the line
33114 .code
33115 LOCAL_SCAN_HAS_OPTIONS=yes
33116 .endd
33117 in your &_Local/Makefile_& when you build Exim. (This line is in
33118 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
33119 file, you must define static variables to hold the option values, and a table
33120 to define them.
33121
33122 The table must be a vector called &%local_scan_options%&, of type
33123 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
33124 and a pointer to the variable that holds the value. The entries must appear in
33125 alphabetical order. Following &%local_scan_options%& you must also define a
33126 variable called &%local_scan_options_count%& that contains the number of
33127 entries in the table. Here is a short example, showing two kinds of option:
33128 .code
33129 static int my_integer_option = 42;
33130 static uschar *my_string_option = US"a default string";
33131
33132 optionlist local_scan_options[] = {
33133   { "my_integer", opt_int,       &my_integer_option },
33134   { "my_string",  opt_stringptr, &my_string_option }
33135 };
33136
33137 int local_scan_options_count =
33138   sizeof(local_scan_options)/sizeof(optionlist);
33139 .endd
33140 The values of the variables can now be changed from Exim's runtime
33141 configuration file by including a local scan section as in this example:
33142 .code
33143 begin local_scan
33144 my_integer = 99
33145 my_string = some string of text...
33146 .endd
33147 The available types of option data are as follows:
33148
33149 .vlist
33150 .vitem &*opt_bool*&
33151 This specifies a boolean (true/false) option. The address should point to a
33152 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
33153 that are defined as &"1"& and &"0"&, respectively. If you want to detect
33154 whether such a variable has been set at all, you can initialize it to
33155 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
33156 values.)
33157
33158 .vitem &*opt_fixed*&
33159 This specifies a fixed point number, such as is used for load averages.
33160 The address should point to a variable of type &`int`&. The value is stored
33161 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
33162
33163 .vitem &*opt_int*&
33164 This specifies an integer; the address should point to a variable of type
33165 &`int`&. The value may be specified in any of the integer formats accepted by
33166 Exim.
33167
33168 .vitem &*opt_mkint*&
33169 This is the same as &%opt_int%&, except that when such a value is output in a
33170 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
33171 printed with the suffix K or M.
33172
33173 .vitem &*opt_octint*&
33174 This also specifies an integer, but the value is always interpreted as an
33175 octal integer, whether or not it starts with the digit zero, and it is
33176 always output in octal.
33177
33178 .vitem &*opt_stringptr*&
33179 This specifies a string value; the address must be a pointer to a
33180 variable that points to a string (for example, of type &`uschar *`&).
33181
33182 .vitem &*opt_time*&
33183 This specifies a time interval value. The address must point to a variable of
33184 type &`int`&. The value that is placed there is a number of seconds.
33185 .endlist
33186
33187 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
33188 out the values of all the &[local_scan()]& options.
33189
33190
33191
33192 .section "Available Exim variables" "SECID208"
33193 .cindex "&[local_scan()]& function" "available Exim variables"
33194 The header &_local_scan.h_& gives you access to a number of C variables. These
33195 are the only ones that are guaranteed to be maintained from release to release.
33196 Note, however, that you can obtain the value of any Exim expansion variable,
33197 including &$recipients$&, by calling &'expand_string()'&. The exported
33198 C variables are as follows:
33199
33200 .vlist
33201 .vitem &*int&~body_linecount*&
33202 This variable contains the number of lines in the message's body.
33203 It is not valid if the &%spool_files_wireformat%& option is used.
33204
33205 .vitem &*int&~body_zerocount*&
33206 This variable contains the number of binary zero bytes in the message's body.
33207 It is not valid if the &%spool_files_wireformat%& option is used.
33208
33209 .vitem &*unsigned&~int&~debug_selector*&
33210 This variable is set to zero when no debugging is taking place. Otherwise, it
33211 is a bitmap of debugging selectors. Two bits are identified for use in
33212 &[local_scan()]&; they are defined as macros:
33213
33214 .ilist
33215 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
33216 testing option that is not privileged &-- any caller may set it. All the
33217 other selector bits can be set only by admin users.
33218
33219 .next
33220 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
33221 by the &`+local_scan`& debug selector. It is not included in the default set
33222 of debugging bits.
33223 .endlist ilist
33224
33225 Thus, to write to the debugging output only when &`+local_scan`& has been
33226 selected, you should use code like this:
33227 .code
33228 if ((debug_selector & D_local_scan) != 0)
33229   debug_printf("xxx", ...);
33230 .endd
33231 .vitem &*uschar&~*expand_string_message*&
33232 After a failing call to &'expand_string()'& (returned value NULL), the
33233 variable &%expand_string_message%& contains the error message, zero-terminated.
33234
33235 .vitem &*header_line&~*header_list*&
33236 A pointer to a chain of header lines. The &%header_line%& structure is
33237 discussed below.
33238
33239 .vitem &*header_line&~*header_last*&
33240 A pointer to the last of the header lines.
33241
33242 .vitem &*uschar&~*headers_charset*&
33243 The value of the &%headers_charset%& configuration option.
33244
33245 .vitem &*BOOL&~host_checking*&
33246 This variable is TRUE during a host checking session that is initiated by the
33247 &%-bh%& command line option.
33248
33249 .vitem &*uschar&~*interface_address*&
33250 The IP address of the interface that received the message, as a string. This
33251 is NULL for locally submitted messages.
33252
33253 .vitem &*int&~interface_port*&
33254 The port on which this message was received. When testing with the &%-bh%&
33255 command line option, the value of this variable is -1 unless a port has been
33256 specified via the &%-oMi%& option.
33257
33258 .vitem &*uschar&~*message_id*&
33259 This variable contains Exim's message id for the incoming message (the value of
33260 &$message_exim_id$&) as a zero-terminated string.
33261
33262 .vitem &*uschar&~*received_protocol*&
33263 The name of the protocol by which the message was received.
33264
33265 .vitem &*int&~recipients_count*&
33266 The number of accepted recipients.
33267
33268 .vitem &*recipient_item&~*recipients_list*&
33269 .cindex "recipient" "adding in local scan"
33270 .cindex "recipient" "removing in local scan"
33271 The list of accepted recipients, held in a vector of length
33272 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
33273 can add additional recipients by calling &'receive_add_recipient()'& (see
33274 below). You can delete recipients by removing them from the vector and
33275 adjusting the value in &%recipients_count%&. In particular, by setting
33276 &%recipients_count%& to zero you remove all recipients. If you then return the
33277 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
33278 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
33279 and then call &'receive_add_recipient()'& as often as needed.
33280
33281 .vitem &*uschar&~*sender_address*&
33282 The envelope sender address. For bounce messages this is the empty string.
33283
33284 .vitem &*uschar&~*sender_host_address*&
33285 The IP address of the sending host, as a string. This is NULL for
33286 locally-submitted messages.
33287
33288 .vitem &*uschar&~*sender_host_authenticated*&
33289 The name of the authentication mechanism that was used, or NULL if the message
33290 was not received over an authenticated SMTP connection.
33291
33292 .vitem &*uschar&~*sender_host_name*&
33293 The name of the sending host, if known.
33294
33295 .vitem &*int&~sender_host_port*&
33296 The port on the sending host.
33297
33298 .vitem &*BOOL&~smtp_input*&
33299 This variable is TRUE for all SMTP input, including BSMTP.
33300
33301 .vitem &*BOOL&~smtp_batched_input*&
33302 This variable is TRUE for BSMTP input.
33303
33304 .vitem &*int&~store_pool*&
33305 The contents of this variable control which pool of memory is used for new
33306 requests. See section &<<SECTmemhanloc>>& for details.
33307 .endlist
33308
33309
33310 .section "Structure of header lines" "SECID209"
33311 The &%header_line%& structure contains the members listed below.
33312 You can add additional header lines by calling the &'header_add()'& function
33313 (see below). You can cause header lines to be ignored (deleted) by setting
33314 their type to *.
33315
33316
33317 .vlist
33318 .vitem &*struct&~header_line&~*next*&
33319 A pointer to the next header line, or NULL for the last line.
33320
33321 .vitem &*int&~type*&
33322 A code identifying certain headers that Exim recognizes. The codes are printing
33323 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
33324 Notice in particular that any header line whose type is * is not transmitted
33325 with the message. This flagging is used for header lines that have been
33326 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
33327 lines.) Effectively, * means &"deleted"&.
33328
33329 .vitem &*int&~slen*&
33330 The number of characters in the header line, including the terminating and any
33331 internal newlines.
33332
33333 .vitem &*uschar&~*text*&
33334 A pointer to the text of the header. It always ends with a newline, followed by
33335 a zero byte. Internal newlines are preserved.
33336 .endlist
33337
33338
33339
33340 .section "Structure of recipient items" "SECID210"
33341 The &%recipient_item%& structure contains these members:
33342
33343 .vlist
33344 .vitem &*uschar&~*address*&
33345 This is a pointer to the recipient address as it was received.
33346
33347 .vitem &*int&~pno*&
33348 This is used in later Exim processing when top level addresses are created by
33349 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
33350 and must always contain -1 at this stage.
33351
33352 .vitem &*uschar&~*errors_to*&
33353 If this value is not NULL, bounce messages caused by failing to deliver to the
33354 recipient are sent to the address it contains. In other words, it overrides the
33355 envelope sender for this one recipient. (Compare the &%errors_to%& generic
33356 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
33357 an unqualified address, Exim qualifies it using the domain from
33358 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
33359 is NULL for all recipients.
33360 .endlist
33361
33362
33363
33364 .section "Available Exim functions" "SECID211"
33365 .cindex "&[local_scan()]& function" "available Exim functions"
33366 The header &_local_scan.h_& gives you access to a number of Exim functions.
33367 These are the only ones that are guaranteed to be maintained from release to
33368 release:
33369
33370 .vlist
33371 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
33372        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
33373
33374 This function creates a child process that runs the command specified by
33375 &%argv%&. The environment for the process is specified by &%envp%&, which can
33376 be NULL if no environment variables are to be passed. A new umask is supplied
33377 for the process in &%newumask%&.
33378
33379 Pipes to the standard input and output of the new process are set up
33380 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
33381 standard error is cloned to the standard output. If there are any file
33382 descriptors &"in the way"& in the new process, they are closed. If the final
33383 argument is TRUE, the new process is made into a process group leader.
33384
33385 The function returns the pid of the new process, or -1 if things go wrong.
33386
33387 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
33388 This function waits for a child process to terminate, or for a timeout (in
33389 seconds) to expire. A timeout value of zero means wait as long as it takes. The
33390 return value is as follows:
33391
33392 .ilist
33393 >= 0
33394
33395 The process terminated by a normal exit and the value is the process
33396 ending status.
33397
33398 .next
33399 < 0 and > &--256
33400
33401 The process was terminated by a signal and the value is the negation of the
33402 signal number.
33403
33404 .next
33405 &--256
33406
33407 The process timed out.
33408 .next
33409 &--257
33410
33411 The was some other error in wait(); &%errno%& is still set.
33412 .endlist
33413
33414 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
33415 This function provide you with a means of submitting a new message to
33416 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
33417 want, but this packages it all up for you.) The function creates a pipe,
33418 forks a subprocess that is running
33419 .code
33420 exim -t -oem -oi -f <>
33421 .endd
33422 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
33423 that is connected to the standard input. The yield of the function is the PID
33424 of the subprocess. You can then write a message to the file descriptor, with
33425 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
33426
33427 When you have finished, call &'child_close()'& to wait for the process to
33428 finish and to collect its ending status. A timeout value of zero is usually
33429 fine in this circumstance. Unless you have made a mistake with the recipient
33430 addresses, you should get a return code of zero.
33431
33432
33433 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
33434        *sender_authentication)*&
33435 This function is a more sophisticated version of &'child_open()'&. The command
33436 that it runs is:
33437 .display
33438 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
33439 .endd
33440 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
33441
33442
33443 .vitem &*void&~debug_printf(char&~*,&~...)*&
33444 This is Exim's debugging function, with arguments as for &'(printf()'&. The
33445 output is written to the standard error stream. If no debugging is selected,
33446 calls to &'debug_printf()'& have no effect. Normally, you should make calls
33447 conditional on the &`local_scan`& debug selector by coding like this:
33448 .code
33449 if ((debug_selector & D_local_scan) != 0)
33450   debug_printf("xxx", ...);
33451 .endd
33452
33453 .vitem &*uschar&~*expand_string(uschar&~*string)*&
33454 This is an interface to Exim's string expansion code. The return value is the
33455 expanded string, or NULL if there was an expansion failure.
33456 The C variable &%expand_string_message%& contains an error message after an
33457 expansion failure. If expansion does not change the string, the return value is
33458 the pointer to the input string. Otherwise, the return value points to a new
33459 block of memory that was obtained by a call to &'store_get()'&. See section
33460 &<<SECTmemhanloc>>& below for a discussion of memory handling.
33461
33462 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
33463 This function allows you to an add additional header line at the end of the
33464 existing ones. The first argument is the type, and should normally be a space
33465 character. The second argument is a format string and any number of
33466 substitution arguments as for &[sprintf()]&. You may include internal newlines
33467 if you want, and you must ensure that the string ends with a newline.
33468
33469 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
33470         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
33471 This function adds a new header line at a specified point in the header
33472 chain. The header itself is specified as for &'header_add()'&.
33473
33474 If &%name%& is NULL, the new header is added at the end of the chain if
33475 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
33476 NULL, the header lines are searched for the first non-deleted header that
33477 matches the name. If one is found, the new header is added before it if
33478 &%after%& is false. If &%after%& is true, the new header is added after the
33479 found header and any adjacent subsequent ones with the same name (even if
33480 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
33481 option controls where the header is added. If it is true, addition is at the
33482 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
33483 headers, or at the top if there are no &'Received:'& headers, you could use
33484 .code
33485 header_add_at_position(TRUE, US"Received", TRUE,
33486   ' ', "X-xxx: ...");
33487 .endd
33488 Normally, there is always at least one non-deleted &'Received:'& header, but
33489 there may not be if &%received_header_text%& expands to an empty string.
33490
33491
33492 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
33493 This function removes header lines. If &%occurrence%& is zero or negative, all
33494 occurrences of the header are removed. If occurrence is greater than zero, that
33495 particular instance of the header is removed. If no header(s) can be found that
33496 match the specification, the function does nothing.
33497
33498
33499 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
33500         int&~length,&~BOOL&~notdel)*&"
33501 This function tests whether the given header has the given name. It is not just
33502 a string comparison, because white space is permitted between the name and the
33503 colon. If the &%notdel%& argument is true, a false return is forced for all
33504 &"deleted"& headers; otherwise they are not treated specially. For example:
33505 .code
33506 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
33507 .endd
33508 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
33509 .cindex "base64 encoding" "functions for &[local_scan()]& use"
33510 This function base64-encodes a string, which is passed by address and length.
33511 The text may contain bytes of any value, including zero. The result is passed
33512 back in dynamic memory that is obtained by calling &'store_get()'&. It is
33513 zero-terminated.
33514
33515 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
33516 This function decodes a base64-encoded string. Its arguments are a
33517 zero-terminated base64-encoded string and the address of a variable that is set
33518 to point to the result, which is in dynamic memory. The length of the decoded
33519 string is the yield of the function. If the input is invalid base64 data, the
33520 yield is -1. A zero byte is added to the end of the output string to make it
33521 easy to interpret as a C string (assuming it contains no zeros of its own). The
33522 added zero byte is not included in the returned count.
33523
33524 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
33525 This function checks for a match in a domain list. Domains are always
33526 matched caselessly. The return value is one of the following:
33527 .display
33528 &`OK     `& match succeeded
33529 &`FAIL   `& match failed
33530 &`DEFER  `& match deferred
33531 .endd
33532 DEFER is usually caused by some kind of lookup defer, such as the
33533 inability to contact a database.
33534
33535 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
33536         BOOL&~caseless)*&"
33537 This function checks for a match in a local part list. The third argument
33538 controls case-sensitivity. The return values are as for
33539 &'lss_match_domain()'&.
33540
33541 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
33542         BOOL&~caseless)*&"
33543 This function checks for a match in an address list. The third argument
33544 controls the case-sensitivity of the local part match. The domain is always
33545 matched caselessly. The return values are as for &'lss_match_domain()'&.
33546
33547 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
33548         uschar&~*list)*&"
33549 This function checks for a match in a host list. The most common usage is
33550 expected to be
33551 .code
33552 lss_match_host(sender_host_name, sender_host_address, ...)
33553 .endd
33554 .vindex "&$sender_host_address$&"
33555 An empty address field matches an empty item in the host list. If the host name
33556 is NULL, the name corresponding to &$sender_host_address$& is automatically
33557 looked up if a host name is required to match an item in the list. The return
33558 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
33559 returns ERROR in the case when it had to look up a host name, but the lookup
33560 failed.
33561
33562 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
33563         *format,&~...)*&"
33564 This function writes to Exim's log files. The first argument should be zero (it
33565 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
33566 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
33567 them. It specifies to which log or logs the message is written. The remaining
33568 arguments are a format and relevant insertion arguments. The string should not
33569 contain any newlines, not even at the end.
33570
33571
33572 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
33573 This function adds an additional recipient to the message. The first argument
33574 is the recipient address. If it is unqualified (has no domain), it is qualified
33575 with the &%qualify_recipient%& domain. The second argument must always be -1.
33576
33577 This function does not allow you to specify a private &%errors_to%& address (as
33578 described with the structure of &%recipient_item%& above), because it pre-dates
33579 the addition of that field to the structure. However, it is easy to add such a
33580 value afterwards. For example:
33581 .code
33582  receive_add_recipient(US"monitor@mydom.example", -1);
33583  recipients_list[recipients_count-1].errors_to =
33584    US"postmaster@mydom.example";
33585 .endd
33586
33587 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
33588 This is a convenience function to remove a named recipient from the list of
33589 recipients. It returns true if a recipient was removed, and false if no
33590 matching recipient could be found. The argument must be a complete email
33591 address.
33592 .endlist
33593
33594
33595 .cindex "RFC 2047"
33596 .vlist
33597 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
33598   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
33599 This function decodes strings that are encoded according to RFC 2047. Typically
33600 these are the contents of header lines. First, each &"encoded word"& is decoded
33601 from the Q or B encoding into a byte-string. Then, if provided with the name of
33602 a charset encoding, and if the &[iconv()]& function is available, an attempt is
33603 made  to translate the result to the named character set. If this fails, the
33604 binary string is returned with an error message.
33605
33606 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
33607 maximum MIME word length is enforced. The third argument is the target
33608 encoding, or NULL if no translation is wanted.
33609
33610 .cindex "binary zero" "in RFC 2047 decoding"
33611 .cindex "RFC 2047" "binary zero in"
33612 If a binary zero is encountered in the decoded string, it is replaced by the
33613 contents of the &%zeroval%& argument. For use with Exim headers, the value must
33614 not be 0 because header lines are handled as zero-terminated strings.
33615
33616 The function returns the result of processing the string, zero-terminated; if
33617 &%lenptr%& is not NULL, the length of the result is set in the variable to
33618 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
33619
33620 If an error is encountered, the function returns NULL and uses the &%error%&
33621 argument to return an error message. The variable pointed to by &%error%& is
33622 set to NULL if there is no error; it may be set non-NULL even when the function
33623 returns a non-NULL value if decoding was successful, but there was a problem
33624 with translation.
33625
33626
33627 .vitem &*int&~smtp_fflush(void)*&
33628 This function is used in conjunction with &'smtp_printf()'&, as described
33629 below.
33630
33631 .vitem &*void&~smtp_printf(char&~*,&~...)*&
33632 The arguments of this function are like &[printf()]&; it writes to the SMTP
33633 output stream. You should use this function only when there is an SMTP output
33634 stream, that is, when the incoming message is being received via interactive
33635 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
33636 is FALSE. If you want to test for an incoming message from another host (as
33637 opposed to a local process that used the &%-bs%& command line option), you can
33638 test the value of &%sender_host_address%&, which is non-NULL when a remote host
33639 is involved.
33640
33641 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
33642 output function, so it can be used for all forms of SMTP connection.
33643
33644 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
33645 must start with an appropriate response code: 550 if you are going to return
33646 LOCAL_SCAN_REJECT, 451 if you are going to return
33647 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
33648 initial lines of a multi-line response, the code must be followed by a hyphen
33649 to indicate that the line is not the final response line. You must also ensure
33650 that the lines you write terminate with CRLF. For example:
33651 .code
33652 smtp_printf("550-this is some extra info\r\n");
33653 return LOCAL_SCAN_REJECT;
33654 .endd
33655 Note that you can also create multi-line responses by including newlines in
33656 the data returned via the &%return_text%& argument. The added value of using
33657 &'smtp_printf()'& is that, for instance, you could introduce delays between
33658 multiple output lines.
33659
33660 The &'smtp_printf()'& function does not return any error indication, because it
33661 does not automatically flush pending output, and therefore does not test
33662 the state of the stream. (In the main code of Exim, flushing and error
33663 detection is done when Exim is ready for the next SMTP input command.) If
33664 you want to flush the output and check for an error (for example, the
33665 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
33666 arguments. It flushes the output stream, and returns a non-zero value if there
33667 is an error.
33668
33669 .vitem &*void&~*store_get(int)*&
33670 This function accesses Exim's internal store (memory) manager. It gets a new
33671 chunk of memory whose size is given by the argument. Exim bombs out if it ever
33672 runs out of memory. See the next section for a discussion of memory handling.
33673
33674 .vitem &*void&~*store_get_perm(int)*&
33675 This function is like &'store_get()'&, but it always gets memory from the
33676 permanent pool. See the next section for a discussion of memory handling.
33677
33678 .vitem &*uschar&~*string_copy(uschar&~*string)*&
33679 See below.
33680
33681 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
33682 See below.
33683
33684 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
33685 These three functions create strings using Exim's dynamic memory facilities.
33686 The first makes a copy of an entire string. The second copies up to a maximum
33687 number of characters, indicated by the second argument. The third uses a format
33688 and insertion arguments to create a new string. In each case, the result is a
33689 pointer to a new string in the current memory pool. See the next section for
33690 more discussion.
33691 .endlist
33692
33693
33694
33695 .section "More about Exim's memory handling" "SECTmemhanloc"
33696 .cindex "&[local_scan()]& function" "memory handling"
33697 No function is provided for freeing memory, because that is never needed.
33698 The dynamic memory that Exim uses when receiving a message is automatically
33699 recycled if another message is received by the same process (this applies only
33700 to incoming SMTP connections &-- other input methods can supply only one
33701 message at a time). After receiving the last message, a reception process
33702 terminates.
33703
33704 Because it is recycled, the normal dynamic memory cannot be used for holding
33705 data that must be preserved over a number of incoming messages on the same SMTP
33706 connection. However, Exim in fact uses two pools of dynamic memory; the second
33707 one is not recycled, and can be used for this purpose.
33708
33709 If you want to allocate memory that remains available for subsequent messages
33710 in the same SMTP connection, you should set
33711 .code
33712 store_pool = POOL_PERM
33713 .endd
33714 before calling the function that does the allocation. There is no need to
33715 restore the value if you do not need to; however, if you do want to revert to
33716 the normal pool, you can either restore the previous value of &%store_pool%& or
33717 set it explicitly to POOL_MAIN.
33718
33719 The pool setting applies to all functions that get dynamic memory, including
33720 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
33721 There is also a convenience function called &'store_get_perm()'& that gets a
33722 block of memory from the permanent pool while preserving the value of
33723 &%store_pool%&.
33724 .ecindex IIDlosca
33725
33726
33727
33728
33729 . ////////////////////////////////////////////////////////////////////////////
33730 . ////////////////////////////////////////////////////////////////////////////
33731
33732 .chapter "System-wide message filtering" "CHAPsystemfilter"
33733 .scindex IIDsysfil1 "filter" "system filter"
33734 .scindex IIDsysfil2 "filtering all mail"
33735 .scindex IIDsysfil3 "system filter"
33736 The previous chapters (on ACLs and the local scan function) describe checks
33737 that can be applied to messages before they are accepted by a host. There is
33738 also a mechanism for checking messages once they have been received, but before
33739 they are delivered. This is called the &'system filter'&.
33740
33741 The system filter operates in a similar manner to users' filter files, but it
33742 is run just once per message (however many recipients the message has).
33743 It should not normally be used as a substitute for routing, because &%deliver%&
33744 commands in a system router provide new envelope recipient addresses.
33745 The system filter must be an Exim filter. It cannot be a Sieve filter.
33746
33747 The system filter is run at the start of a delivery attempt, before any routing
33748 is done. If a message fails to be completely delivered at the first attempt,
33749 the system filter is run again at the start of every retry.
33750 If you want your filter to do something only once per message, you can make use
33751 of the &%first_delivery%& condition in an &%if%& command in the filter to
33752 prevent it happening on retries.
33753
33754 .vindex "&$domain$&"
33755 .vindex "&$local_part$&"
33756 &*Warning*&: Because the system filter runs just once, variables that are
33757 specific to individual recipient addresses, such as &$local_part$& and
33758 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
33759 you want to run a centrally-specified filter for each recipient address
33760 independently, you can do so by setting up a suitable &(redirect)& router, as
33761 described in section &<<SECTperaddfil>>& below.
33762
33763
33764 .section "Specifying a system filter" "SECID212"
33765 .cindex "uid (user id)" "system filter"
33766 .cindex "gid (group id)" "system filter"
33767 The name of the file that contains the system filter must be specified by
33768 setting &%system_filter%&. If you want the filter to run under a uid and gid
33769 other than root, you must also set &%system_filter_user%& and
33770 &%system_filter_group%& as appropriate. For example:
33771 .code
33772 system_filter = /etc/mail/exim.filter
33773 system_filter_user = exim
33774 .endd
33775 If a system filter generates any deliveries directly to files or pipes (via the
33776 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
33777 specified by setting &%system_filter_file_transport%& and
33778 &%system_filter_pipe_transport%&, respectively. Similarly,
33779 &%system_filter_reply_transport%& must be set to handle any messages generated
33780 by the &%reply%& command.
33781
33782
33783 .section "Testing a system filter" "SECID213"
33784 You can run simple tests of a system filter in the same way as for a user
33785 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
33786 are permitted only in system filters are recognized.
33787
33788 If you want to test the combined effect of a system filter and a user filter,
33789 you can use both &%-bF%& and &%-bf%& on the same command line.
33790
33791
33792
33793 .section "Contents of a system filter" "SECID214"
33794 The language used to specify system filters is the same as for users' filter
33795 files. It is described in the separate end-user document &'Exim's interface to
33796 mail filtering'&. However, there are some additional features that are
33797 available only in system filters; these are described in subsequent sections.
33798 If they are encountered in a user's filter file or when testing with &%-bf%&,
33799 they cause errors.
33800
33801 .cindex "frozen messages" "manual thaw; testing in filter"
33802 There are two special conditions which, though available in users' filter
33803 files, are designed for use in system filters. The condition &%first_delivery%&
33804 is true only for the first attempt at delivering a message, and
33805 &%manually_thawed%& is true only if the message has been frozen, and
33806 subsequently thawed by an admin user. An explicit forced delivery counts as a
33807 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
33808
33809 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
33810 specify an &"unseen"& (non-significant) delivery, and that delivery does not
33811 succeed, it will not be tried again.
33812 If you want Exim to retry an unseen delivery until it succeeds, you should
33813 arrange to set it up every time the filter runs.
33814
33815 When a system filter finishes running, the values of the variables &$n0$& &--
33816 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
33817 users' filter files. Thus a system filter can, for example, set up &"scores"&
33818 to which users' filter files can refer.
33819
33820
33821
33822 .section "Additional variable for system filters" "SECID215"
33823 .vindex "&$recipients$&"
33824 The expansion variable &$recipients$&, containing a list of all the recipients
33825 of the message (separated by commas and white space), is available in system
33826 filters. It is not available in users' filters for privacy reasons.
33827
33828
33829
33830 .section "Defer, freeze, and fail commands for system filters" "SECID216"
33831 .cindex "freezing messages"
33832 .cindex "message" "freezing"
33833 .cindex "message" "forced failure"
33834 .cindex "&%fail%&" "in system filter"
33835 .cindex "&%freeze%& in system filter"
33836 .cindex "&%defer%& in system filter"
33837 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
33838 always available in system filters, but are not normally enabled in users'
33839 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
33840 for the &(redirect)& router.) These commands can optionally be followed by the
33841 word &%text%& and a string containing an error message, for example:
33842 .code
33843 fail text "this message looks like spam to me"
33844 .endd
33845 The keyword &%text%& is optional if the next character is a double quote.
33846
33847 The &%defer%& command defers delivery of the original recipients of the
33848 message. The &%fail%& command causes all the original recipients to be failed,
33849 and a bounce message to be created. The &%freeze%& command suspends all
33850 delivery attempts for the original recipients. In all cases, any new deliveries
33851 that are specified by the filter are attempted as normal after the filter has
33852 run.
33853
33854 The &%freeze%& command is ignored if the message has been manually unfrozen and
33855 not manually frozen since. This means that automatic freezing by a system
33856 filter can be used as a way of checking out suspicious messages. If a message
33857 is found to be all right, manually unfreezing it allows it to be delivered.
33858
33859 .cindex "log" "&%fail%& command log line"
33860 .cindex "&%fail%&" "log line; reducing"
33861 The text given with a fail command is used as part of the bounce message as
33862 well as being written to the log. If the message is quite long, this can fill
33863 up a lot of log space when such failures are common. To reduce the size of the
33864 log message, Exim interprets the text in a special way if it starts with the
33865 two characters &`<<`& and contains &`>>`& later. The text between these two
33866 strings is written to the log, and the rest of the text is used in the bounce
33867 message. For example:
33868 .code
33869 fail "<<filter test 1>>Your message is rejected \
33870      because it contains attachments that we are \
33871      not prepared to receive."
33872 .endd
33873
33874 .cindex "loop" "caused by &%fail%&"
33875 Take great care with the &%fail%& command when basing the decision to fail on
33876 the contents of the message, because the bounce message will of course include
33877 the contents of the original message and will therefore trigger the &%fail%&
33878 command again (causing a mail loop) unless steps are taken to prevent this.
33879 Testing the &%error_message%& condition is one way to prevent this. You could
33880 use, for example
33881 .code
33882 if $message_body contains "this is spam" and not error_message
33883 then fail text "spam is not wanted here" endif
33884 .endd
33885 though of course that might let through unwanted bounce messages. The
33886 alternative is clever checking of the body and/or headers to detect bounces
33887 generated by the filter.
33888
33889 The interpretation of a system filter file ceases after a
33890 &%defer%&,
33891 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
33892 set up earlier in the filter file are honoured, so you can use a sequence such
33893 as
33894 .code
33895 mail ...
33896 freeze
33897 .endd
33898 to send a specified message when the system filter is freezing (or deferring or
33899 failing) a message. The normal deliveries for the message do not, of course,
33900 take place.
33901
33902
33903
33904 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
33905 .cindex "header lines" "adding; in system filter"
33906 .cindex "header lines" "removing; in system filter"
33907 .cindex "filter" "header lines; adding/removing"
33908 Two filter commands that are available only in system filters are:
33909 .code
33910 headers add <string>
33911 headers remove <string>
33912 .endd
33913 The argument for the &%headers add%& is a string that is expanded and then
33914 added to the end of the message's headers. It is the responsibility of the
33915 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
33916 space is ignored, and if the string is otherwise empty, or if the expansion is
33917 forced to fail, the command has no effect.
33918
33919 You can use &"\n"& within the string, followed by white space, to specify
33920 continued header lines. More than one header may be added in one command by
33921 including &"\n"& within the string without any following white space. For
33922 example:
33923 .code
33924 headers add "X-header-1: ....\n  \
33925              continuation of X-header-1 ...\n\
33926              X-header-2: ...."
33927 .endd
33928 Note that the header line continuation white space after the first newline must
33929 be placed before the backslash that continues the input string, because white
33930 space after input continuations is ignored.
33931
33932 The argument for &%headers remove%& is a colon-separated list of header names.
33933 This command applies only to those headers that are stored with the message;
33934 those that are added at delivery time (such as &'Envelope-To:'& and
33935 &'Return-Path:'&) cannot be removed by this means. If there is more than one
33936 header with the same name, they are all removed.
33937
33938 The &%headers%& command in a system filter makes an immediate change to the set
33939 of header lines that was received with the message (with possible additions
33940 from ACL processing). Subsequent commands in the system filter operate on the
33941 modified set, which also forms the basis for subsequent message delivery.
33942 Unless further modified during routing or transporting, this set of headers is
33943 used for all recipients of the message.
33944
33945 During routing and transporting, the variables that refer to the contents of
33946 header lines refer only to those lines that are in this set. Thus, header lines
33947 that are added by a system filter are visible to users' filter files and to all
33948 routers and transports. This contrasts with the manipulation of header lines by
33949 routers and transports, which is not immediate, but which instead is saved up
33950 until the message is actually being written (see section
33951 &<<SECTheadersaddrem>>&).
33952
33953 If the message is not delivered at the first attempt, header lines that were
33954 added by the system filter are stored with the message, and so are still
33955 present at the next delivery attempt. Header lines that were removed are still
33956 present, but marked &"deleted"& so that they are not transported with the
33957 message. For this reason, it is usual to make the &%headers%& command
33958 conditional on &%first_delivery%& so that the set of header lines is not
33959 modified more than once.
33960
33961 Because header modification in a system filter acts immediately, you have to
33962 use an indirect approach if you want to modify the contents of a header line.
33963 For example:
33964 .code
33965 headers add "Old-Subject: $h_subject:"
33966 headers remove "Subject"
33967 headers add "Subject: new subject (was: $h_old-subject:)"
33968 headers remove "Old-Subject"
33969 .endd
33970
33971
33972
33973 .section "Setting an errors address in a system filter" "SECID217"
33974 .cindex "envelope sender"
33975 In a system filter, if a &%deliver%& command is followed by
33976 .code
33977 errors_to <some address>
33978 .endd
33979 in order to change the envelope sender (and hence the error reporting) for that
33980 delivery, any address may be specified. (In a user filter, only the current
33981 user's address can be set.) For example, if some mail is being monitored, you
33982 might use
33983 .code
33984 unseen deliver monitor@spying.example errors_to root@local.example
33985 .endd
33986 to take a copy which would not be sent back to the normal error reporting
33987 address if its delivery failed.
33988
33989
33990
33991 .section "Per-address filtering" "SECTperaddfil"
33992 .vindex "&$domain$&"
33993 .vindex "&$local_part$&"
33994 In contrast to the system filter, which is run just once per message for each
33995 delivery attempt, it is also possible to set up a system-wide filtering
33996 operation that runs once for each recipient address. In this case, variables
33997 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
33998 filter file could be made dependent on them. This is an example of a router
33999 which implements such a filter:
34000 .code
34001 central_filter:
34002   check_local_user
34003   driver = redirect
34004   domains = +local_domains
34005   file = /central/filters/$local_part
34006   no_verify
34007   allow_filter
34008   allow_freeze
34009 .endd
34010 The filter is run in a separate process under its own uid. Therefore, either
34011 &%check_local_user%& must be set (as above), in which case the filter is run as
34012 the local user, or the &%user%& option must be used to specify which user to
34013 use. If both are set, &%user%& overrides.
34014
34015 Care should be taken to ensure that none of the commands in the filter file
34016 specify a significant delivery if the message is to go on to be delivered to
34017 its intended recipient. The router will not then claim to have dealt with the
34018 address, so it will be passed on to subsequent routers to be delivered in the
34019 normal way.
34020 .ecindex IIDsysfil1
34021 .ecindex IIDsysfil2
34022 .ecindex IIDsysfil3
34023
34024
34025
34026
34027
34028
34029 . ////////////////////////////////////////////////////////////////////////////
34030 . ////////////////////////////////////////////////////////////////////////////
34031
34032 .chapter "Message processing" "CHAPmsgproc"
34033 .scindex IIDmesproc "message" "general processing"
34034 Exim performs various transformations on the sender and recipient addresses of
34035 all messages that it handles, and also on the messages' header lines. Some of
34036 these are optional and configurable, while others always take place. All of
34037 this processing, except rewriting as a result of routing, and the addition or
34038 removal of header lines while delivering, happens when a message is received,
34039 before it is placed on Exim's queue.
34040
34041 Some of the automatic processing takes place by default only for
34042 &"locally-originated"& messages. This adjective is used to describe messages
34043 that are not received over TCP/IP, but instead are passed to an Exim process on
34044 its standard input. This includes the interactive &"local SMTP"& case that is
34045 set up by the &%-bs%& command line option.
34046
34047 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
34048 or ::1) are not considered to be locally-originated. Exim does not treat the
34049 loopback interface specially in any way.
34050
34051 If you want the loopback interface to be treated specially, you must ensure
34052 that there are appropriate entries in your ACLs.
34053
34054
34055
34056
34057 .section "Submission mode for non-local messages" "SECTsubmodnon"
34058 .cindex "message" "submission"
34059 .cindex "submission mode"
34060 Processing that happens automatically for locally-originated messages (unless
34061 &%suppress_local_fixups%& is set) can also be requested for messages that are
34062 received over TCP/IP. The term &"submission mode"& is used to describe this
34063 state. Submission mode is set by the modifier
34064 .code
34065 control = submission
34066 .endd
34067 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
34068 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
34069 a local submission, and is normally used when the source of the message is
34070 known to be an MUA running on a client host (as opposed to an MTA). For
34071 example, to set submission mode for messages originating on the IPv4 loopback
34072 interface, you could include the following in the MAIL ACL:
34073 .code
34074 warn  hosts = 127.0.0.1
34075       control = submission
34076 .endd
34077 .cindex "&%sender_retain%& submission option"
34078 There are some options that can be used when setting submission mode. A slash
34079 is used to separate options. For example:
34080 .code
34081 control = submission/sender_retain
34082 .endd
34083 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
34084 true and &%local_from_check%& false for the current incoming message. The first
34085 of these allows an existing &'Sender:'& header in the message to remain, and
34086 the second suppresses the check to ensure that &'From:'& matches the
34087 authenticated sender. With this setting, Exim still fixes up messages by adding
34088 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
34089 attempt to check sender authenticity in header lines.
34090
34091 When &%sender_retain%& is not set, a submission mode setting may specify a
34092 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
34093 example:
34094 .code
34095 control = submission/domain=some.domain
34096 .endd
34097 The domain may be empty. How this value is used is described in sections
34098 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
34099 that allows you to specify the user's full name for inclusion in a created
34100 &'Sender:'& or &'From:'& header line. For example:
34101 .code
34102 accept authenticated = *
34103        control = submission/domain=wonderland.example/\
34104                             name=${lookup {$authenticated_id} \
34105                                    lsearch {/etc/exim/namelist}}
34106 .endd
34107 Because the name may contain any characters, including slashes, the &%name%&
34108 option must be given last. The remainder of the string is used as the name. For
34109 the example above, if &_/etc/exim/namelist_& contains:
34110 .code
34111 bigegg:  Humpty Dumpty
34112 .endd
34113 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
34114 line would be:
34115 .code
34116 Sender: Humpty Dumpty <bigegg@wonderland.example>
34117 .endd
34118 .cindex "return path" "in submission mode"
34119 By default, submission mode forces the return path to the same address as is
34120 used to create the &'Sender:'& header. However, if &%sender_retain%& is
34121 specified, the return path is also left unchanged.
34122
34123 &*Note*&: The changes caused by submission mode take effect after the predata
34124 ACL. This means that any sender checks performed before the fix-ups use the
34125 untrusted sender address specified by the user, not the trusted sender address
34126 specified by submission mode. Although this might be slightly unexpected, it
34127 does mean that you can configure ACL checks to spot that a user is trying to
34128 spoof another's address.
34129
34130 .section "Line endings" "SECTlineendings"
34131 .cindex "line endings"
34132 .cindex "carriage return"
34133 .cindex "linefeed"
34134 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
34135 linefeed) is the line ending for messages transmitted over the Internet using
34136 SMTP over TCP/IP. However, within individual operating systems, different
34137 conventions are used. For example, Unix-like systems use just LF, but others
34138 use CRLF or just CR.
34139
34140 Exim was designed for Unix-like systems, and internally, it stores messages
34141 using the system's convention of a single LF as a line terminator. When
34142 receiving a message, all line endings are translated to this standard format.
34143 Originally, it was thought that programs that passed messages directly to an
34144 MTA within an operating system would use that system's convention. Experience
34145 has shown that this is not the case; for example, there are Unix applications
34146 that use CRLF in this circumstance. For this reason, and for compatibility with
34147 other MTAs, the way Exim handles line endings for all messages is now as
34148 follows:
34149
34150 .ilist
34151 LF not preceded by CR is treated as a line ending.
34152 .next
34153 CR is treated as a line ending; if it is immediately followed by LF, the LF
34154 is ignored.
34155 .next
34156 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
34157 nor a local message in the state where a line containing only a dot is a
34158 terminator.
34159 .next
34160 If a bare CR is encountered within a header line, an extra space is added after
34161 the line terminator so as not to end the header line. The reasoning behind this
34162 is that bare CRs in header lines are most likely either to be mistakes, or
34163 people trying to play silly games.
34164 .next
34165 If the first header line received in a message ends with CRLF, a subsequent
34166 bare LF in a header line is treated in the same way as a bare CR in a header
34167 line.
34168 .endlist
34169
34170
34171
34172
34173
34174 .section "Unqualified addresses" "SECID218"
34175 .cindex "unqualified addresses"
34176 .cindex "address" "qualification"
34177 By default, Exim expects every envelope address it receives from an external
34178 host to be fully qualified. Unqualified addresses cause negative responses to
34179 SMTP commands. However, because SMTP is used as a means of transporting
34180 messages from MUAs running on personal workstations, there is sometimes a
34181 requirement to accept unqualified addresses from specific hosts or IP networks.
34182
34183 Exim has two options that separately control which hosts may send unqualified
34184 sender or recipient addresses in SMTP commands, namely
34185 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
34186 cases, if an unqualified address is accepted, it is qualified by adding the
34187 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
34188
34189 .oindex "&%qualify_domain%&"
34190 .oindex "&%qualify_recipient%&"
34191 Unqualified addresses in header lines are automatically qualified for messages
34192 that are locally originated, unless the &%-bnq%& option is given on the command
34193 line. For messages received over SMTP, unqualified addresses in header lines
34194 are qualified only if unqualified addresses are permitted in SMTP commands. In
34195 other words, such qualification is also controlled by
34196 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
34197
34198
34199
34200
34201 .section "The UUCP From line" "SECID219"
34202 .cindex "&""From""& line"
34203 .cindex "UUCP" "&""From""& line"
34204 .cindex "sender" "address"
34205 .oindex "&%uucp_from_pattern%&"
34206 .oindex "&%uucp_from_sender%&"
34207 .cindex "envelope sender"
34208 .cindex "Sendmail compatibility" "&""From""& line"
34209 Messages that have come from UUCP (and some other applications) often begin
34210 with a line containing the envelope sender and a timestamp, following the word
34211 &"From"&. Examples of two common formats are:
34212 .code
34213 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
34214 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
34215 .endd
34216 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
34217 Exim recognizes such lines at the start of messages that are submitted to it
34218 via the command line (that is, on the standard input). It does not recognize
34219 such lines in incoming SMTP messages, unless the sending host matches
34220 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
34221 and &%ignore_fromline_local%& is set. The recognition is controlled by a
34222 regular expression that is defined by the &%uucp_from_pattern%& option, whose
34223 default value matches the two common cases shown above and puts the address
34224 that follows &"From"& into &$1$&.
34225
34226 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
34227 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
34228 a trusted user, the message's sender address is constructed by expanding the
34229 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
34230 then parsed as an RFC 2822 address. If there is no domain, the local part is
34231 qualified with &%qualify_domain%& unless it is the empty string. However, if
34232 the command line &%-f%& option is used, it overrides the &"From"& line.
34233
34234 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
34235 sender address is not changed. This is also the case for incoming SMTP messages
34236 that are permitted to contain &"From"& lines.
34237
34238 Only one &"From"& line is recognized. If there is more than one, the second is
34239 treated as a data line that starts the body of the message, as it is not valid
34240 as a header line. This also happens if a &"From"& line is present in an
34241 incoming SMTP message from a source that is not permitted to send them.
34242
34243
34244
34245 .section "Resent- header lines" "SECID220"
34246 .cindex "&%Resent-%& header lines"
34247 .cindex "header lines" "Resent-"
34248 RFC 2822 makes provision for sets of header lines starting with the string
34249 &`Resent-`& to be added to a message when it is resent by the original
34250 recipient to somebody else. These headers are &'Resent-Date:'&,
34251 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
34252 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
34253
34254 .blockquote
34255 &'Resent fields are strictly informational. They MUST NOT be used in the normal
34256 processing of replies or other such automatic actions on messages.'&
34257 .endblockquote
34258
34259 This leaves things a bit vague as far as other processing actions such as
34260 address rewriting are concerned. Exim treats &%Resent-%& header lines as
34261 follows:
34262
34263 .ilist
34264 A &'Resent-From:'& line that just contains the login id of the submitting user
34265 is automatically rewritten in the same way as &'From:'& (see below).
34266 .next
34267 If there's a rewriting rule for a particular header line, it is also applied to
34268 &%Resent-%& header lines of the same type. For example, a rule that rewrites
34269 &'From:'& also rewrites &'Resent-From:'&.
34270 .next
34271 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
34272 also removed.
34273 .next
34274 For a locally-submitted message,
34275 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
34276 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
34277 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
34278 included in log lines in this case.
34279 .next
34280 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
34281 &%Resent-%& header lines are present.
34282 .endlist
34283
34284
34285
34286
34287 .section "The Auto-Submitted: header line" "SECID221"
34288 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
34289 includes the header line:
34290 .code
34291 Auto-Submitted: auto-replied
34292 .endd
34293
34294 .section "The Bcc: header line" "SECID222"
34295 .cindex "&'Bcc:'& header line"
34296 If Exim is called with the &%-t%& option, to take recipient addresses from a
34297 message's header, it removes any &'Bcc:'& header line that may exist (after
34298 extracting its addresses). If &%-t%& is not present on the command line, any
34299 existing &'Bcc:'& is not removed.
34300
34301
34302 .section "The Date: header line" "SECID223"
34303 .cindex "&'Date:'& header line"
34304 .cindex "header lines" "Date:"
34305 If a locally-generated or submission-mode message has no &'Date:'& header line,
34306 Exim adds one, using the current date and time, unless the
34307 &%suppress_local_fixups%& control has been specified.
34308
34309 .section "The Delivery-date: header line" "SECID224"
34310 .cindex "&'Delivery-date:'& header line"
34311 .oindex "&%delivery_date_remove%&"
34312 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
34313 set. Exim can be configured to add them to the final delivery of messages. (See
34314 the generic &%delivery_date_add%& transport option.) They should not be present
34315 in messages in transit. If the &%delivery_date_remove%& configuration option is
34316 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
34317 messages.
34318
34319
34320 .section "The Envelope-to: header line" "SECID225"
34321 .cindex "&'Envelope-to:'& header line"
34322 .cindex "header lines" "Envelope-to:"
34323 .oindex "&%envelope_to_remove%&"
34324 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
34325 Exim can be configured to add them to the final delivery of messages. (See the
34326 generic &%envelope_to_add%& transport option.) They should not be present in
34327 messages in transit. If the &%envelope_to_remove%& configuration option is set
34328 (the default), Exim removes &'Envelope-to:'& header lines from incoming
34329 messages.
34330
34331
34332 .section "The From: header line" "SECTthefrohea"
34333 .cindex "&'From:'& header line"
34334 .cindex "header lines" "From:"
34335 .cindex "Sendmail compatibility" "&""From""& line"
34336 .cindex "message" "submission"
34337 .cindex "submission mode"
34338 If a submission-mode message does not contain a &'From:'& header line, Exim
34339 adds one if either of the following conditions is true:
34340
34341 .ilist
34342 The envelope sender address is not empty (that is, this is not a bounce
34343 message). The added header line copies the envelope sender address.
34344 .next
34345 .vindex "&$authenticated_id$&"
34346 The SMTP session is authenticated and &$authenticated_id$& is not empty.
34347 .olist
34348 .vindex "&$qualify_domain$&"
34349 If no domain is specified by the submission control, the local part is
34350 &$authenticated_id$& and the domain is &$qualify_domain$&.
34351 .next
34352 If a non-empty domain is specified by the submission control, the local
34353 part is &$authenticated_id$&, and the domain is the specified domain.
34354 .next
34355 If an empty domain is specified by the submission control,
34356 &$authenticated_id$& is assumed to be the complete address.
34357 .endlist
34358 .endlist
34359
34360 A non-empty envelope sender takes precedence.
34361
34362 If a locally-generated incoming message does not contain a &'From:'& header
34363 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
34364 containing the sender's address. The calling user's login name and full name
34365 are used to construct the address, as described in section &<<SECTconstr>>&.
34366 They are obtained from the password data by calling &[getpwuid()]& (but see the
34367 &%unknown_login%& configuration option). The address is qualified with
34368 &%qualify_domain%&.
34369
34370 For compatibility with Sendmail, if an incoming, non-SMTP message has a
34371 &'From:'& header line containing just the unqualified login name of the calling
34372 user, this is replaced by an address containing the user's login name and full
34373 name as described in section &<<SECTconstr>>&.
34374
34375
34376 .section "The Message-ID: header line" "SECID226"
34377 .cindex "&'Message-ID:'& header line"
34378 .cindex "header lines" "Message-ID:"
34379 .cindex "message" "submission"
34380 .oindex "&%message_id_header_text%&"
34381 If a locally-generated or submission-mode incoming message does not contain a
34382 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
34383 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
34384 to the message. If there are any &'Resent-:'& headers in the message, it
34385 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
34386 message id, preceded by the letter E to ensure it starts with a letter, and
34387 followed by @ and the primary host name. Additional information can be included
34388 in this header line by setting the &%message_id_header_text%& and/or
34389 &%message_id_header_domain%& options.
34390
34391
34392 .section "The Received: header line" "SECID227"
34393 .cindex "&'Received:'& header line"
34394 .cindex "header lines" "Received:"
34395 A &'Received:'& header line is added at the start of every message. The
34396 contents are defined by the &%received_header_text%& configuration option, and
34397 Exim automatically adds a semicolon and a timestamp to the configured string.
34398
34399 The &'Received:'& header is generated as soon as the message's header lines
34400 have been received. At this stage, the timestamp in the &'Received:'& header
34401 line is the time that the message started to be received. This is the value
34402 that is seen by the DATA ACL and by the &[local_scan()]& function.
34403
34404 Once a message is accepted, the timestamp in the &'Received:'& header line is
34405 changed to the time of acceptance, which is (apart from a small delay while the
34406 -H spool file is written) the earliest time at which delivery could start.
34407
34408
34409 .section "The References: header line" "SECID228"
34410 .cindex "&'References:'& header line"
34411 .cindex "header lines" "References:"
34412 Messages created by the &(autoreply)& transport include a &'References:'&
34413 header line. This is constructed according to the rules that are described in
34414 section 3.64 of RFC 2822 (which states that replies should contain such a
34415 header line), and section 3.14 of RFC 3834 (which states that automatic
34416 responses are not different in this respect). However, because some mail
34417 processing software does not cope well with very long header lines, no more
34418 than 12 message IDs are copied from the &'References:'& header line in the
34419 incoming message. If there are more than 12, the first one and then the final
34420 11 are copied, before adding the message ID of the incoming message.
34421
34422
34423
34424 .section "The Return-path: header line" "SECID229"
34425 .cindex "&'Return-path:'& header line"
34426 .cindex "header lines" "Return-path:"
34427 .oindex "&%return_path_remove%&"
34428 &'Return-path:'& header lines are defined as something an MTA may insert when
34429 it does the final delivery of messages. (See the generic &%return_path_add%&
34430 transport option.) Therefore, they should not be present in messages in
34431 transit. If the &%return_path_remove%& configuration option is set (the
34432 default), Exim removes &'Return-path:'& header lines from incoming messages.
34433
34434
34435
34436 .section "The Sender: header line" "SECTthesenhea"
34437 .cindex "&'Sender:'& header line"
34438 .cindex "message" "submission"
34439 .cindex "header lines" "Sender:"
34440 For a locally-originated message from an untrusted user, Exim may remove an
34441 existing &'Sender:'& header line, and it may add a new one. You can modify
34442 these actions by setting the &%local_sender_retain%& option true, the
34443 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
34444 control setting.
34445
34446 When a local message is received from an untrusted user and
34447 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
34448 control has not been set, a check is made to see if the address given in the
34449 &'From:'& header line is the correct (local) sender of the message. The address
34450 that is expected has the login name as the local part and the value of
34451 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
34452 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
34453 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
34454 line is added to the message.
34455
34456 If you set &%local_from_check%& false, this checking does not occur. However,
34457 the removal of an existing &'Sender:'& line still happens, unless you also set
34458 &%local_sender_retain%& to be true. It is not possible to set both of these
34459 options true at the same time.
34460
34461 .cindex "submission mode"
34462 By default, no processing of &'Sender:'& header lines is done for messages
34463 received over TCP/IP or for messages submitted by trusted users. However, when
34464 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
34465 not specified on the submission control, the following processing takes place:
34466
34467 .vindex "&$authenticated_id$&"
34468 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
34469 authenticated, and &$authenticated_id$& is not empty, a sender address is
34470 created as follows:
34471
34472 .ilist
34473 .vindex "&$qualify_domain$&"
34474 If no domain is specified by the submission control, the local part is
34475 &$authenticated_id$& and the domain is &$qualify_domain$&.
34476 .next
34477 If a non-empty domain is specified by the submission control, the local part
34478 is &$authenticated_id$&, and the domain is the specified domain.
34479 .next
34480 If an empty domain is specified by the submission control,
34481 &$authenticated_id$& is assumed to be the complete address.
34482 .endlist
34483
34484 This address is compared with the address in the &'From:'& header line. If they
34485 are different, a &'Sender:'& header line containing the created address is
34486 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
34487 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
34488
34489 .cindex "return path" "created from &'Sender:'&"
34490 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
34491 the message (the envelope sender address) is changed to be the same address,
34492 except in the case of submission mode when &%sender_retain%& is specified.
34493
34494
34495
34496 .section "Adding and removing header lines in routers and transports" &&&
34497          "SECTheadersaddrem"
34498 .cindex "header lines" "adding; in router or transport"
34499 .cindex "header lines" "removing; in router or transport"
34500 When a message is delivered, the addition and removal of header lines can be
34501 specified in a system filter, or on any of the routers and transports that
34502 process the message. Section &<<SECTaddremheasys>>& contains details about
34503 modifying headers in a system filter. Header lines can also be added in an ACL
34504 as a message is received (see section &<<SECTaddheadacl>>&).
34505
34506 In contrast to what happens in a system filter, header modifications that are
34507 specified on routers and transports apply only to the particular recipient
34508 addresses that are being processed by those routers and transports. These
34509 changes do not actually take place until a copy of the message is being
34510 transported. Therefore, they do not affect the basic set of header lines, and
34511 they do not affect the values of the variables that refer to header lines.
34512
34513 &*Note*&: In particular, this means that any expansions in the configuration of
34514 the transport cannot refer to the modified header lines, because such
34515 expansions all occur before the message is actually transported.
34516
34517 For both routers and transports, the argument of a &%headers_add%&
34518 option must be in the form of one or more RFC 2822 header lines, separated by
34519 newlines (coded as &"\n"&). For example:
34520 .code
34521 headers_add = X-added-header: added by $primary_hostname\n\
34522               X-added-second: another added header line
34523 .endd
34524 Exim does not check the syntax of these added header lines.
34525
34526 Multiple &%headers_add%& options for a single router or transport can be
34527 specified; the values will append to a single list of header lines.
34528 Each header-line is separately expanded.
34529
34530 The argument of a &%headers_remove%& option must consist of a colon-separated
34531 list of header names. This is confusing, because header names themselves are
34532 often terminated by colons. In this case, the colons are the list separators,
34533 not part of the names. For example:
34534 .code
34535 headers_remove = return-receipt-to:acknowledge-to
34536 .endd
34537
34538 Multiple &%headers_remove%& options for a single router or transport can be
34539 specified; the arguments will append to a single header-names list.
34540 Each item is separately expanded.
34541 Note that colons in complex expansions which are used to
34542 form all or part of a &%headers_remove%& list
34543 will act as list separators.
34544
34545 When &%headers_add%& or &%headers_remove%& is specified on a router,
34546 items are expanded at routing time,
34547 and then associated with all addresses that are
34548 accepted by that router, and also with any new addresses that it generates. If
34549 an address passes through several routers as a result of aliasing or
34550 forwarding, the changes are cumulative.
34551
34552 .oindex "&%unseen%&"
34553 However, this does not apply to multiple routers that result from the use of
34554 the &%unseen%& option. Any header modifications that were specified by the
34555 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
34556
34557 Addresses that end up with different &%headers_add%& or &%headers_remove%&
34558 settings cannot be delivered together in a batch, so a transport is always
34559 dealing with a set of addresses that have the same header-processing
34560 requirements.
34561
34562 The transport starts by writing the original set of header lines that arrived
34563 with the message, possibly modified by the system filter. As it writes out
34564 these lines, it consults the list of header names that were attached to the
34565 recipient address(es) by &%headers_remove%& options in routers, and it also
34566 consults the transport's own &%headers_remove%& option. Header lines whose
34567 names are on either of these lists are not written out. If there are multiple
34568 instances of any listed header, they are all skipped.
34569
34570 After the remaining original header lines have been written, new header
34571 lines that were specified by routers' &%headers_add%& options are written, in
34572 the order in which they were attached to the address. These are followed by any
34573 header lines specified by the transport's &%headers_add%& option.
34574
34575 This way of handling header line modifications in routers and transports has
34576 the following consequences:
34577
34578 .ilist
34579 The original set of header lines, possibly modified by the system filter,
34580 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
34581 to it, at all times.
34582 .next
34583 Header lines that are added by a router's
34584 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
34585 expansion syntax in subsequent routers or the transport.
34586 .next
34587 Conversely, header lines that are specified for removal by &%headers_remove%&
34588 in a router remain visible to subsequent routers and the transport.
34589 .next
34590 Headers added to an address by &%headers_add%& in a router cannot be removed by
34591 a later router or by a transport.
34592 .next
34593 An added header can refer to the contents of an original header that is to be
34594 removed, even it has the same name as the added header. For example:
34595 .code
34596 headers_remove = subject
34597 headers_add = Subject: new subject (was: $h_subject:)
34598 .endd
34599 .endlist
34600
34601 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
34602 for a &(redirect)& router that has the &%one_time%& option set.
34603
34604
34605
34606
34607
34608 .section "Constructed addresses" "SECTconstr"
34609 .cindex "address" "constructed"
34610 .cindex "constructed address"
34611 When Exim constructs a sender address for a locally-generated message, it uses
34612 the form
34613 .display
34614 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
34615 .endd
34616 For example:
34617 .code
34618 Zaphod Beeblebrox <zaphod@end.univ.example>
34619 .endd
34620 The user name is obtained from the &%-F%& command line option if set, or
34621 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
34622 &"gecos"& field from the password entry. If the &"gecos"& field contains an
34623 ampersand character, this is replaced by the login name with the first letter
34624 upper cased, as is conventional in a number of operating systems. See the
34625 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
34626 The &%unknown_username%& option can be used to specify user names in cases when
34627 there is no password file entry.
34628
34629 .cindex "RFC 2047"
34630 In all cases, the user name is made to conform to RFC 2822 by quoting all or
34631 parts of it if necessary. In addition, if it contains any non-printing
34632 characters, it is encoded as described in RFC 2047, which defines a way of
34633 including non-ASCII characters in header lines. The value of the
34634 &%headers_charset%& option specifies the name of the encoding that is used (the
34635 characters are assumed to be in this encoding). The setting of
34636 &%print_topbitchars%& controls whether characters with the top bit set (that
34637 is, with codes greater than 127) count as printing characters or not.
34638
34639
34640
34641 .section "Case of local parts" "SECID230"
34642 .cindex "case of local parts"
34643 .cindex "local part" "case of"
34644 RFC 2822 states that the case of letters in the local parts of addresses cannot
34645 be assumed to be non-significant. Exim preserves the case of local parts of
34646 addresses, but by default it uses a lower-cased form when it is routing,
34647 because on most Unix systems, usernames are in lower case and case-insensitive
34648 routing is required. However, any particular router can be made to use the
34649 original case for local parts by setting the &%caseful_local_part%& generic
34650 router option.
34651
34652 .cindex "mixed-case login names"
34653 If you must have mixed-case user names on your system, the best way to proceed,
34654 assuming you want case-independent handling of incoming email, is to set up
34655 your first router to convert incoming local parts in your domains to the
34656 correct case by means of a file lookup. For example:
34657 .code
34658 correct_case:
34659   driver = redirect
34660   domains = +local_domains
34661   data = ${lookup{$local_part}cdb\
34662               {/etc/usercased.cdb}{$value}fail}\
34663               @$domain
34664 .endd
34665 For this router, the local part is forced to lower case by the default action
34666 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
34667 up a new local part in the correct case. If you then set &%caseful_local_part%&
34668 on any subsequent routers which process your domains, they will operate on
34669 local parts with the correct case in a case-sensitive manner.
34670
34671
34672
34673 .section "Dots in local parts" "SECID231"
34674 .cindex "dot" "in local part"
34675 .cindex "local part" "dots in"
34676 RFC 2822 forbids empty components in local parts. That is, an unquoted local
34677 part may not begin or end with a dot, nor have two consecutive dots in the
34678 middle. However, it seems that many MTAs do not enforce this, so Exim permits
34679 empty components for compatibility.
34680
34681
34682
34683 .section "Rewriting addresses" "SECID232"
34684 .cindex "rewriting" "addresses"
34685 Rewriting of sender and recipient addresses, and addresses in headers, can
34686 happen automatically, or as the result of configuration options, as described
34687 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
34688 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
34689
34690 Automatic rewriting includes qualification, as mentioned above. The other case
34691 in which it can happen is when an incomplete non-local domain is given. The
34692 routing process may cause this to be expanded into the full domain name. For
34693 example, a header such as
34694 .code
34695 To: hare@teaparty
34696 .endd
34697 might get rewritten as
34698 .code
34699 To: hare@teaparty.wonderland.fict.example
34700 .endd
34701 Rewriting as a result of routing is the one kind of message processing that
34702 does not happen at input time, as it cannot be done until the address has
34703 been routed.
34704
34705 Strictly, one should not do &'any'& deliveries of a message until all its
34706 addresses have been routed, in case any of the headers get changed as a
34707 result of routing. However, doing this in practice would hold up many
34708 deliveries for unreasonable amounts of time, just because one address could not
34709 immediately be routed. Exim therefore does not delay other deliveries when
34710 routing of one or more addresses is deferred.
34711 .ecindex IIDmesproc
34712
34713
34714
34715 . ////////////////////////////////////////////////////////////////////////////
34716 . ////////////////////////////////////////////////////////////////////////////
34717
34718 .chapter "SMTP processing" "CHAPSMTP"
34719 .scindex IIDsmtpproc1 "SMTP" "processing details"
34720 .scindex IIDsmtpproc2 "LMTP" "processing details"
34721 Exim supports a number of different ways of using the SMTP protocol, and its
34722 LMTP variant, which is an interactive protocol for transferring messages into a
34723 closed mail store application. This chapter contains details of how SMTP is
34724 processed. For incoming mail, the following are available:
34725
34726 .ilist
34727 SMTP over TCP/IP (Exim daemon or &'inetd'&);
34728 .next
34729 SMTP over the standard input and output (the &%-bs%& option);
34730 .next
34731 Batched SMTP on the standard input (the &%-bS%& option).
34732 .endlist
34733
34734 For mail delivery, the following are available:
34735
34736 .ilist
34737 SMTP over TCP/IP (the &(smtp)& transport);
34738 .next
34739 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
34740 &"lmtp"&);
34741 .next
34742 LMTP over a pipe to a process running in the local host (the &(lmtp)&
34743 transport);
34744 .next
34745 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
34746 the &%use_bsmtp%& option set).
34747 .endlist
34748
34749 &'Batched SMTP'& is the name for a process in which batches of messages are
34750 stored in or read from files (or pipes), in a format in which SMTP commands are
34751 used to contain the envelope information.
34752
34753
34754
34755 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
34756 .cindex "SMTP" "outgoing over TCP/IP"
34757 .cindex "outgoing SMTP over TCP/IP"
34758 .cindex "LMTP" "over TCP/IP"
34759 .cindex "outgoing LMTP over TCP/IP"
34760 .cindex "EHLO"
34761 .cindex "HELO"
34762 .cindex "SIZE option on MAIL command"
34763 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
34764 The &%protocol%& option selects which protocol is to be used, but the actual
34765 processing is the same in both cases.
34766
34767 If, in response to its EHLO command, Exim is told that the SIZE
34768 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
34769 command. The value of <&'n'&> is the message size plus the value of the
34770 &%size_addition%& option (default 1024) to allow for additions to the message
34771 such as per-transport header lines, or changes made in a
34772 .cindex "transport" "filter"
34773 .cindex "filter" "transport filter"
34774 transport filter. If &%size_addition%& is set negative, the use of SIZE is
34775 suppressed.
34776
34777 If the remote server advertises support for PIPELINING, Exim uses the
34778 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
34779 required for the transaction.
34780
34781 If the remote server advertises support for the STARTTLS command, and Exim
34782 was built to support TLS encryption, it tries to start a TLS session unless the
34783 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
34784 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
34785 is called for verification.
34786
34787 If the remote server advertises support for the AUTH command, Exim scans
34788 the authenticators configuration for any suitable client settings, as described
34789 in chapter &<<CHAPSMTPAUTH>>&.
34790
34791 .cindex "carriage return"
34792 .cindex "linefeed"
34793 Responses from the remote host are supposed to be terminated by CR followed by
34794 LF. However, there are known to be hosts that do not send CR characters, so in
34795 order to be able to interwork with such hosts, Exim treats LF on its own as a
34796 line terminator.
34797
34798 If a message contains a number of different addresses, all those with the same
34799 characteristics (for example, the same envelope sender) that resolve to the
34800 same set of hosts, in the same order, are sent in a single SMTP transaction,
34801 even if they are for different domains, unless there are more than the setting
34802 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
34803 they are split into groups containing no more than &%max_rcpt%&s addresses
34804 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
34805 in parallel sessions. The order of hosts with identical MX values is not
34806 significant when checking whether addresses can be batched in this way.
34807
34808 When the &(smtp)& transport suffers a temporary failure that is not
34809 message-related, Exim updates its transport-specific database, which contains
34810 records indexed by host name that remember which messages are waiting for each
34811 particular host. It also updates the retry database with new retry times.
34812
34813 .cindex "hints database" "retry keys"
34814 Exim's retry hints are based on host name plus IP address, so if one address of
34815 a multi-homed host is broken, it will soon be skipped most of the time.
34816 See the next section for more detail about error handling.
34817
34818 .cindex "SMTP" "passed connection"
34819 .cindex "SMTP" "batching over TCP/IP"
34820 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
34821 looks in the hints database for the transport to see if there are any queued
34822 messages waiting for the host to which it is connected. If it finds one, it
34823 creates a new Exim process using the &%-MC%& option (which can only be used by
34824 a process running as root or the Exim user) and passes the TCP/IP socket to it
34825 so that it can deliver another message using the same socket. The new process
34826 does only those deliveries that are routed to the connected host, and may in
34827 turn pass the socket on to a third process, and so on.
34828
34829 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
34830 limit the number of messages sent down a single TCP/IP connection.
34831
34832 .cindex "asterisk" "after IP address"
34833 The second and subsequent messages delivered down an existing connection are
34834 identified in the main log by the addition of an asterisk after the closing
34835 square bracket of the IP address.
34836
34837
34838
34839
34840 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
34841 .cindex "error" "in outgoing SMTP"
34842 .cindex "SMTP" "errors in outgoing"
34843 .cindex "host" "error"
34844 Three different kinds of error are recognized for outgoing SMTP: host errors,
34845 message errors, and recipient errors.
34846
34847 .vlist
34848 .vitem "&*Host errors*&"
34849 A host error is not associated with a particular message or with a
34850 particular recipient of a message. The host errors are:
34851
34852 .ilist
34853 Connection refused or timed out,
34854 .next
34855 Any error response code on connection,
34856 .next
34857 Any error response code to EHLO or HELO,
34858 .next
34859 Loss of connection at any time, except after &"."&,
34860 .next
34861 I/O errors at any time,
34862 .next
34863 Timeouts during the session, other than in response to MAIL, RCPT or
34864 the &"."& at the end of the data.
34865 .endlist ilist
34866
34867 For a host error, a permanent error response on connection, or in response to
34868 EHLO, causes all addresses routed to the host to be failed. Any other host
34869 error causes all addresses to be deferred, and retry data to be created for the
34870 host. It is not tried again, for any message, until its retry time arrives. If
34871 the current set of addresses are not all delivered in this run (to some
34872 alternative host), the message is added to the list of those waiting for this
34873 host, so if it is still undelivered when a subsequent successful delivery is
34874 made to the host, it will be sent down the same SMTP connection.
34875
34876 .vitem "&*Message errors*&"
34877 .cindex "message" "error"
34878 A message error is associated with a particular message when sent to a
34879 particular host, but not with a particular recipient of the message. The
34880 message errors are:
34881
34882 .ilist
34883 Any error response code to MAIL, DATA, or the &"."& that terminates
34884 the data,
34885 .next
34886 Timeout after MAIL,
34887 .next
34888 Timeout or loss of connection after the &"."& that terminates the data. A
34889 timeout after the DATA command itself is treated as a host error, as is loss of
34890 connection at any other time.
34891 .endlist ilist
34892
34893 For a message error, a permanent error response (5&'xx'&) causes all addresses
34894 to be failed, and a delivery error report to be returned to the sender. A
34895 temporary error response (4&'xx'&), or one of the timeouts, causes all
34896 addresses to be deferred. Retry data is not created for the host, but instead,
34897 a retry record for the combination of host plus message id is created. The
34898 message is not added to the list of those waiting for this host. This ensures
34899 that the failing message will not be sent to this host again until the retry
34900 time arrives. However, other messages that are routed to the host are not
34901 affected, so if it is some property of the message that is causing the error,
34902 it will not stop the delivery of other mail.
34903
34904 If the remote host specified support for the SIZE parameter in its response
34905 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
34906 over-large message will cause a message error because the error arrives as a
34907 response to MAIL.
34908
34909 .vitem "&*Recipient errors*&"
34910 .cindex "recipient" "error"
34911 A recipient error is associated with a particular recipient of a message. The
34912 recipient errors are:
34913
34914 .ilist
34915 Any error response to RCPT,
34916 .next
34917 Timeout after RCPT.
34918 .endlist
34919
34920 For a recipient error, a permanent error response (5&'xx'&) causes the
34921 recipient address to be failed, and a bounce message to be returned to the
34922 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
34923 address to be deferred, and routing retry data to be created for it. This is
34924 used to delay processing of the address in subsequent queue runs, until its
34925 routing retry time arrives. This applies to all messages, but because it
34926 operates only in queue runs, one attempt will be made to deliver a new message
34927 to the failing address before the delay starts to operate. This ensures that,
34928 if the failure is really related to the message rather than the recipient
34929 (&"message too big for this recipient"& is a possible example), other messages
34930 have a chance of getting delivered. If a delivery to the address does succeed,
34931 the retry information gets cleared, so all stuck messages get tried again, and
34932 the retry clock is reset.
34933
34934 The message is not added to the list of those waiting for this host. Use of the
34935 host for other messages is unaffected, and except in the case of a timeout,
34936 other recipients are processed independently, and may be successfully delivered
34937 in the current SMTP session. After a timeout it is of course impossible to
34938 proceed with the session, so all addresses get deferred. However, those other
34939 than the one that failed do not suffer any subsequent retry delays. Therefore,
34940 if one recipient is causing trouble, the others have a chance of getting
34941 through when a subsequent delivery attempt occurs before the failing
34942 recipient's retry time.
34943 .endlist
34944
34945 In all cases, if there are other hosts (or IP addresses) available for the
34946 current set of addresses (for example, from multiple MX records), they are
34947 tried in this run for any undelivered addresses, subject of course to their
34948 own retry data. In other words, recipient error retry data does not take effect
34949 until the next delivery attempt.
34950
34951 Some hosts have been observed to give temporary error responses to every
34952 MAIL command at certain times (&"insufficient space"& has been seen). It
34953 would be nice if such circumstances could be recognized, and defer data for the
34954 host itself created, but this is not possible within the current Exim design.
34955 What actually happens is that retry data for every (host, message) combination
34956 is created.
34957
34958 The reason that timeouts after MAIL and RCPT are treated specially is that
34959 these can sometimes arise as a result of the remote host's verification
34960 procedures. Exim makes this assumption, and treats them as if a temporary error
34961 response had been received. A timeout after &"."& is treated specially because
34962 it is known that some broken implementations fail to recognize the end of the
34963 message if the last character of the last line is a binary zero. Thus, it is
34964 helpful to treat this case as a message error.
34965
34966 Timeouts at other times are treated as host errors, assuming a problem with the
34967 host, or the connection to it. If a timeout after MAIL, RCPT,
34968 or &"."& is really a connection problem, the assumption is that at the next try
34969 the timeout is likely to occur at some other point in the dialogue, causing it
34970 then to be treated as a host error.
34971
34972 There is experimental evidence that some MTAs drop the connection after the
34973 terminating &"."& if they do not like the contents of the message for some
34974 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
34975 should be given. That is why Exim treats this case as a message rather than a
34976 host error, in order not to delay other messages to the same host.
34977
34978
34979
34980
34981 .section "Incoming SMTP messages over TCP/IP" "SECID233"
34982 .cindex "SMTP" "incoming over TCP/IP"
34983 .cindex "incoming SMTP over TCP/IP"
34984 .cindex "inetd"
34985 .cindex "daemon"
34986 Incoming SMTP messages can be accepted in one of two ways: by running a
34987 listening daemon, or by using &'inetd'&. In the latter case, the entry in
34988 &_/etc/inetd.conf_& should be like this:
34989 .code
34990 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
34991 .endd
34992 Exim distinguishes between this case and the case of a locally running user
34993 agent using the &%-bs%& option by checking whether or not the standard input is
34994 a socket. When it is, either the port must be privileged (less than 1024), or
34995 the caller must be root or the Exim user. If any other user passes a socket
34996 with an unprivileged port number, Exim prints a message on the standard error
34997 stream and exits with an error code.
34998
34999 By default, Exim does not make a log entry when a remote host connects or
35000 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
35001 unexpected. It can be made to write such log entries by setting the
35002 &%smtp_connection%& log selector.
35003
35004 .cindex "carriage return"
35005 .cindex "linefeed"
35006 Commands from the remote host are supposed to be terminated by CR followed by
35007 LF. However, there are known to be hosts that do not send CR characters. In
35008 order to be able to interwork with such hosts, Exim treats LF on its own as a
35009 line terminator.
35010 Furthermore, because common code is used for receiving messages from all
35011 sources, a CR on its own is also interpreted as a line terminator. However, the
35012 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
35013
35014 .cindex "EHLO" "invalid data"
35015 .cindex "HELO" "invalid data"
35016 One area that sometimes gives rise to problems concerns the EHLO or
35017 HELO commands. Some clients send syntactically invalid versions of these
35018 commands, which Exim rejects by default. (This is nothing to do with verifying
35019 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
35020 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
35021 match the broken hosts that send invalid commands.
35022
35023 .cindex "SIZE option on MAIL command"
35024 .cindex "MAIL" "SIZE option"
35025 The amount of disk space available is checked whenever SIZE is received on
35026 a MAIL command, independently of whether &%message_size_limit%& or
35027 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
35028 false. A temporary error is given if there is not enough space. If
35029 &%check_spool_space%& is set, the check is for that amount of space plus the
35030 value given with SIZE, that is, it checks that the addition of the incoming
35031 message will not reduce the space below the threshold.
35032
35033 When a message is successfully received, Exim includes the local message id in
35034 its response to the final &"."& that terminates the data. If the remote host
35035 logs this text it can help with tracing what has happened to a message.
35036
35037 The Exim daemon can limit the number of simultaneous incoming connections it is
35038 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
35039 number of simultaneous incoming connections from a single remote host (see the
35040 &%smtp_accept_max_per_host%& option). Additional connection attempts are
35041 rejected using the SMTP temporary error code 421.
35042
35043 The Exim daemon does not rely on the SIGCHLD signal to detect when a
35044 subprocess has finished, as this can get lost at busy times. Instead, it looks
35045 for completed subprocesses every time it wakes up. Provided there are other
35046 things happening (new incoming calls, starts of queue runs), completed
35047 processes will be noticed and tidied away. On very quiet systems you may
35048 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
35049 it will be noticed when the daemon next wakes up.
35050
35051 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
35052 and can also be set up to reject SMTP calls from non-reserved hosts at times of
35053 high system load &-- for details see the &%smtp_accept_reserve%&,
35054 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
35055 applies in both the daemon and &'inetd'& cases.
35056
35057 Exim normally starts a delivery process for each message received, though this
35058 can be varied by means of the &%-odq%& command line option and the
35059 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
35060 number of simultaneously running delivery processes started in this way from
35061 SMTP input can be limited by the &%smtp_accept_queue%& and
35062 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
35063 subsequently received messages are just put on the input queue without starting
35064 a delivery process.
35065
35066 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
35067 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
35068 started up from the &'inetd'& daemon, because in that case each connection is
35069 handled by an entirely independent Exim process. Control by load average is,
35070 however, available with &'inetd'&.
35071
35072 Exim can be configured to verify addresses in incoming SMTP commands as they
35073 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
35074 to rewrite addresses at this time &-- before any syntax checking is done. See
35075 section &<<SECTrewriteS>>&.
35076
35077 Exim can also be configured to limit the rate at which a client host submits
35078 MAIL and RCPT commands in a single SMTP session. See the
35079 &%smtp_ratelimit_hosts%& option.
35080
35081
35082
35083 .section "Unrecognized SMTP commands" "SECID234"
35084 .cindex "SMTP" "unrecognized commands"
35085 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
35086 commands during a single SMTP connection, it drops the connection after sending
35087 the error response to the last command. The default value for
35088 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
35089 abuse that subvert web servers into making connections to SMTP ports; in these
35090 circumstances, a number of non-SMTP lines are sent first.
35091
35092
35093 .section "Syntax and protocol errors in SMTP commands" "SECID235"
35094 .cindex "SMTP" "syntax errors"
35095 .cindex "SMTP" "protocol errors"
35096 A syntax error is detected if an SMTP command is recognized, but there is
35097 something syntactically wrong with its data, for example, a malformed email
35098 address in a RCPT command. Protocol errors include invalid command
35099 sequencing such as RCPT before MAIL. If Exim receives more than
35100 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
35101 drops the connection after sending the error response to the last command. The
35102 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
35103 broken clients that loop sending bad commands (yes, it has been seen).
35104
35105
35106
35107 .section "Use of non-mail SMTP commands" "SECID236"
35108 .cindex "SMTP" "non-mail commands"
35109 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
35110 DATA. Exim counts such commands, and drops the connection if there are too
35111 many of them in a single SMTP session. This action catches some
35112 denial-of-service attempts and things like repeated failing AUTHs, or a mad
35113 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
35114 defines what &"too many"& means. Its default value is 10.
35115
35116 When a new message is expected, one occurrence of RSET is not counted. This
35117 allows a client to send one RSET between messages (this is not necessary,
35118 but some clients do it). Exim also allows one uncounted occurrence of HELO
35119 or EHLO, and one occurrence of STARTTLS between messages. After
35120 starting up a TLS session, another EHLO is expected, and so it too is not
35121 counted.
35122
35123 The first occurrence of AUTH in a connection, or immediately following
35124 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
35125 RCPT, DATA, and QUIT are counted.
35126
35127 You can control which hosts are subject to the limit set by
35128 &%smtp_accept_max_nonmail%& by setting
35129 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
35130 the limit apply to all hosts. This option means that you can exclude any
35131 specific badly-behaved hosts that you have to live with.
35132
35133
35134
35135
35136 .section "The VRFY and EXPN commands" "SECID237"
35137 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
35138 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
35139 appropriate) in order to decide whether the command should be accepted or not.
35140
35141 .cindex "VRFY" "processing"
35142 When no ACL is defined for VRFY, or if it rejects without
35143 setting an explicit response code, the command is accepted
35144 (with a 252 SMTP response code)
35145 in order to support awkward clients that do a VRFY before every RCPT.
35146 When VRFY is accepted, it runs exactly the same code as when Exim is
35147 called with the &%-bv%& option, and returns 250/451/550
35148 SMTP response codes.
35149
35150 .cindex "EXPN" "processing"
35151 If no ACL for EXPN is defined, the command is rejected.
35152 When EXPN is accepted, a single-level expansion of the address is done.
35153 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
35154 than a verification (the &%-bv%& option). If an unqualified local part is given
35155 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
35156 of VRFY and EXPN commands are logged on the main and reject logs, and
35157 VRFY verification failures are logged on the main log for consistency with
35158 RCPT failures.
35159
35160
35161
35162 .section "The ETRN command" "SECTETRN"
35163 .cindex "ETRN" "processing"
35164 RFC 1985 describes an SMTP command called ETRN that is designed to
35165 overcome the security problems of the TURN command (which has fallen into
35166 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
35167 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
35168 should be accepted or not. If no ACL is defined, the command is rejected.
35169
35170 The ETRN command is concerned with &"releasing"& messages that are awaiting
35171 delivery to certain hosts. As Exim does not organize its message queue by host,
35172 the only form of ETRN that is supported by default is the one where the
35173 text starts with the &"#"& prefix, in which case the remainder of the text is
35174 specific to the SMTP server. A valid ETRN command causes a run of Exim with
35175 the &%-R%& option to happen, with the remainder of the ETRN text as its
35176 argument. For example,
35177 .code
35178 ETRN #brigadoon
35179 .endd
35180 runs the command
35181 .code
35182 exim -R brigadoon
35183 .endd
35184 which causes a delivery attempt on all messages with undelivered addresses
35185 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
35186 default), Exim prevents the simultaneous execution of more than one queue run
35187 for the same argument string as a result of an ETRN command. This stops
35188 a misbehaving client from starting more than one queue runner at once.
35189
35190 .cindex "hints database" "ETRN serialization"
35191 Exim implements the serialization by means of a hints database in which a
35192 record is written whenever a process is started by ETRN, and deleted when
35193 the process completes. However, Exim does not keep the SMTP session waiting for
35194 the ETRN process to complete. Once ETRN is accepted, the client is sent
35195 a &"success"& return code. Obviously there is scope for hints records to get
35196 left lying around if there is a system or program crash. To guard against this,
35197 Exim ignores any records that are more than six hours old.
35198
35199 .oindex "&%smtp_etrn_command%&"
35200 For more control over what ETRN does, the &%smtp_etrn_command%& option can
35201 used. This specifies a command that is run whenever ETRN is received,
35202 whatever the form of its argument. For
35203 example:
35204 .code
35205 smtp_etrn_command = /etc/etrn_command $domain \
35206                     $sender_host_address
35207 .endd
35208 .vindex "&$domain$&"
35209 The string is split up into arguments which are independently expanded. The
35210 expansion variable &$domain$& is set to the argument of the ETRN command,
35211 and no syntax checking is done on the contents of this argument. Exim does not
35212 wait for the command to complete, so its status code is not checked. Exim runs
35213 under its own uid and gid when receiving incoming SMTP, so it is not possible
35214 for it to change them before running the command.
35215
35216
35217
35218 .section "Incoming local SMTP" "SECID238"
35219 .cindex "SMTP" "local incoming"
35220 Some user agents use SMTP to pass messages to their local MTA using the
35221 standard input and output, as opposed to passing the envelope on the command
35222 line and writing the message to the standard input. This is supported by the
35223 &%-bs%& option. This form of SMTP is handled in the same way as incoming
35224 messages over TCP/IP (including the use of ACLs), except that the envelope
35225 sender given in a MAIL command is ignored unless the caller is trusted. In
35226 an ACL you can detect this form of SMTP input by testing for an empty host
35227 identification. It is common to have this as the first line in the ACL that
35228 runs for RCPT commands:
35229 .code
35230 accept hosts = :
35231 .endd
35232 This accepts SMTP messages from local processes without doing any other tests.
35233
35234
35235
35236 .section "Outgoing batched SMTP" "SECTbatchSMTP"
35237 .cindex "SMTP" "batched outgoing"
35238 .cindex "batched SMTP output"
35239 Both the &(appendfile)& and &(pipe)& transports can be used for handling
35240 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
35241 be output in BSMTP format. No SMTP responses are possible for this form of
35242 delivery. All it is doing is using SMTP commands as a way of transmitting the
35243 envelope along with the message.
35244
35245 The message is written to the file or pipe preceded by the SMTP commands
35246 MAIL and RCPT, and followed by a line containing a single dot. Lines in
35247 the message that start with a dot have an extra dot added. The SMTP command
35248 HELO is not normally used. If it is required, the &%message_prefix%& option
35249 can be used to specify it.
35250
35251 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
35252 one recipient address at a time by default. However, you can arrange for them
35253 to handle several addresses at once by setting the &%batch_max%& option. When
35254 this is done for BSMTP, messages may contain multiple RCPT commands. See
35255 chapter &<<CHAPbatching>>& for more details.
35256
35257 .vindex "&$host$&"
35258 When one or more addresses are routed to a BSMTP transport by a router that
35259 sets up a host list, the name of the first host on the list is available to the
35260 transport in the variable &$host$&. Here is an example of such a transport and
35261 router:
35262 .code
35263 begin routers
35264 route_append:
35265   driver = manualroute
35266   transport = smtp_appendfile
35267   route_list = domain.example  batch.host.example
35268
35269 begin transports
35270 smtp_appendfile:
35271   driver = appendfile
35272   directory = /var/bsmtp/$host
35273   batch_max = 1000
35274   use_bsmtp
35275   user = exim
35276 .endd
35277 This causes messages addressed to &'domain.example'& to be written in BSMTP
35278 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
35279 message (unless there are more than 1000 recipients).
35280
35281
35282
35283 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
35284 .cindex "SMTP" "batched incoming"
35285 .cindex "batched SMTP input"
35286 The &%-bS%& command line option causes Exim to accept one or more messages by
35287 reading SMTP on the standard input, but to generate no responses. If the caller
35288 is trusted, the senders in the MAIL commands are believed; otherwise the
35289 sender is always the caller of Exim. Unqualified senders and receivers are not
35290 rejected (there seems little point) but instead just get qualified. HELO
35291 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
35292 as NOOP; QUIT quits.
35293
35294 Minimal policy checking is done for BSMTP input. Only the non-SMTP
35295 ACL is run in the same way as for non-SMTP local input.
35296
35297 If an error is detected while reading a message, including a missing &"."& at
35298 the end, Exim gives up immediately. It writes details of the error to the
35299 standard output in a stylized way that the calling program should be able to
35300 make some use of automatically, for example:
35301 .code
35302 554 Unexpected end of file
35303 Transaction started in line 10
35304 Error detected in line 14
35305 .endd
35306 It writes a more verbose version, for human consumption, to the standard error
35307 file, for example:
35308 .code
35309 An error was detected while processing a file of BSMTP input.
35310 The error message was:
35311
35312 501 '>' missing at end of address
35313
35314 The SMTP transaction started in line 10.
35315 The error was detected in line 12.
35316 The SMTP command at fault was:
35317
35318 rcpt to:<malformed@in.com.plete
35319
35320 1 previous message was successfully processed.
35321 The rest of the batch was abandoned.
35322 .endd
35323 The return code from Exim is zero only if there were no errors. It is 1 if some
35324 messages were accepted before an error was detected, and 2 if no messages were
35325 accepted.
35326 .ecindex IIDsmtpproc1
35327 .ecindex IIDsmtpproc2
35328
35329
35330
35331 . ////////////////////////////////////////////////////////////////////////////
35332 . ////////////////////////////////////////////////////////////////////////////
35333
35334 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
35335          "Customizing messages"
35336 When a message fails to be delivered, or remains on the queue for more than a
35337 configured amount of time, Exim sends a message to the original sender, or
35338 to an alternative configured address. The text of these messages is built into
35339 the code of Exim, but it is possible to change it, either by adding a single
35340 string, or by replacing each of the paragraphs by text supplied in a file.
35341
35342 The &'From:'& and &'To:'& header lines are automatically generated; you can
35343 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
35344 option. Exim also adds the line
35345 .code
35346 Auto-Submitted: auto-generated
35347 .endd
35348 to all warning and bounce messages,
35349
35350
35351 .section "Customizing bounce messages" "SECID239"
35352 .cindex "customizing" "bounce message"
35353 .cindex "bounce message" "customizing"
35354 If &%bounce_message_text%& is set, its contents are included in the default
35355 message immediately after &"This message was created automatically by mail
35356 delivery software."& The string is not expanded. It is not used if
35357 &%bounce_message_file%& is set.
35358
35359 When &%bounce_message_file%& is set, it must point to a template file for
35360 constructing error messages. The file consists of a series of text items,
35361 separated by lines consisting of exactly four asterisks. If the file cannot be
35362 opened, default text is used and a message is written to the main and panic
35363 logs. If any text item in the file is empty, default text is used for that
35364 item.
35365
35366 .vindex "&$bounce_recipient$&"
35367 .vindex "&$bounce_return_size_limit$&"
35368 Each item of text that is read from the file is expanded, and there are two
35369 expansion variables which can be of use here: &$bounce_recipient$& is set to
35370 the recipient of an error message while it is being created, and
35371 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
35372 option, rounded to a whole number.
35373
35374 The items must appear in the file in the following order:
35375
35376 .ilist
35377 The first item is included in the headers, and should include at least a
35378 &'Subject:'& header. Exim does not check the syntax of these headers.
35379 .next
35380 The second item forms the start of the error message. After it, Exim lists the
35381 failing addresses with their error messages.
35382 .next
35383 The third item is used to introduce any text from pipe transports that is to be
35384 returned to the sender. It is omitted if there is no such text.
35385 .next
35386 The fourth, fifth and sixth items will be ignored and may be empty.
35387 The fields exist for back-compatibility
35388 .endlist
35389
35390 The default state (&%bounce_message_file%& unset) is equivalent to the
35391 following file, in which the sixth item is empty. The &'Subject:'& and some
35392 other lines have been split in order to fit them on the page:
35393 .code
35394 Subject: Mail delivery failed
35395   ${if eq{$sender_address}{$bounce_recipient}
35396   {: returning message to sender}}
35397 ****
35398 This message was created automatically by mail delivery software.
35399
35400 A message ${if eq{$sender_address}{$bounce_recipient}
35401   {that you sent }{sent by
35402
35403 <$sender_address>
35404
35405 }}could not be delivered to all of its recipients.
35406 This is a permanent error. The following address(es) failed:
35407 ****
35408 The following text was generated during the delivery attempt(s):
35409 ****
35410 ------ This is a copy of the message, including all the headers.
35411   ------
35412 ****
35413 ------ The body of the message is $message_size characters long;
35414   only the first
35415 ------ $bounce_return_size_limit or so are included here.
35416 ****
35417 .endd
35418 .section "Customizing warning messages" "SECTcustwarn"
35419 .cindex "customizing" "warning message"
35420 .cindex "warning of delay" "customizing the message"
35421 The option &%warn_message_file%& can be pointed at a template file for use when
35422 warnings about message delays are created. In this case there are only three
35423 text sections:
35424
35425 .ilist
35426 The first item is included in the headers, and should include at least a
35427 &'Subject:'& header. Exim does not check the syntax of these headers.
35428 .next
35429 The second item forms the start of the warning message. After it, Exim lists
35430 the delayed addresses.
35431 .next
35432 The third item then ends the message.
35433 .endlist
35434
35435 The default state is equivalent to the following file, except that some lines
35436 have been split here, in order to fit them on the page:
35437 .code
35438 Subject: Warning: message $message_exim_id delayed
35439   $warn_message_delay
35440 ****
35441 This message was created automatically by mail delivery software.
35442
35443 A message ${if eq{$sender_address}{$warn_message_recipients}
35444 {that you sent }{sent by
35445
35446 <$sender_address>
35447
35448 }}has not been delivered to all of its recipients after
35449 more than $warn_message_delay on the queue on $primary_hostname.
35450
35451 The message identifier is:     $message_exim_id
35452 The subject of the message is: $h_subject
35453 The date of the message is:    $h_date
35454
35455 The following address(es) have not yet been delivered:
35456 ****
35457 No action is required on your part. Delivery attempts will
35458 continue for some time, and this warning may be repeated at
35459 intervals if the message remains undelivered. Eventually the
35460 mail delivery software will give up, and when that happens,
35461 the message will be returned to you.
35462 .endd
35463 .vindex "&$warn_message_delay$&"
35464 .vindex "&$warn_message_recipients$&"
35465 However, in the default state the subject and date lines are omitted if no
35466 appropriate headers exist. During the expansion of this file,
35467 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
35468 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
35469 of recipients for the warning message. There may be more than one if there are
35470 multiple addresses with different &%errors_to%& settings on the routers that
35471 handled them.
35472
35473
35474
35475
35476 . ////////////////////////////////////////////////////////////////////////////
35477 . ////////////////////////////////////////////////////////////////////////////
35478
35479 .chapter "Some common configuration settings" "CHAPcomconreq"
35480 This chapter discusses some configuration settings that seem to be fairly
35481 common. More examples and discussion can be found in the Exim book.
35482
35483
35484
35485 .section "Sending mail to a smart host" "SECID240"
35486 .cindex "smart host" "example router"
35487 If you want to send all mail for non-local domains to a &"smart host"&, you
35488 should replace the default &(dnslookup)& router with a router which does the
35489 routing explicitly:
35490 .code
35491 send_to_smart_host:
35492   driver = manualroute
35493   route_list = !+local_domains smart.host.name
35494   transport = remote_smtp
35495 .endd
35496 You can use the smart host's IP address instead of the name if you wish.
35497 If you are using Exim only to submit messages to a smart host, and not for
35498 receiving incoming messages, you can arrange for it to do the submission
35499 synchronously by setting the &%mua_wrapper%& option (see chapter
35500 &<<CHAPnonqueueing>>&).
35501
35502
35503
35504
35505 .section "Using Exim to handle mailing lists" "SECTmailinglists"
35506 .cindex "mailing lists"
35507 Exim can be used to run simple mailing lists, but for large and/or complicated
35508 requirements, the use of additional specialized mailing list software such as
35509 Majordomo or Mailman is recommended.
35510
35511 The &(redirect)& router can be used to handle mailing lists where each list
35512 is maintained in a separate file, which can therefore be managed by an
35513 independent manager. The &%domains%& router option can be used to run these
35514 lists in a separate domain from normal mail. For example:
35515 .code
35516 lists:
35517   driver = redirect
35518   domains = lists.example
35519   file = /usr/lists/$local_part
35520   forbid_pipe
35521   forbid_file
35522   errors_to = $local_part-request@lists.example
35523   no_more
35524 .endd
35525 This router is skipped for domains other than &'lists.example'&. For addresses
35526 in that domain, it looks for a file that matches the local part. If there is no
35527 such file, the router declines, but because &%no_more%& is set, no subsequent
35528 routers are tried, and so the whole delivery fails.
35529
35530 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
35531 expanded into a file name or a pipe delivery, which is usually inappropriate in
35532 a mailing list.
35533
35534 .oindex "&%errors_to%&"
35535 The &%errors_to%& option specifies that any delivery errors caused by addresses
35536 taken from a mailing list are to be sent to the given address rather than the
35537 original sender of the message. However, before acting on this, Exim verifies
35538 the error address, and ignores it if verification fails.
35539
35540 For example, using the configuration above, mail sent to
35541 &'dicts@lists.example'& is passed on to those addresses contained in
35542 &_/usr/lists/dicts_&, with error reports directed to
35543 &'dicts-request@lists.example'&, provided that this address can be verified.
35544 There could be a file called &_/usr/lists/dicts-request_& containing
35545 the address(es) of this particular list's manager(s), but other approaches,
35546 such as setting up an earlier router (possibly using the &%local_part_prefix%&
35547 or &%local_part_suffix%& options) to handle addresses of the form
35548 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
35549
35550
35551
35552 .section "Syntax errors in mailing lists" "SECID241"
35553 .cindex "mailing lists" "syntax errors in"
35554 If an entry in redirection data contains a syntax error, Exim normally defers
35555 delivery of the original address. That means that a syntax error in a mailing
35556 list holds up all deliveries to the list. This may not be appropriate when a
35557 list is being maintained automatically from data supplied by users, and the
35558 addresses are not rigorously checked.
35559
35560 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
35561 entries that fail to parse, noting the incident in the log. If in addition
35562 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
35563 whenever a broken address is skipped. It is usually appropriate to set
35564 &%syntax_errors_to%& to the same address as &%errors_to%&.
35565
35566
35567
35568 .section "Re-expansion of mailing lists" "SECID242"
35569 .cindex "mailing lists" "re-expansion of"
35570 Exim remembers every individual address to which a message has been delivered,
35571 in order to avoid duplication, but it normally stores only the original
35572 recipient addresses with a message. If all the deliveries to a mailing list
35573 cannot be done at the first attempt, the mailing list is re-expanded when the
35574 delivery is next tried. This means that alterations to the list are taken into
35575 account at each delivery attempt, so addresses that have been added to
35576 the list since the message arrived will therefore receive a copy of the
35577 message, even though it pre-dates their subscription.
35578
35579 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
35580 on the &(redirect)& router. If this is done, any addresses generated by the
35581 router that fail to deliver at the first attempt are added to the message as
35582 &"top level"& addresses, and the parent address that generated them is marked
35583 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
35584 subsequent delivery attempts. The disadvantage of this is that if any of the
35585 failing addresses are incorrect, correcting them in the file has no effect on
35586 pre-existing messages.
35587
35588 The original top-level address is remembered with each of the generated
35589 addresses, and is output in any log messages. However, any intermediate parent
35590 addresses are not recorded. This makes a difference to the log only if the
35591 &%all_parents%& selector is set, but for mailing lists there is normally only
35592 one level of expansion anyway.
35593
35594
35595
35596 .section "Closed mailing lists" "SECID243"
35597 .cindex "mailing lists" "closed"
35598 The examples so far have assumed open mailing lists, to which anybody may
35599 send mail. It is also possible to set up closed lists, where mail is accepted
35600 from specified senders only. This is done by making use of the generic
35601 &%senders%& option to restrict the router that handles the list.
35602
35603 The following example uses the same file as a list of recipients and as a list
35604 of permitted senders. It requires three routers:
35605 .code
35606 lists_request:
35607   driver = redirect
35608   domains = lists.example
35609   local_part_suffix = -request
35610   file = /usr/lists/$local_part$local_part_suffix
35611   no_more
35612
35613 lists_post:
35614   driver = redirect
35615   domains = lists.example
35616   senders = ${if exists {/usr/lists/$local_part}\
35617              {lsearch;/usr/lists/$local_part}{*}}
35618   file = /usr/lists/$local_part
35619   forbid_pipe
35620   forbid_file
35621   errors_to = $local_part-request@lists.example
35622   no_more
35623
35624 lists_closed:
35625   driver = redirect
35626   domains = lists.example
35627   allow_fail
35628   data = :fail: $local_part@lists.example is a closed mailing list
35629 .endd
35630 All three routers have the same &%domains%& setting, so for any other domains,
35631 they are all skipped. The first router runs only if the local part ends in
35632 &%-request%&. It handles messages to the list manager(s) by means of an open
35633 mailing list.
35634
35635 The second router runs only if the &%senders%& precondition is satisfied. It
35636 checks for the existence of a list that corresponds to the local part, and then
35637 checks that the sender is on the list by means of a linear search. It is
35638 necessary to check for the existence of the file before trying to search it,
35639 because otherwise Exim thinks there is a configuration error. If the file does
35640 not exist, the expansion of &%senders%& is *, which matches all senders. This
35641 means that the router runs, but because there is no list, declines, and
35642 &%no_more%& ensures that no further routers are run. The address fails with an
35643 &"unrouteable address"& error.
35644
35645 The third router runs only if the second router is skipped, which happens when
35646 a mailing list exists, but the sender is not on it. This router forcibly fails
35647 the address, giving a suitable error message.
35648
35649
35650
35651
35652 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
35653 .cindex "VERP"
35654 .cindex "Variable Envelope Return Paths"
35655 .cindex "envelope sender"
35656 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
35657 are a way of helping mailing list administrators discover which subscription
35658 address is the cause of a particular delivery failure. The idea is to encode
35659 the original recipient address in the outgoing envelope sender address, so that
35660 if the message is forwarded by another host and then subsequently bounces, the
35661 original recipient can be extracted from the recipient address of the bounce.
35662
35663 .oindex &%errors_to%&
35664 .oindex &%return_path%&
35665 Envelope sender addresses can be modified by Exim using two different
35666 facilities: the &%errors_to%& option on a router (as shown in previous mailing
35667 list examples), or the &%return_path%& option on a transport. The second of
35668 these is effective only if the message is successfully delivered to another
35669 host; it is not used for errors detected on the local host (see the description
35670 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
35671 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
35672 .code
35673 verp_smtp:
35674   driver = smtp
35675   max_rcpt = 1
35676   return_path = \
35677     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
35678       {$1-request+$local_part=$domain@your.dom.example}fail}
35679 .endd
35680 This has the effect of rewriting the return path (envelope sender) on outgoing
35681 SMTP messages, if the local part of the original return path ends in
35682 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
35683 local part and domain of the recipient into the return path. Suppose, for
35684 example, that a message whose return path has been set to
35685 &'somelist-request@your.dom.example'& is sent to
35686 &'subscriber@other.dom.example'&. In the transport, the return path is
35687 rewritten as
35688 .code
35689 somelist-request+subscriber=other.dom.example@your.dom.example
35690 .endd
35691 .vindex "&$local_part$&"
35692 For this to work, you must tell Exim to send multiple copies of messages that
35693 have more than one recipient, so that each copy has just one recipient. This is
35694 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
35695 might be sent to several different recipients in the same domain, in which case
35696 &$local_part$& is not available in the transport, because it is not unique.
35697
35698 Unless your host is doing nothing but mailing list deliveries, you should
35699 probably use a separate transport for the VERP deliveries, so as not to use
35700 extra resources in making one-per-recipient copies for other deliveries. This
35701 can easily be done by expanding the &%transport%& option in the router:
35702 .code
35703 dnslookup:
35704   driver = dnslookup
35705   domains = ! +local_domains
35706   transport = \
35707     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
35708       {verp_smtp}{remote_smtp}}
35709   no_more
35710 .endd
35711 If you want to change the return path using &%errors_to%& in a router instead
35712 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
35713 routers that handle mailing list addresses. This will ensure that all delivery
35714 errors, including those detected on the local host, are sent to the VERP
35715 address.
35716
35717 On a host that does no local deliveries and has no manual routing, only the
35718 &(dnslookup)& router needs to be changed. A special transport is not needed for
35719 SMTP deliveries. Every mailing list recipient has its own return path value,
35720 and so Exim must hand them to the transport one at a time. Here is an example
35721 of a &(dnslookup)& router that implements VERP:
35722 .code
35723 verp_dnslookup:
35724   driver = dnslookup
35725   domains = ! +local_domains
35726   transport = remote_smtp
35727   errors_to = \
35728     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
35729      {$1-request+$local_part=$domain@your.dom.example}fail}
35730   no_more
35731 .endd
35732 Before you start sending out messages with VERPed return paths, you must also
35733 configure Exim to accept the bounce messages that come back to those paths.
35734 Typically this is done by setting a &%local_part_suffix%& option for a
35735 router, and using this to route the messages to wherever you want to handle
35736 them.
35737
35738 The overhead incurred in using VERP depends very much on the size of the
35739 message, the number of recipient addresses that resolve to the same remote
35740 host, and the speed of the connection over which the message is being sent. If
35741 a lot of addresses resolve to the same host and the connection is slow, sending
35742 a separate copy of the message for each address may take substantially longer
35743 than sending a single copy with many recipients (for which VERP cannot be
35744 used).
35745
35746
35747
35748
35749
35750
35751 .section "Virtual domains" "SECTvirtualdomains"
35752 .cindex "virtual domains"
35753 .cindex "domain" "virtual"
35754 The phrase &'virtual domain'& is unfortunately used with two rather different
35755 meanings:
35756
35757 .ilist
35758 A domain for which there are no real mailboxes; all valid local parts are
35759 aliases for other email addresses. Common examples are organizational
35760 top-level domains and &"vanity"& domains.
35761 .next
35762 One of a number of independent domains that are all handled by the same host,
35763 with mailboxes on that host, but where the mailbox owners do not necessarily
35764 have login accounts on that host.
35765 .endlist
35766
35767 The first usage is probably more common, and does seem more &"virtual"& than
35768 the second. This kind of domain can be handled in Exim with a straightforward
35769 aliasing router. One approach is to create a separate alias file for each
35770 virtual domain. Exim can test for the existence of the alias file to determine
35771 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
35772 to a router of this form:
35773 .code
35774 virtual:
35775   driver = redirect
35776   domains = dsearch;/etc/mail/virtual
35777   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
35778   no_more
35779 .endd
35780 The &%domains%& option specifies that the router is to be skipped, unless there
35781 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
35782 domain that is being processed. When the router runs, it looks up the local
35783 part in the file to find a new address (or list of addresses). The &%no_more%&
35784 setting ensures that if the lookup fails (leading to &%data%& being an empty
35785 string), Exim gives up on the address without trying any subsequent routers.
35786
35787 This one router can handle all the virtual domains because the alias file names
35788 follow a fixed pattern. Permissions can be arranged so that appropriate people
35789 can edit the different alias files. A successful aliasing operation results in
35790 a new envelope recipient address, which is then routed from scratch.
35791
35792 The other kind of &"virtual"& domain can also be handled in a straightforward
35793 way. One approach is to create a file for each domain containing a list of
35794 valid local parts, and use it in a router like this:
35795 .code
35796 my_domains:
35797   driver = accept
35798   domains = dsearch;/etc/mail/domains
35799   local_parts = lsearch;/etc/mail/domains/$domain
35800   transport = my_mailboxes
35801 .endd
35802 The address is accepted if there is a file for the domain, and the local part
35803 can be found in the file. The &%domains%& option is used to check for the
35804 file's existence because &%domains%& is tested before the &%local_parts%&
35805 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
35806 because that option is tested after &%local_parts%&. The transport is as
35807 follows:
35808 .code
35809 my_mailboxes:
35810   driver = appendfile
35811   file = /var/mail/$domain/$local_part
35812   user = mail
35813 .endd
35814 This uses a directory of mailboxes for each domain. The &%user%& setting is
35815 required, to specify which uid is to be used for writing to the mailboxes.
35816
35817 The configuration shown here is just one example of how you might support this
35818 requirement. There are many other ways this kind of configuration can be set
35819 up, for example, by using a database instead of separate files to hold all the
35820 information about the domains.
35821
35822
35823
35824 .section "Multiple user mailboxes" "SECTmulbox"
35825 .cindex "multiple mailboxes"
35826 .cindex "mailbox" "multiple"
35827 .cindex "local part" "prefix"
35828 .cindex "local part" "suffix"
35829 Heavy email users often want to operate with multiple mailboxes, into which
35830 incoming mail is automatically sorted. A popular way of handling this is to
35831 allow users to use multiple sender addresses, so that replies can easily be
35832 identified. Users are permitted to add prefixes or suffixes to their local
35833 parts for this purpose. The wildcard facility of the generic router options
35834 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
35835 example, consider this router:
35836 .code
35837 userforward:
35838   driver = redirect
35839   check_local_user
35840   file = $home/.forward
35841   local_part_suffix = -*
35842   local_part_suffix_optional
35843   allow_filter
35844 .endd
35845 .vindex "&$local_part_suffix$&"
35846 It runs a user's &_.forward_& file for all local parts of the form
35847 &'username-*'&. Within the filter file the user can distinguish different
35848 cases by testing the variable &$local_part_suffix$&. For example:
35849 .code
35850 if $local_part_suffix contains -special then
35851 save /home/$local_part/Mail/special
35852 endif
35853 .endd
35854 If the filter file does not exist, or does not deal with such addresses, they
35855 fall through to subsequent routers, and, assuming no subsequent use of the
35856 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
35857 control over which suffixes are valid.
35858
35859 Alternatively, a suffix can be used to trigger the use of a different
35860 &_.forward_& file &-- which is the way a similar facility is implemented in
35861 another MTA:
35862 .code
35863 userforward:
35864   driver = redirect
35865   check_local_user
35866   file = $home/.forward$local_part_suffix
35867   local_part_suffix = -*
35868   local_part_suffix_optional
35869   allow_filter
35870 .endd
35871 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
35872 example, &_.forward-special_& is used. Once again, if the appropriate file
35873 does not exist, or does not deal with the address, it is passed on to
35874 subsequent routers, which could, if required, look for an unqualified
35875 &_.forward_& file to use as a default.
35876
35877
35878
35879 .section "Simplified vacation processing" "SECID244"
35880 .cindex "vacation processing"
35881 The traditional way of running the &'vacation'& program is for a user to set up
35882 a pipe command in a &_.forward_& file
35883 (see section &<<SECTspecitredli>>& for syntax details).
35884 This is prone to error by inexperienced users. There are two features of Exim
35885 that can be used to make this process simpler for users:
35886
35887 .ilist
35888 A local part prefix such as &"vacation-"& can be specified on a router which
35889 can cause the message to be delivered directly to the &'vacation'& program, or
35890 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
35891 &_.forward_& file are then much simpler. For example:
35892 .code
35893 spqr, vacation-spqr
35894 .endd
35895 .next
35896 The &%require_files%& generic router option can be used to trigger a
35897 vacation delivery by checking for the existence of a certain file in the
35898 user's home directory. The &%unseen%& generic option should also be used, to
35899 ensure that the original delivery also proceeds. In this case, all the user has
35900 to do is to create a file called, say, &_.vacation_&, containing a vacation
35901 message.
35902 .endlist
35903
35904 Another advantage of both these methods is that they both work even when the
35905 use of arbitrary pipes by users is locked out.
35906
35907
35908
35909 .section "Taking copies of mail" "SECID245"
35910 .cindex "message" "copying every"
35911 Some installations have policies that require archive copies of all messages to
35912 be made. A single copy of each message can easily be taken by an appropriate
35913 command in a system filter, which could, for example, use a different file for
35914 each day's messages.
35915
35916 There is also a shadow transport mechanism that can be used to take copies of
35917 messages that are successfully delivered by local transports, one copy per
35918 delivery. This could be used, &'inter alia'&, to implement automatic
35919 notification of delivery by sites that insist on doing such things.
35920
35921
35922
35923 .section "Intermittently connected hosts" "SECID246"
35924 .cindex "intermittently connected hosts"
35925 It has become quite common (because it is cheaper) for hosts to connect to the
35926 Internet periodically rather than remain connected all the time. The normal
35927 arrangement is that mail for such hosts accumulates on a system that is
35928 permanently connected.
35929
35930 Exim was designed for use on permanently connected hosts, and so it is not
35931 particularly well-suited to use in an intermittently connected environment.
35932 Nevertheless there are some features that can be used.
35933
35934
35935 .section "Exim on the upstream server host" "SECID247"
35936 It is tempting to arrange for incoming mail for the intermittently connected
35937 host to remain on Exim's queue until the client connects. However, this
35938 approach does not scale very well. Two different kinds of waiting message are
35939 being mixed up in the same queue &-- those that cannot be delivered because of
35940 some temporary problem, and those that are waiting for their destination host
35941 to connect. This makes it hard to manage the queue, as well as wasting
35942 resources, because each queue runner scans the entire queue.
35943
35944 A better approach is to separate off those messages that are waiting for an
35945 intermittently connected host. This can be done by delivering these messages
35946 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
35947 format, from where they are transmitted by other software when their
35948 destination connects. This makes it easy to collect all the mail for one host
35949 in a single directory, and to apply local timeout rules on a per-message basis
35950 if required.
35951
35952 On a very small scale, leaving the mail on Exim's queue can be made to work. If
35953 you are doing this, you should configure Exim with a long retry period for the
35954 intermittent host. For example:
35955 .code
35956 cheshire.wonderland.fict.example    *   F,5d,24h
35957 .endd
35958 This stops a lot of failed delivery attempts from occurring, but Exim remembers
35959 which messages it has queued up for that host. Once the intermittent host comes
35960 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
35961 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
35962 causes all the queued up messages to be delivered, often down a single SMTP
35963 connection. While the host remains connected, any new messages get delivered
35964 immediately.
35965
35966 If the connecting hosts do not have fixed IP addresses, that is, if a host is
35967 issued with a different IP address each time it connects, Exim's retry
35968 mechanisms on the holding host get confused, because the IP address is normally
35969 used as part of the key string for holding retry information. This can be
35970 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
35971 Since this has disadvantages for permanently connected hosts, it is best to
35972 arrange a separate transport for the intermittently connected ones.
35973
35974
35975
35976 .section "Exim on the intermittently connected client host" "SECID248"
35977 The value of &%smtp_accept_queue_per_connection%& should probably be
35978 increased, or even set to zero (that is, disabled) on the intermittently
35979 connected host, so that all incoming messages down a single connection get
35980 delivered immediately.
35981
35982 .cindex "SMTP" "passed connection"
35983 .cindex "SMTP" "multiple deliveries"
35984 .cindex "multiple SMTP deliveries"
35985 Mail waiting to be sent from an intermittently connected host will probably
35986 not have been routed, because without a connection DNS lookups are not
35987 possible. This means that if a normal queue run is done at connection time,
35988 each message is likely to be sent in a separate SMTP session. This can be
35989 avoided by starting the queue run with a command line option beginning with
35990 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
35991 first pass, routing is done but no deliveries take place. The second pass is a
35992 normal queue run; since all the messages have been previously routed, those
35993 destined for the same host are likely to get sent as multiple deliveries in a
35994 single SMTP connection.
35995
35996
35997
35998 . ////////////////////////////////////////////////////////////////////////////
35999 . ////////////////////////////////////////////////////////////////////////////
36000
36001 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
36002          "Exim as a non-queueing client"
36003 .cindex "client, non-queueing"
36004 .cindex "smart host" "suppressing queueing"
36005 On a personal computer, it is a common requirement for all
36006 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
36007 configured to operate that way, for all the popular operating systems.
36008 However, there are some MUAs for Unix-like systems that cannot be so
36009 configured: they submit messages using the command line interface of
36010 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
36011 messages this way.
36012
36013 If the personal computer runs continuously, there is no problem, because it can
36014 run a conventional MTA that handles delivery to the smart host, and deal with
36015 any delays via its queueing mechanism. However, if the computer does not run
36016 continuously or runs different operating systems at different times, queueing
36017 email is not desirable.
36018
36019 There is therefore a requirement for something that can provide the
36020 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
36021 any queueing or retrying facilities. Furthermore, the delivery to the smart
36022 host should be synchronous, so that if it fails, the sending MUA is immediately
36023 informed. In other words, we want something that extends an MUA that submits
36024 to a local MTA via the command line so that it behaves like one that submits
36025 to a remote smart host using TCP/SMTP.
36026
36027 There are a number of applications (for example, there is one called &'ssmtp'&)
36028 that do this job. However, people have found them to be lacking in various
36029 ways. For instance, you might want to allow aliasing and forwarding to be done
36030 before sending a message to the smart host.
36031
36032 Exim already had the necessary infrastructure for doing this job. Just a few
36033 tweaks were needed to make it behave as required, though it is somewhat of an
36034 overkill to use a fully-featured MTA for this purpose.
36035
36036 .oindex "&%mua_wrapper%&"
36037 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
36038 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
36039 assumes that it is being used to &"wrap"& a command-line MUA in the manner
36040 just described. As well as setting &%mua_wrapper%&, you also need to provide a
36041 compatible router and transport configuration. Typically there will be just one
36042 router and one transport, sending everything to a smart host.
36043
36044 When run in MUA wrapping mode, the behaviour of Exim changes in the
36045 following ways:
36046
36047 .ilist
36048 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
36049 In other words, the only way to submit messages is via the command line.
36050 .next
36051 Each message is synchronously delivered as soon as it is received (&%-odi%& is
36052 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
36053 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
36054 does not finish until the delivery attempt is complete. If the delivery is
36055 successful, a zero return code is given.
36056 .next
36057 Address redirection is permitted, but the final routing for all addresses must
36058 be to the same remote transport, and to the same list of hosts. Furthermore,
36059 the return address (envelope sender) must be the same for all recipients, as
36060 must any added or deleted header lines. In other words, it must be possible to
36061 deliver the message in a single SMTP transaction, however many recipients there
36062 are.
36063 .next
36064 If these conditions are not met, or if routing any address results in a
36065 failure or defer status, or if Exim is unable to deliver all the recipients
36066 successfully to one of the smart hosts, delivery of the entire message fails.
36067 .next
36068 Because no queueing is allowed, all failures are treated as permanent; there
36069 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
36070 smart host. Furthermore, because only a single yes/no response can be given to
36071 the caller, it is not possible to deliver to some recipients and not others. If
36072 there is an error (temporary or permanent) for any recipient, all are failed.
36073 .next
36074 If more than one smart host is listed, Exim will try another host after a
36075 connection failure or a timeout, in the normal way. However, if this kind of
36076 failure happens for all the hosts, the delivery fails.
36077 .next
36078 When delivery fails, an error message is written to the standard error stream
36079 (as well as to Exim's log), and Exim exits to the caller with a return code
36080 value 1. The message is expunged from Exim's spool files. No bounce messages
36081 are ever generated.
36082 .next
36083 No retry data is maintained, and any retry rules are ignored.
36084 .next
36085 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
36086 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
36087 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
36088 .endlist
36089
36090 The overall effect is that Exim makes a single synchronous attempt to deliver
36091 the message, failing if there is any kind of problem. Because no local
36092 deliveries are done and no daemon can be run, Exim does not need root
36093 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
36094 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
36095 the advantages and disadvantages of running without root privilege.
36096
36097
36098
36099
36100 . ////////////////////////////////////////////////////////////////////////////
36101 . ////////////////////////////////////////////////////////////////////////////
36102
36103 .chapter "Log files" "CHAPlog"
36104 .scindex IIDloggen "log" "general description"
36105 .cindex "log" "types of"
36106 Exim writes three different logs, referred to as the main log, the reject log,
36107 and the panic log:
36108
36109 .ilist
36110 .cindex "main log"
36111 The main log records the arrival of each message and each delivery in a single
36112 line in each case. The format is as compact as possible, in an attempt to keep
36113 down the size of log files. Two-character flag sequences make it easy to pick
36114 out these lines. A number of other events are recorded in the main log. Some of
36115 them are optional, in which case the &%log_selector%& option controls whether
36116 they are included or not. A Perl script called &'eximstats'&, which does simple
36117 analysis of main log files, is provided in the Exim distribution (see section
36118 &<<SECTmailstat>>&).
36119 .next
36120 .cindex "reject log"
36121 The reject log records information from messages that are rejected as a result
36122 of a configuration option (that is, for policy reasons).
36123 The first line of each rejection is a copy of the line that is also written to
36124 the main log. Then, if the message's header has been read at the time the log
36125 is written, its contents are written to this log. Only the original header
36126 lines are available; header lines added by ACLs are not logged. You can use the
36127 reject log to check that your policy controls are working correctly; on a busy
36128 host this may be easier than scanning the main log for rejection messages. You
36129 can suppress the writing of the reject log by setting &%write_rejectlog%&
36130 false.
36131 .next
36132 .cindex "panic log"
36133 .cindex "system log"
36134 When certain serious errors occur, Exim writes entries to its panic log. If the
36135 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
36136 are usually written to the main log as well, but can get lost amid the mass of
36137 other entries. The panic log should be empty under normal circumstances. It is
36138 therefore a good idea to check it (or to have a &'cron'& script check it)
36139 regularly, in order to become aware of any problems. When Exim cannot open its
36140 panic log, it tries as a last resort to write to the system log (syslog). This
36141 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
36142 message itself is written at priority LOG_CRIT.
36143 .endlist
36144
36145 Every log line starts with a timestamp, in the format shown in the following
36146 example. Note that many of the examples shown in this chapter are line-wrapped.
36147 In the log file, this would be all on one line:
36148 .code
36149 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
36150   by QUIT
36151 .endd
36152 By default, the timestamps are in the local timezone. There are two
36153 ways of changing this:
36154
36155 .ilist
36156 You can set the &%timezone%& option to a different time zone; in particular, if
36157 you set
36158 .code
36159 timezone = UTC
36160 .endd
36161 the timestamps will be in UTC (aka GMT).
36162 .next
36163 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
36164 example:
36165 .code
36166 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
36167 .endd
36168 .endlist
36169
36170 .cindex "log" "process ids in"
36171 .cindex "pid (process id)" "in log lines"
36172 Exim does not include its process id in log lines by default, but you can
36173 request that it does so by specifying the &`pid`& log selector (see section
36174 &<<SECTlogselector>>&). When this is set, the process id is output, in square
36175 brackets, immediately after the time and date.
36176
36177
36178
36179
36180 .section "Where the logs are written" "SECTwhelogwri"
36181 .cindex "log" "destination"
36182 .cindex "log" "to file"
36183 .cindex "log" "to syslog"
36184 .cindex "syslog"
36185 The logs may be written to local files, or to syslog, or both. However, it
36186 should be noted that many syslog implementations use UDP as a transport, and
36187 are therefore unreliable in the sense that messages are not guaranteed to
36188 arrive at the loghost, nor is the ordering of messages necessarily maintained.
36189 It has also been reported that on large log files (tens of megabytes) you may
36190 need to tweak syslog to prevent it syncing the file with each write &-- on
36191 Linux this has been seen to make syslog take 90% plus of CPU time.
36192
36193 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
36194 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
36195 configuration. This latter string is expanded, so it can contain, for example,
36196 references to the host name:
36197 .code
36198 log_file_path = /var/log/$primary_hostname/exim_%slog
36199 .endd
36200 It is generally advisable, however, to set the string in &_Local/Makefile_&
36201 rather than at run time, because then the setting is available right from the
36202 start of Exim's execution. Otherwise, if there's something it wants to log
36203 before it has read the configuration file (for example, an error in the
36204 configuration file) it will not use the path you want, and may not be able to
36205 log at all.
36206
36207 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
36208 list, currently limited to at most two items. This is one option where the
36209 facility for changing a list separator may not be used. The list must always be
36210 colon-separated. If an item in the list is &"syslog"& then syslog is used;
36211 otherwise the item must either be an absolute path, containing &`%s`& at the
36212 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
36213 implying the use of a default path.
36214
36215 When Exim encounters an empty item in the list, it searches the list defined by
36216 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
36217 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
36218 mean &"use the path specified at build time"&. It no such item exists, log
36219 files are written in the &_log_& subdirectory of the spool directory. This is
36220 equivalent to the setting:
36221 .code
36222 log_file_path = $spool_directory/log/%slog
36223 .endd
36224 If you do not specify anything at build time or run time,
36225 or if you unset the option at run time (i.e. &`log_file_path = `&),
36226 that is where the logs are written.
36227
36228 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
36229 are in use &-- see section &<<SECTdatlogfil>>& below.
36230
36231 Here are some examples of possible settings:
36232 .display
36233 &`LOG_FILE_PATH=syslog                    `& syslog only
36234 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
36235 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
36236 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
36237 .endd
36238 If there are more than two paths in the list, the first is used and a panic
36239 error is logged.
36240
36241
36242
36243 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
36244 .cindex "log" "cycling local files"
36245 .cindex "cycling logs"
36246 .cindex "&'exicyclog'&"
36247 .cindex "log" "local files; writing to"
36248 Some operating systems provide centralized and standardized methods for cycling
36249 log files. For those that do not, a utility script called &'exicyclog'& is
36250 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
36251 main and reject logs each time it is called. The maximum number of old logs to
36252 keep can be set. It is suggested this script is run as a daily &'cron'& job.
36253
36254 An Exim delivery process opens the main log when it first needs to write to it,
36255 and it keeps the file open in case subsequent entries are required &-- for
36256 example, if a number of different deliveries are being done for the same
36257 message. However, remote SMTP deliveries can take a long time, and this means
36258 that the file may be kept open long after it is renamed if &'exicyclog'& or
36259 something similar is being used to rename log files on a regular basis. To
36260 ensure that a switch of log files is noticed as soon as possible, Exim calls
36261 &[stat()]& on the main log's name before reusing an open file, and if the file
36262 does not exist, or its inode has changed, the old file is closed and Exim
36263 tries to open the main log from scratch. Thus, an old log file may remain open
36264 for quite some time, but no Exim processes should write to it once it has been
36265 renamed.
36266
36267
36268
36269 .section "Datestamped log files" "SECTdatlogfil"
36270 .cindex "log" "datestamped files"
36271 Instead of cycling the main and reject log files by renaming them
36272 periodically, some sites like to use files whose names contain a datestamp,
36273 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
36274 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
36275 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
36276 point where the datestamp is required. For example:
36277 .code
36278 log_file_path = /var/spool/exim/log/%slog-%D
36279 log_file_path = /var/log/exim-%s-%D.log
36280 log_file_path = /var/spool/exim/log/%D-%slog
36281 log_file_path = /var/log/exim/%s.%M
36282 .endd
36283 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
36284 examples of names generated by the above examples:
36285 .code
36286 /var/spool/exim/log/mainlog-20021225
36287 /var/log/exim-reject-20021225.log
36288 /var/spool/exim/log/20021225-mainlog
36289 /var/log/exim/main.200212
36290 .endd
36291 When this form of log file is specified, Exim automatically switches to new
36292 files at midnight. It does not make any attempt to compress old logs; you
36293 will need to write your own script if you require this. You should not
36294 run &'exicyclog'& with this form of logging.
36295
36296 The location of the panic log is also determined by &%log_file_path%&, but it
36297 is not datestamped, because rotation of the panic log does not make sense.
36298 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
36299 the string. In addition, if it immediately follows a slash, a following
36300 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
36301 character is removed. Thus, the four examples above would give these panic
36302 log names:
36303 .code
36304 /var/spool/exim/log/paniclog
36305 /var/log/exim-panic.log
36306 /var/spool/exim/log/paniclog
36307 /var/log/exim/panic
36308 .endd
36309
36310
36311 .section "Logging to syslog" "SECID249"
36312 .cindex "log" "syslog; writing to"
36313 The use of syslog does not change what Exim logs or the format of its messages,
36314 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
36315 Exim's log lines are omitted when these lines are sent to syslog. Apart from
36316 that, the same strings are written to syslog as to log files. The syslog
36317 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
36318 by default, but you can change these by setting the &%syslog_facility%& and
36319 &%syslog_processname%& options, respectively. If Exim was compiled with
36320 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
36321 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
36322 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
36323 the time and host name to each line.
36324 The three log streams are mapped onto syslog priorities as follows:
36325
36326 .ilist
36327 &'mainlog'& is mapped to LOG_INFO
36328 .next
36329 &'rejectlog'& is mapped to LOG_NOTICE
36330 .next
36331 &'paniclog'& is mapped to LOG_ALERT
36332 .endlist
36333
36334 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
36335 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
36336 these are routed by syslog to the same place. You can suppress this duplication
36337 by setting &%syslog_duplication%& false.
36338
36339 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
36340 entries contain multiple lines when headers are included. To cope with both
36341 these cases, entries written to syslog are split into separate &[syslog()]&
36342 calls at each internal newline, and also after a maximum of
36343 870 data characters. (This allows for a total syslog line length of 1024, when
36344 additions such as timestamps are added.) If you are running a syslog
36345 replacement that can handle lines longer than the 1024 characters allowed by
36346 RFC 3164, you should set
36347 .code
36348 SYSLOG_LONG_LINES=yes
36349 .endd
36350 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
36351 lines, but it still splits at internal newlines in &'reject'& log entries.
36352
36353 To make it easy to re-assemble split lines later, each component of a split
36354 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
36355 where <&'n'&> is the component number and <&'m'&> is the total number of
36356 components in the entry. The / delimiter is used when the line was split
36357 because it was too long; if it was split because of an internal newline, the \
36358 delimiter is used. For example, supposing the length limit to be 50 instead of
36359 870, the following would be the result of a typical rejection message to
36360 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
36361 name, and pid as added by syslog:
36362 .code
36363 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
36364 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
36365 [3/5]  when scanning for sender: missing or malformed lo
36366 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
36367 [5/5] mple>)
36368 .endd
36369 The same error might cause the following lines to be written to &"rejectlog"&
36370 (LOG_NOTICE):
36371 .code
36372 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
36373 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
36374 [3/18] er when scanning for sender: missing or malformed
36375 [4/18]  local part in "<>" (envelope sender is <ph10@cam
36376 [5\18] .example>)
36377 [6\18] Recipients: ph10@some.domain.cam.example
36378 [7\18] P Received: from [127.0.0.1] (ident=ph10)
36379 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
36380 [9\18]        id 16RdAL-0006pc-00
36381 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
36382 [11\18] 09:43 +0100
36383 [12\18] F From: <>
36384 [13\18]   Subject: this is a test header
36385 [18\18]   X-something: this is another header
36386 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
36387 [16\18] le>
36388 [17\18] B Bcc:
36389 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
36390 .endd
36391 Log lines that are neither too long nor contain newlines are written to syslog
36392 without modification.
36393
36394 If only syslog is being used, the Exim monitor is unable to provide a log tail
36395 display, unless syslog is routing &'mainlog'& to a file on the local host and
36396 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
36397 where it is.
36398
36399
36400
36401 .section "Log line flags" "SECID250"
36402 One line is written to the main log for each message received, and for each
36403 successful, unsuccessful, and delayed delivery. These lines can readily be
36404 picked out by the distinctive two-character flags that immediately follow the
36405 timestamp. The flags are:
36406 .display
36407 &`<=`&     message arrival
36408 &`(=`&     message fakereject
36409 &`=>`&     normal message delivery
36410 &`->`&     additional address in same delivery
36411 &`>>`&     cutthrough message delivery
36412 &`*>`&     delivery suppressed by &%-N%&
36413 &`**`&     delivery failed; address bounced
36414 &`==`&     delivery deferred; temporary problem
36415 .endd
36416
36417
36418 .section "Logging message reception" "SECID251"
36419 .cindex "log" "reception line"
36420 The format of the single-line entry in the main log that is written for every
36421 message received is shown in the basic example below, which is split over
36422 several lines in order to fit it on the page:
36423 .code
36424 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
36425   H=mailer.fict.example [192.168.123.123] U=exim
36426   P=smtp S=5678 id=<incoming message id>
36427 .endd
36428 The address immediately following &"<="& is the envelope sender address. A
36429 bounce message is shown with the sender address &"<>"&, and if it is locally
36430 generated, this is followed by an item of the form
36431 .code
36432 R=<message id>
36433 .endd
36434 which is a reference to the message that caused the bounce to be sent.
36435
36436 .cindex "HELO"
36437 .cindex "EHLO"
36438 For messages from other hosts, the H and U fields identify the remote host and
36439 record the RFC 1413 identity of the user that sent the message, if one was
36440 received. The number given in square brackets is the IP address of the sending
36441 host. If there is a single, unparenthesized  host name in the H field, as
36442 above, it has been verified to correspond to the IP address (see the
36443 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
36444 by the remote host in the SMTP HELO or EHLO command, and has not been
36445 verified. If verification yields a different name to that given for HELO or
36446 EHLO, the verified name appears first, followed by the HELO or EHLO
36447 name in parentheses.
36448
36449 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
36450 without brackets, in the HELO or EHLO command, leading to entries in
36451 the log containing text like these examples:
36452 .code
36453 H=(10.21.32.43) [192.168.8.34]
36454 H=([10.21.32.43]) [192.168.8.34]
36455 .endd
36456 This can be confusing. Only the final address in square brackets can be relied
36457 on.
36458
36459 For locally generated messages (that is, messages not received over TCP/IP),
36460 the H field is omitted, and the U field contains the login name of the caller
36461 of Exim.
36462
36463 .cindex "authentication" "logging"
36464 .cindex "AUTH" "logging"
36465 For all messages, the P field specifies the protocol used to receive the
36466 message. This is the value that is stored in &$received_protocol$&. In the case
36467 of incoming SMTP messages, the value indicates whether or not any SMTP
36468 extensions (ESMTP), encryption, or authentication were used. If the SMTP
36469 session was encrypted, there is an additional X field that records the cipher
36470 suite that was used.
36471
36472 .cindex log protocol
36473 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
36474 hosts that have authenticated themselves using the SMTP AUTH command. The first
36475 value is used when the SMTP connection was encrypted (&"secure"&). In this case
36476 there is an additional item A= followed by the name of the authenticator that
36477 was used. If an authenticated identification was set up by the authenticator's
36478 &%server_set_id%& option, this is logged too, separated by a colon from the
36479 authenticator name.
36480
36481 .cindex "size" "of message"
36482 The id field records the existing message id, if present. The size of the
36483 received message is given by the S field. When the message is delivered,
36484 headers may be removed or added, so that the size of delivered copies of the
36485 message may not correspond with this value (and indeed may be different to each
36486 other).
36487
36488 The &%log_selector%& option can be used to request the logging of additional
36489 data when a message is received. See section &<<SECTlogselector>>& below.
36490
36491
36492
36493 .section "Logging deliveries" "SECID252"
36494 .cindex "log" "delivery line"
36495 The format of the single-line entry in the main log that is written for every
36496 delivery is shown in one of the examples below, for local and remote
36497 deliveries, respectively. Each example has been split into multiple lines in order
36498 to fit it on the page:
36499 .code
36500 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
36501   <marv@hitch.fict.example> R=localuser T=local_delivery
36502 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
36503   monk@holistic.fict.example R=dnslookup T=remote_smtp
36504   H=holistic.fict.example [192.168.234.234]
36505 .endd
36506 For ordinary local deliveries, the original address is given in angle brackets
36507 after the final delivery address, which might be a pipe or a file. If
36508 intermediate address(es) exist between the original and the final address, the
36509 last of these is given in parentheses after the final address. The R and T
36510 fields record the router and transport that were used to process the address.
36511
36512 If SMTP AUTH was used for the delivery there is an additional item A=
36513 followed by the name of the authenticator that was used.
36514 If an authenticated identification was set up by the authenticator's &%client_set_id%&
36515 option, this is logged too, separated by a colon from the authenticator name.
36516
36517 If a shadow transport was run after a successful local delivery, the log line
36518 for the successful delivery has an item added on the end, of the form
36519 .display
36520 &`ST=<`&&'shadow transport name'&&`>`&
36521 .endd
36522 If the shadow transport did not succeed, the error message is put in
36523 parentheses afterwards.
36524
36525 .cindex "asterisk" "after IP address"
36526 When more than one address is included in a single delivery (for example, two
36527 SMTP RCPT commands in one transaction) the second and subsequent addresses are
36528 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
36529 down a single SMTP connection, an asterisk follows the IP address in the log
36530 lines for the second and subsequent messages.
36531 When two or more messages are delivered down a single TLS connection, the
36532 DNS and some TLS-related information logged for the first message delivered
36533 will not be present in the log lines for the second and subsequent messages.
36534 TLS cipher information is still available.
36535
36536 .cindex "delivery" "cutthrough; logging"
36537 .cindex "cutthrough" "logging"
36538 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
36539 line precedes the reception line, since cutthrough waits for a possible
36540 rejection from the destination in case it can reject the sourced item.
36541
36542 The generation of a reply message by a filter file gets logged as a
36543 &"delivery"& to the addressee, preceded by &">"&.
36544
36545 The &%log_selector%& option can be used to request the logging of additional
36546 data when a message is delivered. See section &<<SECTlogselector>>& below.
36547
36548
36549 .section "Discarded deliveries" "SECID253"
36550 .cindex "discarded messages"
36551 .cindex "message" "discarded"
36552 .cindex "delivery" "discarded; logging"
36553 When a message is discarded as a result of the command &"seen finish"& being
36554 obeyed in a filter file which generates no deliveries, a log entry of the form
36555 .code
36556 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
36557   <low.club@bridge.example> R=userforward
36558 .endd
36559 is written, to record why no deliveries are logged. When a message is discarded
36560 because it is aliased to &":blackhole:"& the log line is like this:
36561 .code
36562 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
36563   <hole@nowhere.example> R=blackhole_router
36564 .endd
36565
36566
36567 .section "Deferred deliveries" "SECID254"
36568 When a delivery is deferred, a line of the following form is logged:
36569 .code
36570 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
36571   R=dnslookup T=smtp defer (146): Connection refused
36572 .endd
36573 In the case of remote deliveries, the error is the one that was given for the
36574 last IP address that was tried. Details of individual SMTP failures are also
36575 written to the log, so the above line would be preceded by something like
36576 .code
36577 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
36578   mail1.endrest.example [192.168.239.239]: Connection refused
36579 .endd
36580 When a deferred address is skipped because its retry time has not been reached,
36581 a message is written to the log, but this can be suppressed by setting an
36582 appropriate value in &%log_selector%&.
36583
36584
36585
36586 .section "Delivery failures" "SECID255"
36587 .cindex "delivery" "failure; logging"
36588 If a delivery fails because an address cannot be routed, a line of the
36589 following form is logged:
36590 .code
36591 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
36592   <jim@trek99.example>: unknown mail domain
36593 .endd
36594 If a delivery fails at transport time, the router and transport are shown, and
36595 the response from the remote host is included, as in this example:
36596 .code
36597 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
36598   R=dnslookup T=remote_smtp: SMTP error from remote mailer
36599   after pipelined RCPT TO:<ace400@pb.example>: host
36600   pbmail3.py.example [192.168.63.111]: 553 5.3.0
36601   <ace400@pb.example>...Addressee unknown
36602 .endd
36603 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
36604 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
36605 disabling PIPELINING. The log lines for all forms of delivery failure are
36606 flagged with &`**`&.
36607
36608
36609
36610 .section "Fake deliveries" "SECID256"
36611 .cindex "delivery" "fake; logging"
36612 If a delivery does not actually take place because the &%-N%& option has been
36613 used to suppress it, a normal delivery line is written to the log, except that
36614 &"=>"& is replaced by &"*>"&.
36615
36616
36617
36618 .section "Completion" "SECID257"
36619 A line of the form
36620 .code
36621 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
36622 .endd
36623 is written to the main log when a message is about to be removed from the spool
36624 at the end of its processing.
36625
36626
36627
36628
36629 .section "Summary of Fields in Log Lines" "SECID258"
36630 .cindex "log" "summary of fields"
36631 A summary of the field identifiers that are used in log lines is shown in
36632 the following table:
36633 .display
36634 &`A   `&        authenticator name (and optional id and sender)
36635 &`C   `&        SMTP confirmation on delivery
36636 &`    `&        command list for &"no mail in SMTP session"&
36637 &`CV  `&        certificate verification status
36638 &`D   `&        duration of &"no mail in SMTP session"&
36639 &`DKIM`&        domain verified in incoming message
36640 &`DN  `&        distinguished name from peer certificate
36641 &`DS  `&        DNSSEC secured lookups
36642 &`DT  `&        on &`=>`& lines: time taken for a delivery
36643 &`F   `&        sender address (on delivery lines)
36644 &`H   `&        host name and IP address
36645 &`I   `&        local interface used
36646 &`id  `&        message id for incoming message
36647 &`K   `&        CHUNKING extension used
36648 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
36649 &`M8S `&        8BITMIME status for incoming message
36650 &`P   `&        on &`<=`& lines: protocol used
36651 &`    `&        on &`=>`& and &`**`& lines: return path
36652 &`PRDR`&        PRDR extension used
36653 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
36654 &`Q   `&        alternate queue name
36655 &`QT  `&        on &`=>`& lines: time spent on queue so far
36656 &`    `&        on &"Completed"& lines: time spent on queue
36657 &`R   `&        on &`<=`& lines: reference for local bounce
36658 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
36659 &`RT  `&        on &`<=`& lines: time taken for reception
36660 &`S   `&        size of message in bytes
36661 &`SNI `&        server name indication from TLS client hello
36662 &`ST  `&        shadow transport name
36663 &`T   `&        on &`<=`& lines: message subject (topic)
36664 &`TFO `&        connection took advantage of TCP Fast Open
36665 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
36666 &`U   `&        local user or RFC 1413 identity
36667 &`X   `&        TLS cipher suite
36668 .endd
36669
36670
36671 .section "Other log entries" "SECID259"
36672 Various other types of log entry are written from time to time. Most should be
36673 self-explanatory. Among the more common are:
36674
36675 .ilist
36676 .cindex "retry" "time not reached"
36677 &'retry time not reached'&&~&~An address previously suffered a temporary error
36678 during routing or local delivery, and the time to retry has not yet arrived.
36679 This message is not written to an individual message log file unless it happens
36680 during the first delivery attempt.
36681 .next
36682 &'retry time not reached for any host'&&~&~An address previously suffered
36683 temporary errors during remote delivery, and the retry time has not yet arrived
36684 for any of the hosts to which it is routed.
36685 .next
36686 .cindex "spool directory" "file locked"
36687 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
36688 some other Exim process is already working on the message. This can be quite
36689 common if queue running processes are started at frequent intervals. The
36690 &'exiwhat'& utility script can be used to find out what Exim processes are
36691 doing.
36692 .next
36693 .cindex "error" "ignored"
36694 &'error ignored'&&~&~There are several circumstances that give rise to this
36695 message:
36696 .olist
36697 Exim failed to deliver a bounce message whose age was greater than
36698 &%ignore_bounce_errors_after%&. The bounce was discarded.
36699 .next
36700 A filter file set up a delivery using the &"noerror"& option, and the delivery
36701 failed. The delivery was discarded.
36702 .next
36703 A delivery set up by a router configured with
36704 . ==== As this is a nested list, any displays it contains must be indented
36705 . ==== as otherwise they are too far to the left.
36706 .code
36707     errors_to = <>
36708 .endd
36709 failed. The delivery was discarded.
36710 .endlist olist
36711 .next
36712 .cindex DKIM "log line"
36713 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
36714 logging and the message has a DKIM signature header.
36715 .endlist ilist
36716
36717
36718
36719
36720
36721 .section "Reducing or increasing what is logged" "SECTlogselector"
36722 .cindex "log" "selectors"
36723 By setting the &%log_selector%& global option, you can disable some of Exim's
36724 default logging, or you can request additional logging. The value of
36725 &%log_selector%& is made up of names preceded by plus or minus characters. For
36726 example:
36727 .code
36728 log_selector = +arguments -retry_defer
36729 .endd
36730 The list of optional log items is in the following table, with the default
36731 selection marked by asterisks:
36732 .display
36733 &` 8bitmime                   `&  received 8BITMIME status
36734 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
36735 &` address_rewrite            `&  address rewriting
36736 &` all_parents                `&  all parents in => lines
36737 &` arguments                  `&  command line arguments
36738 &`*connection_reject          `&  connection rejections
36739 &`*delay_delivery             `&  immediate delivery delayed
36740 &` deliver_time               `&  time taken to perform delivery
36741 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
36742 &`*dkim                       `&  DKIM verified domain on <= lines
36743 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
36744 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
36745 &` dnssec                     `&  DNSSEC secured lookups
36746 &`*etrn                       `&  ETRN commands
36747 &`*host_lookup_failed         `&  as it says
36748 &` ident_timeout              `&  timeout for ident connection
36749 &` incoming_interface         `&  local interface on <= and => lines
36750 &` incoming_port              `&  remote port on <= lines
36751 &`*lost_incoming_connection   `&  as it says (includes timeouts)
36752 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
36753 &` outgoing_interface         `&  local interface on => lines
36754 &` outgoing_port              `&  add remote port to => lines
36755 &`*queue_run                  `&  start and end queue runs
36756 &` queue_time                 `&  time on queue for one recipient
36757 &` queue_time_overall         `&  time on queue for whole message
36758 &` pid                        `&  Exim process id
36759 &` pipelining                 `&  PIPELINING use, on <= and => lines
36760 &` proxy                      `&  proxy address on <= and => lines
36761 &` receive_time               `&  time taken to receive message
36762 &` received_recipients        `&  recipients on <= lines
36763 &` received_sender            `&  sender on <= lines
36764 &`*rejected_header            `&  header contents on reject log
36765 &`*retry_defer                `&  &"retry time not reached"&
36766 &` return_path_on_delivery    `&  put return path on => and ** lines
36767 &` sender_on_delivery         `&  add sender to => lines
36768 &`*sender_verify_fail         `&  sender verification failures
36769 &`*size_reject                `&  rejection because too big
36770 &`*skip_delivery              `&  delivery skipped in a queue run
36771 &`*smtp_confirmation          `&  SMTP confirmation on => lines
36772 &` smtp_connection            `&  incoming SMTP connections
36773 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
36774 &` smtp_mailauth              `&  AUTH argument to MAIL commands
36775 &` smtp_no_mail               `&  session with no MAIL commands
36776 &` smtp_protocol_error        `&  SMTP protocol errors
36777 &` smtp_syntax_error          `&  SMTP syntax errors
36778 &` subject                    `&  contents of &'Subject:'& on <= lines
36779 &`*tls_certificate_verified   `&  certificate verification status
36780 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
36781 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
36782 &` tls_sni                    `&  TLS SNI on <= lines
36783 &` unknown_in_list            `&  DNS lookup failed in list match
36784
36785 &` all                        `&  all of the above
36786 .endd
36787 See also the &%slow_lookup_log%& main configuration option,
36788 section &<<SECID99>>&
36789
36790 More details on each of these items follows:
36791
36792 .ilist
36793 .cindex "8BITMIME"
36794 .cindex "log" "8BITMIME"
36795 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
36796 which may help in tracking down interoperability issues with ancient MTAs
36797 that are not 8bit clean.  This is added to the &"<="& line, tagged with
36798 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
36799 &`7BIT`& and &`8BITMIME`& respectively.
36800 .next
36801 .cindex "&%warn%& ACL verb" "log when skipping"
36802 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
36803 its conditions cannot be evaluated, a log line to this effect is written if
36804 this log selector is set.
36805 .next
36806 .cindex "log" "rewriting"
36807 .cindex "rewriting" "logging"
36808 &%address_rewrite%&: This applies both to global rewrites and per-transport
36809 rewrites, but not to rewrites in filters run as an unprivileged user (because
36810 such users cannot access the log).
36811 .next
36812 .cindex "log" "full parentage"
36813 &%all_parents%&: Normally only the original and final addresses are logged on
36814 delivery lines; with this selector, intermediate parents are given in
36815 parentheses between them.
36816 .next
36817 .cindex "log" "Exim arguments"
36818 .cindex "Exim arguments, logging"
36819 &%arguments%&: This causes Exim to write the arguments with which it was called
36820 to the main log, preceded by the current working directory. This is a debugging
36821 feature, added to make it easier to find out how certain MUAs call
36822 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
36823 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
36824 that are empty or that contain white space are quoted. Non-printing characters
36825 are shown as escape sequences. This facility cannot log unrecognized arguments,
36826 because the arguments are checked before the configuration file is read. The
36827 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
36828 between the caller and Exim.
36829 .next
36830 .cindex "log" "connection rejections"
36831 &%connection_reject%&: A log entry is written whenever an incoming SMTP
36832 connection is rejected, for whatever reason.
36833 .next
36834 .cindex "log" "delayed delivery"
36835 .cindex "delayed delivery, logging"
36836 &%delay_delivery%&: A log entry is written whenever a delivery process is not
36837 started for an incoming message because the load is too high or too many
36838 messages were received on one connection. Logging does not occur if no delivery
36839 process is started because &%queue_only%& is set or &%-odq%& was used.
36840 .next
36841 .cindex "log" "delivery duration"
36842 &%deliver_time%&: For each delivery, the amount of real time it has taken to
36843 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
36844 If millisecond logging is enabled, short times will be shown with greater
36845 precision, eg. &`DT=0.304s`&.
36846 .next
36847 .cindex "log" "message size on delivery"
36848 .cindex "size" "of message"
36849 &%delivery_size%&: For each delivery, the size of message delivered is added to
36850 the &"=>"& line, tagged with S=.
36851 .next
36852 .cindex log "DKIM verification"
36853 .cindex DKIM "verification logging"
36854 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
36855 verifies successfully a tag of DKIM is added, with one of the verified domains.
36856 .next
36857 .cindex log "DKIM verification"
36858 .cindex DKIM "verification logging"
36859 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
36860 .next
36861 .cindex "log" "dnslist defer"
36862 .cindex "DNS list" "logging defer"
36863 .cindex "black list (DNS)"
36864 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
36865 DNS black list suffers a temporary error.
36866 .next
36867 .cindex log dnssec
36868 .cindex dnssec logging
36869 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
36870 dns lookups gave secure results a tag of DS is added.
36871 For acceptance this covers the reverse and forward lookups for host name verification.
36872 It does not cover helo-name verification.
36873 For delivery this covers the SRV, MX, A and/or AAAA lookups.
36874 .next
36875 .cindex "log" "ETRN commands"
36876 .cindex "ETRN" "logging"
36877 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
36878 is run to determine whether or not it is actually accepted. An invalid ETRN
36879 command, or one received within a message transaction is not logged by this
36880 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
36881 .next
36882 .cindex "log" "host lookup failure"
36883 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
36884 any addresses, or when a lookup of an IP address fails to find a host name, a
36885 log line is written. This logging does not apply to direct DNS lookups when
36886 routing email addresses, but it does apply to &"byname"& lookups.
36887 .next
36888 .cindex "log" "ident timeout"
36889 .cindex "RFC 1413" "logging timeout"
36890 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
36891 client's ident port times out.
36892 .next
36893 .cindex "log" "incoming interface"
36894 .cindex "log" "local interface"
36895 .cindex "log" "local address and port"
36896 .cindex "TCP/IP" "logging local address and port"
36897 .cindex "interface" "logging"
36898 &%incoming_interface%&: The interface on which a message was received is added
36899 to the &"<="& line as an IP address in square brackets, tagged by I= and
36900 followed by a colon and the port number. The local interface and port are also
36901 added to other SMTP log lines, for example &"SMTP connection from"&, to
36902 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
36903 The latter can be disabled by turning off the &%outgoing_interface%& option.
36904 .next
36905 .cindex log "incoming proxy address"
36906 .cindex proxy "logging proxy address"
36907 .cindex "TCP/IP" "logging proxy address"
36908 &%proxy%&: The internal (closest to the system running Exim) IP address
36909 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
36910 on a proxied connection
36911 or the &"=>"& line for a message delivered on a proxied connection.
36912 See &<<SECTproxyInbound>>& for more information.
36913 .next
36914 .cindex "log" "incoming remote port"
36915 .cindex "port" "logging remote"
36916 .cindex "TCP/IP" "logging incoming remote port"
36917 .vindex "&$sender_fullhost$&"
36918 .vindex "&$sender_rcvhost$&"
36919 &%incoming_port%&: The remote port number from which a message was received is
36920 added to log entries and &'Received:'& header lines, following the IP address
36921 in square brackets, and separated from it by a colon. This is implemented by
36922 changing the value that is put in the &$sender_fullhost$& and
36923 &$sender_rcvhost$& variables. Recording the remote port number has become more
36924 important with the widening use of NAT (see RFC 2505).
36925 .next
36926 .cindex "log" "dropped connection"
36927 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
36928 connection is unexpectedly dropped.
36929 .next
36930 .cindex "log" "millisecond timestamps"
36931 .cindex millisecond logging
36932 .cindex timestamps "millisecond, in logs"
36933 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
36934 appended to the seconds value.
36935 .next
36936 .cindex "log" "outgoing interface"
36937 .cindex "log" "local interface"
36938 .cindex "log" "local address and port"
36939 .cindex "TCP/IP" "logging local address and port"
36940 .cindex "interface" "logging"
36941 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
36942 interface on which a message was sent is added to delivery lines as an I= tag
36943 followed by IP address in square brackets. You can disable this by turning
36944 off the &%outgoing_interface%& option.
36945 .next
36946 .cindex "log" "outgoing remote port"
36947 .cindex "port" "logging outgoing remote"
36948 .cindex "TCP/IP" "logging outgoing remote port"
36949 &%outgoing_port%&: The remote port number is added to delivery log lines (those
36950 containing => tags) following the IP address.
36951 The local port is also added if &%incoming_interface%& and
36952 &%outgoing_interface%& are both enabled.
36953 This option is not included in the default setting, because for most ordinary
36954 configurations, the remote port number is always 25 (the SMTP port), and the
36955 local port is a random ephemeral port.
36956 .next
36957 .cindex "log" "process ids in"
36958 .cindex "pid (process id)" "in log lines"
36959 &%pid%&: The current process id is added to every log line, in square brackets,
36960 immediately after the time and date.
36961 .next
36962 .new
36963 .cindex log pipelining
36964 .cindex pipelining "logging outgoing"
36965 &%pipelining%&: A field is added to delivery and accept
36966 log lines when the ESMTP PIPELINING extension was used.
36967 The field is a single "L".
36968
36969 On accept lines, where PIPELINING was offered but not used by the client,
36970 the field has a minus appended.
36971 .next
36972 .cindex "log" "queue run"
36973 .cindex "queue runner" "logging"
36974 &%queue_run%&: The start and end of every queue run are logged.
36975 .next
36976 .cindex "log" "queue time"
36977 &%queue_time%&: The amount of time the message has been in the queue on the
36978 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
36979 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
36980 includes reception time as well as the delivery time for the current address.
36981 This means that it may be longer than the difference between the arrival and
36982 delivery log line times, because the arrival log line is not written until the
36983 message has been successfully received.
36984 If millisecond logging is enabled, short times will be shown with greater
36985 precision, eg. &`QT=1.578s`&.
36986 .next
36987 &%queue_time_overall%&: The amount of time the message has been in the queue on
36988 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
36989 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
36990 message, so it includes reception time as well as the total delivery time.
36991 .next
36992 .cindex "log" "receive duration"
36993 &%receive_time%&: For each message, the amount of real time it has taken to
36994 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
36995 If millisecond logging is enabled, short times will be shown with greater
36996 precision, eg. &`RT=0.204s`&.
36997 .next
36998 .cindex "log" "recipients"
36999 &%received_recipients%&: The recipients of a message are listed in the main log
37000 as soon as the message is received. The list appears at the end of the log line
37001 that is written when a message is received, preceded by the word &"for"&. The
37002 addresses are listed after they have been qualified, but before any rewriting
37003 has taken place.
37004 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
37005 in the list.
37006 .next
37007 .cindex "log" "sender reception"
37008 &%received_sender%&: The unrewritten original sender of a message is added to
37009 the end of the log line that records the message's arrival, after the word
37010 &"from"& (before the recipients if &%received_recipients%& is also set).
37011 .next
37012 .cindex "log" "header lines for rejection"
37013 &%rejected_header%&: If a message's header has been received at the time a
37014 rejection is written to the reject log, the complete header is added to the
37015 log. Header logging can be turned off individually for messages that are
37016 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
37017 .next
37018 .cindex "log" "retry defer"
37019 &%retry_defer%&: A log line is written if a delivery is deferred because a
37020 retry time has not yet been reached. However, this &"retry time not reached"&
37021 message is always omitted from individual message logs after the first delivery
37022 attempt.
37023 .next
37024 .cindex "log" "return path"
37025 &%return_path_on_delivery%&: The return path that is being transmitted with
37026 the message is included in delivery and bounce lines, using the tag P=.
37027 This is omitted if no delivery actually happens, for example, if routing fails,
37028 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
37029 .next
37030 .cindex "log" "sender on delivery"
37031 &%sender_on_delivery%&: The message's sender address is added to every delivery
37032 and bounce line, tagged by F= (for &"from"&).
37033 This is the original sender that was received with the message; it is not
37034 necessarily the same as the outgoing return path.
37035 .next
37036 .cindex "log" "sender verify failure"
37037 &%sender_verify_fail%&: If this selector is unset, the separate log line that
37038 gives details of a sender verification failure is not written. Log lines for
37039 the rejection of SMTP commands contain just &"sender verify failed"&, so some
37040 detail is lost.
37041 .next
37042 .cindex "log" "size rejection"
37043 &%size_reject%&: A log line is written whenever a message is rejected because
37044 it is too big.
37045 .next
37046 .cindex "log" "frozen messages; skipped"
37047 .cindex "frozen messages" "logging skipping"
37048 &%skip_delivery%&: A log line is written whenever a message is skipped during a
37049 queue run because it is frozen or because another process is already delivering
37050 it.
37051 .cindex "&""spool file is locked""&"
37052 The message that is written is &"spool file is locked"&.
37053 .next
37054 .cindex "log" "smtp confirmation"
37055 .cindex "SMTP" "logging confirmation"
37056 .cindex "LMTP" "logging confirmation"
37057 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
37058 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
37059 A number of MTAs (including Exim) return an identifying string in this
37060 response.
37061 .next
37062 .cindex "log" "SMTP connections"
37063 .cindex "SMTP" "logging connections"
37064 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
37065 established or closed, unless the connection is from a host that matches
37066 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
37067 only when the closure is unexpected.) This applies to connections from local
37068 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
37069 dropped in the middle of a message, a log line is always written, whether or
37070 not this selector is set, but otherwise nothing is written at the start and end
37071 of connections unless this selector is enabled.
37072
37073 For TCP/IP connections to an Exim daemon, the current number of connections is
37074 included in the log message for each new connection, but note that the count is
37075 reset if the daemon is restarted.
37076 Also, because connections are closed (and the closure is logged) in
37077 subprocesses, the count may not include connections that have been closed but
37078 whose termination the daemon has not yet noticed. Thus, while it is possible to
37079 match up the opening and closing of connections in the log, the value of the
37080 logged counts may not be entirely accurate.
37081 .next
37082 .cindex "log" "SMTP transaction; incomplete"
37083 .cindex "SMTP" "logging incomplete transactions"
37084 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
37085 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
37086 and the message sender plus any accepted recipients are included in the log
37087 line. This can provide evidence of dictionary attacks.
37088 .next
37089 .cindex "log" "non-MAIL SMTP sessions"
37090 .cindex "MAIL" "logging session without"
37091 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
37092 connection terminates without having issued a MAIL command. This includes both
37093 the case when the connection is dropped, and the case when QUIT is used. It
37094 does not include cases where the connection is rejected right at the start (by
37095 an ACL, or because there are too many connections, or whatever). These cases
37096 already have their own log lines.
37097
37098 The log line that is written contains the identity of the client in the usual
37099 way, followed by D= and a time, which records the duration of the connection.
37100 If the connection was authenticated, this fact is logged exactly as it is for
37101 an incoming message, with an A= item. If the connection was encrypted, CV=,
37102 DN=, and X= items may appear as they do for an incoming message, controlled by
37103 the same logging options.
37104
37105 Finally, if any SMTP commands were issued during the connection, a C= item
37106 is added to the line, listing the commands that were used. For example,
37107 .code
37108 C=EHLO,QUIT
37109 .endd
37110 shows that the client issued QUIT straight after EHLO. If there were fewer
37111 than 20 commands, they are all listed. If there were more than 20 commands,
37112 the last 20 are listed, preceded by &"..."&. However, with the default
37113 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
37114 have been aborted before 20 non-mail commands are processed.
37115 .next
37116 &%smtp_mailauth%&: A third subfield with the authenticated sender,
37117 colon-separated, is appended to the A= item for a message arrival or delivery
37118 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
37119 was accepted or used.
37120 .next
37121 .cindex "log" "SMTP protocol error"
37122 .cindex "SMTP" "logging protocol error"
37123 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
37124 encountered. Exim does not have perfect detection of all protocol errors
37125 because of transmission delays and the use of pipelining. If PIPELINING has
37126 been advertised to a client, an Exim server assumes that the client will use
37127 it, and therefore it does not count &"expected"& errors (for example, RCPT
37128 received after rejecting MAIL) as protocol errors.
37129 .next
37130 .cindex "SMTP" "logging syntax errors"
37131 .cindex "SMTP" "syntax errors; logging"
37132 .cindex "SMTP" "unknown command; logging"
37133 .cindex "log" "unknown SMTP command"
37134 .cindex "log" "SMTP syntax error"
37135 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
37136 encountered. An unrecognized command is treated as a syntax error. For an
37137 external connection, the host identity is given; for an internal connection
37138 using &%-bs%& the sender identification (normally the calling user) is given.
37139 .next
37140 .cindex "log" "subject"
37141 .cindex "subject, logging"
37142 &%subject%&: The subject of the message is added to the arrival log line,
37143 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
37144 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
37145 specifies whether characters with values greater than 127 should be logged
37146 unchanged, or whether they should be rendered as escape sequences.
37147 .next
37148 .cindex "log" "certificate verification"
37149 .cindex log DANE
37150 .cindex DANE logging
37151 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
37152 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
37153 verified
37154 using a CA trust anchor,
37155 &`CA=dane`& if using a DNS trust anchor,
37156 and &`CV=no`& if not.
37157 .next
37158 .cindex "log" "TLS cipher"
37159 .cindex "TLS" "logging cipher"
37160 &%tls_cipher%&: When a message is sent or received over an encrypted
37161 connection, the cipher suite used is added to the log line, preceded by X=.
37162 .next
37163 .cindex "log" "TLS peer DN"
37164 .cindex "TLS" "logging peer DN"
37165 &%tls_peerdn%&: When a message is sent or received over an encrypted
37166 connection, and a certificate is supplied by the remote host, the peer DN is
37167 added to the log line, preceded by DN=.
37168 .next
37169 .cindex "log" "TLS SNI"
37170 .cindex "TLS" "logging SNI"
37171 &%tls_sni%&: When a message is received over an encrypted connection, and
37172 the remote host provided the Server Name Indication extension, the SNI is
37173 added to the log line, preceded by SNI=.
37174 .next
37175 .cindex "log" "DNS failure in list"
37176 &%unknown_in_list%&: This setting causes a log entry to be written when the
37177 result of a list match is failure because a DNS lookup failed.
37178 .endlist
37179
37180
37181 .section "Message log" "SECID260"
37182 .cindex "message" "log file for"
37183 .cindex "log" "message log; description of"
37184 .cindex "&_msglog_& directory"
37185 .oindex "&%preserve_message_logs%&"
37186 In addition to the general log files, Exim writes a log file for each message
37187 that it handles. The names of these per-message logs are the message ids, and
37188 they are kept in the &_msglog_& sub-directory of the spool directory. Each
37189 message log contains copies of the log lines that apply to the message. This
37190 makes it easier to inspect the status of an individual message without having
37191 to search the main log. A message log is deleted when processing of the message
37192 is complete, unless &%preserve_message_logs%& is set, but this should be used
37193 only with great care because they can fill up your disk very quickly.
37194
37195 On a heavily loaded system, it may be desirable to disable the use of
37196 per-message logs, in order to reduce disk I/O. This can be done by setting the
37197 &%message_logs%& option false.
37198 .ecindex IIDloggen
37199
37200
37201
37202
37203 . ////////////////////////////////////////////////////////////////////////////
37204 . ////////////////////////////////////////////////////////////////////////////
37205
37206 .chapter "Exim utilities" "CHAPutils"
37207 .scindex IIDutils "utilities"
37208 A number of utility scripts and programs are supplied with Exim and are
37209 described in this chapter. There is also the Exim Monitor, which is covered in
37210 the next chapter. The utilities described here are:
37211
37212 .itable none 0 0 3  7* left  15* left  40* left
37213 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
37214   "list what Exim processes are doing"
37215 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
37216 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
37217 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
37218 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
37219                                                 various criteria"
37220 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
37221 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
37222   "extract statistics from the log"
37223 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
37224   "check address acceptance from given IP"
37225 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
37226 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
37227 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
37228 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
37229 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
37230 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
37231 .endtable
37232
37233 Another utility that might be of use to sites with many MTAs is Tom Kistner's
37234 &'exilog'&. It provides log visualizations across multiple Exim servers. See
37235 &url(https://duncanthrax.net/exilog/) for details.
37236
37237
37238
37239
37240 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
37241 .cindex "&'exiwhat'&"
37242 .cindex "process, querying"
37243 .cindex "SIGUSR1"
37244 On operating systems that can restart a system call after receiving a signal
37245 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
37246 a line describing what it is doing to the file &_exim-process.info_& in the
37247 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
37248 processes it can find, having first emptied the file. It then waits for one
37249 second to allow the Exim processes to react before displaying the results. In
37250 order to run &'exiwhat'& successfully you have to have sufficient privilege to
37251 send the signal to the Exim processes, so it is normally run as root.
37252
37253 &*Warning*&: This is not an efficient process. It is intended for occasional
37254 use by system administrators. It is not sensible, for example, to set up a
37255 script that sends SIGUSR1 signals to Exim processes at short intervals.
37256
37257
37258 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
37259 varies in different operating systems. Not only are different options used,
37260 but the format of the output is different. For this reason, there are some
37261 system configuration options that configure exactly how &'exiwhat'& works. If
37262 it doesn't seem to be working for you, check the following compile-time
37263 options:
37264 .display
37265 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
37266 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
37267 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
37268 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
37269 .endd
37270 An example of typical output from &'exiwhat'& is
37271 .code
37272 164 daemon: -q1h, listening on port 25
37273 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
37274 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
37275   [10.19.42.42] (editor@ref.example)
37276 10592 handling incoming call from [192.168.243.242]
37277 10628 accepting a local non-SMTP message
37278 .endd
37279 The first number in the output line is the process number. The third line has
37280 been split here, in order to fit it on the page.
37281
37282
37283
37284 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
37285 .cindex "&'exiqgrep'&"
37286 .cindex "queue" "grepping"
37287 This utility is a Perl script contributed by Matt Hubbard. It runs
37288 .code
37289 exim -bpu
37290 .endd
37291 or (in case &*-a*& switch is specified)
37292 .code
37293 exim -bp
37294 .endd
37295 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
37296 contain alternate exim configuration the queue management might be using.
37297
37298 to obtain a queue listing, and then greps the output to select messages
37299 that match given criteria. The following selection options are available:
37300
37301 .vlist
37302 .vitem &*-f*&&~<&'regex'&>
37303 Match the sender address using a case-insensitive search. The field that is
37304 tested is enclosed in angle brackets, so you can test for bounce messages with
37305 .code
37306 exiqgrep -f '^<>$'
37307 .endd
37308 .vitem &*-r*&&~<&'regex'&>
37309 Match a recipient address using a case-insensitive search. The field that is
37310 tested is not enclosed in angle brackets.
37311
37312 .vitem &*-s*&&~<&'regex'&>
37313 Match against the size field.
37314
37315 .vitem &*-y*&&~<&'seconds'&>
37316 Match messages that are younger than the given time.
37317
37318 .vitem &*-o*&&~<&'seconds'&>
37319 Match messages that are older than the given time.
37320
37321 .vitem &*-z*&
37322 Match only frozen messages.
37323
37324 .vitem &*-x*&
37325 Match only non-frozen messages.
37326 .endlist
37327
37328 The following options control the format of the output:
37329
37330 .vlist
37331 .vitem &*-c*&
37332 Display only the count of matching messages.
37333
37334 .vitem &*-l*&
37335 Long format &-- display the full message information as output by Exim. This is
37336 the default.
37337
37338 .vitem &*-i*&
37339 Display message ids only.
37340
37341 .vitem &*-b*&
37342 Brief format &-- one line per message.
37343
37344 .vitem &*-R*&
37345 Display messages in reverse order.
37346
37347 .vitem &*-a*&
37348 Include delivered recipients in queue listing.
37349 .endlist
37350
37351 There is one more option, &%-h%&, which outputs a list of options.
37352
37353
37354
37355 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
37356 .cindex "&'exiqsumm'&"
37357 .cindex "queue" "summary"
37358 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
37359 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
37360 running a command such as
37361 .code
37362 exim -bp | exiqsumm
37363 .endd
37364 The output consists of one line for each domain that has messages waiting for
37365 it, as in the following example:
37366 .code
37367 3   2322   74m   66m  msn.com.example
37368 .endd
37369 Each line lists the number of pending deliveries for a domain, their total
37370 volume, and the length of time that the oldest and the newest messages have
37371 been waiting. Note that the number of pending deliveries is greater than the
37372 number of messages when messages have more than one recipient.
37373
37374 A summary line is output at the end. By default the output is sorted on the
37375 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
37376 the output to be sorted by oldest message and by count of messages,
37377 respectively. There are also three options that split the messages for each
37378 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
37379 separates frozen messages, and &%-s%& separates messages according to their
37380 sender.
37381
37382 The output of &'exim -bp'& contains the original addresses in the message, so
37383 this also applies to the output from &'exiqsumm'&. No domains from addresses
37384 generated by aliasing or forwarding are included (unless the &%one_time%&
37385 option of the &(redirect)& router has been used to convert them into &"top
37386 level"& addresses).
37387
37388
37389
37390
37391 .section "Extracting specific information from the log (exigrep)" &&&
37392          "SECTextspeinf"
37393 .cindex "&'exigrep'&"
37394 .cindex "log" "extracts; grepping for"
37395 The &'exigrep'& utility is a Perl script that searches one or more main log
37396 files for entries that match a given pattern. When it finds a match, it
37397 extracts all the log entries for the relevant message, not just those that
37398 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
37399 given message, or all mail for a given user, or for a given host, for example.
37400 The input files can be in Exim log format or syslog format.
37401 If a matching log line is not associated with a specific message, it is
37402 included in &'exigrep'&'s output without any additional lines. The usage is:
37403 .display
37404 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
37405 .endd
37406 If no log file names are given on the command line, the standard input is read.
37407
37408 The &%-t%& argument specifies a number of seconds. It adds an additional
37409 condition for message selection. Messages that are complete are shown only if
37410 they spent more than <&'n'&> seconds on the queue.
37411
37412 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
37413 makes it case-sensitive. This may give a performance improvement when searching
37414 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
37415 option; with &%-I%& they do not. In both cases it is possible to change the
37416 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
37417
37418 The &%-l%& option means &"literal"&, that is, treat all characters in the
37419 pattern as standing for themselves. Otherwise the pattern must be a Perl
37420 regular expression.
37421
37422 The &%-v%& option inverts the matching condition. That is, a line is selected
37423 if it does &'not'& match the pattern.
37424
37425 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
37426 that are generated as a result/response to a message that &'exigrep'& matched
37427 normally.
37428
37429 Example of &%-M%&:
37430 user_a sends a message to user_b, which generates a bounce back to user_b. If
37431 &'exigrep'& is used to search for &"user_a"&, only the first message will be
37432 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
37433 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
37434 when searching for &"user_a"& will show both messages since the bounce is
37435 &"related"& to or a &"result"& of the first message that was found by the
37436 search term.
37437
37438 If the location of a &'zcat'& command is known from the definition of
37439 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
37440 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
37441 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
37442 autodetection of some well known compression extensions.
37443
37444
37445 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
37446 .cindex "&'exipick'&"
37447 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
37448 lists messages from the queue according to a variety of criteria. For details
37449 of &'exipick'&'s facilities, run &'exipick'& with
37450 the &%--help%& option.
37451
37452
37453 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
37454 .cindex "log" "cycling local files"
37455 .cindex "cycling logs"
37456 .cindex "&'exicyclog'&"
37457 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
37458 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
37459 you are using log files with datestamps in their names (see section
37460 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
37461 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
37462 There are two command line options for &'exicyclog'&:
37463 .ilist
37464 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
37465 default that is set when Exim is built. The default default is 10.
37466 .next
37467 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
37468 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
37469 overriding the script's default, which is to find the setting from Exim's
37470 configuration.
37471 .endlist
37472
37473 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
37474 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
37475 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
37476 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
37477 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
37478 logs are handled similarly.
37479
37480 If the limit is greater than 99, the script uses 3-digit numbers such as
37481 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
37482 to one that is greater, or &'vice versa'&, you will have to fix the names of
37483 any existing log files.
37484
37485 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
37486 the end are deleted. All files with numbers greater than 01 are compressed,
37487 using a compression command which is configured by the COMPRESS_COMMAND
37488 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
37489 root &%crontab%& entry of the form
37490 .code
37491 1 0 * * * su exim -c /usr/exim/bin/exicyclog
37492 .endd
37493 assuming you have used the name &"exim"& for the Exim user. You can run
37494 &'exicyclog'& as root if you wish, but there is no need.
37495
37496
37497
37498 .section "Mail statistics (eximstats)" "SECTmailstat"
37499 .cindex "statistics"
37500 .cindex "&'eximstats'&"
37501 A Perl script called &'eximstats'& is provided for extracting statistical
37502 information from log files. The output is either plain text, or HTML.
37503 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
37504 . --- 404 error and everything else points to that.
37505
37506 The &'eximstats'& script has been hacked about quite a bit over time. The
37507 latest version is the result of some extensive revision by Steve Campbell. A
37508 lot of information is given by default, but there are options for suppressing
37509 various parts of it. Following any options, the arguments to the script are a
37510 list of files, which should be main log files. For example:
37511 .code
37512 eximstats -nr /var/spool/exim/log/mainlog.01
37513 .endd
37514 By default, &'eximstats'& extracts information about the number and volume of
37515 messages received from or delivered to various hosts. The information is sorted
37516 both by message count and by volume, and the top fifty hosts in each category
37517 are listed on the standard output. Similar information, based on email
37518 addresses or domains instead of hosts can be requested by means of various
37519 options. For messages delivered and received locally, similar statistics are
37520 also produced per user.
37521
37522 The output also includes total counts and statistics about delivery errors, and
37523 histograms showing the number of messages received and deliveries made in each
37524 hour of the day. A delivery with more than one address in its envelope (for
37525 example, an SMTP transaction with more than one RCPT command) is counted
37526 as a single delivery by &'eximstats'&.
37527
37528 Though normally more deliveries than receipts are reported (as messages may
37529 have multiple recipients), it is possible for &'eximstats'& to report more
37530 messages received than delivered, even though the queue is empty at the start
37531 and end of the period in question. If an incoming message contains no valid
37532 recipients, no deliveries are recorded for it. A bounce message is handled as
37533 an entirely separate message.
37534
37535 &'eximstats'& always outputs a grand total summary giving the volume and number
37536 of messages received and deliveries made, and the number of hosts involved in
37537 each case. It also outputs the number of messages that were delayed (that is,
37538 not completely delivered at the first attempt), and the number that had at
37539 least one address that failed.
37540
37541 The remainder of the output is in sections that can be independently disabled
37542 or modified by various options. It consists of a summary of deliveries by
37543 transport, histograms of messages received and delivered per time interval
37544 (default per hour), information about the time messages spent on the queue,
37545 a list of relayed messages, lists of the top fifty sending hosts, local
37546 senders, destination hosts, and destination local users by count and by volume,
37547 and a list of delivery errors that occurred.
37548
37549 The relay information lists messages that were actually relayed, that is, they
37550 came from a remote host and were directly delivered to some other remote host,
37551 without being processed (for example, for aliasing or forwarding) locally.
37552
37553 There are quite a few options for &'eximstats'& to control exactly what it
37554 outputs. These are documented in the Perl script itself, and can be extracted
37555 by running the command &(perldoc)& on the script. For example:
37556 .code
37557 perldoc /usr/exim/bin/eximstats
37558 .endd
37559
37560 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
37561 .cindex "&'exim_checkaccess'&"
37562 .cindex "policy control" "checking access"
37563 .cindex "checking access"
37564 The &%-bh%& command line argument allows you to run a fake SMTP session with
37565 debugging output, in order to check what Exim is doing when it is applying
37566 policy controls to incoming SMTP mail. However, not everybody is sufficiently
37567 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
37568 sometimes you just want to answer the question &"Does this address have
37569 access?"& without bothering with any further details.
37570
37571 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
37572 two arguments, an IP address and an email address:
37573 .code
37574 exim_checkaccess 10.9.8.7 A.User@a.domain.example
37575 .endd
37576 The utility runs a call to Exim with the &%-bh%& option, to test whether the
37577 given email address would be accepted in a RCPT command in a TCP/IP
37578 connection from the host with the given IP address. The output of the utility
37579 is either the word &"accepted"&, or the SMTP error response, for example:
37580 .code
37581 Rejected:
37582 550 Relay not permitted
37583 .endd
37584 When running this test, the utility uses &`<>`& as the envelope sender address
37585 for the MAIL command, but you can change this by providing additional
37586 options. These are passed directly to the Exim command. For example, to specify
37587 that the test is to be run with the sender address &'himself@there.example'&
37588 you can use:
37589 .code
37590 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
37591                  -f himself@there.example
37592 .endd
37593 Note that these additional Exim command line items must be given after the two
37594 mandatory arguments.
37595
37596 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
37597 while running its checks. You can run checks that include callouts by using
37598 &%-bhc%&, but this is not yet available in a &"packaged"& form.
37599
37600
37601
37602 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
37603 .cindex "DBM" "building dbm files"
37604 .cindex "building DBM files"
37605 .cindex "&'exim_dbmbuild'&"
37606 .cindex "lower casing"
37607 .cindex "binary zero" "in lookup key"
37608 The &'exim_dbmbuild'& program reads an input file containing keys and data in
37609 the format used by the &(lsearch)& lookup (see section
37610 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
37611 names as keys and the remainder of the information as data. The lower-casing
37612 can be prevented by calling the program with the &%-nolc%& option.
37613
37614 A terminating zero is included as part of the key string. This is expected by
37615 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
37616 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
37617 strings or the data strings. The &(dbmnz)& lookup type can be used with such
37618 files.
37619
37620 The program requires two arguments: the name of the input file (which can be a
37621 single hyphen to indicate the standard input), and the name of the output file.
37622 It creates the output under a temporary name, and then renames it if all went
37623 well.
37624
37625 .cindex "USE_DB"
37626 If the native DB interface is in use (USE_DB is set in a compile-time
37627 configuration file &-- this is common in free versions of Unix) the two file
37628 names must be different, because in this mode the Berkeley DB functions create
37629 a single output file using exactly the name given. For example,
37630 .code
37631 exim_dbmbuild /etc/aliases /etc/aliases.db
37632 .endd
37633 reads the system alias file and creates a DBM version of it in
37634 &_/etc/aliases.db_&.
37635
37636 In systems that use the &'ndbm'& routines (mostly proprietary versions of
37637 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
37638 environment, the suffixes are added to the second argument of
37639 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
37640 when the Berkeley functions are used in compatibility mode (though this is not
37641 recommended), because in that case it adds a &_.db_& suffix to the file name.
37642
37643 If a duplicate key is encountered, the program outputs a warning, and when it
37644 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
37645 option is used. By default, only the first of a set of duplicates is used &--
37646 this makes it compatible with &(lsearch)& lookups. There is an option
37647 &%-lastdup%& which causes it to use the data for the last duplicate instead.
37648 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
37649 &%stderr%&. For other errors, where it doesn't actually make a new file, the
37650 return code is 2.
37651
37652
37653
37654
37655 .section "Finding individual retry times (exinext)" "SECTfinindret"
37656 .cindex "retry" "times"
37657 .cindex "&'exinext'&"
37658 A utility called &'exinext'& (mostly a Perl script) provides the ability to
37659 fish specific information out of the retry database. Given a mail domain (or a
37660 complete address), it looks up the hosts for that domain, and outputs any retry
37661 information for the hosts or for the domain. At present, the retry information
37662 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
37663 output. For example:
37664 .code
37665 $ exinext piglet@milne.fict.example
37666 kanga.milne.example:192.168.8.1 error 146: Connection refused
37667   first failed: 21-Feb-1996 14:57:34
37668   last tried:   21-Feb-1996 14:57:34
37669   next try at:  21-Feb-1996 15:02:34
37670 roo.milne.example:192.168.8.3 error 146: Connection refused
37671   first failed: 20-Jan-1996 13:12:08
37672   last tried:   21-Feb-1996 11:42:03
37673   next try at:  21-Feb-1996 19:42:03
37674   past final cutoff time
37675 .endd
37676 You can also give &'exinext'& a local part, without a domain, and it
37677 will give any retry information for that local part in your default domain.
37678 A message id can be used to obtain retry information pertaining to a specific
37679 message. This exists only when an attempt to deliver a message to a remote host
37680 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
37681 &'exinext'& is not particularly efficient, but then it is not expected to be
37682 run very often.
37683
37684 The &'exinext'& utility calls Exim to find out information such as the location
37685 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
37686 passed on to the &'exim'& commands. The first specifies an alternate Exim
37687 configuration file, and the second sets macros for use within the configuration
37688 file. These features are mainly to help in testing, but might also be useful in
37689 environments where more than one configuration file is in use.
37690
37691
37692
37693 .section "Hints database maintenance" "SECThindatmai"
37694 .cindex "hints database" "maintenance"
37695 .cindex "maintaining Exim's hints database"
37696 Three utility programs are provided for maintaining the DBM files that Exim
37697 uses to contain its delivery hint information. Each program requires two
37698 arguments. The first specifies the name of Exim's spool directory, and the
37699 second is the name of the database it is to operate on. These are as follows:
37700
37701 .ilist
37702 &'retry'&: the database of retry information
37703 .next
37704 &'wait-'&<&'transport name'&>: databases of information about messages waiting
37705 for remote hosts
37706 .next
37707 &'callout'&: the callout cache
37708 .next
37709 &'ratelimit'&: the data for implementing the ratelimit ACL condition
37710 .next
37711 &'misc'&: other hints data
37712 .endlist
37713
37714 The &'misc'& database is used for
37715
37716 .ilist
37717 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
37718 .next
37719 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
37720 &(smtp)& transport)
37721 .next
37722 Limiting the concurrency of specific transports (when &%max_parallel%& is set
37723 in a transport)
37724 .endlist
37725
37726
37727
37728 .section "exim_dumpdb" "SECID261"
37729 .cindex "&'exim_dumpdb'&"
37730 The entire contents of a database are written to the standard output by the
37731 &'exim_dumpdb'& program, which has no options or arguments other than the
37732 spool and database names. For example, to dump the retry database:
37733 .code
37734 exim_dumpdb /var/spool/exim retry
37735 .endd
37736 Two lines of output are produced for each entry:
37737 .code
37738 T:mail.ref.example:192.168.242.242 146 77 Connection refused
37739 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
37740 .endd
37741 The first item on the first line is the key of the record. It starts with one
37742 of the letters R, or T, depending on whether it refers to a routing or
37743 transport retry. For a local delivery, the next part is the local address; for
37744 a remote delivery it is the name of the remote host, followed by its failing IP
37745 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
37746 transport). If the remote port is not the standard one (port 25), it is added
37747 to the IP address. Then there follows an error code, an additional error code,
37748 and a textual description of the error.
37749
37750 The three times on the second line are the time of first failure, the time of
37751 the last delivery attempt, and the computed time for the next attempt. The line
37752 ends with an asterisk if the cutoff time for the last retry rule has been
37753 exceeded.
37754
37755 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
37756 consists of a host name followed by a list of ids for messages that are or were
37757 waiting to be delivered to that host. If there are a very large number for any
37758 one host, continuation records, with a sequence number added to the host name,
37759 may be seen. The data in these records is often out of date, because a message
37760 may be routed to several alternative hosts, and Exim makes no effort to keep
37761 cross-references.
37762
37763
37764
37765 .section "exim_tidydb" "SECID262"
37766 .cindex "&'exim_tidydb'&"
37767 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
37768 database. If run with no options, it removes all records that are more than 30
37769 days old. The age is calculated from the date and time that the record was last
37770 updated. Note that, in the case of the retry database, it is &'not'& the time
37771 since the first delivery failure. Information about a host that has been down
37772 for more than 30 days will remain in the database, provided that the record is
37773 updated sufficiently often.
37774
37775 The cutoff date can be altered by means of the &%-t%& option, which must be
37776 followed by a time. For example, to remove all records older than a week from
37777 the retry database:
37778 .code
37779 exim_tidydb -t 7d /var/spool/exim retry
37780 .endd
37781 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
37782 message ids. In the former these appear as data in records keyed by host &--
37783 they were messages that were waiting for that host &-- and in the latter they
37784 are the keys for retry information for messages that have suffered certain
37785 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
37786 message ids in database records are those of messages that are still on the
37787 queue. Message ids for messages that no longer exist are removed from
37788 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
37789 For the &'retry'& database, records whose keys are non-existent message ids are
37790 removed. The &'exim_tidydb'& utility outputs comments on the standard output
37791 whenever it removes information from the database.
37792
37793 Certain records are automatically removed by Exim when they are no longer
37794 needed, but others are not. For example, if all the MX hosts for a domain are
37795 down, a retry record is created for each one. If the primary MX host comes back
37796 first, its record is removed when Exim successfully delivers to it, but the
37797 records for the others remain because Exim has not tried to use those hosts.
37798
37799 It is important, therefore, to run &'exim_tidydb'& periodically on all the
37800 hints databases. You should do this at a quiet time of day, because it requires
37801 a database to be locked (and therefore inaccessible to Exim) while it does its
37802 work. Removing records from a DBM file does not normally make the file smaller,
37803 but all the common DBM libraries are able to re-use the space that is released.
37804 After an initial phase of increasing in size, the databases normally reach a
37805 point at which they no longer get any bigger, as long as they are regularly
37806 tidied.
37807
37808 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
37809 databases is likely to keep on increasing.
37810
37811
37812
37813
37814 .section "exim_fixdb" "SECID263"
37815 .cindex "&'exim_fixdb'&"
37816 The &'exim_fixdb'& program is a utility for interactively modifying databases.
37817 Its main use is for testing Exim, but it might also be occasionally useful for
37818 getting round problems in a live system. It has no options, and its interface
37819 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
37820 key of a database record can then be entered, and the data for that record is
37821 displayed.
37822
37823 If &"d"& is typed at the next prompt, the entire record is deleted. For all
37824 except the &'retry'& database, that is the only operation that can be carried
37825 out. For the &'retry'& database, each field is output preceded by a number, and
37826 data for individual fields can be changed by typing the field number followed
37827 by new data, for example:
37828 .code
37829 > 4 951102:1000
37830 .endd
37831 resets the time of the next delivery attempt. Time values are given as a
37832 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
37833 used as optional separators.
37834
37835
37836
37837
37838 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
37839 .cindex "mailbox" "maintenance"
37840 .cindex "&'exim_lock'&"
37841 .cindex "locking mailboxes"
37842 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
37843 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
37844 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
37845 a user agent while investigating a problem. The utility requires the name of
37846 the file as its first argument. If the locking is successful, the second
37847 argument is run as a command (using C's &[system()]& function); if there is no
37848 second argument, the value of the SHELL environment variable is used; if this
37849 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
37850 is unlocked and the utility ends. The following options are available:
37851
37852 .vlist
37853 .vitem &%-fcntl%&
37854 Use &[fcntl()]& locking on the open mailbox.
37855
37856 .vitem &%-flock%&
37857 Use &[flock()]& locking on the open mailbox, provided the operating system
37858 supports it.
37859
37860 .vitem &%-interval%&
37861 This must be followed by a number, which is a number of seconds; it sets the
37862 interval to sleep between retries (default 3).
37863
37864 .vitem &%-lockfile%&
37865 Create a lock file before opening the mailbox.
37866
37867 .vitem &%-mbx%&
37868 Lock the mailbox using MBX rules.
37869
37870 .vitem &%-q%&
37871 Suppress verification output.
37872
37873 .vitem &%-retries%&
37874 This must be followed by a number; it sets the number of times to try to get
37875 the lock (default 10).
37876
37877 .vitem &%-restore_time%&
37878 This option causes &%exim_lock%& to restore the modified and read times to the
37879 locked file before exiting. This allows you to access a locked mailbox (for
37880 example, to take a backup copy) without disturbing the times that the user
37881 subsequently sees.
37882
37883 .vitem &%-timeout%&
37884 This must be followed by a number, which is a number of seconds; it sets a
37885 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
37886 default), a non-blocking call is used.
37887
37888 .vitem &%-v%&
37889 Generate verbose output.
37890 .endlist
37891
37892 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
37893 default is to create a lock file and also to use &[fcntl()]& locking on the
37894 mailbox, which is the same as Exim's default. The use of &%-flock%& or
37895 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
37896 requires that the directory containing the file be writeable. Locking by lock
37897 file does not last for ever; Exim assumes that a lock file is expired if it is
37898 more than 30 minutes old.
37899
37900 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
37901 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
37902 to be taken out on the open mailbox, and an exclusive lock on the file
37903 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
37904 number of the mailbox file. When the locking is released, if an exclusive lock
37905 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
37906
37907 The default output contains verification of the locking that takes place. The
37908 &%-v%& option causes some additional information to be given. The &%-q%& option
37909 suppresses all output except error messages.
37910
37911 A command such as
37912 .code
37913 exim_lock /var/spool/mail/spqr
37914 .endd
37915 runs an interactive shell while the file is locked, whereas
37916 .display
37917 &`exim_lock -q /var/spool/mail/spqr <<End`&
37918 <&'some commands'&>
37919 &`End`&
37920 .endd
37921 runs a specific non-interactive sequence of commands while the file is locked,
37922 suppressing all verification output. A single command can be run by a command
37923 such as
37924 .code
37925 exim_lock -q /var/spool/mail/spqr \
37926   "cp /var/spool/mail/spqr /some/where"
37927 .endd
37928 Note that if a command is supplied, it must be entirely contained within the
37929 second argument &-- hence the quotes.
37930 .ecindex IIDutils
37931
37932
37933 . ////////////////////////////////////////////////////////////////////////////
37934 . ////////////////////////////////////////////////////////////////////////////
37935
37936 .chapter "The Exim monitor" "CHAPeximon"
37937 .scindex IIDeximon "Exim monitor" "description"
37938 .cindex "X-windows"
37939 .cindex "&'eximon'&"
37940 .cindex "Local/eximon.conf"
37941 .cindex "&_exim_monitor/EDITME_&"
37942 The Exim monitor is an application which displays in an X window information
37943 about the state of Exim's queue and what Exim is doing. An admin user can
37944 perform certain operations on messages from this GUI interface; however all
37945 such facilities are also available from the command line, and indeed, the
37946 monitor itself makes use of the command line to perform any actions requested.
37947
37948
37949
37950 .section "Running the monitor" "SECID264"
37951 The monitor is started by running the script called &'eximon'&. This is a shell
37952 script that sets up a number of environment variables, and then runs the
37953 binary called &_eximon.bin_&. The default appearance of the monitor window can
37954 be changed by editing the &_Local/eximon.conf_& file created by editing
37955 &_exim_monitor/EDITME_&. Comments in that file describe what the various
37956 parameters are for.
37957
37958 The parameters that get built into the &'eximon'& script can be overridden for
37959 a particular invocation by setting up environment variables of the same names,
37960 preceded by &`EXIMON_`&. For example, a shell command such as
37961 .code
37962 EXIMON_LOG_DEPTH=400 eximon
37963 .endd
37964 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
37965 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
37966 overrides the Exim log file configuration. This makes it possible to have
37967 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
37968 syslog messages are routed to a file on the local host.
37969
37970 X resources can be used to change the appearance of the window in the normal
37971 way. For example, a resource setting of the form
37972 .code
37973 Eximon*background: gray94
37974 .endd
37975 changes the colour of the background to light grey rather than white. The
37976 stripcharts are drawn with both the data lines and the reference lines in
37977 black. This means that the reference lines are not visible when on top of the
37978 data. However, their colour can be changed by setting a resource called
37979 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
37980 For example, if your X server is running Unix, you could set up lighter
37981 reference lines in the stripcharts by obeying
37982 .code
37983 xrdb -merge <<End
37984 Eximon*highlight: gray
37985 End
37986 .endd
37987 .cindex "admin user"
37988 In order to see the contents of messages on the queue, and to operate on them,
37989 &'eximon'& must either be run as root or by an admin user.
37990
37991 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
37992 contain X11 resource parameters interpreted by the X11 library.  In addition,
37993 if the first parameter starts with the string "gdb" then it is removed and the
37994 binary is invoked under gdb (the parameter is used as the gdb command-name, so
37995 versioned variants of gdb can be invoked).
37996
37997 The monitor's window is divided into three parts. The first contains one or
37998 more stripcharts and two action buttons, the second contains a &"tail"& of the
37999 main log file, and the third is a display of the queue of messages awaiting
38000 delivery, with two more action buttons. The following sections describe these
38001 different parts of the display.
38002
38003
38004
38005
38006 .section "The stripcharts" "SECID265"
38007 .cindex "stripchart"
38008 The first stripchart is always a count of messages on the queue. Its name can
38009 be configured by setting QUEUE_STRIPCHART_NAME in the
38010 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
38011 configuration script by regular expression matches on log file entries, making
38012 it possible to display, for example, counts of messages delivered to certain
38013 hosts or using certain transports. The supplied defaults display counts of
38014 received and delivered messages, and of local and SMTP deliveries. The default
38015 period between stripchart updates is one minute; this can be adjusted by a
38016 parameter in the &_Local/eximon.conf_& file.
38017
38018 The stripchart displays rescale themselves automatically as the value they are
38019 displaying changes. There are always 10 horizontal lines in each chart; the
38020 title string indicates the value of each division when it is greater than one.
38021 For example, &"x2"& means that each division represents a value of 2.
38022
38023 It is also possible to have a stripchart which shows the percentage fullness of
38024 a particular disk partition, which is useful when local deliveries are confined
38025 to a single partition.
38026
38027 .cindex "&%statvfs%& function"
38028 This relies on the availability of the &[statvfs()]& function or equivalent in
38029 the operating system. Most, but not all versions of Unix that support Exim have
38030 this. For this particular stripchart, the top of the chart always represents
38031 100%, and the scale is given as &"x10%"&. This chart is configured by setting
38032 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
38033 &_Local/eximon.conf_& file.
38034
38035
38036
38037
38038 .section "Main action buttons" "SECID266"
38039 .cindex "size" "of monitor window"
38040 .cindex "Exim monitor" "window size"
38041 .cindex "window size"
38042 Below the stripcharts there is an action button for quitting the monitor. Next
38043 to this is another button marked &"Size"&. They are placed here so that
38044 shrinking the window to its default minimum size leaves just the queue count
38045 stripchart and these two buttons visible. Pressing the &"Size"& button causes
38046 the window to expand to its maximum size, unless it is already at the maximum,
38047 in which case it is reduced to its minimum.
38048
38049 When expanding to the maximum, if the window cannot be fully seen where it
38050 currently is, it is moved back to where it was the last time it was at full
38051 size. When it is expanding from its minimum size, the old position is
38052 remembered, and next time it is reduced to the minimum it is moved back there.
38053
38054 The idea is that you can keep a reduced window just showing one or two
38055 stripcharts at a convenient place on your screen, easily expand it to show
38056 the full window when required, and just as easily put it back to what it was.
38057 The idea is copied from what the &'twm'& window manager does for its
38058 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
38059 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
38060
38061 Normally, the monitor starts up with the window at its full size, but it can be
38062 built so that it starts up with the window at its smallest size, by setting
38063 START_SMALL=yes in &_Local/eximon.conf_&.
38064
38065
38066
38067 .section "The log display" "SECID267"
38068 .cindex "log" "tail of; in monitor"
38069 The second section of the window is an area in which a display of the tail of
38070 the main log is maintained.
38071 To save space on the screen, the timestamp on each log line is shortened by
38072 removing the date and, if &%log_timezone%& is set, the timezone.
38073 The log tail is not available when the only destination for logging data is
38074 syslog, unless the syslog lines are routed to a local file whose name is passed
38075 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
38076
38077 The log sub-window has a scroll bar at its lefthand side which can be used to
38078 move back to look at earlier text, and the up and down arrow keys also have a
38079 scrolling effect. The amount of log that is kept depends on the setting of
38080 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
38081 to use. When this is full, the earlier 50% of data is discarded &-- this is
38082 much more efficient than throwing it away line by line. The sub-window also has
38083 a horizontal scroll bar for accessing the ends of long log lines. This is the
38084 only means of horizontal scrolling; the right and left arrow keys are not
38085 available. Text can be cut from this part of the window using the mouse in the
38086 normal way. The size of this subwindow is controlled by parameters in the
38087 configuration file &_Local/eximon.conf_&.
38088
38089 Searches of the text in the log window can be carried out by means of the ^R
38090 and ^S keystrokes, which default to a reverse and a forward search,
38091 respectively. The search covers only the text that is displayed in the window.
38092 It cannot go further back up the log.
38093
38094 The point from which the search starts is indicated by a caret marker. This is
38095 normally at the end of the text in the window, but can be positioned explicitly
38096 by pointing and clicking with the left mouse button, and is moved automatically
38097 by a successful search. If new text arrives in the window when it is scrolled
38098 back, the caret remains where it is, but if the window is not scrolled back,
38099 the caret is moved to the end of the new text.
38100
38101 Pressing ^R or ^S pops up a window into which the search text can be typed.
38102 There are buttons for selecting forward or reverse searching, for carrying out
38103 the search, and for cancelling. If the &"Search"& button is pressed, the search
38104 happens and the window remains so that further searches can be done. If the
38105 &"Return"& key is pressed, a single search is done and the window is closed. If
38106 ^C is typed the search is cancelled.
38107
38108 The searching facility is implemented using the facilities of the Athena text
38109 widget. By default this pops up a window containing both &"search"& and
38110 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
38111 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
38112 However, the linkers in BSDI and HP-UX seem unable to handle an externally
38113 provided version of &%TextPop%& when the remaining parts of the text widget
38114 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
38115 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
38116 on these systems, at the expense of having unwanted items in the search popup
38117 window.
38118
38119
38120
38121 .section "The queue display" "SECID268"
38122 .cindex "queue" "display in monitor"
38123 The bottom section of the monitor window contains a list of all messages that
38124 are on the queue, which includes those currently being received or delivered,
38125 as well as those awaiting delivery. The size of this subwindow is controlled by
38126 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
38127 at which it is updated is controlled by another parameter in the same file &--
38128 the default is 5 minutes, since queue scans can be quite expensive. However,
38129 there is an &"Update"& action button just above the display which can be used
38130 to force an update of the queue display at any time.
38131
38132 When a host is down for some time, a lot of pending mail can build up for it,
38133 and this can make it hard to deal with other messages on the queue. To help
38134 with this situation there is a button next to &"Update"& called &"Hide"&. If
38135 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
38136 type anything in here and press &"Return"&, the text is added to a chain of
38137 such texts, and if every undelivered address in a message matches at least one
38138 of the texts, the message is not displayed.
38139
38140 If there is an address that does not match any of the texts, all the addresses
38141 are displayed as normal. The matching happens on the ends of addresses so, for
38142 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
38143 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
38144 has been set up, a button called &"Unhide"& is displayed. If pressed, it
38145 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
38146 a hide request is automatically cancelled after one hour.
38147
38148 While the dialogue box is displayed, you can't press any buttons or do anything
38149 else to the monitor window. For this reason, if you want to cut text from the
38150 queue display to use in the dialogue box, you have to do the cutting before
38151 pressing the &"Hide"& button.
38152
38153 The queue display contains, for each unhidden queued message, the length of
38154 time it has been on the queue, the size of the message, the message id, the
38155 message sender, and the first undelivered recipient, all on one line. If it is
38156 a bounce message, the sender is shown as &"<>"&. If there is more than one
38157 recipient to which the message has not yet been delivered, subsequent ones are
38158 listed on additional lines, up to a maximum configured number, following which
38159 an ellipsis is displayed. Recipients that have already received the message are
38160 not shown.
38161
38162 .cindex "frozen messages" "display"
38163 If a message is frozen, an asterisk is displayed at the left-hand side.
38164
38165 The queue display has a vertical scroll bar, and can also be scrolled by means
38166 of the arrow keys. Text can be cut from it using the mouse in the normal way.
38167 The text searching facilities, as described above for the log window, are also
38168 available, but the caret is always moved to the end of the text when the queue
38169 display is updated.
38170
38171
38172
38173 .section "The queue menu" "SECID269"
38174 .cindex "queue" "menu in monitor"
38175 If the &%shift%& key is held down and the left button is clicked when the mouse
38176 pointer is over the text for any message, an action menu pops up, and the first
38177 line of the queue display for the message is highlighted. This does not affect
38178 any selected text.
38179
38180 If you want to use some other event for popping up the menu, you can set the
38181 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
38182 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
38183 value set in this parameter is a standard X event description. For example, to
38184 run eximon using &%ctrl%& rather than &%shift%& you could use
38185 .code
38186 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
38187 .endd
38188 The title of the menu is the message id, and it contains entries which act as
38189 follows:
38190
38191 .ilist
38192 &'message log'&: The contents of the message log for the message are displayed
38193 in a new text window.
38194 .next
38195 &'headers'&: Information from the spool file that contains the envelope
38196 information and headers is displayed in a new text window. See chapter
38197 &<<CHAPspool>>& for a description of the format of spool files.
38198 .next
38199 &'body'&: The contents of the spool file containing the body of the message are
38200 displayed in a new text window. There is a default limit of 20,000 bytes to the
38201 amount of data displayed. This can be changed by setting the BODY_MAX
38202 option at compile time, or the EXIMON_BODY_MAX option at run time.
38203 .next
38204 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
38205 delivery of the message. This causes an automatic thaw if the message is
38206 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
38207 a new text window. The delivery is run in a separate process, to avoid holding
38208 up the monitor while the delivery proceeds.
38209 .next
38210 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
38211 that the message be frozen.
38212 .next
38213 .cindex "thawing messages"
38214 .cindex "unfreezing messages"
38215 .cindex "frozen messages" "thawing"
38216 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
38217 that the message be thawed.
38218 .next
38219 .cindex "delivery" "forcing failure"
38220 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
38221 that Exim gives up trying to deliver the message. A bounce message is generated
38222 for any remaining undelivered addresses.
38223 .next
38224 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
38225 that the message be deleted from the system without generating a bounce
38226 message.
38227 .next
38228 &'add recipient'&: A dialog box is displayed into which a recipient address can
38229 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38230 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38231 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38232 causes a call to Exim to be made using the &%-Mar%& option to request that an
38233 additional recipient be added to the message, unless the entry box is empty, in
38234 which case no action is taken.
38235 .next
38236 &'mark delivered'&: A dialog box is displayed into which a recipient address
38237 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38238 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38239 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38240 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
38241 recipient address as already delivered, unless the entry box is empty, in which
38242 case no action is taken.
38243 .next
38244 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
38245 mark all recipient addresses as already delivered.
38246 .next
38247 &'edit sender'&: A dialog box is displayed initialized with the current
38248 sender's address. Pressing RETURN causes a call to Exim to be made using the
38249 &%-Mes%& option to replace the sender address, unless the entry box is empty,
38250 in which case no action is taken. If you want to set an empty sender (as in
38251 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
38252 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
38253 the address is qualified with that domain.
38254 .endlist
38255
38256 When a delivery is forced, a window showing the &%-v%& output is displayed. In
38257 other cases when a call to Exim is made, if there is any output from Exim (in
38258 particular, if the command fails) a window containing the command and the
38259 output is displayed. Otherwise, the results of the action are normally apparent
38260 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
38261 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
38262 if no output is generated.
38263
38264 The queue display is automatically updated for actions such as freezing and
38265 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
38266 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
38267 force an update of the display after one of these actions.
38268
38269 In any text window that is displayed as result of a menu action, the normal
38270 cut-and-paste facility is available, and searching can be carried out using ^R
38271 and ^S, as described above for the log tail window.
38272 .ecindex IIDeximon
38273
38274
38275
38276
38277
38278 . ////////////////////////////////////////////////////////////////////////////
38279 . ////////////////////////////////////////////////////////////////////////////
38280
38281 .chapter "Security considerations" "CHAPsecurity"
38282 .scindex IIDsecurcon "security" "discussion of"
38283 This chapter discusses a number of issues concerned with security, some of
38284 which are also covered in other parts of this manual.
38285
38286 For reasons that this author does not understand, some people have promoted
38287 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
38288 existence of this chapter in the documentation. However, the intent of the
38289 chapter is simply to describe the way Exim works in relation to certain
38290 security concerns, not to make any specific claims about the effectiveness of
38291 its security as compared with other MTAs.
38292
38293 What follows is a description of the way Exim is supposed to be. Best efforts
38294 have been made to try to ensure that the code agrees with the theory, but an
38295 absence of bugs can never be guaranteed. Any that are reported will get fixed
38296 as soon as possible.
38297
38298
38299 .section "Building a more &""hardened""& Exim" "SECID286"
38300 .cindex "security" "build-time features"
38301 There are a number of build-time options that can be set in &_Local/Makefile_&
38302 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
38303 Exim administrator who does not have the root password, or by someone who has
38304 penetrated the Exim (but not the root) account. These options are as follows:
38305
38306 .ilist
38307 ALT_CONFIG_PREFIX can be set to a string that is required to match the
38308 start of any file names used with the &%-C%& option. When it is set, these file
38309 names are also not allowed to contain the sequence &"/../"&. (However, if the
38310 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
38311 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
38312 default setting for &%ALT_CONFIG_PREFIX%&.
38313
38314 If the permitted configuration files are confined to a directory to
38315 which only root has access, this guards against someone who has broken
38316 into the Exim account from running a privileged Exim with an arbitrary
38317 configuration file, and using it to break into other accounts.
38318 .next
38319
38320 If a non-trusted configuration file (i.e. not the default configuration file
38321 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
38322 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
38323 the next item), then root privilege is retained only if the caller of Exim is
38324 root. This locks out the possibility of testing a configuration using &%-C%&
38325 right through message reception and delivery, even if the caller is root. The
38326 reception works, but by that time, Exim is running as the Exim user, so when
38327 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
38328 privilege to be lost. However, root can test reception and delivery using two
38329 separate commands.
38330
38331 .next
38332 The WHITELIST_D_MACROS build option declares some macros to be safe to override
38333 with &%-D%& if the real uid is one of root, the Exim run-time user or the
38334 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
38335 requiring the run-time value supplied to &%-D%& to match a regex that errs on
38336 the restrictive side.  Requiring build-time selection of safe macros is onerous
38337 but this option is intended solely as a transition mechanism to permit
38338 previously-working configurations to continue to work after release 4.73.
38339 .next
38340 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
38341 is disabled.
38342 .next
38343 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
38344 never to be used for any deliveries. This is like the &%never_users%& runtime
38345 option, but it cannot be overridden; the runtime option adds additional users
38346 to the list. The default setting is &"root"&; this prevents a non-root user who
38347 is permitted to modify the runtime file from using Exim as a way to get root.
38348 .endlist
38349
38350
38351
38352 .section "Root privilege" "SECID270"
38353 .cindex "setuid"
38354 .cindex "root privilege"
38355 The Exim binary is normally setuid to root, which means that it gains root
38356 privilege (runs as root) when it starts execution. In some special cases (for
38357 example, when the daemon is not in use and there are no local deliveries), it
38358 may be possible to run Exim setuid to some user other than root. This is
38359 discussed in the next section. However, in most installations, root privilege
38360 is required for two things:
38361
38362 .ilist
38363 To set up a socket connected to the standard SMTP port (25) when initialising
38364 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
38365 not required.
38366 .next
38367 To be able to change uid and gid in order to read users' &_.forward_& files and
38368 perform local deliveries as the receiving user or as specified in the
38369 configuration.
38370 .endlist
38371
38372 It is not necessary to be root to do any of the other things Exim does, such as
38373 receiving messages and delivering them externally over SMTP, and it is
38374 obviously more secure if Exim does not run as root except when necessary.
38375 For this reason, a user and group for Exim to use must be defined in
38376 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
38377 group"&. Their values can be changed by the run time configuration, though this
38378 is not recommended. Often a user called &'exim'& is used, but some sites use
38379 &'mail'& or another user name altogether.
38380
38381 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
38382 abdication; the process cannot regain root afterwards. Prior to release 4.00,
38383 &[seteuid()]& was used in some circumstances, but this is no longer the case.
38384
38385 After a new Exim process has interpreted its command line options, it changes
38386 uid and gid in the following cases:
38387
38388 .ilist
38389 .oindex "&%-C%&"
38390 .oindex "&%-D%&"
38391 If the &%-C%& option is used to specify an alternate configuration file, or if
38392 the &%-D%& option is used to define macro values for the configuration, and the
38393 calling process is not running as root, the uid and gid are changed to those of
38394 the calling process.
38395 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
38396 option may not be used at all.
38397 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
38398 can be supplied if the calling process is running as root, the Exim run-time
38399 user or CONFIGURE_OWNER, if defined.
38400 .next
38401 .oindex "&%-be%&"
38402 .oindex "&%-bf%&"
38403 .oindex "&%-bF%&"
38404 If the expansion test option (&%-be%&) or one of the filter testing options
38405 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
38406 calling process.
38407 .next
38408 If the process is not a daemon process or a queue runner process or a delivery
38409 process or a process for testing address routing (started with &%-bt%&), the
38410 uid and gid are changed to the Exim user and group. This means that Exim always
38411 runs under its own uid and gid when receiving messages. This also applies when
38412 testing address verification
38413 .oindex "&%-bv%&"
38414 .oindex "&%-bh%&"
38415 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
38416 option).
38417 .next
38418 For a daemon, queue runner, delivery, or address testing process, the uid
38419 remains as root at this stage, but the gid is changed to the Exim group.
38420 .endlist
38421
38422 The processes that initially retain root privilege behave as follows:
38423
38424 .ilist
38425 A daemon process changes the gid to the Exim group and the uid to the Exim
38426 user after setting up one or more listening sockets. The &[initgroups()]&
38427 function is called, so that if the Exim user is in any additional groups, they
38428 will be used during message reception.
38429 .next
38430 A queue runner process retains root privilege throughout its execution. Its
38431 job is to fork a controlled sequence of delivery processes.
38432 .next
38433 A delivery process retains root privilege throughout most of its execution,
38434 but any actual deliveries (that is, the transports themselves) are run in
38435 subprocesses which always change to a non-root uid and gid. For local
38436 deliveries this is typically the uid and gid of the owner of the mailbox; for
38437 remote deliveries, the Exim uid and gid are used. Once all the delivery
38438 subprocesses have been run, a delivery process changes to the Exim uid and gid
38439 while doing post-delivery tidying up such as updating the retry database and
38440 generating bounce and warning messages.
38441
38442 While the recipient addresses in a message are being routed, the delivery
38443 process runs as root. However, if a user's filter file has to be processed,
38444 this is done in a subprocess that runs under the individual user's uid and
38445 gid. A system filter is run as root unless &%system_filter_user%& is set.
38446 .next
38447 A process that is testing addresses (the &%-bt%& option) runs as root so that
38448 the routing is done in the same environment as a message delivery.
38449 .endlist
38450
38451
38452
38453
38454 .section "Running Exim without privilege" "SECTrunexiwitpri"
38455 .cindex "privilege, running without"
38456 .cindex "unprivileged running"
38457 .cindex "root privilege" "running without"
38458 Some installations like to run Exim in an unprivileged state for more of its
38459 operation, for added security. Support for this mode of operation is provided
38460 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
38461 gid are changed to the Exim user and group at the start of a delivery process
38462 (and also queue runner and address testing processes). This means that address
38463 routing is no longer run as root, and the deliveries themselves cannot change
38464 to any other uid.
38465
38466 .cindex SIGHUP
38467 .cindex "daemon" "restarting"
38468 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
38469 that the daemon can still be started in the usual way, and it can respond
38470 correctly to SIGHUP because the re-invocation regains root privilege.
38471
38472 An alternative approach is to make Exim setuid to the Exim user and also setgid
38473 to the Exim group. If you do this, the daemon must be started from a root
38474 process. (Calling Exim from a root process makes it behave in the way it does
38475 when it is setuid root.) However, the daemon cannot restart itself after a
38476 SIGHUP signal because it cannot regain privilege.
38477
38478 It is still useful to set &%deliver_drop_privilege%& in this case, because it
38479 stops Exim from trying to re-invoke itself to do a delivery after a message has
38480 been received. Such a re-invocation is a waste of resources because it has no
38481 effect.
38482
38483 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
38484 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
38485 to the Exim user seems a clean approach, but there is one complication:
38486
38487 In this style of operation, Exim is running with the real uid and gid set to
38488 those of the calling process, and the effective uid/gid set to Exim's values.
38489 Ideally, any association with the calling process' uid/gid should be dropped,
38490 that is, the real uid/gid should be reset to the effective values so as to
38491 discard any privileges that the caller may have. While some operating systems
38492 have a function that permits this action for a non-root effective uid, quite a
38493 number of them do not. Because of this lack of standardization, Exim does not
38494 address this problem at this time.
38495
38496 For this reason, the recommended approach for &"mostly unprivileged"& running
38497 is to keep the Exim binary setuid to root, and to set
38498 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
38499 be used in the most straightforward way.
38500
38501 If you configure Exim not to run delivery processes as root, there are a
38502 number of restrictions on what you can do:
38503
38504 .ilist
38505 You can deliver only as the Exim user/group. You should  explicitly use the
38506 &%user%& and &%group%& options to override routers or local transports that
38507 normally deliver as the recipient. This makes sure that configurations that
38508 work in this mode function the same way in normal mode. Any implicit or
38509 explicit specification of another user causes an error.
38510 .next
38511 Use of &_.forward_& files is severely restricted, such that it is usually
38512 not worthwhile to include them in the configuration.
38513 .next
38514 Users who wish to use &_.forward_& would have to make their home directory and
38515 the file itself accessible to the Exim user. Pipe and append-to-file entries,
38516 and their equivalents in Exim filters, cannot be used. While they could be
38517 enabled in the Exim user's name, that would be insecure and not very useful.
38518 .next
38519 Unless the local user mailboxes are all owned by the Exim user (possible in
38520 some POP3 or IMAP-only environments):
38521
38522 .olist
38523 They must be owned by the Exim group and be writeable by that group. This
38524 implies you must set &%mode%& in the appendfile configuration, as well as the
38525 mode of the mailbox files themselves.
38526 .next
38527 You must set &%no_check_owner%&, since most or all of the files will not be
38528 owned by the Exim user.
38529 .next
38530 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
38531 on a newly created mailbox when unprivileged. This also implies that new
38532 mailboxes need to be created manually.
38533 .endlist olist
38534 .endlist ilist
38535
38536
38537 These restrictions severely restrict what can be done in local deliveries.
38538 However, there are no restrictions on remote deliveries. If you are running a
38539 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
38540 gives more security at essentially no cost.
38541
38542 If you are using the &%mua_wrapper%& facility (see chapter
38543 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
38544
38545
38546
38547
38548 .section "Delivering to local files" "SECID271"
38549 Full details of the checks applied by &(appendfile)& before it writes to a file
38550 are given in chapter &<<CHAPappendfile>>&.
38551
38552
38553
38554 .section "Running local commands" "SECTsecconslocalcmds"
38555 .cindex "security" "local commands"
38556 .cindex "security" "command injection attacks"
38557 There are a number of ways in which an administrator can configure Exim to run
38558 commands based upon received, untrustworthy, data. Further, in some
38559 configurations a user who can control a &_.forward_& file can also arrange to
38560 run commands. Configuration to check includes, but is not limited to:
38561
38562 .ilist
38563 Use of &%use_shell%& in the pipe transport: various forms of shell command
38564 injection may be possible with this option present. It is dangerous and should
38565 be used only with considerable caution. Consider constraints which whitelist
38566 allowed characters in a variable which is to be used in a pipe transport that
38567 has &%use_shell%& enabled.
38568 .next
38569 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
38570 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
38571 &_.forward_& files in a redirect router. If Exim is running on a central mail
38572 hub to which ordinary users do not have shell access, but home directories are
38573 NFS mounted (for instance) then administrators should review the list of these
38574 forbid options available, and should bear in mind that the options that may
38575 need forbidding can change as new features are added between releases.
38576 .next
38577 The &%${run...}%& expansion item does not use a shell by default, but
38578 administrators can configure use of &_/bin/sh_& as part of the command.
38579 Such invocations should be viewed with prejudicial suspicion.
38580 .next
38581 Administrators who use embedded Perl are advised to explore how Perl's
38582 taint checking might apply to their usage.
38583 .next
38584 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
38585 administrators are well advised to view its use with suspicion, in case (for
38586 instance) it allows a local-part to contain embedded Exim directives.
38587 .next
38588 Use of &%${match_local_part...}%& and friends becomes more dangerous if
38589 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
38590 each can reference arbitrary lists and files, rather than just being a list
38591 of opaque strings.
38592 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
38593 real-world security vulnerabilities caused by its use with untrustworthy data
38594 injected in, for SQL injection attacks.
38595 Consider the use of the &%inlisti%& expansion condition instead.
38596 .endlist
38597
38598
38599
38600
38601 .section "Trust in configuration data" "SECTsecconfdata"
38602 .cindex "security" "data sources"
38603 .cindex "security" "regular expressions"
38604 .cindex "regular expressions" "security"
38605 .cindex "PCRE" "security"
38606 If configuration data for Exim can come from untrustworthy sources, there
38607 are some issues to be aware of:
38608
38609 .ilist
38610 Use of &%${expand...}%& may provide a path for shell injection attacks.
38611 .next
38612 Letting untrusted data provide a regular expression is unwise.
38613 .next
38614 Using &%${match...}%& to apply a fixed regular expression against untrusted
38615 data may result in pathological behaviour within PCRE.  Be aware of what
38616 "backtracking" means and consider options for being more strict with a regular
38617 expression. Avenues to explore include limiting what can match (avoiding &`.`&
38618 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
38619 possessive quantifiers or just not using regular expressions against untrusted
38620 data.
38621 .next
38622 It can be important to correctly use &%${quote:...}%&,
38623 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
38624 items to ensure that data is correctly constructed.
38625 .next
38626 Some lookups might return multiple results, even though normal usage is only
38627 expected to yield one result.
38628 .endlist
38629
38630
38631
38632
38633 .section "IPv4 source routing" "SECID272"
38634 .cindex "source routing" "in IP packets"
38635 .cindex "IP source routing"
38636 Many operating systems suppress IP source-routed packets in the kernel, but
38637 some cannot be made to do this, so Exim does its own check. It logs incoming
38638 IPv4 source-routed TCP calls, and then drops them. Things are all different in
38639 IPv6. No special checking is currently done.
38640
38641
38642
38643 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
38644 Support for these SMTP commands is disabled by default. If required, they can
38645 be enabled by defining suitable ACLs.
38646
38647
38648
38649
38650 .section "Privileged users" "SECID274"
38651 .cindex "trusted users"
38652 .cindex "admin user"
38653 .cindex "privileged user"
38654 .cindex "user" "trusted"
38655 .cindex "user" "admin"
38656 Exim recognizes two sets of users with special privileges. Trusted users are
38657 able to submit new messages to Exim locally, but supply their own sender
38658 addresses and information about a sending host. For other users submitting
38659 local messages, Exim sets up the sender address from the uid, and doesn't
38660 permit a remote host to be specified.
38661
38662 .oindex "&%-f%&"
38663 However, an untrusted user is permitted to use the &%-f%& command line option
38664 in the special form &%-f <>%& to indicate that a delivery failure for the
38665 message should not cause an error report. This affects the message's envelope,
38666 but it does not affect the &'Sender:'& header. Untrusted users may also be
38667 permitted to use specific forms of address with the &%-f%& option by setting
38668 the &%untrusted_set_sender%& option.
38669
38670 Trusted users are used to run processes that receive mail messages from some
38671 other mail domain and pass them on to Exim for delivery either locally, or over
38672 the Internet. Exim trusts a caller that is running as root, as the Exim user,
38673 as any user listed in the &%trusted_users%& configuration option, or under any
38674 group listed in the &%trusted_groups%& option.
38675
38676 Admin users are permitted to do things to the messages on Exim's queue. They
38677 can freeze or thaw messages, cause them to be returned to their senders, remove
38678 them entirely, or modify them in various ways. In addition, admin users can run
38679 the Exim monitor and see all the information it is capable of providing, which
38680 includes the contents of files on the spool.
38681
38682 .oindex "&%-M%&"
38683 .oindex "&%-q%&"
38684 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
38685 delivery of messages on its queue is restricted to admin users. This
38686 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
38687 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
38688 queue is also restricted to admin users. This restriction can be relaxed by
38689 setting &%no_queue_list_requires_admin%&.
38690
38691 Exim recognizes an admin user if the calling process is running as root or as
38692 the Exim user or if any of the groups associated with the calling process is
38693 the Exim group. It is not necessary actually to be running under the Exim
38694 group. However, if admin users who are not root or the Exim user are to access
38695 the contents of files on the spool via the Exim monitor (which runs
38696 unprivileged), Exim must be built to allow group read access to its spool
38697 files.
38698
38699 By default, regular users are trusted to perform basic testing and
38700 introspection commands, as themselves.  This setting can be tightened by
38701 setting the &%commandline_checks_require_admin%& option.
38702 This affects most of the checking options,
38703 such as &%-be%& and anything else &%-b*%&.
38704
38705
38706 .section "Spool files" "SECID275"
38707 .cindex "spool directory" "files"
38708 Exim's spool directory and everything it contains is owned by the Exim user and
38709 set to the Exim group. The mode for spool files is defined in the
38710 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
38711 any user who is a member of the Exim group can access these files.
38712
38713
38714
38715 .section "Use of argv[0]" "SECID276"
38716 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
38717 of specific strings, Exim assumes certain options. For example, calling Exim
38718 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
38719 to calling it with the option &%-bS%&. There are no security implications in
38720 this.
38721
38722
38723
38724 .section "Use of %f formatting" "SECID277"
38725 The only use made of &"%f"& by Exim is in formatting load average values. These
38726 are actually stored in integer variables as 1000 times the load average.
38727 Consequently, their range is limited and so therefore is the length of the
38728 converted output.
38729
38730
38731
38732 .section "Embedded Exim path" "SECID278"
38733 Exim uses its own path name, which is embedded in the code, only when it needs
38734 to re-exec in order to regain root privilege. Therefore, it is not root when it
38735 does so. If some bug allowed the path to get overwritten, it would lead to an
38736 arbitrary program's being run as exim, not as root.
38737
38738
38739
38740 .section "Dynamic module directory" "SECTdynmoddir"
38741 Any dynamically loadable modules must be installed into the directory
38742 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
38743 loading it.
38744
38745
38746 .section "Use of sprintf()" "SECID279"
38747 .cindex "&[sprintf()]&"
38748 A large number of occurrences of &"sprintf"& in the code are actually calls to
38749 &'string_sprintf()'&, a function that returns the result in malloc'd store.
38750 The intermediate formatting is done into a large fixed buffer by a function
38751 that runs through the format string itself, and checks the length of each
38752 conversion before performing it, thus preventing buffer overruns.
38753
38754 The remaining uses of &[sprintf()]& happen in controlled circumstances where
38755 the output buffer is known to be sufficiently long to contain the converted
38756 string.
38757
38758
38759
38760 .section "Use of debug_printf() and log_write()" "SECID280"
38761 Arbitrary strings are passed to both these functions, but they do their
38762 formatting by calling the function &'string_vformat()'&, which runs through
38763 the format string itself, and checks the length of each conversion.
38764
38765
38766
38767 .section "Use of strcat() and strcpy()" "SECID281"
38768 These are used only in cases where the output buffer is known to be large
38769 enough to hold the result.
38770 .ecindex IIDsecurcon
38771
38772
38773
38774
38775 . ////////////////////////////////////////////////////////////////////////////
38776 . ////////////////////////////////////////////////////////////////////////////
38777
38778 .chapter "Format of spool files" "CHAPspool"
38779 .scindex IIDforspo1 "format" "spool files"
38780 .scindex IIDforspo2 "spool directory" "format of files"
38781 .scindex IIDforspo3 "spool files" "format of"
38782 .cindex "spool files" "editing"
38783 A message on Exim's queue consists of two files, whose names are the message id
38784 followed by -D and -H, respectively. The data portion of the message is kept in
38785 the -D file on its own. The message's envelope, status, and headers are all
38786 kept in the -H file, whose format is described in this chapter. Each of these
38787 two files contains the final component of its own name as its first line. This
38788 is insurance against disk crashes where the directory is lost but the files
38789 themselves are recoverable.
38790
38791 .new
38792 The file formats may be changed, or new formats added, at any release.
38793 Spool files are not intended as an interface to other programs
38794 and should not be used as such.
38795 .wen
38796
38797 Some people are tempted into editing -D files in order to modify messages. You
38798 need to be extremely careful if you do this; it is not recommended and you are
38799 on your own if you do it. Here are some of the pitfalls:
38800
38801 .ilist
38802 You must ensure that Exim does not try to deliver the message while you are
38803 fiddling with it. The safest way is to take out a write lock on the -D file,
38804 which is what Exim itself does, using &[fcntl()]&. If you update the file in
38805 place, the lock will be retained. If you write a new file and rename it, the
38806 lock will be lost at the instant of rename.
38807 .next
38808 .vindex "&$body_linecount$&"
38809 If you change the number of lines in the file, the value of
38810 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
38811 cause incomplete transmission of messages or undeliverable messages.
38812 .next
38813 If the message is in MIME format, you must take care not to break it.
38814 .next
38815 If the message is cryptographically signed, any change will invalidate the
38816 signature.
38817 .endlist
38818 All in all, modifying -D files is fraught with danger.
38819
38820 Files whose names end with -J may also be seen in the &_input_& directory (or
38821 its subdirectories when &%split_spool_directory%& is set). These are journal
38822 files, used to record addresses to which the message has been delivered during
38823 the course of a delivery attempt. If there are still undelivered recipients at
38824 the end, the -H file is updated, and the -J file is deleted. If, however, there
38825 is some kind of crash (for example, a power outage) before this happens, the -J
38826 file remains in existence. When Exim next processes the message, it notices the
38827 -J file and uses it to update the -H file before starting the next delivery
38828 attempt.
38829
38830 Files whose names end with -K or .eml may also be seen in the spool.
38831 These are temporaries used for DKIM or malware processing, when that is used.
38832 They should be tidied up by normal operations; any old ones are probably
38833 relics of crashes and can be removed.
38834
38835 .section "Format of the -H file" "SECID282"
38836 .cindex "uid (user id)" "in spool file"
38837 .cindex "gid (group id)" "in spool file"
38838 The second line of the -H file contains the login name for the uid of the
38839 process that called Exim to read the message, followed by the numerical uid and
38840 gid. For a locally generated message, this is normally the user who sent the
38841 message. For a message received over TCP/IP via the daemon, it is
38842 normally the Exim user.
38843
38844 The third line of the file contains the address of the message's sender as
38845 transmitted in the envelope, contained in angle brackets. The sender address is
38846 empty for bounce messages. For incoming SMTP mail, the sender address is given
38847 in the MAIL command. For locally generated mail, the sender address is
38848 created by Exim from the login name of the current user and the configured
38849 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
38850 leading &"From&~"& line if the caller is trusted, or if the supplied address is
38851 &"<>"& or an address that matches &%untrusted_set_senders%&.
38852
38853 The fourth line contains two numbers. The first is the time that the message
38854 was received, in the conventional Unix form &-- the number of seconds since the
38855 start of the epoch. The second number is a count of the number of messages
38856 warning of delayed delivery that have been sent to the sender.
38857
38858 There follow a number of lines starting with a hyphen. These can appear in any
38859 order, and are omitted when not relevant:
38860
38861 .vlist
38862 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
38863 This item is obsolete, and is not generated from Exim release 4.61 onwards;
38864 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
38865 recognized, to provide backward compatibility. In the old format, a line of
38866 this form is present for every ACL variable that is not empty. The number
38867 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
38868 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
38869 the data string for the variable. The string itself starts at the beginning of
38870 the next line, and is followed by a newline character. It may contain internal
38871 newlines.
38872
38873 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
38874 A line of this form is present for every ACL connection variable that is
38875 defined. Note that there is a space between &%-aclc%& and the rest of the name.
38876 The length is the length of the data string for the variable. The string itself
38877 starts at the beginning of the next line, and is followed by a newline
38878 character. It may contain internal newlines.
38879
38880 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
38881 A line of this form is present for every ACL message variable that is defined.
38882 Note that there is a space between &%-aclm%& and the rest of the name. The
38883 length is the length of the data string for the variable. The string itself
38884 starts at the beginning of the next line, and is followed by a newline
38885 character. It may contain internal newlines.
38886
38887 .vitem "&%-active_hostname%&&~<&'hostname'&>"
38888 This is present if, when the message was received over SMTP, the value of
38889 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
38890
38891 .vitem &%-allow_unqualified_recipient%&
38892 This is present if unqualified recipient addresses are permitted in header
38893 lines (to stop such addresses from being qualified if rewriting occurs at
38894 transport time). Local messages that were input using &%-bnq%& and remote
38895 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
38896
38897 .vitem &%-allow_unqualified_sender%&
38898 This is present if unqualified sender addresses are permitted in header lines
38899 (to stop such addresses from being qualified if rewriting occurs at transport
38900 time). Local messages that were input using &%-bnq%& and remote messages from
38901 hosts that match &%sender_unqualified_hosts%& set this flag.
38902
38903 .vitem "&%-auth_id%&&~<&'text'&>"
38904 The id information for a message received on an authenticated SMTP connection
38905 &-- the value of the &$authenticated_id$& variable.
38906
38907 .vitem "&%-auth_sender%&&~<&'address'&>"
38908 The address of an authenticated sender &-- the value of the
38909 &$authenticated_sender$& variable.
38910
38911 .vitem "&%-body_linecount%&&~<&'number'&>"
38912 This records the number of lines in the body of the message, and is
38913 present unless &%-spool_file_wireformat%& is.
38914
38915 .vitem "&%-body_zerocount%&&~<&'number'&>"
38916 This records the number of binary zero bytes in the body of the message, and is
38917 present if the number is greater than zero.
38918
38919 .vitem &%-deliver_firsttime%&
38920 This is written when a new message is first added to the spool. When the spool
38921 file is updated after a deferral, it is omitted.
38922
38923 .vitem "&%-frozen%&&~<&'time'&>"
38924 .cindex "frozen messages" "spool data"
38925 The message is frozen, and the freezing happened at <&'time'&>.
38926
38927 .vitem "&%-helo_name%&&~<&'text'&>"
38928 This records the host name as specified by a remote host in a HELO or EHLO
38929 command.
38930
38931 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
38932 This records the IP address of the host from which the message was received and
38933 the remote port number that was used. It is omitted for locally generated
38934 messages.
38935
38936 .vitem "&%-host_auth%&&~<&'text'&>"
38937 If the message was received on an authenticated SMTP connection, this records
38938 the name of the authenticator &-- the value of the
38939 &$sender_host_authenticated$& variable.
38940
38941 .vitem &%-host_lookup_failed%&
38942 This is present if an attempt to look up the sending host's name from its IP
38943 address failed. It corresponds to the &$host_lookup_failed$& variable.
38944
38945 .vitem "&%-host_name%&&~<&'text'&>"
38946 .cindex "reverse DNS lookup"
38947 .cindex "DNS" "reverse lookup"
38948 This records the name of the remote host from which the message was received,
38949 if the host name was looked up from the IP address when the message was being
38950 received. It is not present if no reverse lookup was done.
38951
38952 .vitem "&%-ident%&&~<&'text'&>"
38953 For locally submitted messages, this records the login of the originating user,
38954 unless it was a trusted user and the &%-oMt%& option was used to specify an
38955 ident value. For messages received over TCP/IP, this records the ident string
38956 supplied by the remote host, if any.
38957
38958 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
38959 This records the IP address of the local interface and the port number through
38960 which a message was received from a remote host. It is omitted for locally
38961 generated messages.
38962
38963 .vitem &%-local%&
38964 The message is from a local sender.
38965
38966 .vitem &%-localerror%&
38967 The message is a locally-generated bounce message.
38968
38969 .vitem "&%-local_scan%&&~<&'string'&>"
38970 This records the data string that was returned by the &[local_scan()]& function
38971 when the message was received &-- the value of the &$local_scan_data$&
38972 variable. It is omitted if no data was returned.
38973
38974 .vitem &%-manual_thaw%&
38975 The message was frozen but has been thawed manually, that is, by an explicit
38976 Exim command rather than via the auto-thaw process.
38977
38978 .vitem &%-N%&
38979 A testing delivery process was started using the &%-N%& option to suppress any
38980 actual deliveries, but delivery was deferred. At any further delivery attempts,
38981 &%-N%& is assumed.
38982
38983 .vitem &%-received_protocol%&
38984 This records the value of the &$received_protocol$& variable, which contains
38985 the name of the protocol by which the message was received.
38986
38987 .vitem &%-sender_set_untrusted%&
38988 The envelope sender of this message was set by an untrusted local caller (used
38989 to ensure that the caller is displayed in queue listings).
38990
38991 .vitem "&%-spam_score_int%&&~<&'number'&>"
38992 If a message was scanned by SpamAssassin, this is present. It records the value
38993 of &$spam_score_int$&.
38994
38995 .vitem &%-spool_file_wireformat%&
38996 The -D file for this message is in wire-format (for ESMTP CHUNKING)
38997 rather than Unix-format.
38998 The line-ending is CRLF rather than newline.
38999 There is still, however, no leading-dot-stuffing.
39000
39001 .vitem &%-tls_certificate_verified%&
39002 A TLS certificate was received from the client that sent this message, and the
39003 certificate was verified by the server.
39004
39005 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
39006 When the message was received over an encrypted connection, this records the
39007 name of the cipher suite that was used.
39008
39009 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
39010 When the message was received over an encrypted connection, and a certificate
39011 was received from the client, this records the Distinguished Name from that
39012 certificate.
39013 .endlist
39014
39015 Following the options there is a list of those addresses to which the message
39016 is not to be delivered. This set of addresses is initialized from the command
39017 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
39018 is set; otherwise it starts out empty. Whenever a successful delivery is made,
39019 the address is added to this set. The addresses are kept internally as a
39020 balanced binary tree, and it is a representation of that tree which is written
39021 to the spool file. If an address is expanded via an alias or forward file, the
39022 original address is added to the tree when deliveries to all its child
39023 addresses are complete.
39024
39025 If the tree is empty, there is a single line in the spool file containing just
39026 the text &"XX"&. Otherwise, each line consists of two letters, which are either
39027 Y or N, followed by an address. The address is the value for the node of the
39028 tree, and the letters indicate whether the node has a left branch and/or a
39029 right branch attached to it, respectively. If branches exist, they immediately
39030 follow. Here is an example of a three-node tree:
39031 .code
39032 YY darcy@austen.fict.example
39033 NN alice@wonderland.fict.example
39034 NN editor@thesaurus.ref.example
39035 .endd
39036 After the non-recipients tree, there is a list of the message's recipients.
39037 This is a simple list, preceded by a count. It includes all the original
39038 recipients of the message, including those to whom the message has already been
39039 delivered. In the simplest case, the list contains one address per line. For
39040 example:
39041 .code
39042 4
39043 editor@thesaurus.ref.example
39044 darcy@austen.fict.example
39045 rdo@foundation
39046 alice@wonderland.fict.example
39047 .endd
39048 However, when a child address has been added to the top-level addresses as a
39049 result of the use of the &%one_time%& option on a &(redirect)& router, each
39050 line is of the following form:
39051 .display
39052 <&'top-level address'&> <&'errors_to address'&> &&&
39053   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
39054 .endd
39055 The 01 flag bit indicates the presence of the three other fields that follow
39056 the top-level address. Other bits may be used in future to support additional
39057 fields. The <&'parent number'&> is the offset in the recipients list of the
39058 original parent of the &"one time"& address. The first two fields are the
39059 envelope sender that is associated with this address and its length. If the
39060 length is zero, there is no special envelope sender (there are then two space
39061 characters in the line). A non-empty field can arise from a &(redirect)& router
39062 that has an &%errors_to%& setting.
39063
39064
39065 A blank line separates the envelope and status information from the headers
39066 which follow. A header may occupy several lines of the file, and to save effort
39067 when reading it in, each header is preceded by a number and an identifying
39068 character. The number is the number of characters in the header, including any
39069 embedded newlines and the terminating newline. The character is one of the
39070 following:
39071
39072 .table2 50pt
39073 .row <&'blank'&>         "header in which Exim has no special interest"
39074 .row &`B`&               "&'Bcc:'& header"
39075 .row &`C`&               "&'Cc:'& header"
39076 .row &`F`&               "&'From:'& header"
39077 .row &`I`&               "&'Message-id:'& header"
39078 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
39079 .row &`R`&               "&'Reply-To:'& header"
39080 .row &`S`&               "&'Sender:'& header"
39081 .row &`T`&               "&'To:'& header"
39082 .row &`*`&               "replaced or deleted header"
39083 .endtable
39084
39085 Deleted or replaced (rewritten) headers remain in the spool file for debugging
39086 purposes. They are not transmitted when the message is delivered. Here is a
39087 typical set of headers:
39088 .code
39089 111P Received: by hobbit.fict.example with local (Exim 4.00)
39090 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
39091 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
39092 038* X-rewrote-sender: bb@hobbit.fict.example
39093 042* From: Bilbo Baggins <bb@hobbit.fict.example>
39094 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
39095 099* To: alice@wonderland.fict.example, rdo@foundation,
39096 darcy@austen.fict.example, editor@thesaurus.ref.example
39097 104T To: alice@wonderland.fict.example, rdo@foundation.example,
39098 darcy@austen.fict.example, editor@thesaurus.ref.example
39099 038  Date: Fri, 11 May 2001 10:28:59 +0100
39100 .endd
39101 The asterisked headers indicate that the envelope sender, &'From:'& header, and
39102 &'To:'& header have been rewritten, the last one because routing expanded the
39103 unqualified domain &'foundation'&.
39104 .ecindex IIDforspo1
39105 .ecindex IIDforspo2
39106 .ecindex IIDforspo3
39107
39108 .section "Format of the -D file" "SECID282a"
39109 The data file is traditionally in Unix-standard format: lines are ended with
39110 an ASCII newline character.
39111 However, when the &%spool_wireformat%& main option is used some -D files
39112 can have an alternate format.
39113 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
39114 The -D file lines (not including the first name-component line) are
39115 suitable for direct copying to the wire when transmitting using the
39116 ESMTP CHUNKING option, meaning lower processing overhead.
39117 Lines are terminated with an ASCII CRLF pair.
39118 There is no dot-stuffing (and no dot-termination).
39119
39120 . ////////////////////////////////////////////////////////////////////////////
39121 . ////////////////////////////////////////////////////////////////////////////
39122
39123 .chapter "DKIM and SPF" "CHAPdkim" &&&
39124          "DKIM and SPF Support"
39125 .cindex "DKIM"
39126
39127 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
39128
39129 DKIM is a mechanism by which messages sent by some entity can be provably
39130 linked to a domain which that entity controls.  It permits reputation to
39131 be tracked on a per-domain basis, rather than merely upon source IP address.
39132 DKIM is documented in RFC 6376.
39133
39134 As DKIM relies on the message being unchanged in transit, messages handled
39135 by a mailing-list (which traditionally adds to the message) will not match
39136 any original DKIM signature.
39137
39138 DKIM support is compiled into Exim by default if TLS support is present.
39139 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
39140
39141 Exim's DKIM implementation allows for
39142 .olist
39143 Signing outgoing messages: This function is implemented in the SMTP transport.
39144 It can co-exist with all other Exim features
39145 (including transport filters)
39146 except cutthrough delivery.
39147 .next
39148 Verifying signatures in incoming messages: This is implemented by an additional
39149 ACL (acl_smtp_dkim), which can be called several times per message, with
39150 different signature contexts.
39151 .endlist
39152
39153 In typical Exim style, the verification implementation does not include any
39154 default "policy". Instead it enables you to build your own policy using
39155 Exim's standard controls.
39156
39157 Please note that verification of DKIM signatures in incoming mail is turned
39158 on by default for logging (in the <= line) purposes.
39159
39160 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
39161 When set, for each signature in incoming email,
39162 exim will log a line displaying the most important signature details, and the
39163 signature status. Here is an example (with line-breaks added for clarity):
39164 .code
39165 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
39166     d=facebookmail.com s=q1-2009b
39167     c=relaxed/relaxed a=rsa-sha1
39168     i=@facebookmail.com t=1252484542 [verification succeeded]
39169 .endd
39170
39171 You might want to turn off DKIM verification processing entirely for internal
39172 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
39173 control modifier. This should typically be done in the RCPT ACL, at points
39174 where you accept mail from relay sources (internal hosts or authenticated
39175 senders).
39176
39177
39178 .section "Signing outgoing messages" "SECDKIMSIGN"
39179 .cindex "DKIM" "signing"
39180
39181 For signing to be usable you must have published a DKIM record in DNS.
39182 Note that RFC 8301 says:
39183 .code
39184 rsa-sha1 MUST NOT be used for signing or verifying.
39185
39186 Signers MUST use RSA keys of at least 1024 bits for all keys.
39187 Signers SHOULD use RSA keys of at least 2048 bits.
39188 .endd
39189
39190 Note also that the key content (the 'p=' field)
39191 in the DNS record is different between RSA and EC keys;
39192 for the former it is the base64 of the ASN.1 for the RSA public key
39193 (equivalent to the private-key .pem with the header/trailer stripped)
39194 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
39195
39196 Signing is enabled by setting private options on the SMTP transport.
39197 These options take (expandable) strings as arguments.
39198
39199 .option dkim_domain smtp string list&!! unset
39200 The domain(s) you want to sign with.
39201 After expansion, this can be a list.
39202 Each element in turn is put into the &%$dkim_domain%& expansion variable
39203 while expanding the remaining signing options.
39204 If it is empty after expansion, DKIM signing is not done,
39205 and no error will result even if &%dkim_strict%& is set.
39206
39207 .option dkim_selector smtp string list&!! unset
39208 This sets the key selector string.
39209 After expansion, which can use &$dkim_domain$&, this can be a list.
39210 Each element in turn is put in the expansion
39211 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
39212 option along with &%$dkim_domain%&.
39213 If the option is empty after expansion, DKIM signing is not done for this domain,
39214 and no error will result even if &%dkim_strict%& is set.
39215
39216 .option dkim_private_key smtp string&!! unset
39217 This sets the private key to use.
39218 You can use the &%$dkim_domain%& and
39219 &%$dkim_selector%& expansion variables to determine the private key to use.
39220 The result can either
39221 .ilist
39222 be a valid RSA private key in ASCII armor (.pem file), including line breaks
39223 .next
39224 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
39225 be a valid Ed25519 private key (same format as above)
39226 .next
39227 start with a slash, in which case it is treated as a file that contains
39228 the private key
39229 .next
39230 be "0", "false" or the empty string, in which case the message will not
39231 be signed. This case will not result in an error, even if &%dkim_strict%&
39232 is set.
39233 .endlist
39234
39235 To generate keys under OpenSSL:
39236 .code
39237 openssl genrsa -out dkim_rsa.private 2048
39238 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
39239 .endd
39240 Take the base-64 lines from the output of the second command, concatenated,
39241 for the DNS TXT record.
39242 See section 3.6 of RFC6376 for the record specification.
39243
39244 Under GnuTLS:
39245 .code
39246 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
39247 certtool --load-privkey=dkim_rsa.private --pubkey-info
39248 .endd
39249
39250 Note that RFC 8301 says:
39251 .code
39252 Signers MUST use RSA keys of at least 1024 bits for all keys.
39253 Signers SHOULD use RSA keys of at least 2048 bits.
39254 .endd
39255
39256 Support for EC keys is being developed under
39257 &url(https://datatracker.ietf.org/doc/draft-ietf-dcrup-dkim-crypto/).
39258 They are considerably smaller than RSA keys for equivalent protection.
39259 As they are a recent development, users should consider dual-signing
39260 (by setting a list of selectors, and an expansion for this option)
39261 for some transition period.
39262 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
39263 for EC keys.
39264
39265 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
39266 .code
39267 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
39268 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
39269 .endd
39270
39271 To produce the required public key value for a DNS record:
39272 .code
39273 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
39274 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
39275 .endd
39276
39277 Note that the format
39278 of Ed25519 keys in DNS has not yet been decided; this release supports
39279 both of the leading candidates at this time, a future release will
39280 probably drop support for whichever proposal loses.
39281
39282 .option dkim_hash smtp string&!! sha256
39283 Can be set to any one of the supported hash methods, which are:
39284 .ilist
39285 &`sha1`& &-- should not be used, is old and insecure
39286 .next
39287 &`sha256`& &-- the default
39288 .next
39289 &`sha512`& &-- possibly more secure but less well supported
39290 .endlist
39291
39292 Note that RFC 8301 says:
39293 .code
39294 rsa-sha1 MUST NOT be used for signing or verifying.
39295 .endd
39296
39297 .option dkim_identity smtp string&!! unset
39298 If set after expansion, the value is used to set an "i=" tag in
39299 the signing header.  The DKIM standards restrict the permissible
39300 syntax of this optional tag to a mail address, with possibly-empty
39301 local part, an @, and a domain identical to or subdomain of the "d="
39302 tag value.  Note that Exim does not check the value.
39303
39304 .option dkim_canon smtp string&!! unset
39305 This option sets the canonicalization method used when signing a message.
39306 The DKIM RFC currently supports two methods: "simple" and "relaxed".
39307 The option defaults to "relaxed" when unset. Note: the current implementation
39308 only supports signing with the same canonicalization method for both headers and body.
39309
39310 .option dkim_strict smtp string&!! unset
39311 This  option  defines  how  Exim  behaves  when  signing a message that
39312 should be signed fails for some reason.  When the expansion evaluates to
39313 either "1" or "true", Exim will defer. Otherwise Exim will send the message
39314 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
39315 variables here.
39316
39317 .option dkim_sign_headers smtp string&!! "see below"
39318 If set, this option must expand to a colon-separated
39319 list of header names.
39320 Headers with these names, or the absence or such a header, will be included
39321 in the message signature.
39322 When unspecified, the header names listed in RFC4871 will be used,
39323 whether or not each header is present in the message.
39324 The default list is available for the expansion in the macro
39325 "_DKIM_SIGN_HEADERS".
39326
39327 If a name is repeated, multiple headers by that name (or the absence thereof)
39328 will be signed.  The textually later headers in the headers part of the
39329 message are signed first, if there are multiples.
39330
39331 A name can be prefixed with either an '=' or a '+' character.
39332 If an '=' prefix is used, all headers that are present with this name
39333 will be signed.
39334 If a '+' prefix if used, all headers that are present with this name
39335 will be signed, and one signature added for a missing header with the
39336 name will be appended.
39337
39338 .new
39339 .option dkim_timestamps smtp integer&!! unset
39340 This option controls the inclusion of timestamp information in the signature.
39341 If not set, no such information will be included.
39342 Otherwise, must be an unsigned number giving an offset in seconds from the current time
39343 for the expiry tag
39344 (eg. 1209600 for two weeks);
39345 both creation (t=) and expiry (x=) tags will be included.
39346
39347 RFC 6376 lists these tags as RECOMMENDED.
39348 .wen
39349
39350
39351 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
39352 .cindex "DKIM" "verification"
39353
39354 .new
39355 Verification of DKIM signatures in SMTP incoming email is done for all
39356 messages for which an ACL control &%dkim_disable_verify%& has not been set.
39357 .cindex authentication "expansion item"
39358 Performing verification sets up information used by the
39359 &$authresults$& expansion item.
39360 .wen
39361
39362 .new The results of that verification are then made available to the
39363 &%acl_smtp_dkim%& ACL, &new(which can examine and modify them).
39364 By default, this ACL is called once for each
39365 syntactically(!) correct signature in the incoming message.
39366 A missing ACL definition defaults to accept.
39367 If any ACL call does not accept, the message is not accepted.
39368 If a cutthrough delivery was in progress for the message, that is
39369 summarily dropped (having wasted the transmission effort).
39370
39371 To evaluate the &new(verification result) in the ACL
39372 a large number of expansion variables
39373 containing the signature status and its details are set up during the
39374 runtime of the ACL.
39375
39376 Calling the ACL only for existing signatures is not sufficient to build
39377 more advanced policies. For that reason, the global option
39378 &%dkim_verify_signers%&, and a global expansion variable
39379 &%$dkim_signers%& exist.
39380
39381 The global option &%dkim_verify_signers%& can be set to a colon-separated
39382 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
39383 called. It is expanded when the message has been received. At this point,
39384 the expansion variable &%$dkim_signers%& already contains a colon-separated
39385 list of signer domains and identities for the message. When
39386 &%dkim_verify_signers%& is not specified in the main configuration,
39387 it defaults as:
39388 .code
39389 dkim_verify_signers = $dkim_signers
39390 .endd
39391 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
39392 DKIM signature in the message. Current DKIM verifiers may want to explicitly
39393 call the ACL for known domains or identities. This would be achieved as follows:
39394 .code
39395 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
39396 .endd
39397 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
39398 and "ebay.com", plus all domains and identities that have signatures in the message.
39399 You can also be more creative in constructing your policy. For example:
39400 .code
39401 dkim_verify_signers = $sender_address_domain:$dkim_signers
39402 .endd
39403
39404 If a domain or identity is listed several times in the (expanded) value of
39405 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
39406
39407 If multiple signatures match a domain (or identity), the ACL is called once
39408 for each matching signature.
39409
39410
39411 Inside the &%acl_smtp_dkim%&, the following expansion variables are
39412 available (from most to least important):
39413
39414
39415 .vlist
39416 .vitem &%$dkim_cur_signer%&
39417 The signer that is being evaluated in this ACL run. This can be a domain or
39418 an identity. This is one of the list items from the expanded main option
39419 &%dkim_verify_signers%& (see above).
39420
39421 .vitem &%$dkim_verify_status%&
39422 Within the DKIM ACL,
39423 a string describing the general status of the signature. One of
39424 .ilist
39425 &%none%&: There is no signature in the message for the current domain or
39426 identity (as reflected by &%$dkim_cur_signer%&).
39427 .next
39428 &%invalid%&: The signature could not be verified due to a processing error.
39429 More detail is available in &%$dkim_verify_reason%&.
39430 .next
39431 &%fail%&: Verification of the signature failed.  More detail is
39432 available in &%$dkim_verify_reason%&.
39433 .next
39434 &%pass%&: The signature passed verification. It is valid.
39435 .endlist
39436
39437 This variable can be overwritten using an ACL 'set' modifier.
39438 This might, for instance, be done to enforce a policy restriction on
39439 hash-method or key-size:
39440 .code
39441   warn condition       = ${if eq {$dkim_verify_status}{pass}}
39442        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
39443        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
39444                                   {< {$dkim_key_length}{1024}}}}
39445        logwrite        = NOTE: forcing DKIM verify fail (was pass)
39446        set dkim_verify_status = fail
39447        set dkim_verify_reason = hash too weak or key too short
39448 .endd
39449
39450 So long as a DKIM ACL is defined (it need do no more than accept),
39451 after all the DKIM ACL runs have completed, the value becomes a
39452 colon-separated list of the values after each run.
39453 This is maintained for the mime, prdr and data ACLs.
39454
39455 .vitem &%$dkim_verify_reason%&
39456 A string giving a little bit more detail when &%$dkim_verify_status%& is either
39457 "fail" or "invalid". One of
39458 .ilist
39459 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
39460 key for the domain could not be retrieved. This may be a temporary problem.
39461 .next
39462 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
39463 record for the domain is syntactically invalid.
39464 .next
39465 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
39466 body hash does not match the one specified in the signature header. This
39467 means that the message body was modified in transit.
39468 .next
39469 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
39470 could not be verified. This may mean that headers were modified,
39471 re-written or otherwise changed in a way which is incompatible with
39472 DKIM verification. It may of course also mean that the signature is forged.
39473 .endlist
39474
39475 This variable can be overwritten, with any value, using an ACL 'set' modifier.
39476
39477 .vitem &%$dkim_domain%&
39478 The signing domain. IMPORTANT: This variable is only populated if there is
39479 an actual signature in the message for the current domain or identity (as
39480 reflected by &%$dkim_cur_signer%&).
39481
39482 .vitem &%$dkim_identity%&
39483 The signing identity, if present. IMPORTANT: This variable is only populated
39484 if there is an actual signature in the message for the current domain or
39485 identity (as reflected by &%$dkim_cur_signer%&).
39486
39487 .vitem &%$dkim_selector%&
39488 The key record selector string.
39489
39490 .vitem &%$dkim_algo%&
39491 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
39492 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
39493 may also be 'ed25519-sha256'.
39494 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
39495 for EC keys.
39496
39497 Note that RFC 8301 says:
39498 .code
39499 rsa-sha1 MUST NOT be used for signing or verifying.
39500
39501 DKIM signatures identified as having been signed with historic
39502 algorithms (currently, rsa-sha1) have permanently failed evaluation
39503 .endd
39504
39505 To enforce this you must have a DKIM ACL which checks this variable
39506 and overwrites the &$dkim_verify_status$& variable as discussed above.
39507
39508 .vitem &%$dkim_canon_body%&
39509 The body canonicalization method. One of 'relaxed' or 'simple'.
39510
39511 .vitem &%$dkim_canon_headers%&
39512 The header canonicalization method. One of 'relaxed' or 'simple'.
39513
39514 .vitem &%$dkim_copiedheaders%&
39515 A transcript of headers and their values which are included in the signature
39516 (copied from the 'z=' tag of the signature).
39517 Note that RFC6376 requires that verification fail if the From: header is
39518 not included in the signature.  Exim does not enforce this; sites wishing
39519 strict enforcement should code the check explicitly.
39520
39521 .vitem &%$dkim_bodylength%&
39522 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
39523 limit was set by the signer, "9999999999999" is returned. This makes sure
39524 that this variable always expands to an integer value.
39525 .new
39526 &*Note:*& The presence of the signature tag specifying a signing body length
39527 is one possible route to spoofing of valid DKIM signatures.
39528 A paranoid implementation might wish to regard signature where this variable
39529 shows less than the "no limit" return as being invalid.
39530 .wen
39531
39532 .vitem &%$dkim_created%&
39533 UNIX timestamp reflecting the date and time when the signature was created.
39534 When this was not specified by the signer, "0" is returned.
39535
39536 .vitem &%$dkim_expires%&
39537 UNIX timestamp reflecting the date and time when the signer wants the
39538 signature to be treated as "expired". When this was not specified by the
39539 signer, "9999999999999" is returned. This makes it possible to do useful
39540 integer size comparisons against this value.
39541 Note that Exim does not check this value.
39542
39543 .vitem &%$dkim_headernames%&
39544 A colon-separated list of names of headers included in the signature.
39545
39546 .vitem &%$dkim_key_testing%&
39547 "1" if the key record has the "testing" flag set, "0" if not.
39548
39549 .vitem &%$dkim_key_nosubdomains%&
39550 "1" if the key record forbids subdomaining, "0" otherwise.
39551
39552 .vitem &%$dkim_key_srvtype%&
39553 Service type (tag s=) from the key record. Defaults to "*" if not specified
39554 in the key record.
39555
39556 .vitem &%$dkim_key_granularity%&
39557 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
39558 in the key record.
39559
39560 .vitem &%$dkim_key_notes%&
39561 Notes from the key record (tag n=).
39562
39563 .vitem &%$dkim_key_length%&
39564 Number of bits in the key.
39565
39566 Note that RFC 8301 says:
39567 .code
39568 Verifiers MUST NOT consider signatures using RSA keys of
39569 less than 1024 bits as valid signatures.
39570 .endd
39571
39572 To enforce this you must have a DKIM ACL which checks this variable
39573 and overwrites the &$dkim_verify_status$& variable as discussed above.
39574 As EC keys are much smaller, the check should only do this for RSA keys.
39575
39576 .endlist
39577
39578 In addition, two ACL conditions are provided:
39579
39580 .vlist
39581 .vitem &%dkim_signers%&
39582 ACL condition that checks a colon-separated list of domains or identities
39583 for a match against the domain or identity that the ACL is currently verifying
39584 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
39585 verb to a group of domains or identities. For example:
39586
39587 .code
39588 # Warn when Mail purportedly from GMail has no gmail signature
39589 warn log_message = GMail sender without gmail.com DKIM signature
39590      sender_domains = gmail.com
39591      dkim_signers = gmail.com
39592      dkim_status = none
39593 .endd
39594
39595 Note that the above does not check for a total lack of DKIM signing;
39596 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
39597
39598 .vitem &%dkim_status%&
39599 ACL condition that checks a colon-separated list of possible DKIM verification
39600 results against the actual result of verification. This is typically used
39601 to restrict an ACL verb to a list of verification outcomes, for example:
39602
39603 .code
39604 deny message = Mail from Paypal with invalid/missing signature
39605      sender_domains = paypal.com:paypal.de
39606      dkim_signers = paypal.com:paypal.de
39607      dkim_status = none:invalid:fail
39608 .endd
39609
39610 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
39611 see the documentation of the &%$dkim_verify_status%& expansion variable above
39612 for more information of what they mean.
39613 .endlist
39614
39615
39616
39617
39618 .section "SPF (Sender Policy Framework)" SECSPF
39619 .cindex SPF verification
39620
39621 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
39622 messages with its domain in the envelope from, documented by RFC 7208.
39623 For more information on SPF see &url(http://www.openspf.org).
39624 . --- 2018-09-07: still not https
39625
39626 Messages sent by a system not authorised will fail checking of such assertions.
39627 This includes retransmissions done by traditional forwarders.
39628
39629 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
39630 &_Local/Makefile_&.  The support uses the &_libspf2_& library
39631 &url(https://www.libspf2.org/).
39632 There is no Exim involvement in the transmission of messages;
39633 publishing certain DNS records is all that is required.
39634
39635 For verification, an ACL condition and an expansion lookup are provided.
39636 .cindex authentication "expansion item"
39637 Performing verification sets up information used by the
39638 &$authresults$& expansion item.
39639
39640
39641 .cindex SPF "ACL condition"
39642 .cindex ACL "spf condition"
39643 The ACL condition "spf" can be used at or after the MAIL ACL.
39644 It takes as an argument a list of strings giving the outcome of the SPF check,
39645 and will succeed for any matching outcome.
39646 Valid strings are:
39647 .vlist
39648 .vitem &%pass%&
39649 The SPF check passed, the sending host is positively verified by SPF.
39650
39651 .vitem &%fail%&
39652 The SPF check failed, the sending host is NOT allowed to send mail for the
39653 domain in the envelope-from address.
39654
39655 .vitem &%softfail%&
39656 The SPF check failed, but the queried domain can't absolutely confirm that this
39657 is a forgery.
39658
39659 .vitem &%none%&
39660 The queried domain does not publish SPF records.
39661
39662 .vitem &%neutral%&
39663 The SPF check returned a "neutral" state.  This means the queried domain has
39664 published a SPF record, but wants to allow outside servers to send mail under
39665 its domain as well.  This should be treated like "none".
39666
39667 .vitem &%permerror%&
39668 This indicates a syntax error in the SPF record of the queried domain.
39669 You may deny messages when this occurs.
39670
39671 .vitem &%temperror%&
39672 This indicates a temporary error during all processing, including Exim's
39673 SPF processing.  You may defer messages when this occurs.
39674 .endlist
39675
39676 You can prefix each string with an exclamation mark to  invert
39677 its meaning,  for example  "!fail" will  match all  results but
39678 "fail".  The  string  list is  evaluated  left-to-right,  in a
39679 short-circuit fashion.
39680
39681 Example:
39682 .code
39683 deny spf = fail
39684      message = $sender_host_address is not allowed to send mail from \
39685                ${if def:sender_address_domain \
39686                     {$sender_address_domain}{$sender_helo_name}}.  \
39687                Please see http://www.openspf.org/Why?scope=\
39688                ${if def:sender_address_domain {mfrom}{helo}};\
39689                identity=${if def:sender_address_domain \
39690                              {$sender_address}{$sender_helo_name}};\
39691                ip=$sender_host_address
39692 .endd
39693
39694 When the spf condition has run, it sets up several expansion
39695 variables:
39696
39697 .cindex SPF "verification variables"
39698 .vlist
39699 .vitem &$spf_header_comment$&
39700 .vindex &$spf_header_comment$&
39701   This contains a human-readable string describing the outcome
39702   of the SPF check. You can add it to a custom header or use
39703   it for logging purposes.
39704
39705 .vitem &$spf_received$&
39706 .vindex &$spf_received$&
39707   This contains a complete Received-SPF: header that can be
39708   added to the message. Please note that according to the SPF
39709   draft, this header must be added at the top of the header
39710   list. Please see section 10 on how you can do this.
39711
39712   Note: in case of "Best-guess" (see below), the convention is
39713   to put this string in a header called X-SPF-Guess: instead.
39714
39715 .vitem &$spf_result$&
39716 .vindex &$spf_result$&
39717   This contains the outcome of the SPF check in string form,
39718   one of pass, fail, softfail, none, neutral, permerror or
39719   temperror.
39720
39721 .vitem &$spf_result_guessed$&
39722 .vindex &$spf_result_guessed$&
39723   This boolean is true only if a best-guess operation was used
39724   and required in order to obtain a result.
39725
39726 .vitem &$spf_smtp_comment$&
39727 .vindex &$spf_smtp_comment$&
39728   This contains a string that can be used in a SMTP response
39729   to the calling party. Useful for "fail".
39730 .endlist
39731
39732
39733 .cindex SPF "ACL condition"
39734 .cindex ACL "spf_guess condition"
39735 .cindex SPF "best guess"
39736 In addition to SPF, you can also perform checks for so-called
39737 "Best-guess".  Strictly speaking, "Best-guess" is not standard
39738 SPF, but it is supported by the same framework that enables SPF
39739 capability.
39740 Refer to &url(http://www.openspf.org/FAQ/Best_guess_record)
39741 for a description of what it means.
39742 . --- 2018-09-07: still not https:
39743
39744 To access this feature, simply use the spf_guess condition in place
39745 of the spf one.  For example:
39746
39747 .code
39748 deny spf_guess = fail
39749      message = $sender_host_address doesn't look trustworthy to me
39750 .endd
39751
39752 In case you decide to reject messages based on this check, you
39753 should note that although it uses the same framework, "Best-guess"
39754 is not SPF, and therefore you should not mention SPF at all in your
39755 reject message.
39756
39757 When the spf_guess condition has run, it sets up the same expansion
39758 variables as when spf condition is run, described above.
39759
39760 Additionally, since Best-guess is not standardized, you may redefine
39761 what "Best-guess" means to you by redefining the main configuration
39762 &%spf_guess%& option.
39763 For example, the following:
39764
39765 .code
39766 spf_guess = v=spf1 a/16 mx/16 ptr ?all
39767 .endd
39768
39769 would relax host matching rules to a broader network range.
39770
39771
39772 .cindex SPF "lookup expansion"
39773 .cindex lookup spf
39774 A lookup expansion is also available. It takes an email
39775 address as the key and an IP address as the database:
39776
39777 .code
39778   ${lookup {username@domain} spf {ip.ip.ip.ip}}
39779 .endd
39780
39781 The lookup will return the same result strings as can appear in
39782 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
39783 Currently, only IPv4 addresses are supported.
39784
39785
39786
39787
39788 . ////////////////////////////////////////////////////////////////////////////
39789 . ////////////////////////////////////////////////////////////////////////////
39790
39791 .chapter "Proxies" "CHAPproxies" &&&
39792          "Proxy support"
39793 .cindex "proxy support"
39794 .cindex "proxy" "access via"
39795
39796 A proxy is an intermediate system through which communication is passed.
39797 Proxies may provide a security, availability or load-distribution function.
39798
39799
39800 .section "Inbound proxies" SECTproxyInbound
39801 .cindex proxy inbound
39802 .cindex proxy "server side"
39803 .cindex proxy "Proxy protocol"
39804 .cindex "Proxy protocol" proxy
39805
39806 Exim has support for receiving inbound SMTP connections via a proxy
39807 that uses &"Proxy Protocol"& to speak to it.
39808 To include this support, include &"SUPPORT_PROXY=yes"&
39809 in Local/Makefile.
39810
39811 It was built on the HAProxy specification, found at
39812 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
39813
39814 The purpose of this facility is so that an application load balancer,
39815 such as HAProxy, can sit in front of several Exim servers
39816 to distribute load.
39817 Exim uses the local protocol communication with the proxy to obtain
39818 the remote SMTP system IP address and port information.
39819 There is no logging if a host passes or
39820 fails Proxy Protocol negotiation, but it can easily be determined and
39821 recorded in an ACL (example is below).
39822
39823 Use of a proxy is enabled by setting the &%hosts_proxy%&
39824 main configuration option to a hostlist; connections from these
39825 hosts will use Proxy Protocol.
39826 Exim supports both version 1 and version 2 of the Proxy Protocol and
39827 automatically determines which version is in use.
39828
39829 The Proxy Protocol header is the first data received on a TCP connection
39830 and is inserted before any TLS-on-connect handshake from the client; Exim
39831 negotiates TLS between Exim-as-server and the remote client, not between
39832 Exim and the proxy server.
39833
39834 The following expansion variables are usable
39835 (&"internal"& and &"external"& here refer to the interfaces
39836 of the proxy):
39837 .display
39838 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
39839 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
39840 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
39841 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
39842 &'proxy_session            '& boolean: SMTP connection via proxy
39843 .endd
39844 If &$proxy_session$& is set but &$proxy_external_address$& is empty
39845 there was a protocol error.
39846
39847 Since the real connections are all coming from the proxy, and the
39848 per host connection tracking is done before Proxy Protocol is
39849 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
39850 handle all of the parallel volume you expect per inbound proxy.
39851 With the option set so high, you lose the ability
39852 to protect your server from many connections from one IP.
39853 In order to prevent your server from overload, you
39854 need to add a per connection ratelimit to your connect ACL.
39855 A possible solution is:
39856 .display
39857   # Set max number of connections per host
39858   LIMIT   = 5
39859   # Or do some kind of IP lookup in a flat file or database
39860   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
39861
39862   defer   message        = Too many connections from this IP right now
39863           ratelimit      = LIMIT / 5s / per_conn / strict
39864 .endd
39865
39866
39867
39868 .section "Outbound proxies" SECTproxySOCKS
39869 .cindex proxy outbound
39870 .cindex proxy "client side"
39871 .cindex proxy SOCKS
39872 .cindex SOCKS proxy
39873 Exim has support for sending outbound SMTP via a proxy
39874 using a protocol called SOCKS5 (defined by RFC1928).
39875 The support can be optionally included by defining SUPPORT_SOCKS=yes in
39876 Local/Makefile.
39877
39878 Use of a proxy is enabled by setting the &%socks_proxy%& option
39879 on an smtp transport.
39880 The option value is expanded and should then be a list
39881 (colon-separated by default) of proxy specifiers.
39882 Each proxy specifier is a list
39883 (space-separated by default) where the initial element
39884 is an IP address and any subsequent elements are options.
39885
39886 Options are a string <name>=<value>.
39887 The list of options is in the following table:
39888 .display
39889 &'auth   '& authentication method
39890 &'name   '& authentication username
39891 &'pass   '& authentication password
39892 &'port   '& tcp port
39893 &'tmo    '& connection timeout
39894 &'pri    '& priority
39895 &'weight '& selection bias
39896 .endd
39897
39898 More details on each of these options follows:
39899
39900 .ilist
39901 .cindex authentication "to proxy"
39902 .cindex proxy authentication
39903 &%auth%&: Either &"none"& (default) or &"name"&.
39904 Using &"name"& selects username/password authentication per RFC 1929
39905 for access to the proxy.
39906 Default is &"none"&.
39907 .next
39908 &%name%&: sets the username for the &"name"& authentication method.
39909 Default is empty.
39910 .next
39911 &%pass%&: sets the password for the &"name"& authentication method.
39912 Default is empty.
39913 .next
39914 &%port%&: the TCP port number to use for the connection to the proxy.
39915 Default is 1080.
39916 .next
39917 &%tmo%&: sets a connection timeout in seconds for this proxy.
39918 Default is 5.
39919 .next
39920 &%pri%&: specifies a priority for the proxy within the list,
39921 higher values being tried first.
39922 The default priority is 1.
39923 .next
39924 &%weight%&: specifies a selection bias.
39925 Within a priority set servers are queried in a random fashion,
39926 weighted by this value.
39927 The default value for selection bias is 1.
39928 .endlist
39929
39930 Proxies from the list are tried according to their priority
39931 and weight settings until one responds.  The timeout for the
39932 overall connection applies to the set of proxied attempts.
39933
39934 .section Logging SECTproxyLog
39935 To log the (local) IP of a proxy in the incoming or delivery logline,
39936 add &"+proxy"& to the &%log_selector%& option.
39937 This will add a component tagged with &"PRX="& to the line.
39938
39939 . ////////////////////////////////////////////////////////////////////////////
39940 . ////////////////////////////////////////////////////////////////////////////
39941
39942 .chapter "Internationalisation" "CHAPi18n" &&&
39943          "Internationalisation""
39944 .cindex internationalisation "email address"
39945 .cindex EAI
39946 .cindex i18n
39947 .cindex utf8 "mail name handling"
39948
39949 Exim has support for Internationalised mail names.
39950 To include this it must be built with SUPPORT_I18N and the libidn library.
39951 Standards supported are RFCs 2060, 5890, 6530 and 6533.
39952
39953 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
39954 instead of it) then IDNA2008 is supported; this adds an extra library
39955 requirement, upon libidn2.
39956
39957 .section "MTA operations" SECTi18nMTA
39958 .cindex SMTPUTF8 "ESMTP option"
39959 The main configuration option &%smtputf8_advertise_hosts%& specifies
39960 a host list.  If this matches the sending host and
39961 accept_8bitmime is true (the default) then the ESMTP option
39962 SMTPUTF8 will be advertised.
39963
39964 If the sender specifies the SMTPUTF8 option on a MAIL command
39965 international handling for the message is enabled and
39966 the expansion variable &$message_smtputf8$& will have value TRUE.
39967
39968 The option &%allow_utf8_domains%& is set to true for this
39969 message. All DNS lookups are converted to a-label form
39970 whatever the setting of &%allow_utf8_domains%&
39971 when Exim is built with SUPPORT_I18N.
39972
39973 Both localparts and domain are maintained as the original
39974 UTF-8 form internally; any comparison or regular-expression use will
39975 require appropriate care.  Filenames created, eg. by
39976 the appendfile transport, will have UTF-8 names.
39977
39978 HELO names sent by the smtp transport will have any UTF-8
39979 components expanded to a-label form,
39980 and any certificate name checks will be done using the a-label
39981 form of the name.
39982
39983 .cindex log protocol
39984 .cindex SMTPUTF8 logging
39985 .cindex i18n logging
39986 Log lines and Received-by: header lines will acquire a "utf8"
39987 prefix on the protocol element, eg. utf8esmtp.
39988
39989 The following expansion operators can be used:
39990 .code
39991 ${utf8_domain_to_alabel:str}
39992 ${utf8_domain_from_alabel:str}
39993 ${utf8_localpart_to_alabel:str}
39994 ${utf8_localpart_from_alabel:str}
39995 .endd
39996
39997 .cindex utf8 "address downconversion"
39998 .cindex i18n "utf8 address downconversion"
39999 The RCPT ACL
40000 may use the following modifier:
40001 .display
40002 control = utf8_downconvert
40003 control = utf8_downconvert/<value>
40004 .endd
40005 This sets a flag requiring that addresses are converted to
40006 a-label form before smtp delivery, for use in a
40007 Message Submission Agent context.
40008 If a value is appended it may be:
40009 .display
40010 &`1  `& (default) mandatory downconversion
40011 &`0  `& no downconversion
40012 &`-1 `& if SMTPUTF8 not supported by destination host
40013 .endd
40014
40015 If mua_wrapper is set, the utf8_downconvert control
40016 is initially set to -1.
40017
40018 .new
40019 The smtp transport has an option &%utf8_downconvert%&.
40020 If set it must expand to one of the three values described above,
40021 and it overrides any previously set value.
40022 .wen
40023
40024
40025 There is no explicit support for VRFY and EXPN.
40026 Configurations supporting these should inspect
40027 &$smtp_command_argument$& for an SMTPUTF8 argument.
40028
40029 There is no support for LMTP on Unix sockets.
40030 Using the "lmtp" protocol option on an smtp transport,
40031 for LMTP over TCP, should work as expected.
40032
40033 There is no support for DSN unitext handling,
40034 and no provision for converting logging from or to UTF-8.
40035
40036
40037
40038 .section "MDA operations" SECTi18nMDA
40039 To aid in constructing names suitable for IMAP folders
40040 the following expansion operator can be used:
40041 .code
40042 ${imapfolder {<string>} {<sep>} {<specials>}}
40043 .endd
40044
40045 The string is converted from the charset specified by
40046 the "headers charset" command (in a filter file)
40047 or &%headers_charset%& main configuration option (otherwise),
40048 to the
40049 modified UTF-7 encoding specified by RFC 2060,
40050 with the following exception: All occurrences of <sep>
40051 (which has to be a single character)
40052 are replaced with periods ("."), and all periods and slashes that are not
40053 <sep> and are not in the <specials> string are BASE64 encoded.
40054
40055 The third argument can be omitted, defaulting to an empty string.
40056 The second argument can be omitted, defaulting to "/".
40057
40058 This is the encoding used by Courier for Maildir names on disk, and followed
40059 by many other IMAP servers.
40060
40061 Examples:
40062 .display
40063 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
40064 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
40065 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
40066 .endd
40067
40068 Note that the source charset setting is vital, and also that characters
40069 must be representable in UTF-16.
40070
40071
40072 . ////////////////////////////////////////////////////////////////////////////
40073 . ////////////////////////////////////////////////////////////////////////////
40074
40075 .chapter "Events" "CHAPevents" &&&
40076          "Events"
40077 .cindex events
40078
40079 The events mechanism in Exim can be used to intercept processing at a number
40080 of points.  It was originally invented to give a way to do customised logging
40081 actions (for example, to a database) but can also be used to modify some
40082 processing actions.
40083
40084 Most installations will never need to use Events.
40085 The support can be left out of a build by defining DISABLE_EVENT=yes
40086 in &_Local/Makefile_&.
40087
40088 There are two major classes of events: main and transport.
40089 The main configuration option &%event_action%& controls reception events;
40090 a transport option &%event_action%& controls delivery events.
40091
40092 Both options are a string which is expanded when the event fires.
40093 An example might look like:
40094 .cindex logging custom
40095 .code
40096 event_action = ${if eq {msg:delivery}{$event_name} \
40097 {${lookup pgsql {SELECT * FROM record_Delivery( \
40098     '${quote_pgsql:$sender_address_domain}',\
40099     '${quote_pgsql:${lc:$sender_address_local_part}}', \
40100     '${quote_pgsql:$domain}', \
40101     '${quote_pgsql:${lc:$local_part}}', \
40102     '${quote_pgsql:$host_address}', \
40103     '${quote_pgsql:${lc:$host}}', \
40104     '${quote_pgsql:$message_exim_id}')}} \
40105 } {}}
40106 .endd
40107
40108 Events have names which correspond to the point in process at which they fire.
40109 The name is placed in the variable &$event_name$& and the event action
40110 expansion must check this, as it will be called for every possible event type.
40111
40112 The current list of events is:
40113 .display
40114 &`dane:fail              after    transport  `& per connection
40115 &`msg:complete           after    main       `& per message
40116 &`msg:delivery           after    transport  `& per recipient
40117 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
40118 &`msg:rcpt:defer         after    transport  `& per recipient
40119 &`msg:host:defer         after    transport  `& per attempt
40120 &`msg:fail:delivery      after    transport  `& per recipient
40121 &`msg:fail:internal      after    main       `& per recipient
40122 &`tcp:connect            before   transport  `& per connection
40123 &`tcp:close              after    transport  `& per connection
40124 &`tls:cert               before   both       `& per certificate in verification chain
40125 &`smtp:connect           after    transport  `& per connection
40126 .endd
40127 New event types may be added in future.
40128
40129 The event name is a colon-separated list, defining the type of
40130 event in a tree of possibilities.  It may be used as a list
40131 or just matched on as a whole.  There will be no spaces in the name.
40132
40133 The second column in the table above describes whether the event fires
40134 before or after the action is associates with.  Those which fire before
40135 can be used to affect that action (more on this below).
40136
40137 The third column in the table above says what section of the configuration
40138 should define the event action.
40139
40140 An additional variable, &$event_data$&, is filled with information varying
40141 with the event type:
40142 .display
40143 &`dane:fail            `& failure reason
40144 &`msg:delivery         `& smtp confirmation message
40145 &`msg:fail:internal    `& failure reason
40146 &`msg:fail:delivery    `& smtp error message
40147 &`msg:rcpt:host:defer  `& error string
40148 &`msg:rcpt:defer       `& error string
40149 &`msg:host:defer       `& error string
40150 &`tls:cert             `& verification chain depth
40151 &`smtp:connect         `& smtp banner
40152 .endd
40153
40154 The :defer events populate one extra variable: &$event_defer_errno$&.
40155
40156 For complex operations an ACL expansion can be used in &%event_action%&
40157 however due to the multiple contexts that Exim operates in during
40158 the course of its processing:
40159 .ilist
40160 variables set in transport events will not be visible outside that
40161 transport call
40162 .next
40163 acl_m variables in a server context are lost on a new connection,
40164 and after smtp helo/ehlo/mail/starttls/rset commands
40165 .endlist
40166 Using an ACL expansion with the logwrite modifier can be
40167 a useful way of writing to the main log.
40168
40169 The expansion of the event_action option should normally
40170 return an empty string.  Should it return anything else the
40171 following will be forced:
40172 .display
40173 &`tcp:connect      `&  do not connect
40174 &`tls:cert         `&  refuse verification
40175 &`smtp:connect     `&  close connection
40176 .endd
40177 All other message types ignore the result string, and
40178 no other use is made of it.
40179
40180 For a tcp:connect event, if the connection is being made to a proxy
40181 then the address and port variables will be that of the proxy and not
40182 the target system.
40183
40184 For tls:cert events, if GnuTLS is in use this will trigger only per
40185 chain element received on the connection.
40186 For OpenSSL it will trigger for every chain element including those
40187 loaded locally.
40188
40189 . ////////////////////////////////////////////////////////////////////////////
40190 . ////////////////////////////////////////////////////////////////////////////
40191
40192 .chapter "Adding new drivers or lookup types" "CHID13" &&&
40193          "Adding drivers or lookups"
40194 .cindex "adding drivers"
40195 .cindex "new drivers, adding"
40196 .cindex "drivers" "adding new"
40197 The following actions have to be taken in order to add a new router, transport,
40198 authenticator, or lookup type to Exim:
40199
40200 .olist
40201 Choose a name for the driver or lookup type that does not conflict with any
40202 existing name; I will use &"newdriver"& in what follows.
40203 .next
40204 Add to &_src/EDITME_& the line:
40205 .display
40206 <&'type'&>&`_NEWDRIVER=yes`&
40207 .endd
40208 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
40209 code is not to be included in the binary by default, comment this line out. You
40210 should also add any relevant comments about the driver or lookup type.
40211 .next
40212 Add to &_src/config.h.defaults_& the line:
40213 .code
40214 #define <type>_NEWDRIVER
40215 .endd
40216 .next
40217 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
40218 and create a table entry as is done for all the other drivers and lookup types.
40219 .next
40220 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
40221 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
40222 Add your &`NEWDRIVER`& to that list.
40223 As long as the dynamic module would be named &_newdriver.so_&, you can use the
40224 simple form that most lookups have.
40225 .next
40226 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
40227 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
40228 driver or lookup type and add it to the definition of OBJ.
40229 .next
40230 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
40231 &_src_&.
40232 .next
40233 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
40234 as for other drivers and lookups.
40235 .endlist
40236
40237 Then all you need to do is write the code! A good way to start is to make a
40238 proforma by copying an existing module of the same type, globally changing all
40239 occurrences of the name, and cutting out most of the code. Note that any
40240 options you create must be listed in alphabetical order, because the tables are
40241 searched using a binary chop procedure.
40242
40243 There is a &_README_& file in each of the sub-directories of &_src_& describing
40244 the interface that is expected.
40245
40246
40247
40248
40249 . ////////////////////////////////////////////////////////////////////////////
40250 . ////////////////////////////////////////////////////////////////////////////
40251
40252 . /////////////////////////////////////////////////////////////////////////////
40253 . These lines are processing instructions for the Simple DocBook Processor that
40254 . Philip Hazel has developed as a less cumbersome way of making PostScript and
40255 . PDFs than using xmlto and fop. They will be ignored by all other XML
40256 . processors.
40257 . /////////////////////////////////////////////////////////////////////////////
40258
40259 .literal xml
40260 <?sdop
40261   format="newpage"
40262   foot_right_recto="&chaptertitle;"
40263   foot_right_verso="&chaptertitle;"
40264 ?>
40265 .literal off
40266
40267 .makeindex "Options index"   "option"
40268 .makeindex "Variables index" "variable"
40269 .makeindex "Concept index"   "concept"
40270
40271
40272 . /////////////////////////////////////////////////////////////////////////////
40273 . /////////////////////////////////////////////////////////////////////////////