Fix broken doc links and http→https where possible
[users/jgh/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 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1368 the local parts handled by the router may or must have certain prefixes and/or
1369 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1370 skipped. These conditions are tested first. When an affix is present, it is
1371 removed from the local part before further processing, including the evaluation
1372 of any other conditions.
1373 .next
1374 Routers can be designated for use only when not verifying an address, that is,
1375 only when routing it for delivery (or testing its delivery routing). If the
1376 &%verify%& option is set false, the router is skipped when Exim is verifying an
1377 address.
1378 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1379 &%verify_recipient%&, which independently control the use of the router for
1380 sender and recipient verification. You can set these options directly if
1381 you want a router to be used for only one type of verification.
1382 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1383 .next
1384 If the &%address_test%& option is set false, the router is skipped when Exim is
1385 run with the &%-bt%& option to test an address routing. This can be helpful
1386 when the first router sends all new messages to a scanner of some sort; it
1387 makes it possible to use &%-bt%& to test subsequent delivery routing without
1388 having to simulate the effect of the scanner.
1389 .next
1390 Routers can be designated for use only when verifying an address, as
1391 opposed to routing it for delivery. The &%verify_only%& option controls this.
1392 Again, cutthrough delivery counts as a verification.
1393 .next
1394 Individual routers can be explicitly skipped when running the routers to
1395 check an address given in the SMTP EXPN command (see the &%expn%& option).
1396 .next
1397 If the &%domains%& option is set, the domain of the address must be in the set
1398 of domains that it defines.
1399 .next
1400 .vindex "&$local_part_prefix$&"
1401 .vindex "&$local_part$&"
1402 .vindex "&$local_part_suffix$&"
1403 If the &%local_parts%& option is set, the local part of the address must be in
1404 the set of local parts that it defines. If &%local_part_prefix%& or
1405 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1406 part before this check. If you want to do precondition tests on local parts
1407 that include affixes, you can do so by using a &%condition%& option (see below)
1408 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1409 &$local_part_suffix$& as necessary.
1410 .next
1411 .vindex "&$local_user_uid$&"
1412 .vindex "&$local_user_gid$&"
1413 .vindex "&$home$&"
1414 If the &%check_local_user%& option is set, the local part must be the name of
1415 an account on the local host. If this check succeeds, the uid and gid of the
1416 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1417 user's home directory is placed in &$home$&; these values can be used in the
1418 remaining preconditions.
1419 .next
1420 If the &%router_home_directory%& option is set, it is expanded at this point,
1421 because it overrides the value of &$home$&. If this expansion were left till
1422 later, the value of &$home$& as set by &%check_local_user%& would be used in
1423 subsequent tests. Having two different values of &$home$& in the same router
1424 could lead to confusion.
1425 .next
1426 If the &%senders%& option is set, the envelope sender address must be in the
1427 set of addresses that it defines.
1428 .next
1429 If the &%require_files%& option is set, the existence or non-existence of
1430 specified files is tested.
1431 .next
1432 .cindex "customizing" "precondition"
1433 If the &%condition%& option is set, it is evaluated and tested. This option
1434 uses an expanded string to allow you to set up your own custom preconditions.
1435 Expanded strings are described in chapter &<<CHAPexpand>>&.
1436 .endlist
1437
1438
1439 Note that &%require_files%& comes near the end of the list, so you cannot use
1440 it to check for the existence of a file in which to lookup up a domain, local
1441 part, or sender. However, as these options are all expanded, you can use the
1442 &%exists%& expansion condition to make such tests within each condition. The
1443 &%require_files%& option is intended for checking files that the router may be
1444 going to use internally, or which are needed by a specific transport (for
1445 example, &_.procmailrc_&).
1446
1447
1448
1449 .section "Delivery in detail" "SECID18"
1450 .cindex "delivery" "in detail"
1451 When a message is to be delivered, the sequence of events is as follows:
1452
1453 .ilist
1454 If a system-wide filter file is specified, the message is passed to it. The
1455 filter may add recipients to the message, replace the recipients, discard the
1456 message, cause a new message to be generated, or cause the message delivery to
1457 fail. The format of the system filter file is the same as for Exim user filter
1458 files, described in the separate document entitled &'Exim's interfaces to mail
1459 filtering'&.
1460 .cindex "Sieve filter" "not available for system filter"
1461 (&*Note*&: Sieve cannot be used for system filter files.)
1462
1463 Some additional features are available in system filters &-- see chapter
1464 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1465 filter only once per delivery attempt, however many recipients it has. However,
1466 if there are several delivery attempts because one or more addresses could not
1467 be immediately delivered, the system filter is run each time. The filter
1468 condition &%first_delivery%& can be used to detect the first run of the system
1469 filter.
1470 .next
1471 Each recipient address is offered to each configured router in turn, subject to
1472 its preconditions, until one is able to handle it. If no router can handle the
1473 address, that is, if they all decline, the address is failed. Because routers
1474 can be targeted at particular domains, several locally handled domains can be
1475 processed entirely independently of each other.
1476 .next
1477 .cindex "routing" "loops in"
1478 .cindex "loop" "while routing"
1479 A router that accepts an address may assign it to a local or a remote
1480 transport. However, the transport is not run at this time. Instead, the address
1481 is placed on a list for the particular transport, which will be run later.
1482 Alternatively, the router may generate one or more new addresses (typically
1483 from alias, forward, or filter files). New addresses are fed back into this
1484 process from the top, but in order to avoid loops, a router ignores any address
1485 which has an identically-named ancestor that was processed by itself.
1486 .next
1487 When all the routing has been done, addresses that have been successfully
1488 handled are passed to their assigned transports. When local transports are
1489 doing real local deliveries, they handle only one address at a time, but if a
1490 local transport is being used as a pseudo-remote transport (for example, to
1491 collect batched SMTP messages for transmission by some other means) multiple
1492 addresses can be handled. Remote transports can always handle more than one
1493 address at a time, but can be configured not to do so, or to restrict multiple
1494 addresses to the same domain.
1495 .next
1496 Each local delivery to a file or a pipe runs in a separate process under a
1497 non-privileged uid, and these deliveries are run one at a time. Remote
1498 deliveries also run in separate processes, normally under a uid that is private
1499 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1500 run in parallel. The maximum number of simultaneous remote deliveries for any
1501 one message is set by the &%remote_max_parallel%& option.
1502 The order in which deliveries are done is not defined, except that all local
1503 deliveries happen before any remote deliveries.
1504 .next
1505 .cindex "queue runner"
1506 When it encounters a local delivery during a queue run, Exim checks its retry
1507 database to see if there has been a previous temporary delivery failure for the
1508 address before running the local transport. If there was a previous failure,
1509 Exim does not attempt a new delivery until the retry time for the address is
1510 reached. However, this happens only for delivery attempts that are part of a
1511 queue run. Local deliveries are always attempted when delivery immediately
1512 follows message reception, even if retry times are set for them. This makes for
1513 better behaviour if one particular message is causing problems (for example,
1514 causing quota overflow, or provoking an error in a filter file).
1515 .next
1516 .cindex "delivery" "retry in remote transports"
1517 Remote transports do their own retry handling, since an address may be
1518 deliverable to one of a number of hosts, each of which may have a different
1519 retry time. If there have been previous temporary failures and no host has
1520 reached its retry time, no delivery is attempted, whether in a queue run or
1521 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1522 .next
1523 If there were any permanent errors, a bounce message is returned to an
1524 appropriate address (the sender in the common case), with details of the error
1525 for each failing address. Exim can be configured to send copies of bounce
1526 messages to other addresses.
1527 .next
1528 .cindex "delivery" "deferral"
1529 If one or more addresses suffered a temporary failure, the message is left on
1530 the queue, to be tried again later. Delivery of these addresses is said to be
1531 &'deferred'&.
1532 .next
1533 When all the recipient addresses have either been delivered or bounced,
1534 handling of the message is complete. The spool files and message log are
1535 deleted, though the message log can optionally be preserved if required.
1536 .endlist
1537
1538
1539
1540
1541 .section "Retry mechanism" "SECID19"
1542 .cindex "delivery" "retry mechanism"
1543 .cindex "retry" "description of mechanism"
1544 .cindex "queue runner"
1545 Exim's mechanism for retrying messages that fail to get delivered at the first
1546 attempt is the queue runner process. You must either run an Exim daemon that
1547 uses the &%-q%& option with a time interval to start queue runners at regular
1548 intervals, or use some other means (such as &'cron'&) to start them. If you do
1549 not arrange for queue runners to be run, messages that fail temporarily at the
1550 first attempt will remain on your queue for ever. A queue runner process works
1551 its way through the queue, one message at a time, trying each delivery that has
1552 passed its retry time.
1553 You can run several queue runners at once.
1554
1555 Exim uses a set of configured rules to determine when next to retry the failing
1556 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1557 should give up trying to deliver to the address, at which point it generates a
1558 bounce message. If no retry rules are set for a particular host, address, and
1559 error combination, no retries are attempted, and temporary errors are treated
1560 as permanent.
1561
1562
1563
1564 .section "Temporary delivery failure" "SECID20"
1565 .cindex "delivery" "temporary failure"
1566 There are many reasons why a message may not be immediately deliverable to a
1567 particular address. Failure to connect to a remote machine (because it, or the
1568 connection to it, is down) is one of the most common. Temporary failures may be
1569 detected during routing as well as during the transport stage of delivery.
1570 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1571 is on a file system where the user is over quota. Exim can be configured to
1572 impose its own quotas on local mailboxes; where system quotas are set they will
1573 also apply.
1574
1575 If a host is unreachable for a period of time, a number of messages may be
1576 waiting for it by the time it recovers, and sending them in a single SMTP
1577 connection is clearly beneficial. Whenever a delivery to a remote host is
1578 deferred,
1579 .cindex "hints database" "deferred deliveries"
1580 Exim makes a note in its hints database, and whenever a successful
1581 SMTP delivery has happened, it looks to see if any other messages are waiting
1582 for the same host. If any are found, they are sent over the same SMTP
1583 connection, subject to a configuration limit as to the maximum number in any
1584 one connection.
1585
1586
1587
1588 .section "Permanent delivery failure" "SECID21"
1589 .cindex "delivery" "permanent failure"
1590 .cindex "bounce message" "when generated"
1591 When a message cannot be delivered to some or all of its intended recipients, a
1592 bounce message is generated. Temporary delivery failures turn into permanent
1593 errors when their timeout expires. All the addresses that fail in a given
1594 delivery attempt are listed in a single message. If the original message has
1595 many recipients, it is possible for some addresses to fail in one delivery
1596 attempt and others to fail subsequently, giving rise to more than one bounce
1597 message. The wording of bounce messages can be customized by the administrator.
1598 See chapter &<<CHAPemsgcust>>& for details.
1599
1600 .cindex "&'X-Failed-Recipients:'& header line"
1601 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1602 failed addresses, for the benefit of programs that try to analyse such messages
1603 automatically.
1604
1605 .cindex "bounce message" "recipient of"
1606 A bounce message is normally sent to the sender of the original message, as
1607 obtained from the message's envelope. For incoming SMTP messages, this is the
1608 address given in the MAIL command. However, when an address is expanded via a
1609 forward or alias file, an alternative address can be specified for delivery
1610 failures of the generated addresses. For a mailing list expansion (see section
1611 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1612 of the list.
1613
1614
1615
1616 .section "Failures to deliver bounce messages" "SECID22"
1617 .cindex "bounce message" "failure to deliver"
1618 If a bounce message (either locally generated or received from a remote host)
1619 itself suffers a permanent delivery failure, the message is left on the queue,
1620 but it is frozen, awaiting the attention of an administrator. There are options
1621 that can be used to make Exim discard such failed messages, or to keep them
1622 for only a short time (see &%timeout_frozen_after%& and
1623 &%ignore_bounce_errors_after%&).
1624
1625
1626
1627
1628
1629 . ////////////////////////////////////////////////////////////////////////////
1630 . ////////////////////////////////////////////////////////////////////////////
1631
1632 .chapter "Building and installing Exim" "CHID3"
1633 .scindex IIDbuex "building Exim"
1634
1635 .section "Unpacking" "SECID23"
1636 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1637 creates a directory with the name of the current release (for example,
1638 &_exim-&version()_&) into which the following files are placed:
1639
1640 .table2 140pt
1641 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1642 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1643   documented"
1644 .irow &_LICENCE_&         "the GNU General Public Licence"
1645 .irow &_Makefile_&        "top-level make file"
1646 .irow &_NOTICE_&          "conditions for the use of Exim"
1647 .irow &_README_&          "list of files, directories and simple build &&&
1648   instructions"
1649 .endtable
1650
1651 Other files whose names begin with &_README_& may also be present. The
1652 following subdirectories are created:
1653
1654 .table2 140pt
1655 .irow &_Local_&           "an empty directory for local configuration files"
1656 .irow &_OS_&              "OS-specific files"
1657 .irow &_doc_&             "documentation files"
1658 .irow &_exim_monitor_&    "source files for the Exim monitor"
1659 .irow &_scripts_&         "scripts used in the build process"
1660 .irow &_src_&             "remaining source files"
1661 .irow &_util_&            "independent utilities"
1662 .endtable
1663
1664 The main utility programs are contained in the &_src_& directory, and are built
1665 with the Exim binary. The &_util_& directory contains a few optional scripts
1666 that may be useful to some sites.
1667
1668
1669 .section "Multiple machine architectures and operating systems" "SECID24"
1670 .cindex "building Exim" "multiple OS/architectures"
1671 The building process for Exim is arranged to make it easy to build binaries for
1672 a number of different architectures and operating systems from the same set of
1673 source files. Compilation does not take place in the &_src_& directory.
1674 Instead, a &'build directory'& is created for each architecture and operating
1675 system.
1676 .cindex "symbolic link" "to build directory"
1677 Symbolic links to the sources are installed in this directory, which is where
1678 the actual building takes place. In most cases, Exim can discover the machine
1679 architecture and operating system for itself, but the defaults can be
1680 overridden if necessary.
1681 .cindex compiler requirements
1682 .cindex compiler version
1683 A C99-capable compiler will be required for the build.
1684
1685
1686 .section "PCRE library" "SECTpcre"
1687 .cindex "PCRE library"
1688 Exim no longer has an embedded PCRE library as the vast majority of
1689 modern systems include PCRE as a system library, although you may need
1690 to install the PCRE or PCRE development package for your operating
1691 system. If your system has a normal PCRE installation the Exim build
1692 process will need no further configuration. If the library or the
1693 headers are in an unusual location you will need to either set the PCRE_LIBS
1694 and INCLUDE directives appropriately,
1695 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1696 If your operating system has no
1697 PCRE support then you will need to obtain and build the current PCRE
1698 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1699 More information on PCRE is available at &url(https://www.pcre.org/).
1700
1701 .section "DBM libraries" "SECTdb"
1702 .cindex "DBM libraries" "discussion of"
1703 .cindex "hints database" "DBM files used for"
1704 Even if you do not use any DBM files in your configuration, Exim still needs a
1705 DBM library in order to operate, because it uses indexed files for its hints
1706 databases. Unfortunately, there are a number of DBM libraries in existence, and
1707 different operating systems often have different ones installed.
1708
1709 .cindex "Solaris" "DBM library for"
1710 .cindex "IRIX, DBM library for"
1711 .cindex "BSD, DBM library for"
1712 .cindex "Linux, DBM library for"
1713 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1714 Linux distribution, the DBM configuration should happen automatically, and you
1715 may be able to ignore this section. Otherwise, you may have to learn more than
1716 you would like about DBM libraries from what follows.
1717
1718 .cindex "&'ndbm'& DBM library"
1719 Licensed versions of Unix normally contain a library of DBM functions operating
1720 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1721 versions of Unix seem to vary in what they contain as standard. In particular,
1722 some early versions of Linux have no default DBM library, and different
1723 distributors have chosen to bundle different libraries with their packaged
1724 versions. However, the more recent releases seem to have standardized on the
1725 Berkeley DB library.
1726
1727 Different DBM libraries have different conventions for naming the files they
1728 use. When a program opens a file called &_dbmfile_&, there are several
1729 possibilities:
1730
1731 .olist
1732 A traditional &'ndbm'& implementation, such as that supplied as part of
1733 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1734 .next
1735 .cindex "&'gdbm'& DBM library"
1736 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1737 compatibility interface it makes two different hard links to it with names
1738 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1739 file name is used unmodified.
1740 .next
1741 .cindex "Berkeley DB library"
1742 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1743 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1744 programmer exactly the same as the traditional &'ndbm'& implementation.
1745 .next
1746 If the Berkeley package is used in its native mode, it operates on a single
1747 file called &_dbmfile_&; the programmer's interface is somewhat different to
1748 the traditional &'ndbm'& interface.
1749 .next
1750 To complicate things further, there are several very different versions of the
1751 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1752 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1753 Maintenance of some of the earlier releases has ceased. All versions of
1754 Berkeley DB could be obtained from
1755 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1756 page with far newer versions listed.
1757 It is probably wise to plan to move your storage configurations away from
1758 Berkeley DB format, as today there are smaller and simpler alternatives more
1759 suited to Exim's usage model.
1760 .next
1761 .cindex "&'tdb'& DBM library"
1762 Yet another DBM library, called &'tdb'&, is available from
1763 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1764 operates on a single file.
1765 .endlist
1766
1767 .cindex "USE_DB"
1768 .cindex "DBM libraries" "configuration for building"
1769 Exim and its utilities can be compiled to use any of these interfaces. In order
1770 to use any version of the Berkeley DB package in native mode, you must set
1771 USE_DB in an appropriate configuration file (typically
1772 &_Local/Makefile_&). For example:
1773 .code
1774 USE_DB=yes
1775 .endd
1776 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1777 error is diagnosed if you set more than one of these.
1778
1779 At the lowest level, the build-time configuration sets none of these options,
1780 thereby assuming an interface of type (1). However, some operating system
1781 configuration files (for example, those for the BSD operating systems and
1782 Linux) assume type (4) by setting USE_DB as their default, and the
1783 configuration files for Cygwin set USE_GDBM. Anything you set in
1784 &_Local/Makefile_&, however, overrides these system defaults.
1785
1786 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1787 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1788 in one of these lines:
1789 .code
1790 DBMLIB = -ldb
1791 DBMLIB = -ltdb
1792 .endd
1793 Settings like that will work if the DBM library is installed in the standard
1794 place. Sometimes it is not, and the library's header file may also not be in
1795 the default path. You may need to set INCLUDE to specify where the header
1796 file is, and to specify the path to the library more fully in DBMLIB, as in
1797 this example:
1798 .code
1799 INCLUDE=-I/usr/local/include/db-4.1
1800 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1801 .endd
1802 There is further detailed discussion about the various DBM libraries in the
1803 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1804
1805
1806
1807 .section "Pre-building configuration" "SECID25"
1808 .cindex "building Exim" "pre-building configuration"
1809 .cindex "configuration for building Exim"
1810 .cindex "&_Local/Makefile_&"
1811 .cindex "&_src/EDITME_&"
1812 Before building Exim, a local configuration file that specifies options
1813 independent of any operating system has to be created with the name
1814 &_Local/Makefile_&. A template for this file is supplied as the file
1815 &_src/EDITME_&, and it contains full descriptions of all the option settings
1816 therein. These descriptions are therefore not repeated here. If you are
1817 building Exim for the first time, the simplest thing to do is to copy
1818 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1819
1820 There are three settings that you must supply, because Exim will not build
1821 without them. They are the location of the run time configuration file
1822 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1823 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1824 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1825 a colon-separated list of file names; Exim uses the first of them that exists.
1826
1827 There are a few other parameters that can be specified either at build time or
1828 at run time, to enable the same binary to be used on a number of different
1829 machines. However, if the locations of Exim's spool directory and log file
1830 directory (if not within the spool directory) are fixed, it is recommended that
1831 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1832 detected early in Exim's execution (such as a malformed configuration file) can
1833 be logged.
1834
1835 .cindex "content scanning" "specifying at build time"
1836 Exim's interfaces for calling virus and spam scanning software directly from
1837 access control lists are not compiled by default. If you want to include these
1838 facilities, you need to set
1839 .code
1840 WITH_CONTENT_SCAN=yes
1841 .endd
1842 in your &_Local/Makefile_&. For details of the facilities themselves, see
1843 chapter &<<CHAPexiscan>>&.
1844
1845
1846 .cindex "&_Local/eximon.conf_&"
1847 .cindex "&_exim_monitor/EDITME_&"
1848 If you are going to build the Exim monitor, a similar configuration process is
1849 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1850 your installation and saved under the name &_Local/eximon.conf_&. If you are
1851 happy with the default settings described in &_exim_monitor/EDITME_&,
1852 &_Local/eximon.conf_& can be empty, but it must exist.
1853
1854 This is all the configuration that is needed in straightforward cases for known
1855 operating systems. However, the building process is set up so that it is easy
1856 to override options that are set by default or by operating-system-specific
1857 configuration files, for example to change the name of the C compiler, which
1858 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1859 do this.
1860
1861
1862
1863 .section "Support for iconv()" "SECID26"
1864 .cindex "&[iconv()]& support"
1865 .cindex "RFC 2047"
1866 The contents of header lines in messages may be encoded according to the rules
1867 described RFC 2047. This makes it possible to transmit characters that are not
1868 in the ASCII character set, and to label them as being in a particular
1869 character set. When Exim is inspecting header lines by means of the &%$h_%&
1870 mechanism, it decodes them, and translates them into a specified character set
1871 (default is set at build time). The translation is possible only if the operating system
1872 supports the &[iconv()]& function.
1873
1874 However, some of the operating systems that supply &[iconv()]& do not support
1875 very many conversions. The GNU &%libiconv%& library (available from
1876 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1877 systems to remedy this deficiency, as well as on systems that do not supply
1878 &[iconv()]& at all. After installing &%libiconv%&, you should add
1879 .code
1880 HAVE_ICONV=yes
1881 .endd
1882 to your &_Local/Makefile_& and rebuild Exim.
1883
1884
1885
1886 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1887 .cindex "TLS" "including support for TLS"
1888 .cindex "encryption" "including support for"
1889 .cindex "SUPPORT_TLS"
1890 .cindex "OpenSSL" "building Exim with"
1891 .cindex "GnuTLS" "building Exim with"
1892 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1893 command as per RFC 2487. It can also support legacy clients that expect to
1894 start a TLS session immediately on connection to a non-standard port (see the
1895 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1896 line option).
1897
1898 If you want to build Exim with TLS support, you must first install either the
1899 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1900 implementing SSL.
1901
1902 If OpenSSL is installed, you should set
1903 .code
1904 SUPPORT_TLS=yes
1905 TLS_LIBS=-lssl -lcrypto
1906 .endd
1907 in &_Local/Makefile_&. You may also need to specify the locations of the
1908 OpenSSL library and include files. For example:
1909 .code
1910 SUPPORT_TLS=yes
1911 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1912 TLS_INCLUDE=-I/usr/local/openssl/include/
1913 .endd
1914 .cindex "pkg-config" "OpenSSL"
1915 If you have &'pkg-config'& available, then instead you can just use:
1916 .code
1917 SUPPORT_TLS=yes
1918 USE_OPENSSL_PC=openssl
1919 .endd
1920 .cindex "USE_GNUTLS"
1921 If GnuTLS is installed, you should set
1922 .code
1923 SUPPORT_TLS=yes
1924 USE_GNUTLS=yes
1925 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1926 .endd
1927 in &_Local/Makefile_&, and again you may need to specify the locations of the
1928 library and include files. For example:
1929 .code
1930 SUPPORT_TLS=yes
1931 USE_GNUTLS=yes
1932 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1933 TLS_INCLUDE=-I/usr/gnu/include
1934 .endd
1935 .cindex "pkg-config" "GnuTLS"
1936 If you have &'pkg-config'& available, then instead you can just use:
1937 .code
1938 SUPPORT_TLS=yes
1939 USE_GNUTLS=yes
1940 USE_GNUTLS_PC=gnutls
1941 .endd
1942
1943 You do not need to set TLS_INCLUDE if the relevant directory is already
1944 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1945 given in chapter &<<CHAPTLS>>&.
1946
1947
1948
1949
1950 .section "Use of tcpwrappers" "SECID27"
1951
1952 .cindex "tcpwrappers, building Exim to support"
1953 .cindex "USE_TCP_WRAPPERS"
1954 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1955 .cindex "tcp_wrappers_daemon_name"
1956 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1957 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1958 alternative to Exim's own checking facilities for installations that are
1959 already making use of &'tcpwrappers'& for other purposes. To do this, you
1960 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1961 &_tcpd.h_& to be available at compile time, and also ensure that the library
1962 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1963 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1964 you might have
1965 .code
1966 USE_TCP_WRAPPERS=yes
1967 CFLAGS=-O -I/usr/local/include
1968 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1969 .endd
1970 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1971 files is &"exim"&. For example, the line
1972 .code
1973 exim : LOCAL  192.168.1.  .friendly.domain.example
1974 .endd
1975 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1976 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1977 All other connections are denied. The daemon name used by &'tcpwrappers'&
1978 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1979 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1980 configure file. Consult the &'tcpwrappers'& documentation for
1981 further details.
1982
1983
1984 .section "Including support for IPv6" "SECID28"
1985 .cindex "IPv6" "including support for"
1986 Exim contains code for use on systems that have IPv6 support. Setting
1987 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1988 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1989 where the IPv6 support is not fully integrated into the normal include and
1990 library files.
1991
1992 Two different types of DNS record for handling IPv6 addresses have been
1993 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1994 currently seen as the mainstream. Another record type called A6 was proposed
1995 as better than AAAA because it had more flexibility. However, it was felt to be
1996 over-complex, and its status was reduced to &"experimental"&.
1997 Exim used to
1998 have a compile option for including A6 record support but this has now been
1999 withdrawn.
2000
2001
2002
2003 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2004 .cindex "lookup modules"
2005 .cindex "dynamic modules"
2006 .cindex ".so building"
2007 On some platforms, Exim supports not compiling all lookup types directly into
2008 the main binary, instead putting some into external modules which can be loaded
2009 on demand.
2010 This permits packagers to build Exim with support for lookups with extensive
2011 library dependencies without requiring all users to install all of those
2012 dependencies.
2013 Most, but not all, lookup types can be built this way.
2014
2015 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2016 installed; Exim will only load modules from that directory, as a security
2017 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2018 for your OS; see &_OS/Makefile-Linux_& for an example.
2019 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2020 see &_src/EDITME_& for details.
2021
2022 Then, for each module to be loaded dynamically, define the relevant
2023 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2024 For example, this will build in lsearch but load sqlite and mysql support
2025 on demand:
2026 .code
2027 LOOKUP_LSEARCH=yes
2028 LOOKUP_SQLITE=2
2029 LOOKUP_MYSQL=2
2030 .endd
2031
2032
2033 .section "The building process" "SECID29"
2034 .cindex "build directory"
2035 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2036 created, run &'make'& at the top level. It determines the architecture and
2037 operating system types, and creates a build directory if one does not exist.
2038 For example, on a Sun system running Solaris 8, the directory
2039 &_build-SunOS5-5.8-sparc_& is created.
2040 .cindex "symbolic link" "to source files"
2041 Symbolic links to relevant source files are installed in the build directory.
2042
2043 If this is the first time &'make'& has been run, it calls a script that builds
2044 a make file inside the build directory, using the configuration files from the
2045 &_Local_& directory. The new make file is then passed to another instance of
2046 &'make'&. This does the real work, building a number of utility scripts, and
2047 then compiling and linking the binaries for the Exim monitor (if configured), a
2048 number of utility programs, and finally Exim itself. The command &`make
2049 makefile`& can be used to force a rebuild of the make file in the build
2050 directory, should this ever be necessary.
2051
2052 If you have problems building Exim, check for any comments there may be in the
2053 &_README_& file concerning your operating system, and also take a look at the
2054 FAQ, where some common problems are covered.
2055
2056
2057
2058 .section 'Output from &"make"&' "SECID283"
2059 The output produced by the &'make'& process for compile lines is often very
2060 unreadable, because these lines can be very long. For this reason, the normal
2061 output is suppressed by default, and instead output similar to that which
2062 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2063 each module that is being compiled or linked. However, it is still possible to
2064 get the full output, by calling &'make'& like this:
2065 .code
2066 FULLECHO='' make -e
2067 .endd
2068 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2069 command reflection in &'make'&. When you ask for the full output, it is
2070 given in addition to the short output.
2071
2072
2073
2074 .section "Overriding build-time options for Exim" "SECToverride"
2075 .cindex "build-time options, overriding"
2076 The main make file that is created at the beginning of the building process
2077 consists of the concatenation of a number of files which set configuration
2078 values, followed by a fixed set of &'make'& instructions. If a value is set
2079 more than once, the last setting overrides any previous ones. This provides a
2080 convenient way of overriding defaults. The files that are concatenated are, in
2081 order:
2082 .display
2083 &_OS/Makefile-Default_&
2084 &_OS/Makefile-_&<&'ostype'&>
2085 &_Local/Makefile_&
2086 &_Local/Makefile-_&<&'ostype'&>
2087 &_Local/Makefile-_&<&'archtype'&>
2088 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2089 &_OS/Makefile-Base_&
2090 .endd
2091 .cindex "&_Local/Makefile_&"
2092 .cindex "building Exim" "operating system type"
2093 .cindex "building Exim" "architecture type"
2094 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2095 architecture type. &_Local/Makefile_& is required to exist, and the building
2096 process fails if it is absent. The other three &_Local_& files are optional,
2097 and are often not needed.
2098
2099 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2100 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2101 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2102 values are used, thereby providing a means of forcing particular settings.
2103 Otherwise, the scripts try to get values from the &%uname%& command. If this
2104 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2105 of &'ad hoc'& transformations are then applied, to produce the standard names
2106 that Exim expects. You can run these scripts directly from the shell in order
2107 to find out what values are being used on your system.
2108
2109
2110 &_OS/Makefile-Default_& contains comments about the variables that are set
2111 therein. Some (but not all) are mentioned below. If there is something that
2112 needs changing, review the contents of this file and the contents of the make
2113 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2114 default values are.
2115
2116
2117 .cindex "building Exim" "overriding default settings"
2118 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2119 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2120 need to change the original files. Instead, you should make the changes by
2121 putting the new values in an appropriate &_Local_& file. For example,
2122 .cindex "Tru64-Unix build-time settings"
2123 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2124 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2125 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2126 called with the option &%-std1%&, to make it recognize some of the features of
2127 Standard C that Exim uses. (Most other compilers recognize Standard C by
2128 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2129 containing the lines
2130 .code
2131 CC=cc
2132 CFLAGS=-std1
2133 .endd
2134 If you are compiling for just one operating system, it may be easier to put
2135 these lines directly into &_Local/Makefile_&.
2136
2137 Keeping all your local configuration settings separate from the distributed
2138 files makes it easy to transfer them to new versions of Exim simply by copying
2139 the contents of the &_Local_& directory.
2140
2141
2142 .cindex "NIS lookup type" "including support for"
2143 .cindex "NIS+ lookup type" "including support for"
2144 .cindex "LDAP" "including support for"
2145 .cindex "lookup" "inclusion in binary"
2146 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2147 lookup, but not all systems have these components installed, so the default is
2148 not to include the relevant code in the binary. All the different kinds of file
2149 and database lookup that Exim supports are implemented as separate code modules
2150 which are included only if the relevant compile-time options are set. In the
2151 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2152 .code
2153 LOOKUP_LDAP=yes
2154 LOOKUP_NIS=yes
2155 LOOKUP_NISPLUS=yes
2156 .endd
2157 and similar settings apply to the other lookup types. They are all listed in
2158 &_src/EDITME_&. In many cases the relevant include files and interface
2159 libraries need to be installed before compiling Exim.
2160 .cindex "cdb" "including support for"
2161 However, there are some optional lookup types (such as cdb) for which
2162 the code is entirely contained within Exim, and no external include
2163 files or libraries are required. When a lookup type is not included in the
2164 binary, attempts to configure Exim to use it cause run time configuration
2165 errors.
2166
2167 .cindex "pkg-config" "lookups"
2168 .cindex "pkg-config" "authenticators"
2169 Many systems now use a tool called &'pkg-config'& to encapsulate information
2170 about how to compile against a library; Exim has some initial support for
2171 being able to use pkg-config for lookups and authenticators.  For any given
2172 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2173 variable with the &`_PC`& suffix in the name and assign as the value the
2174 name of the package to be queried.  The results of querying via the
2175 &'pkg-config'& command will be added to the appropriate Makefile variables
2176 with &`+=`& directives, so your version of &'make'& will need to support that
2177 syntax.  For instance:
2178 .code
2179 LOOKUP_SQLITE=yes
2180 LOOKUP_SQLITE_PC=sqlite3
2181 AUTH_GSASL=yes
2182 AUTH_GSASL_PC=libgsasl
2183 AUTH_HEIMDAL_GSSAPI=yes
2184 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2185 .endd
2186
2187 .cindex "Perl" "including support for"
2188 Exim can be linked with an embedded Perl interpreter, allowing Perl
2189 subroutines to be called during string expansion. To enable this facility,
2190 .code
2191 EXIM_PERL=perl.o
2192 .endd
2193 must be defined in &_Local/Makefile_&. Details of this facility are given in
2194 chapter &<<CHAPperl>>&.
2195
2196 .cindex "X11 libraries, location of"
2197 The location of the X11 libraries is something that varies a lot between
2198 operating systems, and there may be different versions of X11 to cope
2199 with. Exim itself makes no use of X11, but if you are compiling the Exim
2200 monitor, the X11 libraries must be available.
2201 The following three variables are set in &_OS/Makefile-Default_&:
2202 .code
2203 X11=/usr/X11R6
2204 XINCLUDE=-I$(X11)/include
2205 XLFLAGS=-L$(X11)/lib
2206 .endd
2207 These are overridden in some of the operating-system configuration files. For
2208 example, in &_OS/Makefile-SunOS5_& there is
2209 .code
2210 X11=/usr/openwin
2211 XINCLUDE=-I$(X11)/include
2212 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2213 .endd
2214 If you need to override the default setting for your operating system, place a
2215 definition of all three of these variables into your
2216 &_Local/Makefile-<ostype>_& file.
2217
2218 .cindex "EXTRALIBS"
2219 If you need to add any extra libraries to the link steps, these can be put in a
2220 variable called EXTRALIBS, which appears in all the link commands, but by
2221 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2222 command for linking the main Exim binary, and not for any associated utilities.
2223
2224 .cindex "DBM libraries" "configuration for building"
2225 There is also DBMLIB, which appears in the link commands for binaries that
2226 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2227 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2228 binary, and which can be used, for example, to include additional X11
2229 libraries.
2230
2231 .cindex "configuration file" "editing"
2232 The make file copes with rebuilding Exim correctly if any of the configuration
2233 files are edited. However, if an optional configuration file is deleted, it is
2234 necessary to touch the associated non-optional file (that is,
2235 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2236
2237
2238 .section "OS-specific header files" "SECID30"
2239 .cindex "&_os.h_&"
2240 .cindex "building Exim" "OS-specific C header files"
2241 The &_OS_& directory contains a number of files with names of the form
2242 &_os.h-<ostype>_&. These are system-specific C header files that should not
2243 normally need to be changed. There is a list of macro settings that are
2244 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2245 are porting Exim to a new operating system.
2246
2247
2248
2249 .section "Overriding build-time options for the monitor" "SECID31"
2250 .cindex "building Eximon"
2251 A similar process is used for overriding things when building the Exim monitor,
2252 where the files that are involved are
2253 .display
2254 &_OS/eximon.conf-Default_&
2255 &_OS/eximon.conf-_&<&'ostype'&>
2256 &_Local/eximon.conf_&
2257 &_Local/eximon.conf-_&<&'ostype'&>
2258 &_Local/eximon.conf-_&<&'archtype'&>
2259 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2260 .endd
2261 .cindex "&_Local/eximon.conf_&"
2262 As with Exim itself, the final three files need not exist, and in this case the
2263 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2264 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2265 variables of the same name, preceded by EXIMON_. For example, setting
2266 EXIMON_LOG_DEPTH in the environment overrides the value of
2267 LOG_DEPTH at run time.
2268 .ecindex IIDbuex
2269
2270
2271 .section "Installing Exim binaries and scripts" "SECID32"
2272 .cindex "installing Exim"
2273 .cindex "BIN_DIRECTORY"
2274 The command &`make install`& runs the &(exim_install)& script with no
2275 arguments. The script copies binaries and utility scripts into the directory
2276 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2277 .cindex "setuid" "installing Exim with"
2278 The install script copies files only if they are newer than the files they are
2279 going to replace. The Exim binary is required to be owned by root and have the
2280 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2281 install`& as root so that it can set up the Exim binary in this way. However, in
2282 some special situations (for example, if a host is doing no local deliveries)
2283 it may be possible to run Exim without making the binary setuid root (see
2284 chapter &<<CHAPsecurity>>& for details).
2285
2286 .cindex "CONFIGURE_FILE"
2287 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2288 in &_Local/Makefile_&. If this names a single file, and the file does not
2289 exist, the default configuration file &_src/configure.default_& is copied there
2290 by the installation script. If a run time configuration file already exists, it
2291 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2292 alternative files, no default is installed.
2293
2294 .cindex "system aliases file"
2295 .cindex "&_/etc/aliases_&"
2296 One change is made to the default configuration file when it is installed: the
2297 default configuration contains a router that references a system aliases file.
2298 The path to this file is set to the value specified by
2299 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2300 If the system aliases file does not exist, the installation script creates it,
2301 and outputs a comment to the user.
2302
2303 The created file contains no aliases, but it does contain comments about the
2304 aliases a site should normally have. Mail aliases have traditionally been
2305 kept in &_/etc/aliases_&. However, some operating systems are now using
2306 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2307 Exim's configuration if necessary.
2308
2309 The default configuration uses the local host's name as the only local domain,
2310 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2311 running as the local user. System aliases and &_.forward_& files in users' home
2312 directories are supported, but no NIS or NIS+ support is configured. Domains
2313 other than the name of the local host are routed using the DNS, with delivery
2314 over SMTP.
2315
2316 It is possible to install Exim for special purposes (such as building a binary
2317 distribution) in a private part of the file system. You can do this by a
2318 command such as
2319 .code
2320 make DESTDIR=/some/directory/ install
2321 .endd
2322 This has the effect of pre-pending the specified directory to all the file
2323 paths, except the name of the system aliases file that appears in the default
2324 configuration. (If a default alias file is created, its name &'is'& modified.)
2325 For backwards compatibility, ROOT is used if DESTDIR is not set,
2326 but this usage is deprecated.
2327
2328 .cindex "installing Exim" "what is not installed"
2329 Running &'make install'& does not copy the Exim 4 conversion script
2330 &'convert4r4'&. You will probably run this only once if you are
2331 upgrading from Exim 3. None of the documentation files in the &_doc_&
2332 directory are copied, except for the info files when you have set
2333 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2334
2335 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2336 to their names. The Exim binary itself, however, is handled differently. It is
2337 installed under a name that includes the version number and the compile number,
2338 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2339 called &_exim_& to point to the binary. If you are updating a previous version
2340 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2341 from the directory (as seen by other processes).
2342
2343 .cindex "installing Exim" "testing the script"
2344 If you want to see what the &'make install'& will do before running it for
2345 real, you can pass the &%-n%& option to the installation script by this
2346 command:
2347 .code
2348 make INSTALL_ARG=-n install
2349 .endd
2350 The contents of the variable INSTALL_ARG are passed to the installation
2351 script. You do not need to be root to run this test. Alternatively, you can run
2352 the installation script directly, but this must be from within the build
2353 directory. For example, from the top-level Exim directory you could use this
2354 command:
2355 .code
2356 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2357 .endd
2358 .cindex "installing Exim" "install script options"
2359 There are two other options that can be supplied to the installation script.
2360
2361 .ilist
2362 &%-no_chown%& bypasses the call to change the owner of the installed binary
2363 to root, and the call to make it a setuid binary.
2364 .next
2365 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2366 installed binary.
2367 .endlist
2368
2369 INSTALL_ARG can be used to pass these options to the script. For example:
2370 .code
2371 make INSTALL_ARG=-no_symlink install
2372 .endd
2373 The installation script can also be given arguments specifying which files are
2374 to be copied. For example, to install just the Exim binary, and nothing else,
2375 without creating the symbolic link, you could use:
2376 .code
2377 make INSTALL_ARG='-no_symlink exim' install
2378 .endd
2379
2380
2381
2382 .section "Installing info documentation" "SECTinsinfdoc"
2383 .cindex "installing Exim" "&'info'& documentation"
2384 Not all systems use the GNU &'info'& system for documentation, and for this
2385 reason, the Texinfo source of Exim's documentation is not included in the main
2386 distribution. Instead it is available separately from the ftp site (see section
2387 &<<SECTavail>>&).
2388
2389 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2390 source of the documentation is found in the source tree, running &`make
2391 install`& automatically builds the info files and installs them.
2392
2393
2394
2395 .section "Setting up the spool directory" "SECID33"
2396 .cindex "spool directory" "creating"
2397 When it starts up, Exim tries to create its spool directory if it does not
2398 exist. The Exim uid and gid are used for the owner and group of the spool
2399 directory. Sub-directories are automatically created in the spool directory as
2400 necessary.
2401
2402
2403
2404
2405 .section "Testing" "SECID34"
2406 .cindex "testing" "installation"
2407 Having installed Exim, you can check that the run time configuration file is
2408 syntactically valid by running the following command, which assumes that the
2409 Exim binary directory is within your PATH environment variable:
2410 .code
2411 exim -bV
2412 .endd
2413 If there are any errors in the configuration file, Exim outputs error messages.
2414 Otherwise it outputs the version number and build date,
2415 the DBM library that is being used, and information about which drivers and
2416 other optional code modules are included in the binary.
2417 Some simple routing tests can be done by using the address testing option. For
2418 example,
2419 .display
2420 &`exim -bt`& <&'local username'&>
2421 .endd
2422 should verify that it recognizes a local mailbox, and
2423 .display
2424 &`exim -bt`& <&'remote address'&>
2425 .endd
2426 a remote one. Then try getting it to deliver mail, both locally and remotely.
2427 This can be done by passing messages directly to Exim, without going through a
2428 user agent. For example:
2429 .code
2430 exim -v postmaster@your.domain.example
2431 From: user@your.domain.example
2432 To: postmaster@your.domain.example
2433 Subject: Testing Exim
2434
2435 This is a test message.
2436 ^D
2437 .endd
2438 The &%-v%& option causes Exim to output some verification of what it is doing.
2439 In this case you should see copies of three log lines, one for the message's
2440 arrival, one for its delivery, and one containing &"Completed"&.
2441
2442 .cindex "delivery" "problems with"
2443 If you encounter problems, look at Exim's log files (&'mainlog'& and
2444 &'paniclog'&) to see if there is any relevant information there. Another source
2445 of information is running Exim with debugging turned on, by specifying the
2446 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2447 with debugging turned on by a command of the form
2448 .display
2449 &`exim -d -M`& <&'exim-message-id'&>
2450 .endd
2451 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2452 produces rather a lot of output, but you can cut this down to specific areas.
2453 For example, if you use &%-d-all+route%& only the debugging information
2454 relevant to routing is included. (See the &%-d%& option in chapter
2455 &<<CHAPcommandline>>& for more details.)
2456
2457 .cindex '&"sticky"& bit'
2458 .cindex "lock files"
2459 One specific problem that has shown up on some sites is the inability to do
2460 local deliveries into a shared mailbox directory, because it does not have the
2461 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2462 writing to a mailbox file, and if it cannot create the lock file, the delivery
2463 is deferred. You can get round this either by setting the &"sticky bit"& on the
2464 directory, or by setting a specific group for local deliveries and allowing
2465 that group to create files in the directory (see the comments above the
2466 &(local_delivery)& transport in the default configuration file). Another
2467 approach is to configure Exim not to use lock files, but just to rely on
2468 &[fcntl()]& locking instead. However, you should do this only if all user
2469 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2470 see chapter &<<CHAPappendfile>>&.
2471
2472 One thing that cannot be tested on a system that is already running an MTA is
2473 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2474 &%-oX%& option can be used to run an Exim daemon that listens on some other
2475 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2476 &'exim_checkaccess'& utility can be used to check out policy controls on
2477 incoming SMTP mail.
2478
2479 Testing a new version on a system that is already running Exim can most easily
2480 be done by building a binary with a different CONFIGURE_FILE setting. From
2481 within the run time configuration, all other file and directory names
2482 that Exim uses can be altered, in order to keep it entirely clear of the
2483 production version.
2484
2485
2486 .section "Replacing another MTA with Exim" "SECID35"
2487 .cindex "replacing another MTA"
2488 Building and installing Exim for the first time does not of itself put it in
2489 general use. The name by which the system's MTA is called by mail user agents
2490 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2491 operating system), and it is necessary to make this name point to the &'exim'&
2492 binary in order to get the user agents to pass messages to Exim. This is
2493 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2494 or &_/usr/lib/sendmail_&
2495 .cindex "symbolic link" "to &'exim'& binary"
2496 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2497 privilege and executable status from the old MTA. It is then necessary to stop
2498 and restart the mailer daemon, if one is running.
2499
2500 .cindex "FreeBSD, MTA indirection"
2501 .cindex "&_/etc/mail/mailer.conf_&"
2502 Some operating systems have introduced alternative ways of switching MTAs. For
2503 example, if you are running FreeBSD, you need to edit the file
2504 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2505 described. A typical example of the contents of this file for running Exim is
2506 as follows:
2507 .code
2508 sendmail            /usr/exim/bin/exim
2509 send-mail           /usr/exim/bin/exim
2510 mailq               /usr/exim/bin/exim -bp
2511 newaliases          /usr/bin/true
2512 .endd
2513 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2514 your Exim installation is &"live"&. Check it by sending a message from your
2515 favourite user agent.
2516
2517 You should consider what to tell your users about the change of MTA. Exim may
2518 have different capabilities to what was previously running, and there are
2519 various operational differences such as the text of messages produced by
2520 command line options and in bounce messages. If you allow your users to make
2521 use of Exim's filtering capabilities, you should make the document entitled
2522 &'Exim's interface to mail filtering'& available to them.
2523
2524
2525
2526 .section "Upgrading Exim" "SECID36"
2527 .cindex "upgrading Exim"
2528 If you are already running Exim on your host, building and installing a new
2529 version automatically makes it available to MUAs, or any other programs that
2530 call the MTA directly. However, if you are running an Exim daemon, you do need
2531 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2532 new binary. You do not need to stop processing mail in order to install a new
2533 version of Exim. The install script does not modify an existing runtime
2534 configuration file.
2535
2536
2537
2538
2539 .section "Stopping the Exim daemon on Solaris" "SECID37"
2540 .cindex "Solaris" "stopping Exim on"
2541 The standard command for stopping the mailer daemon on Solaris is
2542 .code
2543 /etc/init.d/sendmail stop
2544 .endd
2545 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2546 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2547 for the text &"sendmail"&; this is not present because the actual program name
2548 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2549 solution is to replace the line that finds the process id with something like
2550 .code
2551 pid=`cat /var/spool/exim/exim-daemon.pid`
2552 .endd
2553 to obtain the daemon's pid directly from the file that Exim saves it in.
2554
2555 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2556 still be received from local processes, and if automatic delivery is configured
2557 (the normal case), deliveries will still occur.
2558
2559
2560
2561
2562 . ////////////////////////////////////////////////////////////////////////////
2563 . ////////////////////////////////////////////////////////////////////////////
2564
2565 .chapter "The Exim command line" "CHAPcommandline"
2566 .scindex IIDclo1 "command line" "options"
2567 .scindex IIDclo2 "options" "command line"
2568 Exim's command line takes the standard Unix form of a sequence of options,
2569 each starting with a hyphen character, followed by a number of arguments. The
2570 options are compatible with the main options of Sendmail, and there are also
2571 some additional options, some of which are compatible with Smail 3. Certain
2572 combinations of options do not make sense, and provoke an error if used.
2573 The form of the arguments depends on which options are set.
2574
2575
2576 .section "Setting options by program name" "SECID38"
2577 .cindex "&'mailq'&"
2578 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2579 were present before any other options.
2580 The &%-bp%& option requests a listing of the contents of the mail queue on the
2581 standard output.
2582 This feature is for compatibility with some systems that contain a command of
2583 that name in one of the standard libraries, symbolically linked to
2584 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2585
2586 .cindex "&'rsmtp'&"
2587 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2588 were present before any other options, for compatibility with Smail. The
2589 &%-bS%& option is used for reading in a number of messages in batched SMTP
2590 format.
2591
2592 .cindex "&'rmail'&"
2593 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2594 &%-oee%& options were present before any other options, for compatibility with
2595 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2596
2597 .cindex "&'runq'&"
2598 .cindex "queue runner"
2599 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2600 were present before any other options, for compatibility with Smail. The &%-q%&
2601 option causes a single queue runner process to be started.
2602
2603 .cindex "&'newaliases'&"
2604 .cindex "alias file" "building"
2605 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2606 If Exim is called under the name &'newaliases'& it behaves as if the option
2607 &%-bi%& were present before any other options, for compatibility with Sendmail.
2608 This option is used for rebuilding Sendmail's alias file. Exim does not have
2609 the concept of a single alias file, but can be configured to run a given
2610 command if called with the &%-bi%& option.
2611
2612
2613 .section "Trusted and admin users" "SECTtrustedadmin"
2614 Some Exim options are available only to &'trusted users'& and others are
2615 available only to &'admin users'&. In the description below, the phrases &"Exim
2616 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2617 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2618 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2619
2620 .ilist
2621 .cindex "trusted users" "definition of"
2622 .cindex "user" "trusted definition of"
2623 The trusted users are root, the Exim user, any user listed in the
2624 &%trusted_users%& configuration option, and any user whose current group or any
2625 supplementary group is one of those listed in the &%trusted_groups%&
2626 configuration option. Note that the Exim group is not automatically trusted.
2627
2628 .cindex '&"From"& line'
2629 .cindex "envelope sender"
2630 Trusted users are always permitted to use the &%-f%& option or a leading
2631 &"From&~"& line to specify the envelope sender of a message that is passed to
2632 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2633 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2634 users to set envelope senders.
2635
2636 .cindex "&'From:'& header line"
2637 .cindex "&'Sender:'& header line"
2638 .cindex "header lines" "From:"
2639 .cindex "header lines" "Sender:"
2640 For a trusted user, there is never any check on the contents of the &'From:'&
2641 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2642 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2643
2644 Trusted users may also specify a host name, host address, interface address,
2645 protocol name, ident value, and authentication data when submitting a message
2646 locally. Thus, they are able to insert messages into Exim's queue locally that
2647 have the characteristics of messages received from a remote host. Untrusted
2648 users may in some circumstances use &%-f%&, but can never set the other values
2649 that are available to trusted users.
2650 .next
2651 .cindex "user" "admin definition of"
2652 .cindex "admin user" "definition of"
2653 The admin users are root, the Exim user, and any user that is a member of the
2654 Exim group or of any group listed in the &%admin_groups%& configuration option.
2655 The current group does not have to be one of these groups.
2656
2657 Admin users are permitted to list the queue, and to carry out certain
2658 operations on messages, for example, to force delivery failures. It is also
2659 necessary to be an admin user in order to see the full information provided by
2660 the Exim monitor, and full debugging output.
2661
2662 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2663 Exim to attempt delivery of messages on its queue is restricted to admin users.
2664 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2665 option false (that is, specifying &%no_prod_requires_admin%&).
2666
2667 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2668 is restricted to admin users unless &%queue_list_requires_admin%& is set
2669 false.
2670 .endlist
2671
2672
2673 &*Warning*&: If you configure your system so that admin users are able to
2674 edit Exim's configuration file, you are giving those users an easy way of
2675 getting root. There is further discussion of this issue at the start of chapter
2676 &<<CHAPconf>>&.
2677
2678
2679
2680
2681 .section "Command line options" "SECID39"
2682 Exim's command line options are described in alphabetical order below. If none
2683 of the options that specifies a specific action (such as starting the daemon or
2684 a queue runner, or testing an address, or receiving a message in a specific
2685 format, or listing the queue) are present, and there is at least one argument
2686 on the command line, &%-bm%& (accept a local message on the standard input,
2687 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2688 outputs a brief message about itself and exits.
2689
2690 . ////////////////////////////////////////////////////////////////////////////
2691 . Insert a stylized XML comment here, to identify the start of the command line
2692 . options. This is for the benefit of the Perl script that automatically
2693 . creates a man page for the options.
2694 . ////////////////////////////////////////////////////////////////////////////
2695
2696 .literal xml
2697 <!-- === Start of command line options === -->
2698 .literal off
2699
2700
2701 .vlist
2702 .vitem &%--%&
2703 .oindex "--"
2704 .cindex "options" "command line; terminating"
2705 This is a pseudo-option whose only purpose is to terminate the options and
2706 therefore to cause subsequent command line items to be treated as arguments
2707 rather than options, even if they begin with hyphens.
2708
2709 .vitem &%--help%&
2710 .oindex "&%--help%&"
2711 This option causes Exim to output a few sentences stating what it is.
2712 The same output is generated if the Exim binary is called with no options and
2713 no arguments.
2714
2715 .vitem &%--version%&
2716 .oindex "&%--version%&"
2717 This option is an alias for &%-bV%& and causes version information to be
2718 displayed.
2719
2720 .vitem &%-Ac%& &&&
2721        &%-Am%&
2722 .oindex "&%-Ac%&"
2723 .oindex "&%-Am%&"
2724 These options are used by Sendmail for selecting configuration files and are
2725 ignored by Exim.
2726
2727 .vitem &%-B%&<&'type'&>
2728 .oindex "&%-B%&"
2729 .cindex "8-bit characters"
2730 .cindex "Sendmail compatibility" "8-bit characters"
2731 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2732 clean; it ignores this option.
2733
2734 .vitem &%-bd%&
2735 .oindex "&%-bd%&"
2736 .cindex "daemon"
2737 .cindex "SMTP" "listener"
2738 .cindex "queue runner"
2739 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2740 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2741 that the daemon should also initiate periodic queue runs.
2742
2743 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2744 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2745 disconnect from the controlling terminal. When running this way, it can be
2746 stopped by pressing ctrl-C.
2747
2748 By default, Exim listens for incoming connections to the standard SMTP port on
2749 all the host's running interfaces. However, it is possible to listen on other
2750 ports, on multiple ports, and only on specific interfaces. Chapter
2751 &<<CHAPinterfaces>>& contains a description of the options that control this.
2752
2753 When a listening daemon
2754 .cindex "daemon" "process id (pid)"
2755 .cindex "pid (process id)" "of daemon"
2756 is started without the use of &%-oX%& (that is, without overriding the normal
2757 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2758 in Exim's spool directory. This location can be overridden by setting
2759 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2760 running as root.
2761
2762 When &%-oX%& is used on the command line to start a listening daemon, the
2763 process id is not written to the normal pid file path. However, &%-oP%& can be
2764 used to specify a path on the command line if a pid file is required.
2765
2766 The SIGHUP signal
2767 .cindex "SIGHUP"
2768 .cindex "daemon" "restarting"
2769 can be used to cause the daemon to re-execute itself. This should be done
2770 whenever Exim's configuration file, or any file that is incorporated into it by
2771 means of the &%.include%& facility, is changed, and also whenever a new version
2772 of Exim is installed. It is not necessary to do this when other files that are
2773 referenced from the configuration (for example, alias files) are changed,
2774 because these are reread each time they are used.
2775
2776 .vitem &%-bdf%&
2777 .oindex "&%-bdf%&"
2778 This option has the same effect as &%-bd%& except that it never disconnects
2779 from the controlling terminal, even when no debugging is specified.
2780
2781 .vitem &%-be%&
2782 .oindex "&%-be%&"
2783 .cindex "testing" "string expansion"
2784 .cindex "expansion" "testing"
2785 Run Exim in expansion testing mode. Exim discards its root privilege, to
2786 prevent ordinary users from using this mode to read otherwise inaccessible
2787 files. If no arguments are given, Exim runs interactively, prompting for lines
2788 of data. Otherwise, it processes each argument in turn.
2789
2790 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2791 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2792 used without command line arguments. If successful, it uses the &[readline()]&
2793 function, which provides extensive line-editing facilities, for reading the
2794 test data. A line history is supported.
2795
2796 Long expansion expressions can be split over several lines by using backslash
2797 continuations. As in Exim's run time configuration, white space at the start of
2798 continuation lines is ignored. Each argument or data line is passed through the
2799 string expansion mechanism, and the result is output. Variable values from the
2800 configuration file (for example, &$qualify_domain$&) are available, but no
2801 message-specific values (such as &$message_exim_id$&) are set, because no message
2802 is being processed (but see &%-bem%& and &%-Mset%&).
2803
2804 &*Note*&: If you use this mechanism to test lookups, and you change the data
2805 files or databases you are using, you must exit and restart Exim before trying
2806 the same lookup again. Otherwise, because each Exim process caches the results
2807 of lookups, you will just get the same result as before.
2808
2809 Macro processing is done on lines before string-expansion: new macros can be
2810 defined and macros will be expanded.
2811 Because macros in the config file are often used for secrets, those are only
2812 available to admin users.
2813
2814 .vitem &%-bem%&&~<&'filename'&>
2815 .oindex "&%-bem%&"
2816 .cindex "testing" "string expansion"
2817 .cindex "expansion" "testing"
2818 This option operates like &%-be%& except that it must be followed by the name
2819 of a file. For example:
2820 .code
2821 exim -bem /tmp/testmessage
2822 .endd
2823 The file is read as a message (as if receiving a locally-submitted non-SMTP
2824 message) before any of the test expansions are done. Thus, message-specific
2825 variables such as &$message_size$& and &$header_from:$& are available. However,
2826 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2827 recipients are read from the headers in the normal way, and are shown in the
2828 &$recipients$& variable. Note that recipients cannot be given on the command
2829 line, because further arguments are taken as strings to expand (just like
2830 &%-be%&).
2831
2832 .vitem &%-bF%&&~<&'filename'&>
2833 .oindex "&%-bF%&"
2834 .cindex "system filter" "testing"
2835 .cindex "testing" "system filter"
2836 This option is the same as &%-bf%& except that it assumes that the filter being
2837 tested is a system filter. The additional commands that are available only in
2838 system filters are recognized.
2839
2840 .vitem &%-bf%&&~<&'filename'&>
2841 .oindex "&%-bf%&"
2842 .cindex "filter" "testing"
2843 .cindex "testing" "filter file"
2844 .cindex "forward file" "testing"
2845 .cindex "testing" "forward file"
2846 .cindex "Sieve filter" "testing"
2847 This option runs Exim in user filter testing mode; the file is the filter file
2848 to be tested, and a test message must be supplied on the standard input. If
2849 there are no message-dependent tests in the filter, an empty file can be
2850 supplied.
2851
2852 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2853 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2854 filter and a user filter in the same run. For example:
2855 .code
2856 exim -bF /system/filter -bf /user/filter </test/message
2857 .endd
2858 This is helpful when the system filter adds header lines or sets filter
2859 variables that are used by the user filter.
2860
2861 If the test filter file does not begin with one of the special lines
2862 .code
2863 # Exim filter
2864 # Sieve filter
2865 .endd
2866 it is taken to be a normal &_.forward_& file, and is tested for validity under
2867 that interpretation. See sections &<<SECTitenonfilred>>& to
2868 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2869 redirection lists.
2870
2871 The result of an Exim command that uses &%-bf%&, provided no errors are
2872 detected, is a list of the actions that Exim would try to take if presented
2873 with the message for real. More details of filter testing are given in the
2874 separate document entitled &'Exim's interfaces to mail filtering'&.
2875
2876 When testing a filter file,
2877 .cindex "&""From""& line"
2878 .cindex "envelope sender"
2879 .oindex "&%-f%&" "for filter testing"
2880 the envelope sender can be set by the &%-f%& option,
2881 or by a &"From&~"& line at the start of the test message. Various parameters
2882 that would normally be taken from the envelope recipient address of the message
2883 can be set by means of additional command line options (see the next four
2884 options).
2885
2886 .vitem &%-bfd%&&~<&'domain'&>
2887 .oindex "&%-bfd%&"
2888 .vindex "&$qualify_domain$&"
2889 This sets the domain of the recipient address when a filter file is being
2890 tested by means of the &%-bf%& option. The default is the value of
2891 &$qualify_domain$&.
2892
2893 .vitem &%-bfl%&&~<&'local&~part'&>
2894 .oindex "&%-bfl%&"
2895 This sets the local part of the recipient address when a filter file is being
2896 tested by means of the &%-bf%& option. The default is the username of the
2897 process that calls Exim. A local part should be specified with any prefix or
2898 suffix stripped, because that is how it appears to the filter when a message is
2899 actually being delivered.
2900
2901 .vitem &%-bfp%&&~<&'prefix'&>
2902 .oindex "&%-bfp%&"
2903 This sets the prefix of the local part of the recipient address when a filter
2904 file is being tested by means of the &%-bf%& option. The default is an empty
2905 prefix.
2906
2907 .vitem &%-bfs%&&~<&'suffix'&>
2908 .oindex "&%-bfs%&"
2909 This sets the suffix of the local part of the recipient address when a filter
2910 file is being tested by means of the &%-bf%& option. The default is an empty
2911 suffix.
2912
2913 .vitem &%-bh%&&~<&'IP&~address'&>
2914 .oindex "&%-bh%&"
2915 .cindex "testing" "incoming SMTP"
2916 .cindex "SMTP" "testing incoming"
2917 .cindex "testing" "relay control"
2918 .cindex "relaying" "testing configuration"
2919 .cindex "policy control" "testing"
2920 .cindex "debugging" "&%-bh%& option"
2921 This option runs a fake SMTP session as if from the given IP address, using the
2922 standard input and output. The IP address may include a port number at the end,
2923 after a full stop. For example:
2924 .code
2925 exim -bh 10.9.8.7.1234
2926 exim -bh fe80::a00:20ff:fe86:a061.5678
2927 .endd
2928 When an IPv6 address is given, it is converted into canonical form. In the case
2929 of the second example above, the value of &$sender_host_address$& after
2930 conversion to the canonical form is
2931 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2932
2933 Comments as to what is going on are written to the standard error file. These
2934 include lines beginning with &"LOG"& for anything that would have been logged.
2935 This facility is provided for testing configuration options for incoming
2936 messages, to make sure they implement the required policy. For example, you can
2937 test your relay controls using &%-bh%&.
2938
2939 &*Warning 1*&:
2940 .cindex "RFC 1413"
2941 You can test features of the configuration that rely on ident (RFC 1413)
2942 information by using the &%-oMt%& option. However, Exim cannot actually perform
2943 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2944 connection.
2945
2946 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2947 are also skipped when testing using &%-bh%&. If you want these callouts to
2948 occur, use &%-bhc%& instead.
2949
2950 Messages supplied during the testing session are discarded, and nothing is
2951 written to any of the real log files. There may be pauses when DNS (and other)
2952 lookups are taking place, and of course these may time out. The &%-oMi%& option
2953 can be used to specify a specific IP interface and port if this is important,
2954 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2955 session were authenticated.
2956
2957 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2958 output just states whether a given recipient address from a given host is
2959 acceptable or not. See section &<<SECTcheckaccess>>&.
2960
2961 Features such as authentication and encryption, where the client input is not
2962 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2963 specialized SMTP test program such as
2964 &url(https://www.jetmore.org/john/code/swaks/,swaks).
2965
2966 .vitem &%-bhc%&&~<&'IP&~address'&>
2967 .oindex "&%-bhc%&"
2968 This option operates in the same way as &%-bh%&, except that address
2969 verification callouts are performed if required. This includes consulting and
2970 updating the callout cache database.
2971
2972 .vitem &%-bi%&
2973 .oindex "&%-bi%&"
2974 .cindex "alias file" "building"
2975 .cindex "building alias file"
2976 .cindex "Sendmail compatibility" "&%-bi%& option"
2977 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2978 Exim does not have the concept of a single alias file, and so it cannot mimic
2979 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2980 tend to appear in various scripts such as NIS make files, so the option must be
2981 recognized.
2982
2983 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2984 configuration option is run, under the uid and gid of the caller of Exim. If
2985 the &%-oA%& option is used, its value is passed to the command as an argument.
2986 The command set by &%bi_command%& may not contain arguments. The command can
2987 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2988 if this is required. If the &%bi_command%& option is not set, calling Exim with
2989 &%-bi%& is a no-op.
2990
2991 . // Keep :help first, then the rest in alphabetical order
2992 .vitem &%-bI:help%&
2993 .oindex "&%-bI:help%&"
2994 .cindex "querying exim information"
2995 We shall provide various options starting &`-bI:`& for querying Exim for
2996 information.  The output of many of these will be intended for machine
2997 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2998 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2999 options shall cause Exim to exit after producing the requested output.
3000
3001 .vitem &%-bI:dscp%&
3002 .oindex "&%-bI:dscp%&"
3003 .cindex "DSCP" "values"
3004 This option causes Exim to emit an alphabetically sorted list of all
3005 recognised DSCP names.
3006
3007 .vitem &%-bI:sieve%&
3008 .oindex "&%-bI:sieve%&"
3009 .cindex "Sieve filter" "capabilities"
3010 This option causes Exim to emit an alphabetically sorted list of all supported
3011 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3012 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3013 &`SIEVE`& capability response line.  As the precise list may depend upon
3014 compile-time build options, which this option will adapt to, this is the only
3015 way to guarantee a correct response.
3016
3017 .vitem &%-bm%&
3018 .oindex "&%-bm%&"
3019 .cindex "local message reception"
3020 This option runs an Exim receiving process that accepts an incoming,
3021 locally-generated message on the standard input. The recipients are given as the
3022 command arguments (except when &%-t%& is also present &-- see below). Each
3023 argument can be a comma-separated list of RFC 2822 addresses. This is the
3024 default option for selecting the overall action of an Exim call; it is assumed
3025 if no other conflicting option is present.
3026
3027 If any addresses in the message are unqualified (have no domain), they are
3028 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3029 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3030 suppressing this for special cases.
3031
3032 Policy checks on the contents of local messages can be enforced by means of
3033 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3034
3035 .cindex "return code" "for &%-bm%&"
3036 The return code is zero if the message is successfully accepted. Otherwise, the
3037 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3038
3039 The format
3040 .cindex "message" "format"
3041 .cindex "format" "message"
3042 .cindex "&""From""& line"
3043 .cindex "UUCP" "&""From""& line"
3044 .cindex "Sendmail compatibility" "&""From""& line"
3045 of the message must be as defined in RFC 2822, except that, for
3046 compatibility with Sendmail and Smail, a line in one of the forms
3047 .code
3048 From sender Fri Jan  5 12:55 GMT 1997
3049 From sender Fri, 5 Jan 97 12:55:01
3050 .endd
3051 (with the weekday optional, and possibly with additional text after the date)
3052 is permitted to appear at the start of the message. There appears to be no
3053 authoritative specification of the format of this line. Exim recognizes it by
3054 matching against the regular expression defined by the &%uucp_from_pattern%&
3055 option, which can be changed if necessary.
3056
3057 .oindex "&%-f%&" "overriding &""From""& line"
3058 The specified sender is treated as if it were given as the argument to the
3059 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3060 preference to the address taken from the message. The caller of Exim must be a
3061 trusted user for the sender of a message to be set in this way.
3062
3063 .vitem &%-bmalware%&&~<&'filename'&>
3064 .oindex "&%-bmalware%&"
3065 .cindex "testing", "malware"
3066 .cindex "malware scan test"
3067 This debugging option causes Exim to scan the given file or directory
3068 (depending on the used scanner interface),
3069 using the malware scanning framework.  The option of &%av_scanner%& influences
3070 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3071 the expansion should have defaults which apply to this invocation.  ACLs are
3072 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3073 will never be populated and &%-bmalware%& will fail.
3074
3075 Exim will have changed working directory before resolving the filename, so
3076 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3077 user when it tries to open the file, rather than as the invoking user.
3078 This option requires admin privileges.
3079
3080 The &%-bmalware%& option will not be extended to be more generally useful,
3081 there are better tools for file-scanning.  This option exists to help
3082 administrators verify their Exim and AV scanner configuration.
3083
3084 .vitem &%-bnq%&
3085 .oindex "&%-bnq%&"
3086 .cindex "address qualification, suppressing"
3087 By default, Exim automatically qualifies unqualified addresses (those
3088 without domains) that appear in messages that are submitted locally (that
3089 is, not over TCP/IP). This qualification applies both to addresses in
3090 envelopes, and addresses in header lines. Sender addresses are qualified using
3091 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3092 defaults to the value of &%qualify_domain%&).
3093
3094 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3095 being used to re-submit messages that originally came from remote hosts after
3096 content scanning, you probably do not want to qualify unqualified addresses in
3097 header lines. (Such lines will be present only if you have not enabled a header
3098 syntax check in the appropriate ACL.)
3099
3100 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3101 messages that originate on the local host. When this is used, unqualified
3102 addresses in the envelope provoke errors (causing message rejection) and
3103 unqualified addresses in header lines are left alone.
3104
3105
3106 .vitem &%-bP%&
3107 .oindex "&%-bP%&"
3108 .cindex "configuration options" "extracting"
3109 .cindex "options" "configuration &-- extracting"
3110 If this option is given with no arguments, it causes the values of all Exim's
3111 main configuration options to be written to the standard output. The values
3112 of one or more specific options can be requested by giving their names as
3113 arguments, for example:
3114 .code
3115 exim -bP qualify_domain hold_domains
3116 .endd
3117 .cindex "hiding configuration option values"
3118 .cindex "configuration options" "hiding value of"
3119 .cindex "options" "hiding value of"
3120 However, any option setting that is preceded by the word &"hide"& in the
3121 configuration file is not shown in full, except to an admin user. For other
3122 users, the output is as in this example:
3123 .code
3124 mysql_servers = <value not displayable>
3125 .endd
3126 If &%config%& is given as an argument, the config is
3127 output, as it was parsed, any include file resolved, any comment removed.
3128
3129 If &%config_file%& is given as an argument, the name of the run time
3130 configuration file is output. (&%configure_file%& works too, for
3131 backward compatibility.)
3132 If a list of configuration files was supplied, the value that is output here
3133 is the name of the file that was actually used.
3134
3135 .cindex "options" "hiding name of"
3136 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3137 name will not be output.
3138
3139 .cindex "daemon" "process id (pid)"
3140 .cindex "pid (process id)" "of daemon"
3141 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3142 directories where log files and daemon pid files are written are output,
3143 respectively. If these values are unset, log files are written in a
3144 sub-directory of the spool directory called &%log%&, and the pid file is
3145 written directly into the spool directory.
3146
3147 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3148 .code
3149 exim -bP +local_domains
3150 .endd
3151 it searches for a matching named list of any type (domain, host, address, or
3152 local part) and outputs what it finds.
3153
3154 .cindex "options" "router &-- extracting"
3155 .cindex "options" "transport &-- extracting"
3156 .cindex "options" "authenticator &-- extracting"
3157 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3158 followed by the name of an appropriate driver instance, the option settings for
3159 that driver are output. For example:
3160 .code
3161 exim -bP transport local_delivery
3162 .endd
3163 The generic driver options are output first, followed by the driver's private
3164 options. A list of the names of drivers of a particular type can be obtained by
3165 using one of the words &%router_list%&, &%transport_list%&, or
3166 &%authenticator_list%&, and a complete list of all drivers with their option
3167 settings can be obtained by using &%routers%&, &%transports%&, or
3168 &%authenticators%&.
3169
3170 .cindex "environment"
3171 If &%environment%& is given as an argument, the set of environment
3172 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3173 variables.
3174
3175 .cindex "options" "macro &-- extracting"
3176 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3177 are available, similarly to the drivers.  Because macros are sometimes used
3178 for storing passwords, this option is restricted.
3179 The output format is one item per line.
3180 For the "-bP macro <name>" form, if no such macro is found
3181 the exit status will be nonzero.
3182
3183 .vitem &%-bp%&
3184 .oindex "&%-bp%&"
3185 .cindex "queue" "listing messages on"
3186 .cindex "listing" "messages on the queue"
3187 This option requests a listing of the contents of the mail queue on the
3188 standard output. If the &%-bp%& option is followed by a list of message ids,
3189 just those messages are listed. By default, this option can be used only by an
3190 admin user. However, the &%queue_list_requires_admin%& option can be set false
3191 to allow any user to see the queue.
3192
3193 Each message on the queue is displayed as in the following example:
3194 .code
3195 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3196           red.king@looking-glass.fict.example
3197           <other addresses>
3198 .endd
3199 .cindex "message" "size in queue listing"
3200 .cindex "size" "of message"
3201 The first line contains the length of time the message has been on the queue
3202 (in this case 25 minutes), the size of the message (2.9K), the unique local
3203 identifier for the message, and the message sender, as contained in the
3204 envelope. For bounce messages, the sender address is empty, and appears as
3205 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3206 the default sender address, the user's login name is shown in parentheses
3207 before the sender address.
3208
3209 .cindex "frozen messages" "in queue listing"
3210 If the message is frozen (attempts to deliver it are suspended) then the text
3211 &"*** frozen ***"& is displayed at the end of this line.
3212
3213 The recipients of the message (taken from the envelope, not the headers) are
3214 displayed on subsequent lines. Those addresses to which the message has already
3215 been delivered are marked with the letter D. If an original address gets
3216 expanded into several addresses via an alias or forward file, the original is
3217 displayed with a D only when deliveries for all of its child addresses are
3218 complete.
3219
3220
3221 .vitem &%-bpa%&
3222 .oindex "&%-bpa%&"
3223 This option operates like &%-bp%&, but in addition it shows delivered addresses
3224 that were generated from the original top level address(es) in each message by
3225 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3226 of just &"D"&.
3227
3228
3229 .vitem &%-bpc%&
3230 .oindex "&%-bpc%&"
3231 .cindex "queue" "count of messages on"
3232 This option counts the number of messages on the queue, and writes the total
3233 to the standard output. It is restricted to admin users, unless
3234 &%queue_list_requires_admin%& is set false.
3235
3236
3237 .vitem &%-bpr%&
3238 .oindex "&%-bpr%&"
3239 This option operates like &%-bp%&, but the output is not sorted into
3240 chronological order of message arrival. This can speed it up when there are
3241 lots of messages on the queue, and is particularly useful if the output is
3242 going to be post-processed in a way that doesn't need the sorting.
3243
3244 .vitem &%-bpra%&
3245 .oindex "&%-bpra%&"
3246 This option is a combination of &%-bpr%& and &%-bpa%&.
3247
3248 .vitem &%-bpru%&
3249 .oindex "&%-bpru%&"
3250 This option is a combination of &%-bpr%& and &%-bpu%&.
3251
3252
3253 .vitem &%-bpu%&
3254 .oindex "&%-bpu%&"
3255 This option operates like &%-bp%& but shows only undelivered top-level
3256 addresses for each message displayed. Addresses generated by aliasing or
3257 forwarding are not shown, unless the message was deferred after processing by a
3258 router with the &%one_time%& option set.
3259
3260
3261 .vitem &%-brt%&
3262 .oindex "&%-brt%&"
3263 .cindex "testing" "retry configuration"
3264 .cindex "retry" "configuration testing"
3265 This option is for testing retry rules, and it must be followed by up to three
3266 arguments. It causes Exim to look for a retry rule that matches the values
3267 and to write it to the standard output. For example:
3268 .code
3269 exim -brt bach.comp.mus.example
3270 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3271 .endd
3272 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3273 argument, which is required, can be a complete address in the form
3274 &'local_part@domain'&, or it can be just a domain name. If the second argument
3275 contains a dot, it is interpreted as an optional second domain name; if no
3276 retry rule is found for the first argument, the second is tried. This ties in
3277 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3278 rule is found that matches the host, one that matches the mail domain is
3279 sought. Finally, an argument that is the name of a specific delivery error, as
3280 used in setting up retry rules, can be given. For example:
3281 .code
3282 exim -brt haydn.comp.mus.example quota_3d
3283 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3284 .endd
3285
3286 .vitem &%-brw%&
3287 .oindex "&%-brw%&"
3288 .cindex "testing" "rewriting"
3289 .cindex "rewriting" "testing"
3290 This option is for testing address rewriting rules, and it must be followed by
3291 a single argument, consisting of either a local part without a domain, or a
3292 complete address with a fully qualified domain. Exim outputs how this address
3293 would be rewritten for each possible place it might appear. See chapter
3294 &<<CHAPrewrite>>& for further details.
3295
3296 .vitem &%-bS%&
3297 .oindex "&%-bS%&"
3298 .cindex "SMTP" "batched incoming"
3299 .cindex "batched SMTP input"
3300 This option is used for batched SMTP input, which is an alternative interface
3301 for non-interactive local message submission. A number of messages can be
3302 submitted in a single run. However, despite its name, this is not really SMTP
3303 input. Exim reads each message's envelope from SMTP commands on the standard
3304 input, but generates no responses. If the caller is trusted, or
3305 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3306 believed; otherwise the sender is always the caller of Exim.
3307
3308 The message itself is read from the standard input, in SMTP format (leading
3309 dots doubled), terminated by a line containing just a single dot. An error is
3310 provoked if the terminating dot is missing. A further message may then follow.
3311
3312 As for other local message submissions, the contents of incoming batch SMTP
3313 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3314 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3315 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3316
3317 Some other SMTP commands are recognized in the input. HELO and EHLO act
3318 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3319 QUIT quits, ignoring the rest of the standard input.
3320
3321 .cindex "return code" "for &%-bS%&"
3322 If any error is encountered, reports are written to the standard output and
3323 error streams, and Exim gives up immediately. The return code is 0 if no error
3324 was detected; it is 1 if one or more messages were accepted before the error
3325 was detected; otherwise it is 2.
3326
3327 More details of input using batched SMTP are given in section
3328 &<<SECTincomingbatchedSMTP>>&.
3329
3330 .vitem &%-bs%&
3331 .oindex "&%-bs%&"
3332 .cindex "SMTP" "local input"
3333 .cindex "local SMTP input"
3334 This option causes Exim to accept one or more messages by reading SMTP commands
3335 on the standard input, and producing SMTP replies on the standard output. SMTP
3336 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3337 Some user agents use this interface as a way of passing locally-generated
3338 messages to the MTA.
3339
3340 In
3341 .cindex "sender" "source of"
3342 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3343 set, the senders of messages are taken from the SMTP MAIL commands.
3344 Otherwise the content of these commands is ignored and the sender is set up as
3345 the calling user. Unqualified addresses are automatically qualified using
3346 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3347 &%-bnq%& option is used.
3348
3349 .cindex "inetd"
3350 The
3351 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3352 using a listening daemon. Exim can distinguish the two cases by checking
3353 whether the standard input is a TCP/IP socket. When Exim is called from
3354 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3355 above concerning senders and qualification do not apply. In this situation,
3356 Exim behaves in exactly the same way as it does when receiving a message via
3357 the listening daemon.
3358
3359 .vitem &%-bt%&
3360 .oindex "&%-bt%&"
3361 .cindex "testing" "addresses"
3362 .cindex "address" "testing"
3363 This option runs Exim in address testing mode, in which each argument is taken
3364 as a recipient address to be tested for deliverability. The results are
3365 written to the standard output. If a test fails, and the caller is not an admin
3366 user, no details of the failure are output, because these might contain
3367 sensitive information such as usernames and passwords for database lookups.
3368
3369 If no arguments are given, Exim runs in an interactive manner, prompting with a
3370 right angle bracket for addresses to be tested.
3371
3372 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3373 &[readline()]& function, because it is running as &'root'& and there are
3374 security issues.
3375
3376 Each address is handled as if it were the recipient address of a message
3377 (compare the &%-bv%& option). It is passed to the routers and the result is
3378 written to the standard output. However, any router that has
3379 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3380 genuine routing tests if your first router passes everything to a scanner
3381 program.
3382
3383 .cindex "return code" "for &%-bt%&"
3384 The return code is 2 if any address failed outright; it is 1 if no address
3385 failed outright but at least one could not be resolved for some reason. Return
3386 code 0 is given only when all addresses succeed.
3387
3388 .cindex "duplicate addresses"
3389 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3390 addresses after routing is complete, so that only one delivery takes place.
3391 This does not happen when testing with &%-bt%&; the full results of routing are
3392 always shown.
3393
3394 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3395 routers in the configuration makes any tests on the sender address of a
3396 message,
3397 .oindex "&%-f%&" "for address testing"
3398 you can use the &%-f%& option to set an appropriate sender when running
3399 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3400 default qualifying domain. However, if you have set up (for example) routers
3401 whose behaviour depends on the contents of an incoming message, you cannot test
3402 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3403 doing such tests.
3404
3405 .vitem &%-bV%&
3406 .oindex "&%-bV%&"
3407 .cindex "version number of Exim"
3408 This option causes Exim to write the current version number, compilation
3409 number, and compilation date of the &'exim'& binary to the standard output.
3410 It also lists the DBM library that is being used, the optional modules (such as
3411 specific lookup types), the drivers that are included in the binary, and the
3412 name of the run time configuration file that is in use.
3413
3414 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3415 configuration file. However, this is a static check only. It cannot check
3416 values that are to be expanded. For example, although a misspelt ACL verb is
3417 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3418 alone to discover (for example) all the typos in the configuration; some
3419 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3420 dynamic testing facilities.
3421
3422 .vitem &%-bv%&
3423 .oindex "&%-bv%&"
3424 .cindex "verifying address" "using &%-bv%&"
3425 .cindex "address" "verification"
3426 This option runs Exim in address verification mode, in which each argument is
3427 taken as a recipient address to be verified by the routers. (This does
3428 not involve any verification callouts). During normal operation, verification
3429 happens mostly as a consequence processing a &%verify%& condition in an ACL
3430 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3431 including callouts, see the &%-bh%& and &%-bhc%& options.
3432
3433 If verification fails, and the caller is not an admin user, no details of the
3434 failure are output, because these might contain sensitive information such as
3435 usernames and passwords for database lookups.
3436
3437 If no arguments are given, Exim runs in an interactive manner, prompting with a
3438 right angle bracket for addresses to be verified.
3439
3440 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3441 &[readline()]& function, because it is running as &'exim'& and there are
3442 security issues.
3443
3444 Verification differs from address testing (the &%-bt%& option) in that routers
3445 that have &%no_verify%& set are skipped, and if the address is accepted by a
3446 router that has &%fail_verify%& set, verification fails. The address is
3447 verified as a recipient if &%-bv%& is used; to test verification for a sender
3448 address, &%-bvs%& should be used.
3449
3450 If the &%-v%& option is not set, the output consists of a single line for each
3451 address, stating whether it was verified or not, and giving a reason in the
3452 latter case. Without &%-v%&, generating more than one address by redirection
3453 causes verification to end successfully, without considering the generated
3454 addresses. However, if just one address is generated, processing continues,
3455 and the generated address must verify successfully for the overall verification
3456 to succeed.
3457
3458 When &%-v%& is set, more details are given of how the address has been handled,
3459 and in the case of address redirection, all the generated addresses are also
3460 considered. Verification may succeed for some and fail for others.
3461
3462 The
3463 .cindex "return code" "for &%-bv%&"
3464 return code is 2 if any address failed outright; it is 1 if no address
3465 failed outright but at least one could not be resolved for some reason. Return
3466 code 0 is given only when all addresses succeed.
3467
3468 If any of the routers in the configuration makes any tests on the sender
3469 address of a message, you should use the &%-f%& option to set an appropriate
3470 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3471 calling user at the default qualifying domain.
3472
3473 .vitem &%-bvs%&
3474 .oindex "&%-bvs%&"
3475 This option acts like &%-bv%&, but verifies the address as a sender rather
3476 than a recipient address. This affects any rewriting and qualification that
3477 might happen.
3478
3479 .vitem &%-bw%&
3480 .oindex "&%-bw%&"
3481 .cindex "daemon"
3482 .cindex "inetd"
3483 .cindex "inetd" "wait mode"
3484 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3485 similarly to the &%-bd%& option.  All port specifications on the command-line
3486 and in the configuration file are ignored.  Queue-running may not be specified.
3487
3488 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3489 listening for connections.  This permits the system to start up and have
3490 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3491 each port only when the first connection is received.
3492
3493 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3494 which the daemon will exit, which should cause inetd to listen once more.
3495
3496 .vitem &%-C%&&~<&'filelist'&>
3497 .oindex "&%-C%&"
3498 .cindex "configuration file" "alternate"
3499 .cindex "CONFIGURE_FILE"
3500 .cindex "alternate configuration file"
3501 This option causes Exim to find the run time configuration file from the given
3502 list instead of from the list specified by the CONFIGURE_FILE
3503 compile-time setting. Usually, the list will consist of just a single file
3504 name, but it can be a colon-separated list of names. In this case, the first
3505 file that exists is used. Failure to open an existing file stops Exim from
3506 proceeding any further along the list, and an error is generated.
3507
3508 When this option is used by a caller other than root, and the list is different
3509 from the compiled-in list, Exim gives up its root privilege immediately, and
3510 runs with the real and effective uid and gid set to those of the caller.
3511 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3512 file contains a list of full pathnames, one per line, for configuration files
3513 which are trusted. Root privilege is retained for any configuration file so
3514 listed, as long as the caller is the Exim user (or the user specified in the
3515 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3516 not writeable by inappropriate users or groups.
3517
3518 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3519 configuration using &%-C%& right through message reception and delivery,
3520 even if the caller is root. The reception works, but by that time, Exim is
3521 running as the Exim user, so when it re-executes to regain privilege for the
3522 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3523 test reception and delivery using two separate commands (one to put a message
3524 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3525
3526 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3527 prefix string with which any file named in a &%-C%& command line option
3528 must start. In addition, the file name must not contain the sequence &`/../`&.
3529 However, if the value of the &%-C%& option is identical to the value of
3530 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3531 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3532 unset, any file name can be used with &%-C%&.
3533
3534 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3535 to a directory to which only root has access. This prevents someone who has
3536 broken into the Exim account from running a privileged Exim with an arbitrary
3537 configuration file.
3538
3539 The &%-C%& facility is useful for ensuring that configuration files are
3540 syntactically correct, but cannot be used for test deliveries, unless the
3541 caller is privileged, or unless it is an exotic configuration that does not
3542 require privilege. No check is made on the owner or group of the files
3543 specified by this option.
3544
3545
3546 .vitem &%-D%&<&'macro'&>=<&'value'&>
3547 .oindex "&%-D%&"
3548 .cindex "macro" "setting on command line"
3549 This option can be used to override macro definitions in the configuration file
3550 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3551 unprivileged caller, it causes Exim to give up its root privilege.
3552 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3553 completely disabled, and its use causes an immediate error exit.
3554
3555 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3556 colon-separated list of macros which are considered safe and, if &%-D%& only
3557 supplies macros from this list, and the values are acceptable, then Exim will
3558 not give up root privilege if the caller is root, the Exim run-time user, or
3559 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3560 to be removed in the future.  Acceptable values for the macros satisfy the
3561 regexp: &`^[A-Za-z0-9_/.-]*$`&
3562
3563 The entire option (including equals sign if present) must all be within one
3564 command line item. &%-D%& can be used to set the value of a macro to the empty
3565 string, in which case the equals sign is optional. These two commands are
3566 synonymous:
3567 .code
3568 exim -DABC  ...
3569 exim -DABC= ...
3570 .endd
3571 To include spaces in a macro definition item, quotes must be used. If you use
3572 quotes, spaces are permitted around the macro name and the equals sign. For
3573 example:
3574 .code
3575 exim '-D ABC = something' ...
3576 .endd
3577 &%-D%& may be repeated up to 10 times on a command line.
3578 Only macro names up to 22 letters long can be set.
3579
3580
3581 .vitem &%-d%&<&'debug&~options'&>
3582 .oindex "&%-d%&"
3583 .cindex "debugging" "list of selectors"
3584 .cindex "debugging" "&%-d%& option"
3585 This option causes debugging information to be written to the standard
3586 error stream. It is restricted to admin users because debugging output may show
3587 database queries that contain password information. Also, the details of users'
3588 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3589 writes an error message to the standard error stream and exits with a non-zero
3590 return code.
3591
3592 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3593 standard debugging data is output. This can be reduced, or increased to include
3594 some more rarely needed information, by directly following &%-d%& with a string
3595 made up of names preceded by plus or minus characters. These add or remove sets
3596 of debugging data, respectively. For example, &%-d+filter%& adds filter
3597 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3598 no spaces are allowed in the debug setting. The available debugging categories
3599 are:
3600 .display
3601 &`acl            `& ACL interpretation
3602 &`auth           `& authenticators
3603 &`deliver        `& general delivery logic
3604 &`dns            `& DNS lookups (see also resolver)
3605 &`dnsbl          `& DNS black list (aka RBL) code
3606 &`exec           `& arguments for &[execv()]& calls
3607 &`expand         `& detailed debugging for string expansions
3608 &`filter         `& filter handling
3609 &`hints_lookup   `& hints data lookups
3610 &`host_lookup    `& all types of name-to-IP address handling
3611 &`ident          `& ident lookup
3612 &`interface      `& lists of local interfaces
3613 &`lists          `& matching things in lists
3614 &`load           `& system load checks
3615 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3616                     &<<CHAPlocalscan>>&)
3617 &`lookup         `& general lookup code and all lookups
3618 &`memory         `& memory handling
3619 &`pid            `& add pid to debug output lines
3620 &`process_info   `& setting info for the process log
3621 &`queue_run      `& queue runs
3622 &`receive        `& general message reception logic
3623 &`resolver       `& turn on the DNS resolver's debugging output
3624 &`retry          `& retry handling
3625 &`rewrite        `& address rewriting
3626 &`route          `& address routing
3627 &`timestamp      `& add timestamp to debug output lines
3628 &`tls            `& TLS logic
3629 &`transport      `& transports
3630 &`uid            `& changes of uid/gid and looking up uid/gid
3631 &`verify         `& address verification logic
3632 &`all            `& almost all of the above (see below), and also &%-v%&
3633 .endd
3634 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3635 for &`-all`&. The reason for this is that &`+all`& is something that people
3636 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3637 is included, an awful lot of output that is very rarely of interest is
3638 generated, so it now has to be explicitly requested. However, &`-all`& does
3639 turn everything off.
3640
3641 .cindex "resolver, debugging output"
3642 .cindex "DNS resolver, debugging output"
3643 The &`resolver`& option produces output only if the DNS resolver was compiled
3644 with DEBUG enabled. This is not the case in some operating systems. Also,
3645 unfortunately, debugging output from the DNS resolver is written to stdout
3646 rather than stderr.
3647
3648 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3649 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3650 However, the &`pid`& selector is forced when debugging is turned on for a
3651 daemon, which then passes it on to any re-executed Exims. Exim also
3652 automatically adds the pid to debug lines when several remote deliveries are
3653 run in parallel.
3654
3655 The &`timestamp`& selector causes the current time to be inserted at the start
3656 of all debug output lines. This can be useful when trying to track down delays
3657 in processing.
3658
3659 If the &%debug_print%& option is set in any driver, it produces output whenever
3660 any debugging is selected, or if &%-v%& is used.
3661
3662 .vitem &%-dd%&<&'debug&~options'&>
3663 .oindex "&%-dd%&"
3664 This option behaves exactly like &%-d%& except when used on a command that
3665 starts a daemon process. In that case, debugging is turned off for the
3666 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3667 behaviour of the daemon without creating as much output as full debugging does.
3668
3669 .vitem &%-dropcr%&
3670 .oindex "&%-dropcr%&"
3671 This is an obsolete option that is now a no-op. It used to affect the way Exim
3672 handled CR and LF characters in incoming messages. What happens now is
3673 described in section &<<SECTlineendings>>&.
3674
3675 .vitem &%-E%&
3676 .oindex "&%-E%&"
3677 .cindex "bounce message" "generating"
3678 This option specifies that an incoming message is a locally-generated delivery
3679 failure report. It is used internally by Exim when handling delivery failures
3680 and is not intended for external use. Its only effect is to stop Exim
3681 generating certain messages to the postmaster, as otherwise message cascades
3682 could occur in some situations. As part of the same option, a message id may
3683 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3684 new message contains the id, following &"R="&, as a cross-reference.
3685
3686 .vitem &%-e%&&'x'&
3687 .oindex "&%-e%&&'x'&"
3688 There are a number of Sendmail options starting with &%-oe%& which seem to be
3689 called by various programs without the leading &%o%& in the option. For
3690 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3691 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3692
3693 .vitem &%-F%&&~<&'string'&>
3694 .oindex "&%-F%&"
3695 .cindex "sender" "name"
3696 .cindex "name" "of sender"
3697 This option sets the sender's full name for use when a locally-generated
3698 message is being accepted. In the absence of this option, the user's &'gecos'&
3699 entry from the password data is used. As users are generally permitted to alter
3700 their &'gecos'& entries, no security considerations are involved. White space
3701 between &%-F%& and the <&'string'&> is optional.
3702
3703 .vitem &%-f%&&~<&'address'&>
3704 .oindex "&%-f%&"
3705 .cindex "sender" "address"
3706 .cindex "address" "sender"
3707 .cindex "trusted users"
3708 .cindex "envelope sender"
3709 .cindex "user" "trusted"
3710 This option sets the address of the envelope sender of a locally-generated
3711 message (also known as the return path). The option can normally be used only
3712 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3713 users to use it.
3714
3715 Processes running as root or the Exim user are always trusted. Other
3716 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3717 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3718 of a local message is set to the caller's login name at the default qualify
3719 domain.
3720
3721 There is one exception to the restriction on the use of &%-f%&: an empty sender
3722 can be specified by any user, trusted or not, to create a message that can
3723 never provoke a bounce. An empty sender can be specified either as an empty
3724 string, or as a pair of angle brackets with nothing between them, as in these
3725 examples of shell commands:
3726 .code
3727 exim -f '<>' user@domain
3728 exim -f "" user@domain
3729 .endd
3730 In addition, the use of &%-f%& is not restricted when testing a filter file
3731 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3732 &%-bv%& options.
3733
3734 Allowing untrusted users to change the sender address does not of itself make
3735 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3736 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3737 though this can be overridden by setting &%no_local_from_check%&.
3738
3739 White
3740 .cindex "&""From""& line"
3741 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3742 given as two arguments or one combined argument). The sender of a
3743 locally-generated message can also be set (when permitted) by an initial
3744 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3745 if &%-f%& is also present, it overrides &"From&~"&.
3746
3747 .vitem &%-G%&
3748 .oindex "&%-G%&"
3749 .cindex "submission fixups, suppressing (command-line)"
3750 This option is equivalent to an ACL applying:
3751 .code
3752 control = suppress_local_fixups
3753 .endd
3754 for every message received.  Note that Sendmail will complain about such
3755 bad formatting, where Exim silently just does not fix it up.  This may change
3756 in future.
3757
3758 As this affects audit information, the caller must be a trusted user to use
3759 this option.
3760
3761 .vitem &%-h%&&~<&'number'&>
3762 .oindex "&%-h%&"
3763 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3764 This option is accepted for compatibility with Sendmail, but has no effect. (In
3765 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3766 headers.)
3767
3768 .vitem &%-i%&
3769 .oindex "&%-i%&"
3770 .cindex "Solaris" "&'mail'& command"
3771 .cindex "dot" "in incoming non-SMTP message"
3772 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3773 line by itself should not terminate an incoming, non-SMTP message. I can find
3774 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3775 command in Solaris 2.4 uses it. See also &%-ti%&.
3776
3777 .vitem &%-L%&&~<&'tag'&>
3778 .oindex "&%-L%&"
3779 .cindex "syslog" "process name; set with flag"
3780 This option is equivalent to setting &%syslog_processname%& in the config
3781 file and setting &%log_file_path%& to &`syslog`&.
3782 Its use is restricted to administrators.  The configuration file has to be
3783 read and parsed, to determine access rights, before this is set and takes
3784 effect, so early configuration file errors will not honour this flag.
3785
3786 The tag should not be longer than 32 characters.
3787
3788 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3789 .oindex "&%-M%&"
3790 .cindex "forcing delivery"
3791 .cindex "delivery" "forcing attempt"
3792 .cindex "frozen messages" "forcing delivery"
3793 This option requests Exim to run a delivery attempt on each message in turn. If
3794 any of the messages are frozen, they are automatically thawed before the
3795 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3796 and &%hold_domains%& are ignored.
3797
3798 Retry
3799 .cindex "hints database" "overriding retry hints"
3800 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3801 the normal retry time has not yet been reached. This option requires the caller
3802 to be an admin user. However, there is an option called &%prod_requires_admin%&
3803 which can be set false to relax this restriction (and also the same requirement
3804 for the &%-q%&, &%-R%&, and &%-S%& options).
3805
3806 The deliveries happen synchronously, that is, the original Exim process does
3807 not terminate until all the delivery attempts have finished. No output is
3808 produced unless there is a serious error. If you want to see what is happening,
3809 use the &%-v%& option as well, or inspect Exim's main log.
3810
3811 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3812 .oindex "&%-Mar%&"
3813 .cindex "message" "adding recipients"
3814 .cindex "recipient" "adding"
3815 This option requests Exim to add the addresses to the list of recipients of the
3816 message (&"ar"& for &"add recipients"&). The first argument must be a message
3817 id, and the remaining ones must be email addresses. However, if the message is
3818 active (in the middle of a delivery attempt), it is not altered. This option
3819 can be used only by an admin user.
3820
3821 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3822         &~<&'message&~id'&>"
3823 .oindex "&%-MC%&"
3824 .cindex "SMTP" "passed connection"
3825 .cindex "SMTP" "multiple deliveries"
3826 .cindex "multiple SMTP deliveries"
3827 This option is not intended for use by external callers. It is used internally
3828 by Exim to invoke another instance of itself to deliver a waiting message using
3829 an existing SMTP connection, which is passed as the standard input. Details are
3830 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3831 must be root or the Exim user in order to use it.
3832
3833 .vitem &%-MCA%&
3834 .oindex "&%-MCA%&"
3835 This option is not intended for use by external callers. It is used internally
3836 by Exim in conjunction with the &%-MC%& option. It signifies that the
3837 connection to the remote host has been authenticated.
3838
3839 .vitem &%-MCD%&
3840 .oindex "&%-MCD%&"
3841 This option is not intended for use by external callers. It is used internally
3842 by Exim in conjunction with the &%-MC%& option. It signifies that the
3843 remote host supports the ESMTP &_DSN_& extension.
3844
3845 .vitem &%-MCG%&&~<&'queue&~name'&>
3846 .oindex "&%-MCG%&"
3847 This option is not intended for use by external callers. It is used internally
3848 by Exim in conjunction with the &%-MC%& option. It signifies that an
3849 alternate queue is used, named by the following argument.
3850
3851 .vitem &%-MCK%&
3852 .oindex "&%-MCK%&"
3853 This option is not intended for use by external callers. It is used internally
3854 by Exim in conjunction with the &%-MC%& option. It signifies that a
3855 remote host supports the ESMTP &_CHUNKING_& extension.
3856
3857 .vitem &%-MCP%&
3858 .oindex "&%-MCP%&"
3859 This option is not intended for use by external callers. It is used internally
3860 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3861 which Exim is connected supports pipelining.
3862
3863 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3864 .oindex "&%-MCQ%&"
3865 This option is not intended for use by external callers. It is used internally
3866 by Exim in conjunction with the &%-MC%& option when the original delivery was
3867 started by a queue runner. It passes on the process id of the queue runner,
3868 together with the file descriptor number of an open pipe. Closure of the pipe
3869 signals the final completion of the sequence of processes that are passing
3870 messages through the same SMTP connection.
3871
3872 .vitem &%-MCS%&
3873 .oindex "&%-MCS%&"
3874 This option is not intended for use by external callers. It is used internally
3875 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3876 SMTP SIZE option should be used on messages delivered down the existing
3877 connection.
3878
3879 .vitem &%-MCT%&
3880 .oindex "&%-MCT%&"
3881 This option is not intended for use by external callers. It is used internally
3882 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3883 host to which Exim is connected supports TLS encryption.
3884
3885 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3886 .oindex "&%-MCt%&"
3887 This option is not intended for use by external callers. It is used internally
3888 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3889 connection is being proxied by a parent process for handling TLS encryption.
3890 The arguments give the local address and port being proxied, and the TLS cipher.
3891
3892 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3893 .oindex "&%-Mc%&"
3894 .cindex "hints database" "not overridden by &%-Mc%&"
3895 .cindex "delivery" "manually started &-- not forced"
3896 This option requests Exim to run a delivery attempt on each message in turn,
3897 but unlike the &%-M%& option, it does check for retry hints, and respects any
3898 that are found. This option is not very useful to external callers. It is
3899 provided mainly for internal use by Exim when it needs to re-invoke itself in
3900 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3901 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3902 respects retry times and other options such as &%hold_domains%& that are
3903 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3904 If you want to run a specific delivery as if in a queue run, you should use
3905 &%-q%& with a message id argument. A distinction between queue run deliveries
3906 and other deliveries is made in one or two places.
3907
3908 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3909 .oindex "&%-Mes%&"
3910 .cindex "message" "changing sender"
3911 .cindex "sender" "changing"
3912 This option requests Exim to change the sender address in the message to the
3913 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3914 &"edit sender"&). There must be exactly two arguments. The first argument must
3915 be a message id, and the second one an email address. However, if the message
3916 is active (in the middle of a delivery attempt), its status is not altered.
3917 This option can be used only by an admin user.
3918
3919 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3920 .oindex "&%-Mf%&"
3921 .cindex "freezing messages"
3922 .cindex "message" "manually freezing"
3923 This option requests Exim to mark each listed message as &"frozen"&. This
3924 prevents any delivery attempts taking place until the message is &"thawed"&,
3925 either manually or as a result of the &%auto_thaw%& configuration option.
3926 However, if any of the messages are active (in the middle of a delivery
3927 attempt), their status is not altered. This option can be used only by an admin
3928 user.
3929
3930 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3931 .oindex "&%-Mg%&"
3932 .cindex "giving up on messages"
3933 .cindex "message" "abandoning delivery attempts"
3934 .cindex "delivery" "abandoning further attempts"
3935 This option requests Exim to give up trying to deliver the listed messages,
3936 including any that are frozen. However, if any of the messages are active,
3937 their status is not altered. For non-bounce messages, a delivery error message
3938 is sent to the sender, containing the text &"cancelled by administrator"&.
3939 Bounce messages are just discarded. This option can be used only by an admin
3940 user.
3941
3942 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3943 .oindex "&%-Mmad%&"
3944 .cindex "delivery" "cancelling all"
3945 This option requests Exim to mark all the recipient addresses in the messages
3946 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3947 message is active (in the middle of a delivery attempt), its status is not
3948 altered. This option can be used only by an admin user.
3949
3950 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3951 .oindex "&%-Mmd%&"
3952 .cindex "delivery" "cancelling by address"
3953 .cindex "recipient" "removing"
3954 .cindex "removing recipients"
3955 This option requests Exim to mark the given addresses as already delivered
3956 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3957 the remaining ones must be email addresses. These are matched to recipient
3958 addresses in the message in a case-sensitive manner. If the message is active
3959 (in the middle of a delivery attempt), its status is not altered. This option
3960 can be used only by an admin user.
3961
3962 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3963 .oindex "&%-Mrm%&"
3964 .cindex "removing messages"
3965 .cindex "abandoning mail"
3966 .cindex "message" "manually discarding"
3967 This option requests Exim to remove the given messages from the queue. No
3968 bounce messages are sent; each message is simply forgotten. However, if any of
3969 the messages are active, their status is not altered. This option can be used
3970 only by an admin user or by the user who originally caused the message to be
3971 placed on the queue.
3972
3973 . .new
3974 . .vitem &%-MS%&
3975 . .oindex "&%-MS%&"
3976 . .cindex REQUIRETLS
3977 . This option is used to request REQUIRETLS processing on the message.
3978 . It is used internally by Exim in conjunction with -E when generating
3979 . a bounce message.
3980 . .wen
3981
3982 .vitem &%-Mset%&&~<&'message&~id'&>
3983 .oindex "&%-Mset%&"
3984 .cindex "testing" "string expansion"
3985 .cindex "expansion" "testing"
3986 This option is useful only in conjunction with &%-be%& (that is, when testing
3987 string expansions). Exim loads the given message from its spool before doing
3988 the test expansions, thus setting message-specific variables such as
3989 &$message_size$& and the header variables. The &$recipients$& variable is made
3990 available. This feature is provided to make it easier to test expansions that
3991 make use of these variables. However, this option can be used only by an admin
3992 user. See also &%-bem%&.
3993
3994 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3995 .oindex "&%-Mt%&"
3996 .cindex "thawing messages"
3997 .cindex "unfreezing messages"
3998 .cindex "frozen messages" "thawing"
3999 .cindex "message" "thawing frozen"
4000 This option requests Exim to &"thaw"& any of the listed messages that are
4001 &"frozen"&, so that delivery attempts can resume. However, if any of the
4002 messages are active, their status is not altered. This option can be used only
4003 by an admin user.
4004
4005 .vitem &%-Mvb%&&~<&'message&~id'&>
4006 .oindex "&%-Mvb%&"
4007 .cindex "listing" "message body"
4008 .cindex "message" "listing body of"
4009 This option causes the contents of the message body (-D) spool file to be
4010 written to the standard output. This option can be used only by an admin user.
4011
4012 .vitem &%-Mvc%&&~<&'message&~id'&>
4013 .oindex "&%-Mvc%&"
4014 .cindex "message" "listing in RFC 2822 format"
4015 .cindex "listing" "message in RFC 2822 format"
4016 This option causes a copy of the complete message (header lines plus body) to
4017 be written to the standard output in RFC 2822 format. This option can be used
4018 only by an admin user.
4019
4020 .vitem &%-Mvh%&&~<&'message&~id'&>
4021 .oindex "&%-Mvh%&"
4022 .cindex "listing" "message headers"
4023 .cindex "header lines" "listing"
4024 .cindex "message" "listing header lines"
4025 This option causes the contents of the message headers (-H) spool file to be
4026 written to the standard output. This option can be used only by an admin user.
4027
4028 .vitem &%-Mvl%&&~<&'message&~id'&>
4029 .oindex "&%-Mvl%&"
4030 .cindex "listing" "message log"
4031 .cindex "message" "listing message log"
4032 This option causes the contents of the message log spool file to be written to
4033 the standard output. This option can be used only by an admin user.
4034
4035 .vitem &%-m%&
4036 .oindex "&%-m%&"
4037 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4038 treats it that way too.
4039
4040 .vitem &%-N%&
4041 .oindex "&%-N%&"
4042 .cindex "debugging" "&%-N%& option"
4043 .cindex "debugging" "suppressing delivery"
4044 This is a debugging option that inhibits delivery of a message at the transport
4045 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4046 it just doesn't actually transport the message, but instead behaves as if it
4047 had successfully done so. However, it does not make any updates to the retry
4048 database, and the log entries for deliveries are flagged with &"*>"& rather
4049 than &"=>"&.
4050
4051 Because &%-N%& discards any message to which it applies, only root or the Exim
4052 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4053 words, an ordinary user can use it only when supplying an incoming message to
4054 which it will apply. Although transportation never fails when &%-N%& is set, an
4055 address may be deferred because of a configuration problem on a transport, or a
4056 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4057 the message, and applies to any subsequent delivery attempts that may happen
4058 for that message.
4059
4060 .vitem &%-n%&
4061 .oindex "&%-n%&"
4062 This option is interpreted by Sendmail to mean &"no aliasing"&.
4063 For normal modes of operation, it is ignored by Exim.
4064 When combined with &%-bP%& it makes the output more terse (suppresses
4065 option names, environment values and config pretty printing).
4066
4067 .vitem &%-O%&&~<&'data'&>
4068 .oindex "&%-O%&"
4069 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4070 Exim.
4071
4072 .vitem &%-oA%&&~<&'file&~name'&>
4073 .oindex "&%-oA%&"
4074 .cindex "Sendmail compatibility" "&%-oA%& option"
4075 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4076 alternative alias file name. Exim handles &%-bi%& differently; see the
4077 description above.
4078
4079 .vitem &%-oB%&&~<&'n'&>
4080 .oindex "&%-oB%&"
4081 .cindex "SMTP" "passed connection"
4082 .cindex "SMTP" "multiple deliveries"
4083 .cindex "multiple SMTP deliveries"
4084 This is a debugging option which limits the maximum number of messages that can
4085 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4086 transport. If <&'n'&> is omitted, the limit is set to 1.
4087
4088 .vitem &%-odb%&
4089 .oindex "&%-odb%&"
4090 .cindex "background delivery"
4091 .cindex "delivery" "in the background"
4092 This option applies to all modes in which Exim accepts incoming messages,
4093 including the listening daemon. It requests &"background"& delivery of such
4094 messages, which means that the accepting process automatically starts a
4095 delivery process for each message received, but does not wait for the delivery
4096 processes to finish.
4097
4098 When all the messages have been received, the reception process exits,
4099 leaving the delivery processes to finish in their own time. The standard output
4100 and error streams are closed at the start of each delivery process.
4101 This is the default action if none of the &%-od%& options are present.
4102
4103 If one of the queueing options in the configuration file
4104 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4105 overrides it if &%queue_only_override%& is set true, which is the default
4106 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4107
4108 .vitem &%-odf%&
4109 .oindex "&%-odf%&"
4110 .cindex "foreground delivery"
4111 .cindex "delivery" "in the foreground"
4112 This option requests &"foreground"& (synchronous) delivery when Exim has
4113 accepted a locally-generated message. (For the daemon it is exactly the same as
4114 &%-odb%&.) A delivery process is automatically started to deliver the message,
4115 and Exim waits for it to complete before proceeding.
4116
4117 The original Exim reception process does not finish until the delivery
4118 process for the final message has ended. The standard error stream is left open
4119 during deliveries.
4120
4121 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4122 false and one of the queueing options in the configuration file is in effect.
4123
4124 If there is a temporary delivery error during foreground delivery, the
4125 message is left on the queue for later delivery, and the original reception
4126 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4127 restricted configuration that never queues messages.
4128
4129
4130 .vitem &%-odi%&
4131 .oindex "&%-odi%&"
4132 This option is synonymous with &%-odf%&. It is provided for compatibility with
4133 Sendmail.
4134
4135 .vitem &%-odq%&
4136 .oindex "&%-odq%&"
4137 .cindex "non-immediate delivery"
4138 .cindex "delivery" "suppressing immediate"
4139 .cindex "queueing incoming messages"
4140 This option applies to all modes in which Exim accepts incoming messages,
4141 including the listening daemon. It specifies that the accepting process should
4142 not automatically start a delivery process for each message received. Messages
4143 are placed on the queue, and remain there until a subsequent queue runner
4144 process encounters them. There are several configuration options (such as
4145 &%queue_only%&) that can be used to queue incoming messages under certain
4146 conditions. This option overrides all of them and also &%-odqs%&. It always
4147 forces queueing.
4148
4149 .vitem &%-odqs%&
4150 .oindex "&%-odqs%&"
4151 .cindex "SMTP" "delaying delivery"
4152 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4153 However, like &%-odb%& and &%-odi%&, this option has no effect if
4154 &%queue_only_override%& is false and one of the queueing options in the
4155 configuration file is in effect.
4156
4157 When &%-odqs%& does operate, a delivery process is started for each incoming
4158 message, in the background by default, but in the foreground if &%-odi%& is
4159 also present. The recipient addresses are routed, and local deliveries are done
4160 in the normal way. However, if any SMTP deliveries are required, they are not
4161 done at this time, so the message remains on the queue until a subsequent queue
4162 runner process encounters it. Because routing was done, Exim knows which
4163 messages are waiting for which hosts, and so a number of messages for the same
4164 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4165 configuration option has the same effect for specific domains. See also the
4166 &%-qq%& option.
4167
4168 .vitem &%-oee%&
4169 .oindex "&%-oee%&"
4170 .cindex "error" "reporting"
4171 If an error is detected while a non-SMTP message is being received (for
4172 example, a malformed address), the error is reported to the sender in a mail
4173 message.
4174
4175 .cindex "return code" "for &%-oee%&"
4176 Provided
4177 this error message is successfully sent, the Exim receiving process
4178 exits with a return code of zero. If not, the return code is 2 if the problem
4179 is that the original message has no recipients, or 1 for any other error.
4180 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4181
4182 .vitem &%-oem%&
4183 .oindex "&%-oem%&"
4184 .cindex "error" "reporting"
4185 .cindex "return code" "for &%-oem%&"
4186 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4187 return code, whether or not the error message was successfully sent.
4188 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4189
4190 .vitem &%-oep%&
4191 .oindex "&%-oep%&"
4192 .cindex "error" "reporting"
4193 If an error is detected while a non-SMTP message is being received, the
4194 error is reported by writing a message to the standard error file (stderr).
4195 .cindex "return code" "for &%-oep%&"
4196 The return code is 1 for all errors.
4197
4198 .vitem &%-oeq%&
4199 .oindex "&%-oeq%&"
4200 .cindex "error" "reporting"
4201 This option is supported for compatibility with Sendmail, but has the same
4202 effect as &%-oep%&.
4203
4204 .vitem &%-oew%&
4205 .oindex "&%-oew%&"
4206 .cindex "error" "reporting"
4207 This option is supported for compatibility with Sendmail, but has the same
4208 effect as &%-oem%&.
4209
4210 .vitem &%-oi%&
4211 .oindex "&%-oi%&"
4212 .cindex "dot" "in incoming non-SMTP message"
4213 This option, which has the same effect as &%-i%&, specifies that a dot on a
4214 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4215 single dot does terminate, though Exim does no special processing for other
4216 lines that start with a dot. This option is set by default if Exim is called as
4217 &'rmail'&. See also &%-ti%&.
4218
4219 .vitem &%-oitrue%&
4220 .oindex "&%-oitrue%&"
4221 This option is treated as synonymous with &%-oi%&.
4222
4223 .vitem &%-oMa%&&~<&'host&~address'&>
4224 .oindex "&%-oMa%&"
4225 .cindex "sender" "host address, specifying for local message"
4226 A number of options starting with &%-oM%& can be used to set values associated
4227 with remote hosts on locally-submitted messages (that is, messages not received
4228 over TCP/IP). These options can be used by any caller in conjunction with the
4229 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4230 other circumstances, they are ignored unless the caller is trusted.
4231
4232 The &%-oMa%& option sets the sender host address. This may include a port
4233 number at the end, after a full stop (period). For example:
4234 .code
4235 exim -bs -oMa 10.9.8.7.1234
4236 .endd
4237 An alternative syntax is to enclose the IP address in square brackets,
4238 followed by a colon and the port number:
4239 .code
4240 exim -bs -oMa [10.9.8.7]:1234
4241 .endd
4242 The IP address is placed in the &$sender_host_address$& variable, and the
4243 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4244 are present on the command line, the sender host IP address is taken from
4245 whichever one is last.
4246
4247 .vitem &%-oMaa%&&~<&'name'&>
4248 .oindex "&%-oMaa%&"
4249 .cindex "authentication" "name, specifying for local message"
4250 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4251 option sets the value of &$sender_host_authenticated$& (the authenticator
4252 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4253 This option can be used with &%-bh%& and &%-bs%& to set up an
4254 authenticated SMTP session without actually using the SMTP AUTH command.
4255
4256 .vitem &%-oMai%&&~<&'string'&>
4257 .oindex "&%-oMai%&"
4258 .cindex "authentication" "id, specifying for local message"
4259 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4260 option sets the value of &$authenticated_id$& (the id that was authenticated).
4261 This overrides the default value (the caller's login id, except with &%-bh%&,
4262 where there is no default) for messages from local sources. See chapter
4263 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4264
4265 .vitem &%-oMas%&&~<&'address'&>
4266 .oindex "&%-oMas%&"
4267 .cindex "authentication" "sender, specifying for local message"
4268 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4269 option sets the authenticated sender value in &$authenticated_sender$&. It
4270 overrides the sender address that is created from the caller's login id for
4271 messages from local sources, except when &%-bh%& is used, when there is no
4272 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4273 specified on a MAIL command overrides this value. See chapter
4274 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4275
4276 .vitem &%-oMi%&&~<&'interface&~address'&>
4277 .oindex "&%-oMi%&"
4278 .cindex "interface" "address, specifying for local message"
4279 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4280 option sets the IP interface address value. A port number may be included,
4281 using the same syntax as for &%-oMa%&. The interface address is placed in
4282 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4283
4284 .vitem &%-oMm%&&~<&'message&~reference'&>
4285 .oindex "&%-oMm%&"
4286 .cindex "message reference" "message reference, specifying for local message"
4287 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4288 option sets the message reference, e.g. message-id, and is logged during
4289 delivery. This is useful when some kind of audit trail is required to tie
4290 messages together. The format of the message reference is checked and will
4291 abort if the format is invalid. The option will only be accepted if exim is
4292 running in trusted mode, not as any regular user.
4293
4294 The best example of a message reference is when Exim sends a bounce message.
4295 The message reference is the message-id of the original message for which Exim
4296 is sending the bounce.
4297
4298 .vitem &%-oMr%&&~<&'protocol&~name'&>
4299 .oindex "&%-oMr%&"
4300 .cindex "protocol, specifying for local message"
4301 .vindex "&$received_protocol$&"
4302 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4303 option sets the received protocol value that is stored in
4304 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4305 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4306 SMTP protocol names (see the description of &$received_protocol$& in section
4307 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4308 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4309 be set by &%-oMr%&. Repeated use of this option is not supported.
4310
4311 .vitem &%-oMs%&&~<&'host&~name'&>
4312 .oindex "&%-oMs%&"
4313 .cindex "sender" "host name, specifying for local message"
4314 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4315 option sets the sender host name in &$sender_host_name$&. When this option is
4316 present, Exim does not attempt to look up a host name from an IP address; it
4317 uses the name it is given.
4318
4319 .vitem &%-oMt%&&~<&'ident&~string'&>
4320 .oindex "&%-oMt%&"
4321 .cindex "sender" "ident string, specifying for local message"
4322 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4323 option sets the sender ident value in &$sender_ident$&. The default setting for
4324 local callers is the login id of the calling process, except when &%-bh%& is
4325 used, when there is no default.
4326
4327 .vitem &%-om%&
4328 .oindex "&%-om%&"
4329 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4330 In Sendmail, this option means &"me too"&, indicating that the sender of a
4331 message should receive a copy of the message if the sender appears in an alias
4332 expansion. Exim always does this, so the option does nothing.
4333
4334 .vitem &%-oo%&
4335 .oindex "&%-oo%&"
4336 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4337 This option is ignored. In Sendmail it specifies &"old style headers"&,
4338 whatever that means.
4339
4340 .vitem &%-oP%&&~<&'path'&>
4341 .oindex "&%-oP%&"
4342 .cindex "pid (process id)" "of daemon"
4343 .cindex "daemon" "process id (pid)"
4344 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4345 value. The option specifies the file to which the process id of the daemon is
4346 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4347 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4348 because in those cases, the normal pid file is not used.
4349
4350 .vitem &%-or%&&~<&'time'&>
4351 .oindex "&%-or%&"
4352 .cindex "timeout" "for non-SMTP input"
4353 This option sets a timeout value for incoming non-SMTP messages. If it is not
4354 set, Exim will wait forever for the standard input. The value can also be set
4355 by the &%receive_timeout%& option. The format used for specifying times is
4356 described in section &<<SECTtimeformat>>&.
4357
4358 .vitem &%-os%&&~<&'time'&>
4359 .oindex "&%-os%&"
4360 .cindex "timeout" "for SMTP input"
4361 .cindex "SMTP" "input timeout"
4362 This option sets a timeout value for incoming SMTP messages. The timeout
4363 applies to each SMTP command and block of data. The value can also be set by
4364 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4365 for specifying times is described in section &<<SECTtimeformat>>&.
4366
4367 .vitem &%-ov%&
4368 .oindex "&%-ov%&"
4369 This option has exactly the same effect as &%-v%&.
4370
4371 .vitem &%-oX%&&~<&'number&~or&~string'&>
4372 .oindex "&%-oX%&"
4373 .cindex "TCP/IP" "setting listening ports"
4374 .cindex "TCP/IP" "setting listening interfaces"
4375 .cindex "port" "receiving TCP/IP"
4376 This option is relevant only when the &%-bd%& (start listening daemon) option
4377 is also given. It controls which ports and interfaces the daemon uses. Details
4378 of the syntax, and how it interacts with configuration file options, are given
4379 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4380 file is written unless &%-oP%& is also present to specify a pid file name.
4381
4382 .vitem &%-pd%&
4383 .oindex "&%-pd%&"
4384 .cindex "Perl" "starting the interpreter"
4385 This option applies when an embedded Perl interpreter is linked with Exim (see
4386 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4387 option, forcing the starting of the interpreter to be delayed until it is
4388 needed.
4389
4390 .vitem &%-ps%&
4391 .oindex "&%-ps%&"
4392 .cindex "Perl" "starting the interpreter"
4393 This option applies when an embedded Perl interpreter is linked with Exim (see
4394 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4395 option, forcing the starting of the interpreter to occur as soon as Exim is
4396 started.
4397
4398 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4399 .oindex "&%-p%&"
4400 For compatibility with Sendmail, this option is equivalent to
4401 .display
4402 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4403 .endd
4404 It sets the incoming protocol and host name (for trusted callers). The
4405 host name and its colon can be omitted when only the protocol is to be set.
4406 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4407 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4408 or &`s`& using this option (but that does not seem a real limitation).
4409 Repeated use of this option is not supported.
4410
4411 .vitem &%-q%&
4412 .oindex "&%-q%&"
4413 .cindex "queue runner" "starting manually"
4414 This option is normally restricted to admin users. However, there is a
4415 configuration option called &%prod_requires_admin%& which can be set false to
4416 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4417 and &%-S%& options).
4418
4419 .cindex "queue runner" "description of operation"
4420 If other commandline options do not specify an action,
4421 the &%-q%& option starts one queue runner process. This scans the queue of
4422 waiting messages, and runs a delivery process for each one in turn. It waits
4423 for each delivery process to finish before starting the next one. A delivery
4424 process may not actually do any deliveries if the retry times for the addresses
4425 have not been reached. Use &%-qf%& (see below) if you want to override this.
4426
4427 If
4428 .cindex "SMTP" "passed connection"
4429 .cindex "SMTP" "multiple deliveries"
4430 .cindex "multiple SMTP deliveries"
4431 the delivery process spawns other processes to deliver other messages down
4432 passed SMTP connections, the queue runner waits for these to finish before
4433 proceeding.
4434
4435 When all the queued messages have been considered, the original queue runner
4436 process terminates. In other words, a single pass is made over the waiting
4437 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4438 this to be repeated periodically.
4439
4440 Exim processes the waiting messages in an unpredictable order. It isn't very
4441 random, but it is likely to be different each time, which is all that matters.
4442 If one particular message screws up a remote MTA, other messages to the same
4443 MTA have a chance of getting through if they get tried first.
4444
4445 It is possible to cause the messages to be processed in lexical message id
4446 order, which is essentially the order in which they arrived, by setting the
4447 &%queue_run_in_order%& option, but this is not recommended for normal use.
4448
4449 .vitem &%-q%&<&'qflags'&>
4450 The &%-q%& option may be followed by one or more flag letters that change its
4451 behaviour. They are all optional, but if more than one is present, they must
4452 appear in the correct order. Each flag is described in a separate item below.
4453
4454 .vitem &%-qq...%&
4455 .oindex "&%-qq%&"
4456 .cindex "queue" "double scanning"
4457 .cindex "queue" "routing"
4458 .cindex "routing" "whole queue before delivery"
4459 An option starting with &%-qq%& requests a two-stage queue run. In the first
4460 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4461 every domain. Addresses are routed, local deliveries happen, but no remote
4462 transports are run.
4463
4464 .cindex "hints database" "remembering routing"
4465 The hints database that remembers which messages are waiting for specific hosts
4466 is updated, as if delivery to those hosts had been deferred. After this is
4467 complete, a second, normal queue scan happens, with routing and delivery taking
4468 place as normal. Messages that are routed to the same host should mostly be
4469 delivered down a single SMTP
4470 .cindex "SMTP" "passed connection"
4471 .cindex "SMTP" "multiple deliveries"
4472 .cindex "multiple SMTP deliveries"
4473 connection because of the hints that were set up during the first queue scan.
4474 This option may be useful for hosts that are connected to the Internet
4475 intermittently.
4476
4477 .vitem &%-q[q]i...%&
4478 .oindex "&%-qi%&"
4479 .cindex "queue" "initial delivery"
4480 If the &'i'& flag is present, the queue runner runs delivery processes only for
4481 those messages that haven't previously been tried. (&'i'& stands for &"initial
4482 delivery"&.) This can be helpful if you are putting messages on the queue using
4483 &%-odq%& and want a queue runner just to process the new messages.
4484
4485 .vitem &%-q[q][i]f...%&
4486 .oindex "&%-qf%&"
4487 .cindex "queue" "forcing delivery"
4488 .cindex "delivery" "forcing in queue run"
4489 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4490 message, whereas without &'f'& only those non-frozen addresses that have passed
4491 their retry times are tried.
4492
4493 .vitem &%-q[q][i]ff...%&
4494 .oindex "&%-qff%&"
4495 .cindex "frozen messages" "forcing delivery"
4496 If &'ff'& is present, a delivery attempt is forced for every message, whether
4497 frozen or not.
4498
4499 .vitem &%-q[q][i][f[f]]l%&
4500 .oindex "&%-ql%&"
4501 .cindex "queue" "local deliveries only"
4502 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4503 be done. If a message requires any remote deliveries, it remains on the queue
4504 for later delivery.
4505
4506 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4507 .oindex "&%-qG%&"
4508 .cindex queue named
4509 .cindex "named queues"
4510 .cindex "queue" "delivering specific messages"
4511 If the &'G'& flag and a name is present, the queue runner operates on the
4512 queue with the given name rather than the default queue.
4513 The name should not contain a &'/'& character.
4514 For a periodic queue run (see below)
4515 append to the name a slash and a time value.
4516
4517 If other commandline options specify an action, a &'-qG<name>'& option
4518 will specify a queue to operate on.
4519 For example:
4520 .code
4521 exim -bp -qGquarantine
4522 mailq -qGquarantine
4523 exim -qGoffpeak -Rf @special.domain.example
4524 .endd
4525
4526 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4527 When scanning the queue, Exim can be made to skip over messages whose ids are
4528 lexically less than a given value by following the &%-q%& option with a
4529 starting message id. For example:
4530 .code
4531 exim -q 0t5C6f-0000c8-00
4532 .endd
4533 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4534 second message id is given, messages whose ids are lexically greater than it
4535 are also skipped. If the same id is given twice, for example,
4536 .code
4537 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4538 .endd
4539 just one delivery process is started, for that message. This differs from
4540 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4541 that it counts as a delivery from a queue run. Note that the selection
4542 mechanism does not affect the order in which the messages are scanned. There
4543 are also other ways of selecting specific sets of messages for delivery in a
4544 queue run &-- see &%-R%& and &%-S%&.
4545
4546 .vitem &%-q%&<&'qflags'&><&'time'&>
4547 .cindex "queue runner" "starting periodically"
4548 .cindex "periodic queue running"
4549 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4550 starting a queue runner process at intervals specified by the given time value
4551 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4552 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4553 single daemon process handles both functions. A common way of starting up a
4554 combined daemon at system boot time is to use a command such as
4555 .code
4556 /usr/exim/bin/exim -bd -q30m
4557 .endd
4558 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4559 process every 30 minutes.
4560
4561 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4562 pid file is written unless one is explicitly requested by the &%-oP%& option.
4563
4564 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4565 .oindex "&%-qR%&"
4566 This option is synonymous with &%-R%&. It is provided for Sendmail
4567 compatibility.
4568
4569 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4570 .oindex "&%-qS%&"
4571 This option is synonymous with &%-S%&.
4572
4573 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4574 .oindex "&%-R%&"
4575 .cindex "queue runner" "for specific recipients"
4576 .cindex "delivery" "to given domain"
4577 .cindex "domain" "delivery to"
4578 The <&'rsflags'&> may be empty, in which case the white space before the string
4579 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4580 which are the possible values for <&'rsflags'&>. White space is required if
4581 <&'rsflags'&> is not empty.
4582
4583 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4584 perform a single queue run, except that, when scanning the messages on the
4585 queue, Exim processes only those that have at least one undelivered recipient
4586 address containing the given string, which is checked in a case-independent
4587 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4588 regular expression; otherwise it is a literal string.
4589
4590 If you want to do periodic queue runs for messages with specific recipients,
4591 you can combine &%-R%& with &%-q%& and a time value. For example:
4592 .code
4593 exim -q25m -R @special.domain.example
4594 .endd
4595 This example does a queue run for messages with recipients in the given domain
4596 every 25 minutes. Any additional flags that are specified with &%-q%& are
4597 applied to each queue run.
4598
4599 Once a message is selected for delivery by this mechanism, all its addresses
4600 are processed. For the first selected message, Exim overrides any retry
4601 information and forces a delivery attempt for each undelivered address. This
4602 means that if delivery of any address in the first message is successful, any
4603 existing retry information is deleted, and so delivery attempts for that
4604 address in subsequently selected messages (which are processed without forcing)
4605 will run. However, if delivery of any address does not succeed, the retry
4606 information is updated, and in subsequently selected messages, the failing
4607 address will be skipped.
4608
4609 .cindex "frozen messages" "forcing delivery"
4610 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4611 all selected messages, not just the first; frozen messages are included when
4612 &'ff'& is present.
4613
4614 The &%-R%& option makes it straightforward to initiate delivery of all messages
4615 to a given domain after a host has been down for some time. When the SMTP
4616 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4617 effect is to run Exim with the &%-R%& option, but it can be configured to run
4618 an arbitrary command instead.
4619
4620 .vitem &%-r%&
4621 .oindex "&%-r%&"
4622 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4623
4624 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4625 .oindex "&%-S%&"
4626 .cindex "delivery" "from given sender"
4627 .cindex "queue runner" "for specific senders"
4628 This option acts like &%-R%& except that it checks the string against each
4629 message's sender instead of against the recipients. If &%-R%& is also set, both
4630 conditions must be met for a message to be selected. If either of the options
4631 has &'f'& or &'ff'& in its flags, the associated action is taken.
4632
4633 .vitem &%-Tqt%&&~<&'times'&>
4634 .oindex "&%-Tqt%&"
4635 This is an option that is exclusively for use by the Exim testing suite. It is not
4636 recognized when Exim is run normally. It allows for the setting up of explicit
4637 &"queue times"& so that various warning/retry features can be tested.
4638
4639 .vitem &%-t%&
4640 .oindex "&%-t%&"
4641 .cindex "recipient" "extracting from header lines"
4642 .cindex "&'Bcc:'& header line"
4643 .cindex "&'Cc:'& header line"
4644 .cindex "&'To:'& header line"
4645 When Exim is receiving a locally-generated, non-SMTP message on its standard
4646 input, the &%-t%& option causes the recipients of the message to be obtained
4647 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4648 from the command arguments. The addresses are extracted before any rewriting
4649 takes place and the &'Bcc:'& header line, if present, is then removed.
4650
4651 .cindex "Sendmail compatibility" "&%-t%& option"
4652 If the command has any arguments, they specify addresses to which the message
4653 is &'not'& to be delivered. That is, the argument addresses are removed from
4654 the recipients list obtained from the headers. This is compatible with Smail 3
4655 and in accordance with the documented behaviour of several versions of
4656 Sendmail, as described in man pages on a number of operating systems (e.g.
4657 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4658 argument addresses to those obtained from the headers, and the O'Reilly
4659 Sendmail book documents it that way. Exim can be made to add argument addresses
4660 instead of subtracting them by setting the option
4661 &%extract_addresses_remove_arguments%& false.
4662
4663 .cindex "&%Resent-%& header lines" "with &%-t%&"
4664 If there are any &%Resent-%& header lines in the message, Exim extracts
4665 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4666 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4667 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4668 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4669
4670 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4671 message is resent several times). The RFC also specifies that they should be
4672 added at the front of the message, and separated by &'Received:'& lines. It is
4673 not at all clear how &%-t%& should operate in the present of multiple sets,
4674 nor indeed exactly what constitutes a &"set"&.
4675 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4676 are often added at the end of the header, and if a message is resent more than
4677 once, it is common for the original set of &%Resent-%& headers to be renamed as
4678 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4679
4680 .vitem &%-ti%&
4681 .oindex "&%-ti%&"
4682 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4683 compatibility with Sendmail.
4684
4685 .vitem &%-tls-on-connect%&
4686 .oindex "&%-tls-on-connect%&"
4687 .cindex "TLS" "use without STARTTLS"
4688 .cindex "TLS" "automatic start"
4689 This option is available when Exim is compiled with TLS support. It forces all
4690 incoming SMTP connections to behave as if the incoming port is listed in the
4691 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4692 &<<CHAPTLS>>& for further details.
4693
4694
4695 .vitem &%-U%&
4696 .oindex "&%-U%&"
4697 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4698 Sendmail uses this option for &"initial message submission"&, and its
4699 documentation states that in future releases, it may complain about
4700 syntactically invalid messages rather than fixing them when this flag is not
4701 set. Exim ignores this option.
4702
4703 .vitem &%-v%&
4704 .oindex "&%-v%&"
4705 This option causes Exim to write information to the standard error stream,
4706 describing what it is doing. In particular, it shows the log lines for
4707 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4708 dialogue is shown. Some of the log lines shown may not actually be written to
4709 the log if the setting of &%log_selector%& discards them. Any relevant
4710 selectors are shown with each log line. If none are shown, the logging is
4711 unconditional.
4712
4713 .vitem &%-x%&
4714 .oindex "&%-x%&"
4715 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4716 National Language Support extended characters in the body of the mail item"&).
4717 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4718 this option.
4719
4720 .vitem &%-X%&&~<&'logfile'&>
4721 .oindex "&%-X%&"
4722 This option is interpreted by Sendmail to cause debug information to be sent
4723 to the named file.  It is ignored by Exim.
4724
4725 .vitem &%-z%&&~<&'log-line'&>
4726 .oindex "&%-z%&"
4727 This option writes its argument to Exim's logfile.
4728 Use is restricted to administrators; the intent is for operational notes.
4729 Quotes should be used to maintain a multi-word item as a single argument,
4730 under most shells.
4731 .endlist
4732
4733 .ecindex IIDclo1
4734 .ecindex IIDclo2
4735
4736
4737 . ////////////////////////////////////////////////////////////////////////////
4738 . Insert a stylized DocBook comment here, to identify the end of the command
4739 . line options. This is for the benefit of the Perl script that automatically
4740 . creates a man page for the options.
4741 . ////////////////////////////////////////////////////////////////////////////
4742
4743 .literal xml
4744 <!-- === End of command line options === -->
4745 .literal off
4746
4747
4748
4749
4750
4751 . ////////////////////////////////////////////////////////////////////////////
4752 . ////////////////////////////////////////////////////////////////////////////
4753
4754
4755 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4756          "The runtime configuration file"
4757
4758 .cindex "run time configuration"
4759 .cindex "configuration file" "general description"
4760 .cindex "CONFIGURE_FILE"
4761 .cindex "configuration file" "errors in"
4762 .cindex "error" "in configuration file"
4763 .cindex "return code" "for bad configuration"
4764 Exim uses a single run time configuration file that is read whenever an Exim
4765 binary is executed. Note that in normal operation, this happens frequently,
4766 because Exim is designed to operate in a distributed manner, without central
4767 control.
4768
4769 If a syntax error is detected while reading the configuration file, Exim
4770 writes a message on the standard error, and exits with a non-zero return code.
4771 The message is also written to the panic log. &*Note*&: Only simple syntax
4772 errors can be detected at this time. The values of any expanded options are
4773 not checked until the expansion happens, even when the expansion does not
4774 actually alter the string.
4775
4776 The name of the configuration file is compiled into the binary for security
4777 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4778 most configurations, this specifies a single file. However, it is permitted to
4779 give a colon-separated list of file names, in which case Exim uses the first
4780 existing file in the list.
4781
4782 .cindex "EXIM_USER"
4783 .cindex "EXIM_GROUP"
4784 .cindex "CONFIGURE_OWNER"
4785 .cindex "CONFIGURE_GROUP"
4786 .cindex "configuration file" "ownership"
4787 .cindex "ownership" "configuration file"
4788 The run time configuration file must be owned by root or by the user that is
4789 specified at compile time by the CONFIGURE_OWNER option (if set). The
4790 configuration file must not be world-writeable, or group-writeable unless its
4791 group is the root group or the one specified at compile time by the
4792 CONFIGURE_GROUP option.
4793
4794 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4795 to root, anybody who is able to edit the run time configuration file has an
4796 easy way to run commands as root. If you specify a user or group in the
4797 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4798 who are members of that group will trivially be able to obtain root privileges.
4799
4800 Up to Exim version 4.72, the run time configuration file was also permitted to
4801 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4802 since it offered a simple privilege escalation for any attacker who managed to
4803 compromise the Exim user account.
4804
4805 A default configuration file, which will work correctly in simple situations,
4806 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4807 defines just one file name, the installation process copies the default
4808 configuration to a new file of that name if it did not previously exist. If
4809 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4810 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4811 configuration.
4812
4813
4814
4815 .section "Using a different configuration file" "SECID40"
4816 .cindex "configuration file" "alternate"
4817 A one-off alternate configuration can be specified by the &%-C%& command line
4818 option, which may specify a single file or a list of files. However, when
4819 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4820 unless the argument for &%-C%& is identical to the built-in value from
4821 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4822 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4823 is useful mainly for checking the syntax of configuration files before
4824 installing them. No owner or group checks are done on a configuration file
4825 specified by &%-C%&, if root privilege has been dropped.
4826
4827 Even the Exim user is not trusted to specify an arbitrary configuration file
4828 with the &%-C%& option to be used with root privileges, unless that file is
4829 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4830 testing a configuration using &%-C%& right through message reception and
4831 delivery, even if the caller is root. The reception works, but by that time,
4832 Exim is running as the Exim user, so when it re-execs to regain privilege for
4833 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4834 can test reception and delivery using two separate commands (one to put a
4835 message on the queue, using &%-odq%&, and another to do the delivery, using
4836 &%-M%&).
4837
4838 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4839 prefix string with which any file named in a &%-C%& command line option must
4840 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4841 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4842 name can be used with &%-C%&.
4843
4844 One-off changes to a configuration can be specified by the &%-D%& command line
4845 option, which defines and overrides values for macros used inside the
4846 configuration file. However, like &%-C%&, the use of this option by a
4847 non-privileged user causes Exim to discard its root privilege.
4848 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4849 completely disabled, and its use causes an immediate error exit.
4850
4851 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4852 to declare certain macro names trusted, such that root privilege will not
4853 necessarily be discarded.
4854 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4855 considered safe and, if &%-D%& only supplies macros from this list, and the
4856 values are acceptable, then Exim will not give up root privilege if the caller
4857 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4858 transition mechanism and is expected to be removed in the future.  Acceptable
4859 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4860
4861 Some sites may wish to use the same Exim binary on different machines that
4862 share a file system, but to use different configuration files on each machine.
4863 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4864 looks for a file whose name is the configuration file name followed by a dot
4865 and the machine's node name, as obtained from the &[uname()]& function. If this
4866 file does not exist, the standard name is tried. This processing occurs for
4867 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4868
4869 In some esoteric situations different versions of Exim may be run under
4870 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4871 help with this. See the comments in &_src/EDITME_& for details.
4872
4873
4874
4875 .section "Configuration file format" "SECTconffilfor"
4876 .cindex "configuration file" "format of"
4877 .cindex "format" "configuration file"
4878 Exim's configuration file is divided into a number of different parts. General
4879 option settings must always appear at the start of the file. The other parts
4880 are all optional, and may appear in any order. Each part other than the first
4881 is introduced by the word &"begin"& followed by at least one literal
4882 space, and the name of the part. The optional parts are:
4883
4884 .ilist
4885 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4886 &<<CHAPACL>>&).
4887 .next
4888 .cindex "AUTH" "configuration"
4889 &'authenticators'&: Configuration settings for the authenticator drivers. These
4890 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4891 .next
4892 &'routers'&: Configuration settings for the router drivers. Routers process
4893 addresses and determine how the message is to be delivered (see chapters
4894 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4895 .next
4896 &'transports'&: Configuration settings for the transport drivers. Transports
4897 define mechanisms for copying messages to destinations (see chapters
4898 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4899 .next
4900 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4901 If there is no retry section, or if it is empty (that is, no retry rules are
4902 defined), Exim will not retry deliveries. In this situation, temporary errors
4903 are treated the same as permanent errors. Retry rules are discussed in chapter
4904 &<<CHAPretry>>&.
4905 .next
4906 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4907 when new addresses are generated during delivery. Rewriting is discussed in
4908 chapter &<<CHAPrewrite>>&.
4909 .next
4910 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4911 want to use this feature, you must set
4912 .code
4913 LOCAL_SCAN_HAS_OPTIONS=yes
4914 .endd
4915 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4916 facility are given in chapter &<<CHAPlocalscan>>&.
4917 .endlist
4918
4919 .cindex "configuration file" "leading white space in"
4920 .cindex "configuration file" "trailing white space in"
4921 .cindex "white space" "in configuration file"
4922 Leading and trailing white space in configuration lines is always ignored.
4923
4924 Blank lines in the file, and lines starting with a # character (ignoring
4925 leading white space) are treated as comments and are ignored. &*Note*&: A
4926 # character other than at the beginning of a line is not treated specially,
4927 and does not introduce a comment.
4928
4929 Any non-comment line can be continued by ending it with a backslash. Note that
4930 the general rule for white space means that trailing white space after the
4931 backslash and leading white space at the start of continuation
4932 lines is ignored. Comment lines beginning with # (but not empty lines) may
4933 appear in the middle of a sequence of continuation lines.
4934
4935 A convenient way to create a configuration file is to start from the
4936 default, which is supplied in &_src/configure.default_&, and add, delete, or
4937 change settings as required.
4938
4939 The ACLs, retry rules, and rewriting rules have their own syntax which is
4940 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4941 respectively. The other parts of the configuration file have some syntactic
4942 items in common, and these are described below, from section &<<SECTcos>>&
4943 onwards. Before that, the inclusion, macro, and conditional facilities are
4944 described.
4945
4946
4947
4948 .section "File inclusions in the configuration file" "SECID41"
4949 .cindex "inclusions in configuration file"
4950 .cindex "configuration file" "including other files"
4951 .cindex "&`.include`& in configuration file"
4952 .cindex "&`.include_if_exists`& in configuration file"
4953 You can include other files inside Exim's run time configuration file by
4954 using this syntax:
4955 .display
4956 &`.include`& <&'file name'&>
4957 &`.include_if_exists`& <&'file name'&>
4958 .endd
4959 on a line by itself. Double quotes round the file name are optional. If you use
4960 the first form, a configuration error occurs if the file does not exist; the
4961 second form does nothing for non-existent files.
4962 The first form allows a relative name. It is resolved relative to
4963 the directory of the including file. For the second form an absolute file
4964 name is required.
4965
4966 Includes may be nested to any depth, but remember that Exim reads its
4967 configuration file often, so it is a good idea to keep them to a minimum.
4968 If you change the contents of an included file, you must HUP the daemon,
4969 because an included file is read only when the configuration itself is read.
4970
4971 The processing of inclusions happens early, at a physical line level, so, like
4972 comment lines, an inclusion can be used in the middle of an option setting,
4973 for example:
4974 .code
4975 hosts_lookup = a.b.c \
4976                .include /some/file
4977 .endd
4978 Include processing happens after macro processing (see below). Its effect is to
4979 process the lines of the included file as if they occurred inline where the
4980 inclusion appears.
4981
4982
4983
4984 .section "Macros in the configuration file" "SECTmacrodefs"
4985 .cindex "macro" "description of"
4986 .cindex "configuration file" "macros"
4987 If a line in the main part of the configuration (that is, before the first
4988 &"begin"& line) begins with an upper case letter, it is taken as a macro
4989 definition, and must be of the form
4990 .display
4991 <&'name'&> = <&'rest of line'&>
4992 .endd
4993 The name must consist of letters, digits, and underscores, and need not all be
4994 in upper case, though that is recommended. The rest of the line, including any
4995 continuations, is the replacement text, and has leading and trailing white
4996 space removed. Quotes are not removed. The replacement text can never end with
4997 a backslash character, but this doesn't seem to be a serious limitation.
4998
4999 Macros may also be defined between router, transport, authenticator, or ACL
5000 definitions. They may not, however, be defined within an individual driver or
5001 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5002
5003 .section "Macro substitution" "SECID42"
5004 Once a macro is defined, all subsequent lines in the file (and any included
5005 files) are scanned for the macro name; if there are several macros, the line is
5006 scanned for each in turn, in the order in which the macros are defined. The
5007 replacement text is not re-scanned for the current macro, though it is scanned
5008 for subsequently defined macros. For this reason, a macro name may not contain
5009 the name of a previously defined macro as a substring. You could, for example,
5010 define
5011 .display
5012 &`ABCD_XYZ = `&<&'something'&>
5013 &`ABCD = `&<&'something else'&>
5014 .endd
5015 but putting the definitions in the opposite order would provoke a configuration
5016 error. Macro expansion is applied to individual physical lines from the file,
5017 before checking for line continuation or file inclusion (see above). If a line
5018 consists solely of a macro name, and the expansion of the macro is empty, the
5019 line is ignored. A macro at the start of a line may turn the line into a
5020 comment line or a &`.include`& line.
5021
5022
5023 .section "Redefining macros" "SECID43"
5024 Once defined, the value of a macro can be redefined later in the configuration
5025 (or in an included file). Redefinition is specified by using &'=='& instead of
5026 &'='&. For example:
5027 .code
5028 MAC =  initial value
5029 ...
5030 MAC == updated value
5031 .endd
5032 Redefinition does not alter the order in which the macros are applied to the
5033 subsequent lines of the configuration file. It is still the same order in which
5034 the macros were originally defined. All that changes is the macro's value.
5035 Redefinition makes it possible to accumulate values. For example:
5036 .code
5037 MAC =  initial value
5038 ...
5039 MAC == MAC and something added
5040 .endd
5041 This can be helpful in situations where the configuration file is built
5042 from a number of other files.
5043
5044 .section "Overriding macro values" "SECID44"
5045 The values set for macros in the configuration file can be overridden by the
5046 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5047 used, unless called by root or the Exim user. A definition on the command line
5048 using the &%-D%& option causes all definitions and redefinitions within the
5049 file to be ignored.
5050
5051
5052
5053 .section "Example of macro usage" "SECID45"
5054 As an example of macro usage, consider a configuration where aliases are looked
5055 up in a MySQL database. It helps to keep the file less cluttered if long
5056 strings such as SQL statements are defined separately as macros, for example:
5057 .code
5058 ALIAS_QUERY = select mailbox from user where \
5059               login='${quote_mysql:$local_part}';
5060 .endd
5061 This can then be used in a &(redirect)& router setting like this:
5062 .code
5063 data = ${lookup mysql{ALIAS_QUERY}}
5064 .endd
5065 In earlier versions of Exim macros were sometimes used for domain, host, or
5066 address lists. In Exim 4 these are handled better by named lists &-- see
5067 section &<<SECTnamedlists>>&.
5068
5069
5070 .section "Builtin macros" "SECTbuiltinmacros"
5071 Exim defines some macros depending on facilities available, which may
5072 differ due to build-time definitions and from one release to another.
5073 All of these macros start with an underscore.
5074 They can be used to conditionally include parts of a configuration
5075 (see below).
5076
5077 The following classes of macros are defined:
5078 .display
5079 &` _HAVE_*                    `&  build-time defines
5080 &` _DRIVER_ROUTER_*           `&  router drivers
5081 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5082 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5083 &` _LOG_*                     `&  log_selector values
5084 &` _OPT_MAIN_*                `&  main config options
5085 &` _OPT_ROUTERS_*             `&  generic router options
5086 &` _OPT_TRANSPORTS_*          `&  generic transport options
5087 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5088 &` _OPT_ROUTER_*_*            `&  private router options
5089 &` _OPT_TRANSPORT_*_*         `&  private transport options
5090 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5091 .endd
5092
5093 Use an &"exim -bP macros"& command to get the list of macros.
5094
5095
5096 .section "Conditional skips in the configuration file" "SECID46"
5097 .cindex "configuration file" "conditional skips"
5098 .cindex "&`.ifdef`&"
5099 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5100 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5101 portions of the configuration file. The processing happens whenever the file is
5102 read (that is, when an Exim binary starts to run).
5103
5104 The implementation is very simple. Instances of the first four directives must
5105 be followed by text that includes the names of one or macros. The condition
5106 that is tested is whether or not any macro substitution has taken place in the
5107 line. Thus:
5108 .code
5109 .ifdef AAA
5110 message_size_limit = 50M
5111 .else
5112 message_size_limit = 100M
5113 .endif
5114 .endd
5115 sets a message size limit of 50M if the macro &`AAA`& is defined
5116 (or &`A`& or &`AA`&), and 100M
5117 otherwise. If there is more than one macro named on the line, the condition
5118 is true if any of them are defined. That is, it is an &"or"& condition. To
5119 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5120
5121 Although you can use a macro expansion to generate one of these directives,
5122 it is not very useful, because the condition &"there was a macro substitution
5123 in this line"& will always be true.
5124
5125 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5126 to clarify complicated nestings.
5127
5128
5129
5130 .section "Common option syntax" "SECTcos"
5131 .cindex "common option syntax"
5132 .cindex "syntax of common options"
5133 .cindex "configuration file" "common option syntax"
5134 For the main set of options, driver options, and &[local_scan()]& options,
5135 each setting is on a line by itself, and starts with a name consisting of
5136 lower-case letters and underscores. Many options require a data value, and in
5137 these cases the name must be followed by an equals sign (with optional white
5138 space) and then the value. For example:
5139 .code
5140 qualify_domain = mydomain.example.com
5141 .endd
5142 .cindex "hiding configuration option values"
5143 .cindex "configuration options" "hiding value of"
5144 .cindex "options" "hiding value of"
5145 Some option settings may contain sensitive data, for example, passwords for
5146 accessing databases. To stop non-admin users from using the &%-bP%& command
5147 line option to read these values, you can precede the option settings with the
5148 word &"hide"&. For example:
5149 .code
5150 hide mysql_servers = localhost/users/admin/secret-password
5151 .endd
5152 For non-admin users, such options are displayed like this:
5153 .code
5154 mysql_servers = <value not displayable>
5155 .endd
5156 If &"hide"& is used on a driver option, it hides the value of that option on
5157 all instances of the same driver.
5158
5159 The following sections describe the syntax used for the different data types
5160 that are found in option settings.
5161
5162
5163 .section "Boolean options" "SECID47"
5164 .cindex "format" "boolean"
5165 .cindex "boolean configuration values"
5166 .oindex "&%no_%&&'xxx'&"
5167 .oindex "&%not_%&&'xxx'&"
5168 Options whose type is given as boolean are on/off switches. There are two
5169 different ways of specifying such options: with and without a data value. If
5170 the option name is specified on its own without data, the switch is turned on;
5171 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5172 boolean options may be followed by an equals sign and one of the words
5173 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5174 the following two settings have exactly the same effect:
5175 .code
5176 queue_only
5177 queue_only = true
5178 .endd
5179 The following two lines also have the same (opposite) effect:
5180 .code
5181 no_queue_only
5182 queue_only = false
5183 .endd
5184 You can use whichever syntax you prefer.
5185
5186
5187
5188
5189 .section "Integer values" "SECID48"
5190 .cindex "integer configuration values"
5191 .cindex "format" "integer"
5192 If an option's type is given as &"integer"&, the value can be given in decimal,
5193 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5194 number is assumed. Otherwise, it is treated as an octal number unless it starts
5195 with the characters &"0x"&, in which case the remainder is interpreted as a
5196 hexadecimal number.
5197
5198 If an integer value is followed by the letter K, it is multiplied by 1024; if
5199 it is followed by the letter M, it is multiplied by 1024x1024;
5200 if by the letter G, 1024x1024x1024.
5201 When the values
5202 of integer option settings are output, values which are an exact multiple of
5203 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5204 and M. The printing style is independent of the actual input format that was
5205 used.
5206
5207
5208 .section "Octal integer values" "SECID49"
5209 .cindex "integer format"
5210 .cindex "format" "octal integer"
5211 If an option's type is given as &"octal integer"&, its value is always
5212 interpreted as an octal number, whether or not it starts with the digit zero.
5213 Such options are always output in octal.
5214
5215
5216 .section "Fixed point numbers" "SECID50"
5217 .cindex "fixed point configuration values"
5218 .cindex "format" "fixed point"
5219 If an option's type is given as &"fixed-point"&, its value must be a decimal
5220 integer, optionally followed by a decimal point and up to three further digits.
5221
5222
5223
5224 .section "Time intervals" "SECTtimeformat"
5225 .cindex "time interval" "specifying in configuration"
5226 .cindex "format" "time interval"
5227 A time interval is specified as a sequence of numbers, each followed by one of
5228 the following letters, with no intervening white space:
5229
5230 .table2 30pt
5231 .irow &%s%& seconds
5232 .irow &%m%& minutes
5233 .irow &%h%& hours
5234 .irow &%d%& days
5235 .irow &%w%& weeks
5236 .endtable
5237
5238 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5239 intervals are output in the same format. Exim does not restrict the values; it
5240 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5241
5242
5243
5244 .section "String values" "SECTstrings"
5245 .cindex "string" "format of configuration values"
5246 .cindex "format" "string"
5247 If an option's type is specified as &"string"&, the value can be specified with
5248 or without double-quotes. If it does not start with a double-quote, the value
5249 consists of the remainder of the line plus any continuation lines, starting at
5250 the first character after any leading white space, with trailing white space
5251 removed, and with no interpretation of the characters in the string. Because
5252 Exim removes comment lines (those beginning with #) at an early stage, they can
5253 appear in the middle of a multi-line string. The following two settings are
5254 therefore equivalent:
5255 .code
5256 trusted_users = uucp:mail
5257 trusted_users = uucp:\
5258                 # This comment line is ignored
5259                 mail
5260 .endd
5261 .cindex "string" "quoted"
5262 .cindex "escape characters in quoted strings"
5263 If a string does start with a double-quote, it must end with a closing
5264 double-quote, and any backslash characters other than those used for line
5265 continuation are interpreted as escape characters, as follows:
5266
5267 .table2 100pt
5268 .irow &`\\`&                     "single backslash"
5269 .irow &`\n`&                     "newline"
5270 .irow &`\r`&                     "carriage return"
5271 .irow &`\t`&                     "tab"
5272 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5273 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5274                                    character"
5275 .endtable
5276
5277 If a backslash is followed by some other character, including a double-quote
5278 character, that character replaces the pair.
5279
5280 Quoting is necessary only if you want to make use of the backslash escapes to
5281 insert special characters, or if you need to specify a value with leading or
5282 trailing spaces. These cases are rare, so quoting is almost never needed in
5283 current versions of Exim. In versions of Exim before 3.14, quoting was required
5284 in order to continue lines, so you may come across older configuration files
5285 and examples that apparently quote unnecessarily.
5286
5287
5288 .section "Expanded strings" "SECID51"
5289 .cindex "expansion" "definition of"
5290 Some strings in the configuration file are subjected to &'string expansion'&,
5291 by which means various parts of the string may be changed according to the
5292 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5293 is as just described; in particular, the handling of backslashes in quoted
5294 strings is done as part of the input process, before expansion takes place.
5295 However, backslash is also an escape character for the expander, so any
5296 backslashes that are required for that reason must be doubled if they are
5297 within a quoted configuration string.
5298
5299
5300 .section "User and group names" "SECID52"
5301 .cindex "user name" "format of"
5302 .cindex "format" "user name"
5303 .cindex "groups" "name format"
5304 .cindex "format" "group name"
5305 User and group names are specified as strings, using the syntax described
5306 above, but the strings are interpreted specially. A user or group name must
5307 either consist entirely of digits, or be a name that can be looked up using the
5308 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5309
5310
5311 .section "List construction" "SECTlistconstruct"
5312 .cindex "list" "syntax of in configuration"
5313 .cindex "format" "list item in configuration"
5314 .cindex "string" "list, definition of"
5315 The data for some configuration options is a list of items, with colon as the
5316 default separator. Many of these options are shown with type &"string list"& in
5317 the descriptions later in this document. Others are listed as &"domain list"&,
5318 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5319 are all the same; however, those other than &"string list"& are subject to
5320 particular kinds of interpretation, as described in chapter
5321 &<<CHAPdomhosaddlists>>&.
5322
5323 In all these cases, the entire list is treated as a single string as far as the
5324 input syntax is concerned. The &%trusted_users%& setting in section
5325 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5326 in a list, it must be entered as two colons. Leading and trailing white space
5327 on each item in a list is ignored. This makes it possible to include items that
5328 start with a colon, and in particular, certain forms of IPv6 address. For
5329 example, the list
5330 .code
5331 local_interfaces = 127.0.0.1 : ::::1
5332 .endd
5333 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5334
5335 &*Note*&: Although leading and trailing white space is ignored in individual
5336 list items, it is not ignored when parsing the list. The space after the first
5337 colon in the example above is necessary. If it were not there, the list would
5338 be interpreted as the two items 127.0.0.1:: and 1.
5339
5340 .section "Changing list separators" "SECTlistsepchange"
5341 .cindex "list separator" "changing"
5342 .cindex "IPv6" "addresses in lists"
5343 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5344 introduced to allow the separator character to be changed. If a list begins
5345 with a left angle bracket, followed by any punctuation character, that
5346 character is used instead of colon as the list separator. For example, the list
5347 above can be rewritten to use a semicolon separator like this:
5348 .code
5349 local_interfaces = <; 127.0.0.1 ; ::1
5350 .endd
5351 This facility applies to all lists, with the exception of the list in
5352 &%log_file_path%&. It is recommended that the use of non-colon separators be
5353 confined to circumstances where they really are needed.
5354
5355 .cindex "list separator" "newline as"
5356 .cindex "newline" "as list separator"
5357 It is also possible to use newline and other control characters (those with
5358 code values less than 32, plus DEL) as separators in lists. Such separators
5359 must be provided literally at the time the list is processed. For options that
5360 are string-expanded, you can write the separator using a normal escape
5361 sequence. This will be processed by the expander before the string is
5362 interpreted as a list. For example, if a newline-separated list of domains is
5363 generated by a lookup, you can process it directly by a line such as this:
5364 .code
5365 domains = <\n ${lookup mysql{.....}}
5366 .endd
5367 This avoids having to change the list separator in such data. You are unlikely
5368 to want to use a control character as a separator in an option that is not
5369 expanded, because the value is literal text. However, it can be done by giving
5370 the value in quotes. For example:
5371 .code
5372 local_interfaces = "<\n 127.0.0.1 \n ::1"
5373 .endd
5374 Unlike printing character separators, which can be included in list items by
5375 doubling, it is not possible to include a control character as data when it is
5376 set as the separator. Two such characters in succession are interpreted as
5377 enclosing an empty list item.
5378
5379
5380
5381 .section "Empty items in lists" "SECTempitelis"
5382 .cindex "list" "empty item in"
5383 An empty item at the end of a list is always ignored. In other words, trailing
5384 separator characters are ignored. Thus, the list in
5385 .code
5386 senders = user@domain :
5387 .endd
5388 contains only a single item. If you want to include an empty string as one item
5389 in a list, it must not be the last item. For example, this list contains three
5390 items, the second of which is empty:
5391 .code
5392 senders = user1@domain : : user2@domain
5393 .endd
5394 &*Note*&: There must be white space between the two colons, as otherwise they
5395 are interpreted as representing a single colon data character (and the list
5396 would then contain just one item). If you want to specify a list that contains
5397 just one, empty item, you can do it as in this example:
5398 .code
5399 senders = :
5400 .endd
5401 In this case, the first item is empty, and the second is discarded because it
5402 is at the end of the list.
5403
5404
5405
5406
5407 .section "Format of driver configurations" "SECTfordricon"
5408 .cindex "drivers" "configuration format"
5409 There are separate parts in the configuration for defining routers, transports,
5410 and authenticators. In each part, you are defining a number of driver
5411 instances, each with its own set of options. Each driver instance is defined by
5412 a sequence of lines like this:
5413 .display
5414 <&'instance name'&>:
5415   <&'option'&>
5416   ...
5417   <&'option'&>
5418 .endd
5419 In the following example, the instance name is &(localuser)&, and it is
5420 followed by three options settings:
5421 .code
5422 localuser:
5423   driver = accept
5424   check_local_user
5425   transport = local_delivery
5426 .endd
5427 For each driver instance, you specify which Exim code module it uses &-- by the
5428 setting of the &%driver%& option &-- and (optionally) some configuration
5429 settings. For example, in the case of transports, if you want a transport to
5430 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5431 a local file you would use the &(appendfile)& driver. Each of the drivers is
5432 described in detail in its own separate chapter later in this manual.
5433
5434 You can have several routers, transports, or authenticators that are based on
5435 the same underlying driver (each must have a different instance name).
5436
5437 The order in which routers are defined is important, because addresses are
5438 passed to individual routers one by one, in order. The order in which
5439 transports are defined does not matter at all. The order in which
5440 authenticators are defined is used only when Exim, as a client, is searching
5441 them to find one that matches an authentication mechanism offered by the
5442 server.
5443
5444 .cindex "generic options"
5445 .cindex "options" "generic &-- definition of"
5446 Within a driver instance definition, there are two kinds of option: &'generic'&
5447 and &'private'&. The generic options are those that apply to all drivers of the
5448 same type (that is, all routers, all transports or all authenticators). The
5449 &%driver%& option is a generic option that must appear in every definition.
5450 .cindex "private options"
5451 The private options are special for each driver, and none need appear, because
5452 they all have default values.
5453
5454 The options may appear in any order, except that the &%driver%& option must
5455 precede any private options, since these depend on the particular driver. For
5456 this reason, it is recommended that &%driver%& always be the first option.
5457
5458 Driver instance names, which are used for reference in log entries and
5459 elsewhere, can be any sequence of letters, digits, and underscores (starting
5460 with a letter) and must be unique among drivers of the same type. A router and
5461 a transport (for example) can each have the same name, but no two router
5462 instances can have the same name. The name of a driver instance should not be
5463 confused with the name of the underlying driver module. For example, the
5464 configuration lines:
5465 .code
5466 remote_smtp:
5467   driver = smtp
5468 .endd
5469 create an instance of the &(smtp)& transport driver whose name is
5470 &(remote_smtp)&. The same driver code can be used more than once, with
5471 different instance names and different option settings each time. A second
5472 instance of the &(smtp)& transport, with different options, might be defined
5473 thus:
5474 .code
5475 special_smtp:
5476   driver = smtp
5477   port = 1234
5478   command_timeout = 10s
5479 .endd
5480 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5481 these transport instances from routers, and these names would appear in log
5482 lines.
5483
5484 Comment lines may be present in the middle of driver specifications. The full
5485 list of option settings for any particular driver instance, including all the
5486 defaulted values, can be extracted by making use of the &%-bP%& command line
5487 option.
5488
5489
5490
5491
5492
5493
5494 . ////////////////////////////////////////////////////////////////////////////
5495 . ////////////////////////////////////////////////////////////////////////////
5496
5497 .chapter "The default configuration file" "CHAPdefconfil"
5498 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5499 .cindex "default" "configuration file &""walk through""&"
5500 The default configuration file supplied with Exim as &_src/configure.default_&
5501 is sufficient for a host with simple mail requirements. As an introduction to
5502 the way Exim is configured, this chapter &"walks through"& the default
5503 configuration, giving brief explanations of the settings. Detailed descriptions
5504 of the options are given in subsequent chapters. The default configuration file
5505 itself contains extensive comments about ways you might want to modify the
5506 initial settings. However, note that there are many options that are not
5507 mentioned at all in the default configuration.
5508
5509
5510
5511 .section "Main configuration settings" "SECTdefconfmain"
5512 The main (global) configuration option settings must always come first in the
5513 file. The first thing you'll see in the file, after some initial comments, is
5514 the line
5515 .code
5516 # primary_hostname =
5517 .endd
5518 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5519 to know the official, fully qualified name of your host, and this is where you
5520 can specify it. However, in most cases you do not need to set this option. When
5521 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5522
5523 The first three non-comment configuration lines are as follows:
5524 .code
5525 domainlist local_domains    = @
5526 domainlist relay_to_domains =
5527 hostlist   relay_from_hosts = 127.0.0.1
5528 .endd
5529 These are not, in fact, option settings. They are definitions of two named
5530 domain lists and one named host list. Exim allows you to give names to lists of
5531 domains, hosts, and email addresses, in order to make it easier to manage the
5532 configuration file (see section &<<SECTnamedlists>>&).
5533
5534 The first line defines a domain list called &'local_domains'&; this is used
5535 later in the configuration to identify domains that are to be delivered
5536 on the local host.
5537
5538 .cindex "@ in a domain list"
5539 There is just one item in this list, the string &"@"&. This is a special form
5540 of entry which means &"the name of the local host"&. Thus, if the local host is
5541 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5542 be delivered locally. Because the local host's name is referenced indirectly,
5543 the same configuration file can be used on different hosts.
5544
5545 The second line defines a domain list called &'relay_to_domains'&, but the
5546 list itself is empty. Later in the configuration we will come to the part that
5547 controls mail relaying through the local host; it allows relaying to any
5548 domains in this list. By default, therefore, no relaying on the basis of a mail
5549 domain is permitted.
5550
5551 The third line defines a host list called &'relay_from_hosts'&. This list is
5552 used later in the configuration to permit relaying from any host or IP address
5553 that matches the list. The default contains just the IP address of the IPv4
5554 loopback interface, which means that processes on the local host are able to
5555 submit mail for relaying by sending it over TCP/IP to that interface. No other
5556 hosts are permitted to submit messages for relaying.
5557
5558 Just to be sure there's no misunderstanding: at this point in the configuration
5559 we aren't actually setting up any controls. We are just defining some domains
5560 and hosts that will be used in the controls that are specified later.
5561
5562 The next two configuration lines are genuine option settings:
5563 .code
5564 acl_smtp_rcpt = acl_check_rcpt
5565 acl_smtp_data = acl_check_data
5566 .endd
5567 These options specify &'Access Control Lists'& (ACLs) that are to be used
5568 during an incoming SMTP session for every recipient of a message (every RCPT
5569 command), and after the contents of the message have been received,
5570 respectively. The names of the lists are &'acl_check_rcpt'& and
5571 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5572 section of the configuration. The RCPT ACL controls which recipients are
5573 accepted for an incoming message &-- if a configuration does not provide an ACL
5574 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5575 contents of a message to be checked.
5576
5577 Two commented-out option settings are next:
5578 .code
5579 # av_scanner = clamd:/tmp/clamd
5580 # spamd_address = 127.0.0.1 783
5581 .endd
5582 These are example settings that can be used when Exim is compiled with the
5583 content-scanning extension. The first specifies the interface to the virus
5584 scanner, and the second specifies the interface to SpamAssassin. Further
5585 details are given in chapter &<<CHAPexiscan>>&.
5586
5587 Three more commented-out option settings follow:
5588 .code
5589 # tls_advertise_hosts = *
5590 # tls_certificate = /etc/ssl/exim.crt
5591 # tls_privatekey = /etc/ssl/exim.pem
5592 .endd
5593 These are example settings that can be used when Exim is compiled with
5594 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5595 first one specifies the list of clients that are allowed to use TLS when
5596 connecting to this server; in this case the wildcard means all clients. The
5597 other options specify where Exim should find its TLS certificate and private
5598 key, which together prove the server's identity to any clients that connect.
5599 More details are given in chapter &<<CHAPTLS>>&.
5600
5601 Another two commented-out option settings follow:
5602 .code
5603 # daemon_smtp_ports = 25 : 465 : 587
5604 # tls_on_connect_ports = 465
5605 .endd
5606 .cindex "port" "465 and 587"
5607 .cindex "port" "for message submission"
5608 .cindex "message" "submission, ports for"
5609 .cindex "submissions protocol"
5610 .cindex "smtps protocol"
5611 .cindex "ssmtp protocol"
5612 .cindex "SMTP" "submissions protocol"
5613 .cindex "SMTP" "ssmtp protocol"
5614 .cindex "SMTP" "smtps protocol"
5615 These options provide better support for roaming users who wish to use this
5616 server for message submission. They are not much use unless you have turned on
5617 TLS (as described in the previous paragraph) and authentication (about which
5618 more in section &<<SECTdefconfauth>>&).
5619 Mail submission from mail clients (MUAs) should be separate from inbound mail
5620 to your domain (MX delivery) for various good reasons (eg, ability to impose
5621 much saner TLS protocol and ciphersuite requirements without unintended
5622 consequences).
5623 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5624 which uses STARTTLS, so this is the &"submission"& port.
5625 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5626 which should be used in preference to 587.
5627 You should also consider deploying SRV records to help clients find
5628 these ports.
5629 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5630
5631 Two more commented-out options settings follow:
5632 .code
5633 # qualify_domain =
5634 # qualify_recipient =
5635 .endd
5636 The first of these specifies a domain that Exim uses when it constructs a
5637 complete email address from a local login name. This is often needed when Exim
5638 receives a message from a local process. If you do not set &%qualify_domain%&,
5639 the value of &%primary_hostname%& is used. If you set both of these options,
5640 you can have different qualification domains for sender and recipient
5641 addresses. If you set only the first one, its value is used in both cases.
5642
5643 .cindex "domain literal" "recognizing format"
5644 The following line must be uncommented if you want Exim to recognize
5645 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5646 (an IP address within square brackets) instead of a named domain.
5647 .code
5648 # allow_domain_literals
5649 .endd
5650 The RFCs still require this form, but many people think that in the modern
5651 Internet it makes little sense to permit mail to be sent to specific hosts by
5652 quoting their IP addresses. This ancient format has been used by people who
5653 try to abuse hosts by using them for unwanted relaying. However, some
5654 people believe there are circumstances (for example, messages addressed to
5655 &'postmaster'&) where domain literals are still useful.
5656
5657 The next configuration line is a kind of trigger guard:
5658 .code
5659 never_users = root
5660 .endd
5661 It specifies that no delivery must ever be run as the root user. The normal
5662 convention is to set up &'root'& as an alias for the system administrator. This
5663 setting is a guard against slips in the configuration.
5664 The list of users specified by &%never_users%& is not, however, the complete
5665 list; the build-time configuration in &_Local/Makefile_& has an option called
5666 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5667 contents of &%never_users%& are added to this list. By default
5668 FIXED_NEVER_USERS also specifies root.
5669
5670 When a remote host connects to Exim in order to send mail, the only information
5671 Exim has about the host's identity is its IP address. The next configuration
5672 line,
5673 .code
5674 host_lookup = *
5675 .endd
5676 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5677 in order to get a host name. This improves the quality of the logging
5678 information, but if you feel it is too expensive, you can remove it entirely,
5679 or restrict the lookup to hosts on &"nearby"& networks.
5680 Note that it is not always possible to find a host name from an IP address,
5681 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5682 unreachable.
5683
5684 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5685 1413 (hence their names):
5686 .code
5687 rfc1413_hosts = *
5688 rfc1413_query_timeout = 0s
5689 .endd
5690 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5691 Few hosts offer RFC1413 service these days; calls have to be
5692 terminated by a timeout and this needlessly delays the startup
5693 of an incoming SMTP connection.
5694 If you have hosts for which you trust RFC1413 and need this
5695 information, you can change this.
5696
5697 This line enables an efficiency SMTP option.  It is negotiated by clients
5698 and not expected to cause problems but can be disabled if needed.
5699 .code
5700 prdr_enable = true
5701 .endd
5702
5703 When Exim receives messages over SMTP connections, it expects all addresses to
5704 be fully qualified with a domain, as required by the SMTP definition. However,
5705 if you are running a server to which simple clients submit messages, you may
5706 find that they send unqualified addresses. The two commented-out options:
5707 .code
5708 # sender_unqualified_hosts =
5709 # recipient_unqualified_hosts =
5710 .endd
5711 show how you can specify hosts that are permitted to send unqualified sender
5712 and recipient addresses, respectively.
5713
5714 The &%log_selector%& option is used to increase the detail of logging
5715 over the default:
5716 .code
5717 log_selector = +smtp_protocol_error +smtp_syntax_error \
5718                +tls_certificate_verified
5719 .endd
5720
5721 The &%percent_hack_domains%& option is also commented out:
5722 .code
5723 # percent_hack_domains =
5724 .endd
5725 It provides a list of domains for which the &"percent hack"& is to operate.
5726 This is an almost obsolete form of explicit email routing. If you do not know
5727 anything about it, you can safely ignore this topic.
5728
5729 The next two settings in the main part of the default configuration are
5730 concerned with messages that have been &"frozen"& on Exim's queue. When a
5731 message is frozen, Exim no longer continues to try to deliver it. Freezing
5732 occurs when a bounce message encounters a permanent failure because the sender
5733 address of the original message that caused the bounce is invalid, so the
5734 bounce cannot be delivered. This is probably the most common case, but there
5735 are also other conditions that cause freezing, and frozen messages are not
5736 always bounce messages.
5737 .code
5738 ignore_bounce_errors_after = 2d
5739 timeout_frozen_after = 7d
5740 .endd
5741 The first of these options specifies that failing bounce messages are to be
5742 discarded after 2 days on the queue. The second specifies that any frozen
5743 message (whether a bounce message or not) is to be timed out (and discarded)
5744 after a week. In this configuration, the first setting ensures that no failing
5745 bounce message ever lasts a week.
5746
5747 Exim queues it's messages in a spool directory. If you expect to have
5748 large queues, you may consider using this option. It splits the spool
5749 directory into subdirectories to avoid file system degradation from
5750 many files in a single directory, resulting in better performance.
5751 Manual manipulation of queued messages becomes more complex (though fortunately
5752 not often needed).
5753 .code
5754 # split_spool_directory = true
5755 .endd
5756
5757 In an ideal world everybody follows the standards. For non-ASCII
5758 messages RFC 2047 is a standard, allowing a maximum line length of 76
5759 characters. Exim adheres that standard and won't process messages which
5760 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5761 In particular, the Exim maintainers have had multiple reports of
5762 problems from Russian administrators of issues until they disable this
5763 check, because of some popular, yet buggy, mail composition software.
5764 .code
5765 # check_rfc2047_length = false
5766 .endd
5767
5768 If you need to be strictly RFC compliant you may wish to disable the
5769 8BITMIME advertisement. Use this, if you exchange mails with systems
5770 that are not 8-bit clean.
5771 .code
5772 # accept_8bitmime = false
5773 .endd
5774
5775 Libraries you use may depend on specific environment settings.  This
5776 imposes a security risk (e.g. PATH). There are two lists:
5777 &%keep_environment%& for the variables to import as they are, and
5778 &%add_environment%& for variables we want to set to a fixed value.
5779 Note that TZ is handled separately, by the $%timezone%$ runtime
5780 option and by the TIMEZONE_DEFAULT buildtime option.
5781 .code
5782 # keep_environment = ^LDAP
5783 # add_environment = PATH=/usr/bin::/bin
5784 .endd
5785
5786
5787 .section "ACL configuration" "SECID54"
5788 .cindex "default" "ACLs"
5789 .cindex "&ACL;" "default configuration"
5790 In the default configuration, the ACL section follows the main configuration.
5791 It starts with the line
5792 .code
5793 begin acl
5794 .endd
5795 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5796 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5797 and &%acl_smtp_data%& above.
5798
5799 .cindex "RCPT" "ACL for"
5800 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5801 RCPT command specifies one of the message's recipients. The ACL statements
5802 are considered in order, until the recipient address is either accepted or
5803 rejected. The RCPT command is then accepted or rejected, according to the
5804 result of the ACL processing.
5805 .code
5806 acl_check_rcpt:
5807 .endd
5808 This line, consisting of a name terminated by a colon, marks the start of the
5809 ACL, and names it.
5810 .code
5811 accept  hosts = :
5812 .endd
5813 This ACL statement accepts the recipient if the sending host matches the list.
5814 But what does that strange list mean? It doesn't actually contain any host
5815 names or IP addresses. The presence of the colon puts an empty item in the
5816 list; Exim matches this only if the incoming message did not come from a remote
5817 host, because in that case, the remote hostname is empty. The colon is
5818 important. Without it, the list itself is empty, and can never match anything.
5819
5820 What this statement is doing is to accept unconditionally all recipients in
5821 messages that are submitted by SMTP from local processes using the standard
5822 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5823 manner.
5824 .code
5825 deny    message       = Restricted characters in address
5826         domains       = +local_domains
5827         local_parts   = ^[.] : ^.*[@%!/|]
5828
5829 deny    message       = Restricted characters in address
5830         domains       = !+local_domains
5831         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5832 .endd
5833 These statements are concerned with local parts that contain any of the
5834 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5835 Although these characters are entirely legal in local parts (in the case of
5836 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5837 in Internet mail addresses.
5838
5839 The first three have in the past been associated with explicitly routed
5840 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5841 option). Addresses containing these characters are regularly tried by spammers
5842 in an attempt to bypass relaying restrictions, and also by open relay testing
5843 programs. Unless you really need them it is safest to reject these characters
5844 at this early stage. This configuration is heavy-handed in rejecting these
5845 characters for all messages it accepts from remote hosts. This is a deliberate
5846 policy of being as safe as possible.
5847
5848 The first rule above is stricter, and is applied to messages that are addressed
5849 to one of the local domains handled by this host. This is implemented by the
5850 first condition, which restricts it to domains that are listed in the
5851 &'local_domains'& domain list. The &"+"& character is used to indicate a
5852 reference to a named list. In this configuration, there is just one domain in
5853 &'local_domains'&, but in general there may be many.
5854
5855 The second condition on the first statement uses two regular expressions to
5856 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5857 or &"|"&. If you have local accounts that include these characters, you will
5858 have to modify this rule.
5859
5860 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5861 allows them because they have been encountered in practice. (Consider the
5862 common convention of local parts constructed as
5863 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5864 the author of Exim, who has no second initial.) However, a local part starting
5865 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5866 file name (for example, for a mailing list). This is also true for local parts
5867 that contain slashes. A pipe symbol can also be troublesome if the local part
5868 is incorporated unthinkingly into a shell command line.
5869
5870 The second rule above applies to all other domains, and is less strict. This
5871 allows your own users to send outgoing messages to sites that use slashes
5872 and vertical bars in their local parts. It blocks local parts that begin
5873 with a dot, slash, or vertical bar, but allows these characters within the
5874 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5875 and &"!"& is blocked, as before. The motivation here is to prevent your users
5876 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5877 .code
5878 accept  local_parts   = postmaster
5879         domains       = +local_domains
5880 .endd
5881 This statement, which has two conditions, accepts an incoming address if the
5882 local part is &'postmaster'& and the domain is one of those listed in the
5883 &'local_domains'& domain list. The &"+"& character is used to indicate a
5884 reference to a named list. In this configuration, there is just one domain in
5885 &'local_domains'&, but in general there may be many.
5886
5887 The presence of this statement means that mail to postmaster is never blocked
5888 by any of the subsequent tests. This can be helpful while sorting out problems
5889 in cases where the subsequent tests are incorrectly denying access.
5890 .code
5891 require verify        = sender
5892 .endd
5893 This statement requires the sender address to be verified before any subsequent
5894 ACL statement can be used. If verification fails, the incoming recipient
5895 address is refused. Verification consists of trying to route the address, to
5896 see if a bounce message could be delivered to it. In the case of remote
5897 addresses, basic verification checks only the domain, but &'callouts'& can be
5898 used for more verification if required. Section &<<SECTaddressverification>>&
5899 discusses the details of address verification.
5900 .code
5901 accept  hosts         = +relay_from_hosts
5902         control       = submission
5903 .endd
5904 This statement accepts the address if the message is coming from one of the
5905 hosts that are defined as being allowed to relay through this host. Recipient
5906 verification is omitted here, because in many cases the clients are dumb MUAs
5907 that do not cope well with SMTP error responses. For the same reason, the
5908 second line specifies &"submission mode"& for messages that are accepted. This
5909 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5910 messages that are deficient in some way, for example, because they lack a
5911 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5912 probably add recipient verification here, and disable submission mode.
5913 .code
5914 accept  authenticated = *
5915         control       = submission
5916 .endd
5917 This statement accepts the address if the client host has authenticated itself.
5918 Submission mode is again specified, on the grounds that such messages are most
5919 likely to come from MUAs. The default configuration does not define any
5920 authenticators, though it does include some nearly complete commented-out
5921 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5922 fact authenticate until you complete the authenticator definitions.
5923 .code
5924 require message = relay not permitted
5925         domains = +local_domains : +relay_to_domains
5926 .endd
5927 This statement rejects the address if its domain is neither a local domain nor
5928 one of the domains for which this host is a relay.
5929 .code
5930 require verify = recipient
5931 .endd
5932 This statement requires the recipient address to be verified; if verification
5933 fails, the address is rejected.
5934 .code
5935 # deny    message     = rejected because $sender_host_address \
5936 #                       is in a black list at $dnslist_domain\n\
5937 #                       $dnslist_text
5938 #         dnslists    = black.list.example
5939 #
5940 # warn    dnslists    = black.list.example
5941 #         add_header  = X-Warning: $sender_host_address is in \
5942 #                       a black list at $dnslist_domain
5943 #         log_message = found in $dnslist_domain
5944 .endd
5945 These commented-out lines are examples of how you could configure Exim to check
5946 sending hosts against a DNS black list. The first statement rejects messages
5947 from blacklisted hosts, whereas the second just inserts a warning header
5948 line.
5949 .code
5950 # require verify = csa
5951 .endd
5952 This commented-out line is an example of how you could turn on client SMTP
5953 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5954 records.
5955 .code
5956 accept
5957 .endd
5958 The final statement in the first ACL unconditionally accepts any recipient
5959 address that has successfully passed all the previous tests.
5960 .code
5961 acl_check_data:
5962 .endd
5963 This line marks the start of the second ACL, and names it. Most of the contents
5964 of this ACL are commented out:
5965 .code
5966 # deny    malware   = *
5967 #         message   = This message contains a virus \
5968 #                     ($malware_name).
5969 .endd
5970 These lines are examples of how to arrange for messages to be scanned for
5971 viruses when Exim has been compiled with the content-scanning extension, and a
5972 suitable virus scanner is installed. If the message is found to contain a
5973 virus, it is rejected with the given custom error message.
5974 .code
5975 # warn    spam      = nobody
5976 #         message   = X-Spam_score: $spam_score\n\
5977 #                     X-Spam_score_int: $spam_score_int\n\
5978 #                     X-Spam_bar: $spam_bar\n\
5979 #                     X-Spam_report: $spam_report
5980 .endd
5981 These lines are an example of how to arrange for messages to be scanned by
5982 SpamAssassin when Exim has been compiled with the content-scanning extension,
5983 and SpamAssassin has been installed. The SpamAssassin check is run with
5984 &`nobody`& as its user parameter, and the results are added to the message as a
5985 series of extra header line. In this case, the message is not rejected,
5986 whatever the spam score.
5987 .code
5988 accept
5989 .endd
5990 This final line in the DATA ACL accepts the message unconditionally.
5991
5992
5993 .section "Router configuration" "SECID55"
5994 .cindex "default" "routers"
5995 .cindex "routers" "default"
5996 The router configuration comes next in the default configuration, introduced
5997 by the line
5998 .code
5999 begin routers
6000 .endd
6001 Routers are the modules in Exim that make decisions about where to send
6002 messages. An address is passed to each router in turn, until it is either
6003 accepted, or failed. This means that the order in which you define the routers
6004 matters. Each router is fully described in its own chapter later in this
6005 manual. Here we give only brief overviews.
6006 .code
6007 # domain_literal:
6008 #   driver = ipliteral
6009 #   domains = !+local_domains
6010 #   transport = remote_smtp
6011 .endd
6012 .cindex "domain literal" "default router"
6013 This router is commented out because the majority of sites do not want to
6014 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6015 you uncomment this router, you also need to uncomment the setting of
6016 &%allow_domain_literals%& in the main part of the configuration.
6017 .code
6018 dnslookup:
6019   driver = dnslookup
6020   domains = ! +local_domains
6021   transport = remote_smtp
6022   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6023   no_more
6024 .endd
6025 The first uncommented router handles addresses that do not involve any local
6026 domains. This is specified by the line
6027 .code
6028 domains = ! +local_domains
6029 .endd
6030 The &%domains%& option lists the domains to which this router applies, but the
6031 exclamation mark is a negation sign, so the router is used only for domains
6032 that are not in the domain list called &'local_domains'& (which was defined at
6033 the start of the configuration). The plus sign before &'local_domains'&
6034 indicates that it is referring to a named list. Addresses in other domains are
6035 passed on to the following routers.
6036
6037 The name of the router driver is &(dnslookup)&,
6038 and is specified by the &%driver%& option. Do not be confused by the fact that
6039 the name of this router instance is the same as the name of the driver. The
6040 instance name is arbitrary, but the name set in the &%driver%& option must be
6041 one of the driver modules that is in the Exim binary.
6042
6043 The &(dnslookup)& router routes addresses by looking up their domains in the
6044 DNS in order to obtain a list of hosts to which the address is routed. If the
6045 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6046 specified by the &%transport%& option. If the router does not find the domain
6047 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6048 the address fails and is bounced.
6049
6050 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6051 be entirely ignored. This option is present because a number of cases have been
6052 encountered where MX records in the DNS point to host names
6053 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6054 Completely ignoring these IP addresses causes Exim to fail to route the
6055 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6056 continue to try to deliver the message periodically until the address timed
6057 out.
6058 .code
6059 system_aliases:
6060   driver = redirect
6061   allow_fail
6062   allow_defer
6063   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6064 # user = exim
6065   file_transport = address_file
6066   pipe_transport = address_pipe
6067 .endd
6068 Control reaches this and subsequent routers only for addresses in the local
6069 domains. This router checks to see whether the local part is defined as an
6070 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6071 data that it looks up from that file. If no data is found for the local part,
6072 the value of the &%data%& option is empty, causing the address to be passed to
6073 the next router.
6074
6075 &_/etc/aliases_& is a conventional name for the system aliases file that is
6076 often used. That is why it is referenced by from the default configuration
6077 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6078 &_Local/Makefile_& before building Exim.
6079 .code
6080 userforward:
6081   driver = redirect
6082   check_local_user
6083 # local_part_suffix = +* : -*
6084 # local_part_suffix_optional
6085   file = $home/.forward
6086 # allow_filter
6087   no_verify
6088   no_expn
6089   check_ancestor
6090   file_transport = address_file
6091   pipe_transport = address_pipe
6092   reply_transport = address_reply
6093 .endd
6094 This is the most complicated router in the default configuration. It is another
6095 redirection router, but this time it is looking for forwarding data set up by
6096 individual users. The &%check_local_user%& setting specifies a check that the
6097 local part of the address is the login name of a local user. If it is not, the
6098 router is skipped. The two commented options that follow &%check_local_user%&,
6099 namely:
6100 .code
6101 # local_part_suffix = +* : -*
6102 # local_part_suffix_optional
6103 .endd
6104 .vindex "&$local_part_suffix$&"
6105 show how you can specify the recognition of local part suffixes. If the first
6106 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6107 by any sequence of characters, is removed from the local part and placed in the
6108 variable &$local_part_suffix$&. The second suffix option specifies that the
6109 presence of a suffix in the local part is optional. When a suffix is present,
6110 the check for a local login uses the local part with the suffix removed.
6111
6112 When a local user account is found, the file called &_.forward_& in the user's
6113 home directory is consulted. If it does not exist, or is empty, the router
6114 declines. Otherwise, the contents of &_.forward_& are interpreted as
6115 redirection data (see chapter &<<CHAPredirect>>& for more details).
6116
6117 .cindex "Sieve filter" "enabling in default router"
6118 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6119 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6120 is commented out by default), the contents of the file are interpreted as a set
6121 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6122 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6123 separate document entitled &'Exim's interfaces to mail filtering'&.
6124
6125 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6126 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6127 There are two reasons for doing this:
6128
6129 .olist
6130 Whether or not a local user has a &_.forward_& file is not really relevant when
6131 checking an address for validity; it makes sense not to waste resources doing
6132 unnecessary work.
6133 .next
6134 More importantly, when Exim is verifying addresses or handling an EXPN
6135 command during an SMTP session, it is running as the Exim user, not as root.
6136 The group is the Exim group, and no additional groups are set up.
6137 It may therefore not be possible for Exim to read users' &_.forward_& files at
6138 this time.
6139 .endlist
6140
6141 The setting of &%check_ancestor%& prevents the router from generating a new
6142 address that is the same as any previous address that was redirected. (This
6143 works round a problem concerning a bad interaction between aliasing and
6144 forwarding &-- see section &<<SECTredlocmai>>&).
6145
6146 The final three option settings specify the transports that are to be used when
6147 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6148 auto-reply, respectively. For example, if a &_.forward_& file contains
6149 .code
6150 a.nother@elsewhere.example, /home/spqr/archive
6151 .endd
6152 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6153 transport.
6154 .code
6155 localuser:
6156   driver = accept
6157   check_local_user
6158 # local_part_suffix = +* : -*
6159 # local_part_suffix_optional
6160   transport = local_delivery
6161 .endd
6162 The final router sets up delivery into local mailboxes, provided that the local
6163 part is the name of a local login, by accepting the address and assigning it to
6164 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6165 routers, so the address is bounced. The commented suffix settings fulfil the
6166 same purpose as they do for the &(userforward)& router.
6167
6168
6169 .section "Transport configuration" "SECID56"
6170 .cindex "default" "transports"
6171 .cindex "transports" "default"
6172 Transports define mechanisms for actually delivering messages. They operate
6173 only when referenced from routers, so the order in which they are defined does
6174 not matter. The transports section of the configuration starts with
6175 .code
6176 begin transports
6177 .endd
6178 One remote transport and four local transports are defined.
6179 .code
6180 remote_smtp:
6181   driver = smtp
6182   hosts_try_prdr = *
6183 .endd
6184 This transport is used for delivering messages over SMTP connections.
6185 The list of remote hosts comes from the router.
6186 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6187 It is negotiated between client and server
6188 and not expected to cause problems but can be disabled if needed.
6189 All other options are defaulted.
6190 .code
6191 local_delivery:
6192   driver = appendfile
6193   file = /var/mail/$local_part
6194   delivery_date_add
6195   envelope_to_add
6196   return_path_add
6197 # group = mail
6198 # mode = 0660
6199 .endd
6200 This &(appendfile)& transport is used for local delivery to user mailboxes in
6201 traditional BSD mailbox format. By default it runs under the uid and gid of the
6202 local user, which requires the sticky bit to be set on the &_/var/mail_&
6203 directory. Some systems use the alternative approach of running mail deliveries
6204 under a particular group instead of using the sticky bit. The commented options
6205 show how this can be done.
6206
6207 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6208 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6209 similarly-named options above.
6210 .code
6211 address_pipe:
6212   driver = pipe
6213   return_output
6214 .endd
6215 This transport is used for handling deliveries to pipes that are generated by
6216 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6217 option specifies that any output on stdout or stderr generated by the pipe is to
6218 be returned to the sender.
6219 .code
6220 address_file:
6221   driver = appendfile
6222   delivery_date_add
6223   envelope_to_add
6224   return_path_add
6225 .endd
6226 This transport is used for handling deliveries to files that are generated by
6227 redirection. The name of the file is not specified in this instance of
6228 &(appendfile)&, because it comes from the &(redirect)& router.
6229 .code
6230 address_reply:
6231   driver = autoreply
6232 .endd
6233 This transport is used for handling automatic replies generated by users'
6234 filter files.
6235
6236
6237
6238 .section "Default retry rule" "SECID57"
6239 .cindex "retry" "default rule"
6240 .cindex "default" "retry rule"
6241 The retry section of the configuration file contains rules which affect the way
6242 Exim retries deliveries that cannot be completed at the first attempt. It is
6243 introduced by the line
6244 .code
6245 begin retry
6246 .endd
6247 In the default configuration, there is just one rule, which applies to all
6248 errors:
6249 .code
6250 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6251 .endd
6252 This causes any temporarily failing address to be retried every 15 minutes for
6253 2 hours, then at intervals starting at one hour and increasing by a factor of
6254 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6255 is not delivered after 4 days of temporary failure, it is bounced. The time is
6256 measured from first failure, not from the time the message was received.
6257
6258 If the retry section is removed from the configuration, or is empty (that is,
6259 if no retry rules are defined), Exim will not retry deliveries. This turns
6260 temporary errors into permanent errors.
6261
6262
6263 .section "Rewriting configuration" "SECID58"
6264 The rewriting section of the configuration, introduced by
6265 .code
6266 begin rewrite
6267 .endd
6268 contains rules for rewriting addresses in messages as they arrive. There are no
6269 rewriting rules in the default configuration file.
6270
6271
6272
6273 .section "Authenticators configuration" "SECTdefconfauth"
6274 .cindex "AUTH" "configuration"
6275 The authenticators section of the configuration, introduced by
6276 .code
6277 begin authenticators
6278 .endd
6279 defines mechanisms for the use of the SMTP AUTH command. The default
6280 configuration file contains two commented-out example authenticators
6281 which support plaintext username/password authentication using the
6282 standard PLAIN mechanism and the traditional but non-standard LOGIN
6283 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6284 to support most MUA software.
6285
6286 The example PLAIN authenticator looks like this:
6287 .code
6288 #PLAIN:
6289 #  driver                  = plaintext
6290 #  server_set_id           = $auth2
6291 #  server_prompts          = :
6292 #  server_condition        = Authentication is not yet configured
6293 #  server_advertise_condition = ${if def:tls_in_cipher }
6294 .endd
6295 And the example LOGIN authenticator looks like this:
6296 .code
6297 #LOGIN:
6298 #  driver                  = plaintext
6299 #  server_set_id           = $auth1
6300 #  server_prompts          = <| Username: | Password:
6301 #  server_condition        = Authentication is not yet configured
6302 #  server_advertise_condition = ${if def:tls_in_cipher }
6303 .endd
6304
6305 The &%server_set_id%& option makes Exim remember the authenticated username
6306 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6307 &%server_prompts%& option configures the &(plaintext)& authenticator so
6308 that it implements the details of the specific authentication mechanism,
6309 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6310 when Exim offers authentication to clients; in the examples, this is only
6311 when TLS or SSL has been started, so to enable the authenticators you also
6312 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6313
6314 The &%server_condition%& setting defines how to verify that the username and
6315 password are correct. In the examples it just produces an error message.
6316 To make the authenticators work, you can use a string expansion
6317 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6318
6319 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6320 usercode and password are in different positions.
6321 Chapter &<<CHAPplaintext>>& covers both.
6322
6323 .ecindex IIDconfiwal
6324
6325
6326
6327 . ////////////////////////////////////////////////////////////////////////////
6328 . ////////////////////////////////////////////////////////////////////////////
6329
6330 .chapter "Regular expressions" "CHAPregexp"
6331
6332 .cindex "regular expressions" "library"
6333 .cindex "PCRE"
6334 Exim supports the use of regular expressions in many of its options. It
6335 uses the PCRE regular expression library; this provides regular expression
6336 matching that is compatible with Perl 5. The syntax and semantics of
6337 regular expressions is discussed in
6338 online Perl manpages, in
6339 many Perl reference books, and also in
6340 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6341 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6342 . --- the http: URL here redirects to another page with the ISBN in the URL
6343 . --- where trying to use https: just redirects back to http:, so sticking
6344 . --- to the old URL for now.  2018-09-07.
6345
6346 The documentation for the syntax and semantics of the regular expressions that
6347 are supported by PCRE is included in the PCRE distribution, and no further
6348 description is included here. The PCRE functions are called from Exim using
6349 the default option settings (that is, with no PCRE options set), except that
6350 the PCRE_CASELESS option is set when the matching is required to be
6351 case-insensitive.
6352
6353 In most cases, when a regular expression is required in an Exim configuration,
6354 it has to start with a circumflex, in order to distinguish it from plain text
6355 or an &"ends with"& wildcard. In this example of a configuration setting, the
6356 second item in the colon-separated list is a regular expression.
6357 .code
6358 domains = a.b.c : ^\\d{3} : *.y.z : ...
6359 .endd
6360 The doubling of the backslash is required because of string expansion that
6361 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6362 of this issue, and a way of avoiding the need for doubling backslashes. The
6363 regular expression that is eventually used in this example contains just one
6364 backslash. The circumflex is included in the regular expression, and has the
6365 normal effect of &"anchoring"& it to the start of the string that is being
6366 matched.
6367
6368 There are, however, two cases where a circumflex is not required for the
6369 recognition of a regular expression: these are the &%match%& condition in a
6370 string expansion, and the &%matches%& condition in an Exim filter file. In
6371 these cases, the relevant string is always treated as a regular expression; if
6372 it does not start with a circumflex, the expression is not anchored, and can
6373 match anywhere in the subject string.
6374
6375 In all cases, if you want a regular expression to match at the end of a string,
6376 you must code the $ metacharacter to indicate this. For example:
6377 .code
6378 domains = ^\\d{3}\\.example
6379 .endd
6380 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6381 You need to use:
6382 .code
6383 domains = ^\\d{3}\\.example\$
6384 .endd
6385 if you want &'example'& to be the top-level domain. The backslash before the
6386 $ is needed because string expansion also interprets dollar characters.
6387
6388
6389
6390 . ////////////////////////////////////////////////////////////////////////////
6391 . ////////////////////////////////////////////////////////////////////////////
6392
6393 .chapter "File and database lookups" "CHAPfdlookup"
6394 .scindex IIDfidalo1 "file" "lookups"
6395 .scindex IIDfidalo2 "database" "lookups"
6396 .cindex "lookup" "description of"
6397 Exim can be configured to look up data in files or databases as it processes
6398 messages. Two different kinds of syntax are used:
6399
6400 .olist
6401 A string that is to be expanded may contain explicit lookup requests. These
6402 cause parts of the string to be replaced by data that is obtained from the
6403 lookup. Lookups of this type are conditional expansion items. Different results
6404 can be defined for the cases of lookup success and failure. See chapter
6405 &<<CHAPexpand>>&, where string expansions are described in detail.
6406 The key for the lookup is specified as part of the string expansion.
6407 .next
6408 Lists of domains, hosts, and email addresses can contain lookup requests as a
6409 way of avoiding excessively long linear lists. In this case, the data that is
6410 returned by the lookup is often (but not always) discarded; whether the lookup
6411 succeeds or fails is what really counts. These kinds of list are described in
6412 chapter &<<CHAPdomhosaddlists>>&.
6413 The key for the lookup is given by the context in which the list is expanded.
6414 .endlist
6415
6416 String expansions, lists, and lookups interact with each other in such a way
6417 that there is no order in which to describe any one of them that does not
6418 involve references to the others. Each of these three chapters makes more sense
6419 if you have read the other two first. If you are reading this for the first
6420 time, be aware that some of it will make a lot more sense after you have read
6421 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6422
6423 .section "Examples of different lookup syntax" "SECID60"
6424 It is easy to confuse the two different kinds of lookup, especially as the
6425 lists that may contain the second kind are always expanded before being
6426 processed as lists. Therefore, they may also contain lookups of the first kind.
6427 Be careful to distinguish between the following two examples:
6428 .code
6429 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6430 domains = lsearch;/some/file
6431 .endd
6432 The first uses a string expansion, the result of which must be a domain list.
6433 No strings have been specified for a successful or a failing lookup; the
6434 defaults in this case are the looked-up data and an empty string, respectively.
6435 The expansion takes place before the string is processed as a list, and the
6436 file that is searched could contain lines like this:
6437 .code
6438 192.168.3.4: domain1:domain2:...
6439 192.168.1.9: domain3:domain4:...
6440 .endd
6441 When the lookup succeeds, the result of the expansion is a list of domains (and
6442 possibly other types of item that are allowed in domain lists).
6443
6444 In the second example, the lookup is a single item in a domain list. It causes
6445 Exim to use a lookup to see if the domain that is being processed can be found
6446 in the file. The file could contains lines like this:
6447 .code
6448 domain1:
6449 domain2:
6450 .endd
6451 Any data that follows the keys is not relevant when checking that the domain
6452 matches the list item.
6453
6454 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6455 Consider a file containing lines like this:
6456 .code
6457 192.168.5.6: lsearch;/another/file
6458 .endd
6459 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6460 first &%domains%& setting above generates the second setting, which therefore
6461 causes a second lookup to occur.
6462
6463 The rest of this chapter describes the different lookup types that are
6464 available. Any of them can be used in any part of the configuration where a
6465 lookup is permitted.
6466
6467
6468 .section "Lookup types" "SECID61"
6469 .cindex "lookup" "types of"
6470 .cindex "single-key lookup" "definition of"
6471 Two different types of data lookup are implemented:
6472
6473 .ilist
6474 The &'single-key'& type requires the specification of a file in which to look,
6475 and a single key to search for. The key must be a non-empty string for the
6476 lookup to succeed. The lookup type determines how the file is searched.
6477 .next
6478 .cindex "query-style lookup" "definition of"
6479 The &'query-style'& type accepts a generalized database query. No particular
6480 key value is assumed by Exim for query-style lookups. You can use whichever
6481 Exim variables you need to construct the database query.
6482 .endlist
6483
6484 The code for each lookup type is in a separate source file that is included in
6485 the binary of Exim only if the corresponding compile-time option is set. The
6486 default settings in &_src/EDITME_& are:
6487 .code
6488 LOOKUP_DBM=yes
6489 LOOKUP_LSEARCH=yes
6490 .endd
6491 which means that only linear searching and DBM lookups are included by default.
6492 For some types of lookup (e.g. SQL databases), you need to install appropriate
6493 libraries and header files before building Exim.
6494
6495
6496
6497
6498 .section "Single-key lookup types" "SECTsinglekeylookups"
6499 .cindex "lookup" "single-key types"
6500 .cindex "single-key lookup" "list of types"
6501 The following single-key lookup types are implemented:
6502
6503 .ilist
6504 .cindex "cdb" "description of"
6505 .cindex "lookup" "cdb"
6506 .cindex "binary zero" "in lookup key"
6507 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6508 string without a terminating binary zero. The cdb format is designed for
6509 indexed files that are read frequently and never updated, except by total
6510 re-creation. As such, it is particularly suitable for large files containing
6511 aliases or other indexed data referenced by an MTA. Information about cdb and
6512 tools for building the files can be found in several places:
6513 .display
6514 &url(https://cr.yp.to/cdb.html)
6515 &url(http://www.corpit.ru/mjt/tinycdb.html)
6516 &url(https://packages.debian.org/stable/utils/freecdb)
6517 &url(https://github.com/philpennock/cdbtools) (in Go)
6518 .endd
6519 . --- 2018-09-07: corpit.ru http:-only
6520 A cdb distribution is not needed in order to build Exim with cdb support,
6521 because the code for reading cdb files is included directly in Exim itself.
6522 However, no means of building or testing cdb files is provided with Exim, so
6523 you need to obtain a cdb distribution in order to do this.
6524 .next
6525 .cindex "DBM" "lookup type"
6526 .cindex "lookup" "dbm"
6527 .cindex "binary zero" "in lookup key"
6528 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6529 DBM file by looking up the record with the given key. A terminating binary
6530 zero is included in the key that is passed to the DBM library. See section
6531 &<<SECTdb>>& for a discussion of DBM libraries.
6532
6533 .cindex "Berkeley DB library" "file format"
6534 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6535 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6536 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6537 the DB_UNKNOWN option. This enables it to handle any of the types of database
6538 that the library supports, and can be useful for accessing DBM files created by
6539 other applications. (For earlier DB versions, DB_HASH is always used.)
6540 .next
6541 .cindex "lookup" "dbmjz"
6542 .cindex "lookup" "dbm &-- embedded NULs"
6543 .cindex "sasldb2"
6544 .cindex "dbmjz lookup type"
6545 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6546 interpreted as an Exim list; the elements of the list are joined together with
6547 ASCII NUL characters to form the lookup key.  An example usage would be to
6548 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6549 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6550 &(cram_md5)& authenticator.
6551 .next
6552 .cindex "lookup" "dbmnz"
6553 .cindex "lookup" "dbm &-- terminating zero"
6554 .cindex "binary zero" "in lookup key"
6555 .cindex "Courier"
6556 .cindex "&_/etc/userdbshadow.dat_&"
6557 .cindex "dbmnz lookup type"
6558 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6559 is not included in the key that is passed to the DBM library. You may need this
6560 if you want to look up data in files that are created by or shared with some
6561 other application that does not use terminating zeros. For example, you need to
6562 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6563 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6564 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6565 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6566 .next
6567 .cindex "lookup" "dsearch"
6568 .cindex "dsearch lookup type"
6569 &(dsearch)&: The given file must be a directory; this is searched for an entry
6570 whose name is the key by calling the &[lstat()]& function. The key may not
6571 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6572 the lookup is the name of the entry, which may be a file, directory,
6573 symbolic link, or any other kind of directory entry. An example of how this
6574 lookup can be used to support virtual domains is given in section
6575 &<<SECTvirtualdomains>>&.
6576 .next
6577 .cindex "lookup" "iplsearch"
6578 .cindex "iplsearch lookup type"
6579 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6580 terminated by a colon or white space or the end of the line. The keys in the
6581 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6582 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6583 being interpreted as a key terminator. For example:
6584 .code
6585 1.2.3.4:           data for 1.2.3.4
6586 192.168.0.0/16:    data for 192.168.0.0/16
6587 "abcd::cdab":      data for abcd::cdab
6588 "abcd:abcd::/32"   data for abcd:abcd::/32
6589 .endd
6590 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6591 file is searched linearly, using the CIDR masks where present, until a matching
6592 key is found. The first key that matches is used; there is no attempt to find a
6593 &"best"& match. Apart from the way the keys are matched, the processing for
6594 &(iplsearch)& is the same as for &(lsearch)&.
6595
6596 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6597 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6598 lookup types support only literal keys.
6599
6600 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6601 the implicit key is the host's IP address rather than its name (see section
6602 &<<SECThoslispatsikey>>&).
6603 .next
6604 .cindex "linear search"
6605 .cindex "lookup" "lsearch"
6606 .cindex "lsearch lookup type"
6607 .cindex "case sensitivity" "in lsearch lookup"
6608 &(lsearch)&: The given file is a text file that is searched linearly for a
6609 line beginning with the search key, terminated by a colon or white space or the
6610 end of the line. The search is case-insensitive; that is, upper and lower case
6611 letters are treated as the same. The first occurrence of the key that is found
6612 in the file is used.
6613
6614 White space between the key and the colon is permitted. The remainder of the
6615 line, with leading and trailing white space removed, is the data. This can be
6616 continued onto subsequent lines by starting them with any amount of white
6617 space, but only a single space character is included in the data at such a
6618 junction. If the data begins with a colon, the key must be terminated by a
6619 colon, for example:
6620 .code
6621 baduser:  :fail:
6622 .endd
6623 Empty lines and lines beginning with # are ignored, even if they occur in the
6624 middle of an item. This is the traditional textual format of alias files. Note
6625 that the keys in an &(lsearch)& file are literal strings. There is no
6626 wildcarding of any kind.
6627
6628 .cindex "lookup" "lsearch &-- colons in keys"
6629 .cindex "white space" "in lsearch key"
6630 In most &(lsearch)& files, keys are not required to contain colons or #
6631 characters, or white space. However, if you need this feature, it is available.
6632 If a key begins with a doublequote character, it is terminated only by a
6633 matching quote (or end of line), and the normal escaping rules apply to its
6634 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6635 quoted keys (exactly as for unquoted keys). There is no special handling of
6636 quotes for the data part of an &(lsearch)& line.
6637
6638 .next
6639 .cindex "NIS lookup type"
6640 .cindex "lookup" "NIS"
6641 .cindex "binary zero" "in lookup key"
6642 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6643 the given key, without a terminating binary zero. There is a variant called
6644 &(nis0)& which does include the terminating binary zero in the key. This is
6645 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6646 aliases; the full map names must be used.
6647
6648 .next
6649 .cindex "wildlsearch lookup type"
6650 .cindex "lookup" "wildlsearch"
6651 .cindex "nwildlsearch lookup type"
6652 .cindex "lookup" "nwildlsearch"
6653 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6654 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6655 the file may be wildcarded. The difference between these two lookup types is
6656 that for &(wildlsearch)&, each key in the file is string-expanded before being
6657 used, whereas for &(nwildlsearch)&, no expansion takes place.
6658
6659 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6660 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6661 file that are regular expressions can be made case-sensitive by the use of
6662 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6663
6664 . ==== As this is a nested list, any displays it contains must be indented
6665 . ==== as otherwise they are too far to the left.
6666
6667 .olist
6668 The string may begin with an asterisk to mean &"ends with"&. For example:
6669 .code
6670     *.a.b.c       data for anything.a.b.c
6671     *fish         data for anythingfish
6672 .endd
6673 .next
6674 The string may begin with a circumflex to indicate a regular expression. For
6675 example, for &(wildlsearch)&:
6676 .code
6677     ^\N\d+\.a\.b\N    data for <digits>.a.b
6678 .endd
6679 Note the use of &`\N`& to disable expansion of the contents of the regular
6680 expression. If you are using &(nwildlsearch)&, where the keys are not
6681 string-expanded, the equivalent entry is:
6682 .code
6683     ^\d+\.a\.b        data for <digits>.a.b
6684 .endd
6685 The case-insensitive flag is set at the start of compiling the regular
6686 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6687 For example, to make the entire pattern case-sensitive:
6688 .code
6689     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6690 .endd
6691
6692 If the regular expression contains white space or colon characters, you must
6693 either quote it (see &(lsearch)& above), or represent these characters in other
6694 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6695 colon. This may be easier than quoting, because if you quote, you have to
6696 escape all the backslashes inside the quotes.
6697
6698 &*Note*&: It is not possible to capture substrings in a regular expression
6699 match for later use, because the results of all lookups are cached. If a lookup
6700 is repeated, the result is taken from the cache, and no actual pattern matching
6701 takes place. The values of all the numeric variables are unset after a
6702 &((n)wildlsearch)& match.
6703
6704 .next
6705 Although I cannot see it being of much use, the general matching function that
6706 is used to implement &((n)wildlsearch)& means that the string may begin with a
6707 lookup name terminated by a semicolon, and followed by lookup data. For
6708 example:
6709 .code
6710     cdb;/some/file  data for keys that match the file
6711 .endd
6712 The data that is obtained from the nested lookup is discarded.
6713 .endlist olist
6714
6715 Keys that do not match any of these patterns are interpreted literally. The
6716 continuation rules for the data are the same as for &(lsearch)&, and keys may
6717 be followed by optional colons.
6718
6719 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6720 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6721 lookup types support only literal keys.
6722 .endlist ilist
6723
6724
6725 .section "Query-style lookup types" "SECTquerystylelookups"
6726 .cindex "lookup" "query-style types"
6727 .cindex "query-style lookup" "list of types"
6728 The supported query-style lookup types are listed below. Further details about
6729 many of them are given in later sections.
6730
6731 .ilist
6732 .cindex "DNS" "as a lookup type"
6733 .cindex "lookup" "DNS"
6734 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6735 are given in the supplied query. The resulting data is the contents of the
6736 records. See section &<<SECTdnsdb>>&.
6737 .next
6738 .cindex "InterBase lookup type"
6739 .cindex "lookup" "InterBase"
6740 &(ibase)&: This does a lookup in an InterBase database.
6741 .next
6742 .cindex "LDAP" "lookup type"
6743 .cindex "lookup" "LDAP"
6744 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6745 returns attributes from a single entry. There is a variant called &(ldapm)&
6746 that permits values from multiple entries to be returned. A third variant
6747 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6748 any attribute values. See section &<<SECTldap>>&.
6749 .next
6750 .cindex "MySQL" "lookup type"
6751 .cindex "lookup" "MySQL"
6752 &(mysql)&: The format of the query is an SQL statement that is passed to a
6753 MySQL database. See section &<<SECTsql>>&.
6754 .next
6755 .cindex "NIS+ lookup type"
6756 .cindex "lookup" "NIS+"
6757 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6758 the field to be returned. See section &<<SECTnisplus>>&.
6759 .next
6760 .cindex "Oracle" "lookup type"
6761 .cindex "lookup" "Oracle"
6762 &(oracle)&: The format of the query is an SQL statement that is passed to an
6763 Oracle database. See section &<<SECTsql>>&.
6764 .next
6765 .cindex "lookup" "passwd"
6766 .cindex "passwd lookup type"
6767 .cindex "&_/etc/passwd_&"
6768 &(passwd)& is a query-style lookup with queries that are just user names. The
6769 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6770 success, the result string is the same as you would get from an &(lsearch)&
6771 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6772 password value. For example:
6773 .code
6774 *:42:42:King Rat:/home/kr:/bin/bash
6775 .endd
6776 .next
6777 .cindex "PostgreSQL lookup type"
6778 .cindex "lookup" "PostgreSQL"
6779 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6780 PostgreSQL database. See section &<<SECTsql>>&.
6781
6782 .next
6783 .cindex "Redis lookup type"
6784 .cindex lookup Redis
6785 &(redis)&: The format of the query is either a simple get or simple set,
6786 passed to a Redis database. See section &<<SECTsql>>&.
6787
6788 .next
6789 .cindex "sqlite lookup type"
6790 .cindex "lookup" "sqlite"
6791 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6792 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6793
6794 .next
6795 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6796 not likely to be useful in normal operation.
6797 .next
6798 .cindex "whoson lookup type"
6799 .cindex "lookup" "whoson"
6800 . --- still http:-only, 2018-09-07
6801 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6802 allows a server to check whether a particular (dynamically allocated) IP
6803 address is currently allocated to a known (trusted) user and, optionally, to
6804 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6805 at one time for &"POP before SMTP"& authentication, but that approach has been
6806 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6807 &"POP before SMTP"& checking using ACL statements such as
6808 .code
6809 require condition = \
6810   ${lookup whoson {$sender_host_address}{yes}{no}}
6811 .endd
6812 The query consists of a single IP address. The value returned is the name of
6813 the authenticated user, which is stored in the variable &$value$&. However, in
6814 this example, the data in &$value$& is not used; the result of the lookup is
6815 one of the fixed strings &"yes"& or &"no"&.
6816 .endlist
6817
6818
6819
6820 .section "Temporary errors in lookups" "SECID63"
6821 .cindex "lookup" "temporary error in"
6822 Lookup functions can return temporary error codes if the lookup cannot be
6823 completed. For example, an SQL or LDAP database might be unavailable. For this
6824 reason, it is not advisable to use a lookup that might do this for critical
6825 options such as a list of local domains.
6826
6827 When a lookup cannot be completed in a router or transport, delivery
6828 of the message (to the relevant address) is deferred, as for any other
6829 temporary error. In other circumstances Exim may assume the lookup has failed,
6830 or may give up altogether.
6831
6832
6833
6834 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6835 .cindex "wildcard lookups"
6836 .cindex "lookup" "default values"
6837 .cindex "lookup" "wildcard"
6838 .cindex "lookup" "* added to type"
6839 .cindex "default" "in single-key lookups"
6840 In this context, a &"default value"& is a value specified by the administrator
6841 that is to be used if a lookup fails.
6842
6843 &*Note:*& This section applies only to single-key lookups. For query-style
6844 lookups, the facilities of the query language must be used. An attempt to
6845 specify a default for a query-style lookup provokes an error.
6846
6847 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6848 and the initial lookup fails, the key &"*"& is looked up in the file to
6849 provide a default value. See also the section on partial matching below.
6850
6851 .cindex "*@ with single-key lookup"
6852 .cindex "lookup" "*@ added to type"
6853 .cindex "alias file" "per-domain default"
6854 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6855 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6856 character, a second lookup is done with everything before the last @ replaced
6857 by *. This makes it possible to provide per-domain defaults in alias files
6858 that include the domains in the keys. If the second lookup fails (or doesn't
6859 take place because there is no @ in the key), &"*"& is looked up.
6860 For example, a &(redirect)& router might contain:
6861 .code
6862 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6863 .endd
6864 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6865 looks up these keys, in this order:
6866 .code
6867 jane@eyre.example
6868 *@eyre.example
6869 *
6870 .endd
6871 The data is taken from whichever key it finds first. &*Note*&: In an
6872 &(lsearch)& file, this does not mean the first of these keys in the file. A
6873 complete scan is done for each key, and only if it is not found at all does
6874 Exim move on to try the next key.
6875
6876
6877
6878 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6879 .cindex "partial matching"
6880 .cindex "wildcard lookups"
6881 .cindex "lookup" "partial matching"
6882 .cindex "lookup" "wildcard"
6883 .cindex "asterisk" "in search type"
6884 The normal operation of a single-key lookup is to search the file for an exact
6885 match with the given key. However, in a number of situations where domains are
6886 being looked up, it is useful to be able to do partial matching. In this case,
6887 information in the file that has a key starting with &"*."& is matched by any
6888 domain that ends with the components that follow the full stop. For example, if
6889 a key in a DBM file is
6890 .code
6891 *.dates.fict.example
6892 .endd
6893 then when partial matching is enabled this is matched by (amongst others)
6894 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6895 by &'dates.fict.example'&, if that does not appear as a separate key in the
6896 file.
6897
6898 &*Note*&: Partial matching is not available for query-style lookups. It is
6899 also not available for any lookup items in address lists (see section
6900 &<<SECTaddresslist>>&).
6901
6902 Partial matching is implemented by doing a series of separate lookups using
6903 keys constructed by modifying the original subject key. This means that it can
6904 be used with any of the single-key lookup types, provided that
6905 partial matching keys
6906 beginning with a special prefix (default &"*."&) are included in the data file.
6907 Keys in the file that do not begin with the prefix are matched only by
6908 unmodified subject keys when partial matching is in use.
6909
6910 Partial matching is requested by adding the string &"partial-"& to the front of
6911 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6912 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6913 is added at the start of the subject key, and it is looked up again. If that
6914 fails, further lookups are tried with dot-separated components removed from the
6915 start of the subject key, one-by-one, and &"*."& added on the front of what
6916 remains.
6917
6918 A minimum number of two non-* components are required. This can be adjusted
6919 by including a number before the hyphen in the search type. For example,
6920 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6921 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6922 subject key is &'2250.dates.fict.example'& then the following keys are looked
6923 up when the minimum number of non-* components is two:
6924 .code
6925 2250.dates.fict.example
6926 *.2250.dates.fict.example
6927 *.dates.fict.example
6928 *.fict.example
6929 .endd
6930 As soon as one key in the sequence is successfully looked up, the lookup
6931 finishes.
6932
6933 .cindex "lookup" "partial matching &-- changing prefix"
6934 .cindex "prefix" "for partial matching"
6935 The use of &"*."& as the partial matching prefix is a default that can be
6936 changed. The motivation for this feature is to allow Exim to operate with file
6937 formats that are used by other MTAs. A different prefix can be supplied in
6938 parentheses instead of the hyphen after &"partial"&. For example:
6939 .code
6940 domains = partial(.)lsearch;/some/file
6941 .endd
6942 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6943 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6944 components is unchanged). The prefix may consist of any punctuation characters
6945 other than a closing parenthesis. It may be empty, for example:
6946 .code
6947 domains = partial1()cdb;/some/file
6948 .endd
6949 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6950 &`a.b.c`&, &`b.c`&, and &`c`&.
6951
6952 If &"partial0"& is specified, what happens at the end (when the lookup with
6953 just one non-wild component has failed, and the original key is shortened right
6954 down to the null string) depends on the prefix:
6955
6956 .ilist
6957 If the prefix has zero length, the whole lookup fails.
6958 .next
6959 If the prefix has length 1, a lookup for just the prefix is done. For
6960 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6961 .next
6962 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6963 remainder is looked up. With the default prefix, therefore, the final lookup is
6964 for &"*"& on its own.
6965 .next
6966 Otherwise, the whole prefix is looked up.
6967 .endlist
6968
6969
6970 If the search type ends in &"*"& or &"*@"& (see section
6971 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6972 this implies happens after all partial lookups have failed. If &"partial0"& is
6973 specified, adding &"*"& to the search type has no effect with the default
6974 prefix, because the &"*"& key is already included in the sequence of partial
6975 lookups. However, there might be a use for lookup types such as
6976 &"partial0(.)lsearch*"&.
6977
6978 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6979 in domain lists and the like. Partial matching works only in terms of
6980 dot-separated components; a key such as &`*fict.example`&
6981 in a database file is useless, because the asterisk in a partial matching
6982 subject key is always followed by a dot.
6983
6984
6985
6986
6987 .section "Lookup caching" "SECID64"
6988 .cindex "lookup" "caching"
6989 .cindex "caching" "lookup data"
6990 Exim caches all lookup results in order to avoid needless repetition of
6991 lookups. However, because (apart from the daemon) Exim operates as a collection
6992 of independent, short-lived processes, this caching applies only within a
6993 single Exim process. There is no inter-process lookup caching facility.
6994
6995 For single-key lookups, Exim keeps the relevant files open in case there is
6996 another lookup that needs them. In some types of configuration this can lead to
6997 many files being kept open for messages with many recipients. To avoid hitting
6998 the operating system limit on the number of simultaneously open files, Exim
6999 closes the least recently used file when it needs to open more files than its
7000 own internal limit, which can be changed via the &%lookup_open_max%& option.
7001
7002 The single-key lookup files are closed and the lookup caches are flushed at
7003 strategic points during delivery &-- for example, after all routing is
7004 complete.
7005
7006
7007
7008
7009 .section "Quoting lookup data" "SECID65"
7010 .cindex "lookup" "quoting"
7011 .cindex "quoting" "in lookups"
7012 When data from an incoming message is included in a query-style lookup, there
7013 is the possibility of special characters in the data messing up the syntax of
7014 the query. For example, a NIS+ query that contains
7015 .code
7016 [name=$local_part]
7017 .endd
7018 will be broken if the local part happens to contain a closing square bracket.
7019 For NIS+, data can be enclosed in double quotes like this:
7020 .code
7021 [name="$local_part"]
7022 .endd
7023 but this still leaves the problem of a double quote in the data. The rule for
7024 NIS+ is that double quotes must be doubled. Other lookup types have different
7025 rules, and to cope with the differing requirements, an expansion operator
7026 of the following form is provided:
7027 .code
7028 ${quote_<lookup-type>:<string>}
7029 .endd
7030 For example, the safest way to write the NIS+ query is
7031 .code
7032 [name="${quote_nisplus:$local_part}"]
7033 .endd
7034 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7035 operator can be used for all lookup types, but has no effect for single-key
7036 lookups, since no quoting is ever needed in their key strings.
7037
7038
7039
7040
7041 .section "More about dnsdb" "SECTdnsdb"
7042 .cindex "dnsdb lookup"
7043 .cindex "lookup" "dnsdb"
7044 .cindex "DNS" "as a lookup type"
7045 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7046 of a record type and a domain name, separated by an equals sign. For example,
7047 an expansion string could contain:
7048 .code
7049 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7050 .endd
7051 If the lookup succeeds, the result is placed in &$value$&, which in this case
7052 is used on its own as the result. If the lookup does not succeed, the
7053 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7054 &<<SECTforexpfai>>& for an explanation of what this means.
7055
7056 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7057 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7058 If no type is given, TXT is assumed.
7059
7060 For any record type, if multiple records are found, the data is returned as a
7061 concatenation, with newline as the default separator. The order, of course,
7062 depends on the DNS resolver. You can specify a different separator character
7063 between multiple records by putting a right angle-bracket followed immediately
7064 by the new separator at the start of the query. For example:
7065 .code
7066 ${lookup dnsdb{>: a=host1.example}}
7067 .endd
7068 It is permitted to specify a space as the separator character. Further
7069 white space is ignored.
7070 For lookup types that return multiple fields per record,
7071 an alternate field separator can be specified using a comma after the main
7072 separator character, followed immediately by the field separator.
7073
7074 .cindex "PTR record" "in &(dnsdb)& lookup"
7075 When the type is PTR,
7076 the data can be an IP address, written as normal; inversion and the addition of
7077 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7078 .code
7079 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7080 .endd
7081 If the data for a PTR record is not a syntactically valid IP address, it is not
7082 altered and nothing is added.
7083
7084 .cindex "MX record" "in &(dnsdb)& lookup"
7085 .cindex "SRV record" "in &(dnsdb)& lookup"
7086 For an MX lookup, both the preference value and the host name are returned for
7087 each record, separated by a space. For an SRV lookup, the priority, weight,
7088 port, and host name are returned for each record, separated by spaces.
7089 The field separator can be modified as above.
7090
7091 .cindex "TXT record" "in &(dnsdb)& lookup"
7092 .cindex "SPF record" "in &(dnsdb)& lookup"
7093 For TXT records with multiple items of data, only the first item is returned,
7094 unless a field separator is specified.
7095 To concatenate items without a separator, use a semicolon instead.
7096 For SPF records the
7097 default behaviour is to concatenate multiple items without using a separator.
7098 .code
7099 ${lookup dnsdb{>\n,: txt=a.b.example}}
7100 ${lookup dnsdb{>\n; txt=a.b.example}}
7101 ${lookup dnsdb{spf=example.org}}
7102 .endd
7103 It is permitted to specify a space as the separator character. Further
7104 white space is ignored.
7105
7106 .cindex "SOA record" "in &(dnsdb)& lookup"
7107 For an SOA lookup, while no result is obtained the lookup is redone with
7108 successively more leading components dropped from the given domain.
7109 Only the primary-nameserver field is returned unless a field separator is
7110 specified.
7111 .code
7112 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7113 .endd
7114
7115 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7116 .cindex "dnsdb modifiers"
7117 .cindex "modifiers" "dnsdb"
7118 .cindex "options" "dnsdb"
7119 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7120 each followed by a comma,
7121 that may appear before the record type.
7122
7123 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7124 temporary DNS error for any of them, the behaviour is controlled by
7125 a defer-option modifier.
7126 The possible keywords are
7127 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7128 With &"strict"& behaviour, any temporary DNS error causes the
7129 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7130 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7131 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7132 error causes the whole lookup to defer only if none of the other lookups
7133 succeed. The default is &"lax"&, so the following lookups are equivalent:
7134 .code
7135 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7136 ${lookup dnsdb{a=one.host.com:two.host.com}}
7137 .endd
7138 Thus, in the default case, as long as at least one of the DNS lookups
7139 yields some data, the lookup succeeds.
7140
7141 .cindex "DNSSEC" "dns lookup"
7142 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7143 The possible keywords are
7144 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7145 With &"strict"& or &"lax"& DNSSEC information is requested
7146 with the lookup.
7147 With &"strict"& a response from the DNS resolver that
7148 is not labelled as authenticated data
7149 is treated as equivalent to a temporary DNS error.
7150 The default is &"never"&.
7151
7152 See also the &$lookup_dnssec_authenticated$& variable.
7153
7154 .cindex timeout "dns lookup"
7155 .cindex "DNS" timeout
7156 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7157 The form is &"retrans_VAL"& where VAL is an Exim time specification
7158 (e.g. &"5s"&).
7159 The default value is set by the main configuration option &%dns_retrans%&.
7160
7161 Retries for the dnsdb lookup can be controlled by a retry modifier.
7162 The form if &"retry_VAL"& where VAL is an integer.
7163 The default count is set by the main configuration option &%dns_retry%&.
7164
7165 .cindex caching "of dns lookup"
7166 .cindex TTL "of dns lookup"
7167 .cindex DNS TTL
7168 Dnsdb lookup results are cached within a single process (and its children).
7169 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7170 value of the set of returned DNS records.
7171
7172
7173 .section "Pseudo dnsdb record types" "SECID66"
7174 .cindex "MX record" "in &(dnsdb)& lookup"
7175 By default, both the preference value and the host name are returned for
7176 each MX record, separated by a space. If you want only host names, you can use
7177 the pseudo-type MXH:
7178 .code
7179 ${lookup dnsdb{mxh=a.b.example}}
7180 .endd
7181 In this case, the preference values are omitted, and just the host names are
7182 returned.
7183
7184 .cindex "name server for enclosing domain"
7185 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7186 records on the given domain, but if none are found, it removes the first
7187 component of the domain name, and tries again. This process continues until NS
7188 records are found or there are no more components left (or there is a DNS
7189 error). In other words, it may return the name servers for a top-level domain,
7190 but it never returns the root name servers. If there are no NS records for the
7191 top-level domain, the lookup fails. Consider these examples:
7192 .code
7193 ${lookup dnsdb{zns=xxx.quercite.com}}
7194 ${lookup dnsdb{zns=xxx.edu}}
7195 .endd
7196 Assuming that in each case there are no NS records for the full domain name,
7197 the first returns the name servers for &%quercite.com%&, and the second returns
7198 the name servers for &%edu%&.
7199
7200 You should be careful about how you use this lookup because, unless the
7201 top-level domain does not exist, the lookup always returns some host names. The
7202 sort of use to which this might be put is for seeing if the name servers for a
7203 given domain are on a blacklist. You can probably assume that the name servers
7204 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7205 such a list.
7206
7207 .cindex "CSA" "in &(dnsdb)& lookup"
7208 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7209 records according to the CSA rules, which are described in section
7210 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7211 not sufficient because of the extra parent domain search behaviour of CSA. The
7212 result of a successful lookup such as:
7213 .code
7214 ${lookup dnsdb {csa=$sender_helo_name}}
7215 .endd
7216 has two space-separated fields: an authorization code and a target host name.
7217 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7218 authorization required but absent, or &"?"& for unknown.
7219
7220 .cindex "A+" "in &(dnsdb)& lookup"
7221 The pseudo-type A+ performs an AAAA
7222 and then an A lookup.  All results are returned; defer processing
7223 (see below) is handled separately for each lookup.  Example:
7224 .code
7225 ${lookup dnsdb {>; a+=$sender_helo_name}}
7226 .endd
7227
7228
7229 .section "Multiple dnsdb lookups" "SECID67"
7230 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7231 However, you can specify a list of domains or IP addresses in a single
7232 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7233 the default separator, but with the ability to change this. For example:
7234 .code
7235 ${lookup dnsdb{one.domain.com:two.domain.com}}
7236 ${lookup dnsdb{a=one.host.com:two.host.com}}
7237 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7238 .endd
7239 In order to retain backwards compatibility, there is one special case: if
7240 the lookup type is PTR and no change of separator is specified, Exim looks
7241 to see if the rest of the string is precisely one IPv6 address. In this
7242 case, it does not treat it as a list.
7243
7244 The data from each lookup is concatenated, with newline separators by default,
7245 in the same way that multiple DNS records for a single item are handled. A
7246 different separator can be specified, as described above.
7247
7248
7249
7250
7251 .section "More about LDAP" "SECTldap"
7252 .cindex "LDAP" "lookup, more about"
7253 .cindex "lookup" "LDAP"
7254 .cindex "Solaris" "LDAP"
7255 The original LDAP implementation came from the University of Michigan; this has
7256 become &"Open LDAP"&, and there are now two different releases. Another
7257 implementation comes from Netscape, and Solaris 7 and subsequent releases
7258 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7259 the lookup function level, their error handling is different. For this reason
7260 it is necessary to set a compile-time variable when building Exim with LDAP, to
7261 indicate which LDAP library is in use. One of the following should appear in
7262 your &_Local/Makefile_&:
7263 .code
7264 LDAP_LIB_TYPE=UMICHIGAN
7265 LDAP_LIB_TYPE=OPENLDAP1
7266 LDAP_LIB_TYPE=OPENLDAP2
7267 LDAP_LIB_TYPE=NETSCAPE
7268 LDAP_LIB_TYPE=SOLARIS
7269 .endd
7270 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7271 same interface as the University of Michigan version.
7272
7273 There are three LDAP lookup types in Exim. These behave slightly differently in
7274 the way they handle the results of a query:
7275
7276 .ilist
7277 &(ldap)& requires the result to contain just one entry; if there are more, it
7278 gives an error.
7279 .next
7280 &(ldapdn)& also requires the result to contain just one entry, but it is the
7281 Distinguished Name that is returned rather than any attribute values.
7282 .next
7283 &(ldapm)& permits the result to contain more than one entry; the attributes
7284 from all of them are returned.
7285 .endlist
7286
7287
7288 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7289 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7290 the data returned by a successful lookup is described in the next section.
7291 First we explain how LDAP queries are coded.
7292
7293
7294 .section "Format of LDAP queries" "SECTforldaque"
7295 .cindex "LDAP" "query format"
7296 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7297 the configuration of a &(redirect)& router one might have this setting:
7298 .code
7299 data = ${lookup ldap \
7300   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7301   c=UK?mailbox?base?}}
7302 .endd
7303 .cindex "LDAP" "with TLS"
7304 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7305 secure (encrypted) LDAP connections. The second of these ensures that an
7306 encrypted TLS connection is used.
7307
7308 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7309 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7310 See the &%ldap_start_tls%& option.
7311
7312 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7313 controlled. Every part of the TLS configuration can be configured by settings in
7314 &_exim.conf_&. Depending on the version of the client libraries installed on
7315 your system, some of the initialization may have required setting options in
7316 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7317 certificates. This revealed a nuance where the current UID that exim was
7318 running as could affect which config files it read. With Exim 4.83, these
7319 methods become optional, only taking effect if not specifically set in
7320 &_exim.conf_&.
7321
7322
7323 .section "LDAP quoting" "SECID68"
7324 .cindex "LDAP" "quoting"
7325 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7326 and the second because the LDAP query is represented as a URL. Furthermore,
7327 within an LDAP query, two different kinds of quoting are required. For this
7328 reason, there are two different LDAP-specific quoting operators.
7329
7330 The &%quote_ldap%& operator is designed for use on strings that are part of
7331 filter specifications. Conceptually, it first does the following conversions on
7332 the string:
7333 .code
7334 *   =>   \2A
7335 (   =>   \28
7336 )   =>   \29
7337 \   =>   \5C
7338 .endd
7339 in accordance with RFC 2254. The resulting string is then quoted according
7340 to the rules for URLs, that is, all non-alphanumeric characters except
7341 .code
7342 ! $ ' - . _ ( ) * +
7343 .endd
7344 are converted to their hex values, preceded by a percent sign. For example:
7345 .code
7346 ${quote_ldap: a(bc)*, a<yz>; }
7347 .endd
7348 yields
7349 .code
7350 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7351 .endd
7352 Removing the URL quoting, this is (with a leading and a trailing space):
7353 .code
7354 a\28bc\29\2A, a<yz>;
7355 .endd
7356 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7357 base DN specifications in queries. Conceptually, it first converts the string
7358 by inserting a backslash in front of any of the following characters:
7359 .code
7360 , + " \ < > ;
7361 .endd
7362 It also inserts a backslash before any leading spaces or # characters, and
7363 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7364 is then quoted according to the rules for URLs. For example:
7365 .code
7366 ${quote_ldap_dn: a(bc)*, a<yz>; }
7367 .endd
7368 yields
7369 .code
7370 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7371 .endd
7372 Removing the URL quoting, this is (with a trailing space):
7373 .code
7374 \ a(bc)*\, a\<yz\>\;\
7375 .endd
7376 There are some further comments about quoting in the section on LDAP
7377 authentication below.
7378
7379
7380 .section "LDAP connections" "SECID69"
7381 .cindex "LDAP" "connections"
7382 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7383 is in use, via a Unix domain socket. The example given above does not specify
7384 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7385 by starting it with
7386 .code
7387 ldap://<hostname>:<port>/...
7388 .endd
7389 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7390 used. When no server is specified in a query, a list of default servers is
7391 taken from the &%ldap_default_servers%& configuration option. This supplies a
7392 colon-separated list of servers which are tried in turn until one successfully
7393 handles a query, or there is a serious error. Successful handling either
7394 returns the requested data, or indicates that it does not exist. Serious errors
7395 are syntactical, or multiple values when only a single value is expected.
7396 Errors which cause the next server to be tried are connection failures, bind
7397 failures, and timeouts.
7398
7399 For each server name in the list, a port number can be given. The standard way
7400 of specifying a host and port is to use a colon separator (RFC 1738). Because
7401 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7402 doubled. For example
7403 .code
7404 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7405 .endd
7406 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7407 to the LDAP library with no server name, and the library's default (normally
7408 the local host) is used.
7409
7410 If you are using the OpenLDAP library, you can connect to an LDAP server using
7411 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7412 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7413 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7414 not available.
7415
7416 For this type of connection, instead of a host name for the server, a pathname
7417 for the socket is required, and the port number is not relevant. The pathname
7418 can be specified either as an item in &%ldap_default_servers%&, or inline in
7419 the query. In the former case, you can have settings such as
7420 .code
7421 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7422 .endd
7423 When the pathname is given in the query, you have to escape the slashes as
7424 &`%2F`& to fit in with the LDAP URL syntax. For example:
7425 .code
7426 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7427 .endd
7428 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7429 a pathname, it uses the Unix domain socket code, even if the query actually
7430 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7431 socket connection. This behaviour means that you can use a setting of
7432 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7433 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7434 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7435 backup host.
7436
7437 If an explicit &`ldapi`& type is given in a query when a host name is
7438 specified, an error is diagnosed. However, if there are more items in
7439 &%ldap_default_servers%&, they are tried. In other words:
7440
7441 .ilist
7442 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7443 interface.
7444 .next
7445 Using &`ldapi`& with a host name causes an error.
7446 .endlist
7447
7448
7449 Using &`ldapi`& with no host or path in the query, and no setting of
7450 &%ldap_default_servers%&, does whatever the library does by default.
7451
7452
7453
7454 .section "LDAP authentication and control information" "SECID70"
7455 .cindex "LDAP" "authentication"
7456 The LDAP URL syntax provides no way of passing authentication and other control
7457 information to the server. To make this possible, the URL in an LDAP query may
7458 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7459 spaces. If a value contains spaces it must be enclosed in double quotes, and
7460 when double quotes are used, backslash is interpreted in the usual way inside
7461 them. The following names are recognized:
7462 .display
7463 &`DEREFERENCE`&  set the dereferencing parameter
7464 &`NETTIME    `&  set a timeout for a network operation
7465 &`USER       `&  set the DN, for authenticating the LDAP bind
7466 &`PASS       `&  set the password, likewise
7467 &`REFERRALS  `&  set the referrals parameter
7468 &`SERVERS    `&  set alternate server list for this query only
7469 &`SIZE       `&  set the limit for the number of entries returned
7470 &`TIME       `&  set the maximum waiting time for a query
7471 .endd
7472 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7473 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7474 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7475 library from trying to follow referrals issued by the LDAP server.
7476
7477 .cindex LDAP timeout
7478 .cindex timeout "LDAP lookup"
7479 The name CONNECT is an obsolete name for NETTIME, retained for
7480 backwards compatibility. This timeout (specified as a number of seconds) is
7481 enforced from the client end for operations that can be carried out over a
7482 network. Specifically, it applies to network connections and calls to the
7483 &'ldap_result()'& function. If the value is greater than zero, it is used if
7484 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7485 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7486 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7487 Netscape SDK; for OpenLDAP no action is taken.
7488
7489 The TIME parameter (also a number of seconds) is passed to the server to
7490 set a server-side limit on the time taken to complete a search.
7491
7492 The SERVERS parameter allows you to specify an alternate list of ldap servers
7493 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7494 default list of ldap servers, and a single lookup can specify a single ldap
7495 server to use.  But when you need to do a lookup with a list of servers that is
7496 different than the default list (maybe different order, maybe a completely
7497 different set of servers), the SERVERS parameter allows you to specify this
7498 alternate list (colon-separated).
7499
7500 Here is an example of an LDAP query in an Exim lookup that uses some of these
7501 values. This is a single line, folded to fit on the page:
7502 .code
7503 ${lookup ldap
7504   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7505   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7506   {$value}fail}
7507 .endd
7508 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7509 any of the auxiliary data. Exim configuration settings that include lookups
7510 which contain password information should be preceded by &"hide"& to prevent
7511 non-admin users from using the &%-bP%& option to see their values.
7512
7513 The auxiliary data items may be given in any order. The default is no
7514 connection timeout (the system timeout is used), no user or password, no limit
7515 on the number of entries returned, and no time limit on queries.
7516
7517 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7518 removes any URL quoting that it may contain before passing it LDAP. Apparently
7519 some libraries do this for themselves, but some do not. Removing the URL
7520 quoting has two advantages:
7521
7522 .ilist
7523 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7524 DNs as with DNs inside actual queries.
7525 .next
7526 It permits spaces inside USER= DNs.
7527 .endlist
7528
7529 For example, a setting such as
7530 .code
7531 USER=cn=${quote_ldap_dn:$1}
7532 .endd
7533 should work even if &$1$& contains spaces.
7534
7535 Expanded data for the PASS= value should be quoted using the &%quote%&
7536 expansion operator, rather than the LDAP quote operators. The only reason this
7537 field needs quoting is to ensure that it conforms to the Exim syntax, which
7538 does not allow unquoted spaces. For example:
7539 .code
7540 PASS=${quote:$3}
7541 .endd
7542 The LDAP authentication mechanism can be used to check passwords as part of
7543 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7544 &<<CHAPexpand>>&.
7545
7546
7547
7548 .section "Format of data returned by LDAP" "SECID71"
7549 .cindex "LDAP" "returned data formats"
7550 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7551 as a sequence of values, for example
7552 .code
7553 cn=manager,o=University of Cambridge,c=UK
7554 .endd
7555 The &(ldap)& lookup type generates an error if more than one entry matches the
7556 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7557 the result between the data from different entries. It is possible for multiple
7558 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7559 you know that whatever values are returned all came from a single entry in the
7560 directory.
7561
7562 In the common case where you specify a single attribute in your LDAP query, the
7563 result is not quoted, and does not contain the attribute name. If the attribute
7564 has multiple values, they are separated by commas. Any comma that is
7565 part of an attribute's value is doubled.
7566
7567 If you specify multiple attributes, the result contains space-separated, quoted
7568 strings, each preceded by the attribute name and an equals sign. Within the
7569 quotes, the quote character, backslash, and newline are escaped with
7570 backslashes, and commas are used to separate multiple values for the attribute.
7571 Any commas in attribute values are doubled
7572 (permitting treatment of the values as a comma-separated list).
7573 Apart from the escaping, the string within quotes takes the same form as the
7574 output when a single attribute is requested. Specifying no attributes is the
7575 same as specifying all of an entry's attributes.
7576
7577 Here are some examples of the output format. The first line of each pair is an
7578 LDAP query, and the second is the data that is returned. The attribute called
7579 &%attr1%& has two values, one of them with an embedded comma, whereas
7580 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7581 (they have SUP &%attr%& in their schema definitions).
7582
7583 .code
7584 ldap:///o=base?attr1?sub?(uid=fred)
7585 value1.1,value1,,2
7586
7587 ldap:///o=base?attr2?sub?(uid=fred)
7588 value two
7589
7590 ldap:///o=base?attr?sub?(uid=fred)
7591 value1.1,value1,,2,value two
7592
7593 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7594 attr1="value1.1,value1,,2" attr2="value two"
7595
7596 ldap:///o=base??sub?(uid=fred)
7597 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7598 .endd
7599 You can
7600 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7601 results of LDAP lookups.
7602 The &%extract%& operator in string expansions can be used to pick out
7603 individual fields from data that consists of &'key'&=&'value'& pairs.
7604 The &%listextract%& operator should be used to pick out individual values
7605 of attributes, even when only a single value is expected.
7606 The doubling of embedded commas allows you to use the returned data as a
7607 comma separated list (using the "<," syntax for changing the input list separator).
7608
7609
7610
7611
7612 .section "More about NIS+" "SECTnisplus"
7613 .cindex "NIS+ lookup type"
7614 .cindex "lookup" "NIS+"
7615 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7616 and field name. If this is given, the result of a successful query is the
7617 contents of the named field; otherwise the result consists of a concatenation
7618 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7619 values containing spaces are quoted. For example, the query
7620 .code
7621 [name=mg1456],passwd.org_dir
7622 .endd
7623 might return the string
7624 .code
7625 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7626 home=/home/mg1456 shell=/bin/bash shadow=""
7627 .endd
7628 (split over two lines here to fit on the page), whereas
7629 .code
7630 [name=mg1456],passwd.org_dir:gcos
7631 .endd
7632 would just return
7633 .code
7634 Martin Guerre
7635 .endd
7636 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7637 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7638 operator is to double any quote characters within the text.
7639
7640
7641
7642 .section "SQL lookups" "SECTsql"
7643 .cindex "SQL lookup types"
7644 .cindex "MySQL" "lookup type"
7645 .cindex "PostgreSQL lookup type"
7646 .cindex "lookup" "MySQL"
7647 .cindex "lookup" "PostgreSQL"
7648 .cindex "Oracle" "lookup type"
7649 .cindex "lookup" "Oracle"
7650 .cindex "InterBase lookup type"
7651 .cindex "lookup" "InterBase"
7652 .cindex "Redis lookup type"
7653 .cindex lookup Redis
7654 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7655 and SQLite
7656 databases. Queries for these databases contain SQL statements, so an example
7657 might be
7658 .code
7659 ${lookup mysql{select mailbox from users where id='userx'}\
7660   {$value}fail}
7661 .endd
7662 If the result of the query contains more than one field, the data for each
7663 field in the row is returned, preceded by its name, so the result of
7664 .code
7665 ${lookup pgsql{select home,name from users where id='userx'}\
7666   {$value}}
7667 .endd
7668 might be
7669 .code
7670 home=/home/userx name="Mister X"
7671 .endd
7672 Empty values and values containing spaces are double quoted, with embedded
7673 quotes escaped by a backslash. If the result of the query contains just one
7674 field, the value is passed back verbatim, without a field name, for example:
7675 .code
7676 Mister X
7677 .endd
7678 If the result of the query yields more than one row, it is all concatenated,
7679 with a newline between the data for each row.
7680
7681
7682 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7683 .cindex "MySQL" "lookup type"
7684 .cindex "PostgreSQL lookup type"
7685 .cindex "lookup" "MySQL"
7686 .cindex "lookup" "PostgreSQL"
7687 .cindex "Oracle" "lookup type"
7688 .cindex "lookup" "Oracle"
7689 .cindex "InterBase lookup type"
7690 .cindex "lookup" "InterBase"
7691 .cindex "Redis lookup type"
7692 .cindex lookup Redis
7693 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7694 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7695 or &%redis_servers%&
7696 option (as appropriate) must be set to a colon-separated list of server
7697 information.
7698 (For MySQL and PostgreSQL, the global option need not be set if all
7699 queries contain their own server information &-- see section
7700 &<<SECTspeserque>>&.)
7701 For all but Redis
7702 each item in the list is a slash-separated list of four
7703 items: host name, database name, user name, and password. In the case of
7704 Oracle, the host name field is used for the &"service name"&, and the database
7705 name field is not used and should be empty. For example:
7706 .code
7707 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7708 .endd
7709 Because password data is sensitive, you should always precede the setting with
7710 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7711 option. Here is an example where two MySQL servers are listed:
7712 .code
7713 hide mysql_servers = localhost/users/root/secret:\
7714                      otherhost/users/root/othersecret
7715 .endd
7716 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7717 because this is a colon-separated list, the colon has to be doubled. For each
7718 query, these parameter groups are tried in order until a connection is made and
7719 a query is successfully processed. The result of a query may be that no data is
7720 found, but that is still a successful query. In other words, the list of
7721 servers provides a backup facility, not a list of different places to look.
7722
7723 For Redis the global option need not be specified if all queries contain their
7724 own server information &-- see section &<<SECTspeserque>>&.
7725 If specified, the option must be set to a colon-separated list of server
7726 information.
7727 Each item in the list is a slash-separated list of three items:
7728 host, database number, and password.
7729 .olist
7730 The host is required and may be either an IPv4 address and optional
7731 port number (separated by a colon, which needs doubling due to the
7732 higher-level list), or a Unix socket pathname enclosed in parentheses
7733 .next
7734 The database number is optional; if present that number is selected in the backend
7735 .next
7736 The password is optional; if present it is used to authenticate to the backend
7737 .endlist
7738
7739 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7740 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7741 respectively, and the characters single-quote, double-quote, and backslash
7742 itself are escaped with backslashes.
7743
7744 The &%quote_redis%& expansion operator
7745 escapes whitespace and backslash characters with a backslash.
7746
7747 .section "Specifying the server in the query" "SECTspeserque"
7748 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7749 it is possible to specify a list of servers with an individual query. This is
7750 done by starting the query with
7751 .display
7752 &`servers=`&&'server1:server2:server3:...'&&`;`&
7753 .endd
7754 Each item in the list may take one of two forms:
7755 .olist
7756 If it contains no slashes it is assumed to be just a host name. The appropriate
7757 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7758 of the same name, and the remaining parameters (database, user, password) are
7759 taken from there.
7760 .next
7761 If it contains any slashes, it is taken as a complete parameter set.
7762 .endlist
7763 The list of servers is used in exactly the same way as the global list.
7764 Once a connection to a server has happened and a query has been
7765 successfully executed, processing of the lookup ceases.
7766
7767 This feature is intended for use in master/slave situations where updates
7768 are occurring and you want to update the master rather than a slave. If the
7769 master is in the list as a backup for reading, you might have a global setting
7770 like this:
7771 .code
7772 mysql_servers = slave1/db/name/pw:\
7773                 slave2/db/name/pw:\
7774                 master/db/name/pw
7775 .endd
7776 In an updating lookup, you could then write:
7777 .code
7778 ${lookup mysql{servers=master; UPDATE ...} }
7779 .endd
7780 That query would then be sent only to the master server. If, on the other hand,
7781 the master is not to be used for reading, and so is not present in the global
7782 option, you can still update it by a query of this form:
7783 .code
7784 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7785 .endd
7786
7787
7788 .section "Special MySQL features" "SECID73"
7789 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7790 causes a connection to the server on the local host by means of a Unix domain
7791 socket. An alternate socket can be specified in parentheses.
7792 An option group name for MySQL option files can be specified in square brackets;
7793 the default value is &"exim"&.
7794 The full syntax of each item in &%mysql_servers%& is:
7795 .display
7796 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7797   <&'database'&>/<&'user'&>/<&'password'&>
7798 .endd
7799 Any of the four sub-parts of the first field can be omitted. For normal use on
7800 the local host it can be left blank or set to just &"localhost"&.
7801
7802 No database need be supplied &-- but if it is absent here, it must be given in
7803 the queries.
7804
7805 If a MySQL query is issued that does not request any data (an insert, update,
7806 or delete command), the result of the lookup is the number of rows affected.
7807
7808 &*Warning*&: This can be misleading. If an update does not actually change
7809 anything (for example, setting a field to the value it already has), the result
7810 is zero because no rows are affected.
7811
7812
7813 .section "Special PostgreSQL features" "SECID74"
7814 PostgreSQL lookups can also use Unix domain socket connections to the database.
7815 This is usually faster and costs less CPU time than a TCP/IP connection.
7816 However it can be used only if the mail server runs on the same machine as the
7817 database server. A configuration line for PostgreSQL via Unix domain sockets
7818 looks like this:
7819 .code
7820 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7821 .endd
7822 In other words, instead of supplying a host name, a path to the socket is
7823 given. The path name is enclosed in parentheses so that its slashes aren't
7824 visually confused with the delimiters for the other server parameters.
7825
7826 If a PostgreSQL query is issued that does not request any data (an insert,
7827 update, or delete command), the result of the lookup is the number of rows
7828 affected.
7829
7830 .section "More about SQLite" "SECTsqlite"
7831 .cindex "lookup" "SQLite"
7832 .cindex "sqlite lookup type"
7833 SQLite is different to the other SQL lookups because a file name is required in
7834 addition to the SQL query. An SQLite database is a single file, and there is no
7835 daemon as in the other SQL databases. The interface to Exim requires the name
7836 of the file, as an absolute path, to be given at the start of the query. It is
7837 separated from the query by white space. This means that the path name cannot
7838 contain white space. Here is a lookup expansion example:
7839 .code
7840 ${lookup sqlite {/some/thing/sqlitedb \
7841   select name from aliases where id='userx';}}
7842 .endd
7843 In a list, the syntax is similar. For example:
7844 .code
7845 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7846    select * from relays where ip='$sender_host_address';
7847 .endd
7848 The only character affected by the &%quote_sqlite%& operator is a single
7849 quote, which it doubles.
7850
7851 .cindex timeout SQLite
7852 .cindex sqlite "lookup timeout"
7853 The SQLite library handles multiple simultaneous accesses to the database
7854 internally. Multiple readers are permitted, but only one process can
7855 update at once. Attempts to access the database while it is being updated
7856 are rejected after a timeout period, during which the SQLite library
7857 waits for the lock to be released. In Exim, the default timeout is set
7858 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7859 option.
7860
7861 .section "More about Redis" "SECTredis"
7862 .cindex "lookup" "Redis"
7863 .cindex "redis lookup type"
7864 Redis is a non-SQL database. Commands are simple get and set.
7865 Examples:
7866 .code
7867 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
7868 ${lookup redis{get keyname}}
7869 .endd
7870
7871 As of release 4.91, "lightweight" support for Redis Cluster is available.
7872 Requires &%redis_servers%& list to contain all the servers in the cluster, all
7873 of which must be reachable from the running exim instance. If the cluster has
7874 master/slave replication, the list must contain all the master and slave
7875 servers.
7876
7877 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
7878 immediately follow the redirection but treats the response as a DEFER, moving on
7879 to the next server in the &%redis_servers%& list until the correct server is
7880 reached.
7881
7882 .ecindex IIDfidalo1
7883 .ecindex IIDfidalo2
7884
7885
7886 . ////////////////////////////////////////////////////////////////////////////
7887 . ////////////////////////////////////////////////////////////////////////////
7888
7889 .chapter "Domain, host, address, and local part lists" &&&
7890          "CHAPdomhosaddlists" &&&
7891          "Domain, host, and address lists"
7892 .scindex IIDdohoadli "lists of domains; hosts; etc."
7893 A number of Exim configuration options contain lists of domains, hosts,
7894 email addresses, or local parts. For example, the &%hold_domains%& option
7895 contains a list of domains whose delivery is currently suspended. These lists
7896 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7897 arguments to expansion conditions such as &%match_domain%&.
7898
7899 Each item in one of these lists is a pattern to be matched against a domain,
7900 host, email address, or local part, respectively. In the sections below, the
7901 different types of pattern for each case are described, but first we cover some
7902 general facilities that apply to all four kinds of list.
7903
7904 Note that other parts of Exim use a &'string list'& which does not
7905 support all the complexity available in
7906 domain, host, address and local part lists.
7907
7908
7909
7910 .section "Expansion of lists" "SECTlistexpand"
7911 .cindex "expansion" "of lists"
7912 Each list is expanded as a single string before it is used.
7913
7914 &'Exception: the router headers_remove option, where list-item
7915 splitting is done before string-expansion.'&
7916
7917 The result of
7918 expansion must be a list, possibly containing empty items, which is split up
7919 into separate items for matching. By default, colon is the separator character,
7920 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7921 &<<SECTempitelis>>& for details of the list syntax; the second of these
7922 discusses the way to specify empty list items.
7923
7924
7925 If the string expansion is forced to fail, Exim behaves as if the item it is
7926 testing (domain, host, address, or local part) is not in the list. Other
7927 expansion failures cause temporary errors.
7928
7929 If an item in a list is a regular expression, backslashes, dollars and possibly
7930 other special characters in the expression must be protected against
7931 misinterpretation by the string expander. The easiest way to do this is to use
7932 the &`\N`& expansion feature to indicate that the contents of the regular
7933 expression should not be expanded. For example, in an ACL you might have:
7934 .code
7935 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7936                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7937 .endd
7938 The first item is a regular expression that is protected from expansion by
7939 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7940 senders based on the receiving domain.
7941
7942
7943
7944
7945 .section "Negated items in lists" "SECID76"
7946 .cindex "list" "negation"
7947 .cindex "negation" "in lists"
7948 Items in a list may be positive or negative. Negative items are indicated by a
7949 leading exclamation mark, which may be followed by optional white space. A list
7950 defines a set of items (domains, etc). When Exim processes one of these lists,
7951 it is trying to find out whether a domain, host, address, or local part
7952 (respectively) is in the set that is defined by the list. It works like this:
7953
7954 The list is scanned from left to right. If a positive item is matched, the
7955 subject that is being checked is in the set; if a negative item is matched, the
7956 subject is not in the set. If the end of the list is reached without the
7957 subject having matched any of the patterns, it is in the set if the last item
7958 was a negative one, but not if it was a positive one. For example, the list in
7959 .code
7960 domainlist relay_to_domains = !a.b.c : *.b.c
7961 .endd
7962 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7963 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7964 list is positive. However, if the setting were
7965 .code
7966 domainlist relay_to_domains = !a.b.c
7967 .endd
7968 then all domains other than &'a.b.c'& would match because the last item in the
7969 list is negative. In other words, a list that ends with a negative item behaves
7970 as if it had an extra item &`:*`& on the end.
7971
7972 Another way of thinking about positive and negative items in lists is to read
7973 the connector as &"or"& after a positive item and as &"and"& after a negative
7974 item.
7975
7976
7977
7978 .section "File names in lists" "SECTfilnamlis"
7979 .cindex "list" "file name in"
7980 If an item in a domain, host, address, or local part list is an absolute file
7981 name (beginning with a slash character), each line of the file is read and
7982 processed as if it were an independent item in the list, except that further
7983 file names are not allowed,
7984 and no expansion of the data from the file takes place.
7985 Empty lines in the file are ignored, and the file may also contain comment
7986 lines:
7987
7988 .ilist
7989 For domain and host lists, if a # character appears anywhere in a line of the
7990 file, it and all following characters are ignored.
7991 .next
7992 Because local parts may legitimately contain # characters, a comment in an
7993 address list or local part list file is recognized only if # is preceded by
7994 white space or the start of the line. For example:
7995 .code
7996 not#comment@x.y.z   # but this is a comment
7997 .endd
7998 .endlist
7999
8000 Putting a file name in a list has the same effect as inserting each line of the
8001 file as an item in the list (blank lines and comments excepted). However, there
8002 is one important difference: the file is read each time the list is processed,
8003 so if its contents vary over time, Exim's behaviour changes.
8004
8005 If a file name is preceded by an exclamation mark, the sense of any match
8006 within the file is inverted. For example, if
8007 .code
8008 hold_domains = !/etc/nohold-domains
8009 .endd
8010 and the file contains the lines
8011 .code
8012 !a.b.c
8013 *.b.c
8014 .endd
8015 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8016 any domain matching &`*.b.c`& is not.
8017
8018
8019
8020 .section "An lsearch file is not an out-of-line list" "SECID77"
8021 As will be described in the sections that follow, lookups can be used in lists
8022 to provide indexed methods of checking list membership. There has been some
8023 confusion about the way &(lsearch)& lookups work in lists. Because
8024 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8025 sometimes thought that it is allowed to contain wild cards and other kinds of
8026 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8027 always fixed strings, just as for any other single-key lookup type.
8028
8029 If you want to use a file to contain wild-card patterns that form part of a
8030 list, just give the file name on its own, without a search type, as described
8031 in the previous section. You could also use the &(wildlsearch)& or
8032 &(nwildlsearch)&, but there is no advantage in doing this.
8033
8034
8035
8036
8037 .section "Named lists" "SECTnamedlists"
8038 .cindex "named lists"
8039 .cindex "list" "named"
8040 A list of domains, hosts, email addresses, or local parts can be given a name
8041 which is then used to refer to the list elsewhere in the configuration. This is
8042 particularly convenient if the same list is required in several different
8043 places. It also allows lists to be given meaningful names, which can improve
8044 the readability of the configuration. For example, it is conventional to define
8045 a domain list called &'local_domains'& for all the domains that are handled
8046 locally on a host, using a configuration line such as
8047 .code
8048 domainlist local_domains = localhost:my.dom.example
8049 .endd
8050 Named lists are referenced by giving their name preceded by a plus sign, so,
8051 for example, a router that is intended to handle local domains would be
8052 configured with the line
8053 .code
8054 domains = +local_domains
8055 .endd
8056 The first router in a configuration is often one that handles all domains
8057 except the local ones, using a configuration with a negated item like this:
8058 .code
8059 dnslookup:
8060   driver = dnslookup
8061   domains = ! +local_domains
8062   transport = remote_smtp
8063   no_more
8064 .endd
8065 The four kinds of named list are created by configuration lines starting with
8066 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8067 respectively. Then there follows the name that you are defining, followed by an
8068 equals sign and the list itself. For example:
8069 .code
8070 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8071 addresslist bad_senders = cdb;/etc/badsenders
8072 .endd
8073 A named list may refer to other named lists:
8074 .code
8075 domainlist  dom1 = first.example : second.example
8076 domainlist  dom2 = +dom1 : third.example
8077 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8078 .endd
8079 &*Warning*&: If the last item in a referenced list is a negative one, the
8080 effect may not be what you intended, because the negation does not propagate
8081 out to the higher level. For example, consider:
8082 .code
8083 domainlist  dom1 = !a.b
8084 domainlist  dom2 = +dom1 : *.b
8085 .endd
8086 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8087 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8088 means it matches the second list as well. The effect is not the same as
8089 .code
8090 domainlist  dom2 = !a.b : *.b
8091 .endd
8092 where &'x.y'& does not match. It's best to avoid negation altogether in
8093 referenced lists if you can.
8094
8095 Named lists may have a performance advantage. When Exim is routing an
8096 address or checking an incoming message, it caches the result of tests on named
8097 lists. So, if you have a setting such as
8098 .code
8099 domains = +local_domains
8100 .endd
8101 on several of your routers
8102 or in several ACL statements,
8103 the actual test is done only for the first one. However, the caching works only
8104 if there are no expansions within the list itself or any sublists that it
8105 references. In other words, caching happens only for lists that are known to be
8106 the same each time they are referenced.
8107
8108 By default, there may be up to 16 named lists of each type. This limit can be
8109 extended by changing a compile-time variable. The use of domain and host lists
8110 is recommended for concepts such as local domains, relay domains, and relay
8111 hosts. The default configuration is set up like this.
8112
8113
8114
8115 .section "Named lists compared with macros" "SECID78"
8116 .cindex "list" "named compared with macro"
8117 .cindex "macro" "compared with named list"
8118 At first sight, named lists might seem to be no different from macros in the
8119 configuration file. However, macros are just textual substitutions. If you
8120 write
8121 .code
8122 ALIST = host1 : host2
8123 auth_advertise_hosts = !ALIST
8124 .endd
8125 it probably won't do what you want, because that is exactly the same as
8126 .code
8127 auth_advertise_hosts = !host1 : host2
8128 .endd
8129 Notice that the second host name is not negated. However, if you use a host
8130 list, and write
8131 .code
8132 hostlist alist = host1 : host2
8133 auth_advertise_hosts = ! +alist
8134 .endd
8135 the negation applies to the whole list, and so that is equivalent to
8136 .code
8137 auth_advertise_hosts = !host1 : !host2
8138 .endd
8139
8140
8141 .section "Named list caching" "SECID79"
8142 .cindex "list" "caching of named"
8143 .cindex "caching" "named lists"
8144 While processing a message, Exim caches the result of checking a named list if
8145 it is sure that the list is the same each time. In practice, this means that
8146 the cache operates only if the list contains no $ characters, which guarantees
8147 that it will not change when it is expanded. Sometimes, however, you may have
8148 an expanded list that you know will be the same each time within a given
8149 message. For example:
8150 .code
8151 domainlist special_domains = \
8152            ${lookup{$sender_host_address}cdb{/some/file}}
8153 .endd
8154 This provides a list of domains that depends only on the sending host's IP
8155 address. If this domain list is referenced a number of times (for example,
8156 in several ACL lines, or in several routers) the result of the check is not
8157 cached by default, because Exim does not know that it is going to be the
8158 same list each time.
8159
8160 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8161 cache the result anyway. For example:
8162 .code
8163 domainlist_cache special_domains = ${lookup{...
8164 .endd
8165 If you do this, you should be absolutely sure that caching is going to do
8166 the right thing in all cases. When in doubt, leave it out.
8167
8168
8169
8170 .section "Domain lists" "SECTdomainlist"
8171 .cindex "domain list" "patterns for"
8172 .cindex "list" "domain list"
8173 Domain lists contain patterns that are to be matched against a mail domain.
8174 The following types of item may appear in domain lists:
8175
8176 .ilist
8177 .cindex "primary host name"
8178 .cindex "host name" "matched in domain list"
8179 .oindex "&%primary_hostname%&"
8180 .cindex "domain list" "matching primary host name"
8181 .cindex "@ in a domain list"
8182 If a pattern consists of a single @ character, it matches the local host name,
8183 as set by the &%primary_hostname%& option (or defaulted). This makes it
8184 possible to use the same configuration file on several different hosts that
8185 differ only in their names.
8186 .next
8187 .cindex "@[] in a domain list"
8188 .cindex "domain list" "matching local IP interfaces"
8189 .cindex "domain literal"
8190 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8191 in square brackets (as in an email address that contains a domain literal), but
8192 only if that IP address is recognized as local for email routing purposes. The
8193 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8194 control which of a host's several IP addresses are treated as local.
8195 In today's Internet, the use of domain literals is controversial.
8196 .next
8197 .cindex "@mx_any"
8198 .cindex "@mx_primary"
8199 .cindex "@mx_secondary"
8200 .cindex "domain list" "matching MX pointers to local host"
8201 If a pattern consists of the string &`@mx_any`& it matches any domain that
8202 has an MX record pointing to the local host or to any host that is listed in
8203 .oindex "&%hosts_treat_as_local%&"
8204 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8205 are similar, except that the first matches only when a primary MX target is the
8206 local host, and the second only when no primary MX target is the local host,
8207 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8208 preference value &-- there may of course be more than one of them.
8209
8210 The MX lookup that takes place when matching a pattern of this type is
8211 performed with the resolver options for widening names turned off. Thus, for
8212 example, a single-component domain will &'not'& be expanded by adding the
8213 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8214 options of the &(dnslookup)& router for a discussion of domain widening.
8215
8216 Sometimes you may want to ignore certain IP addresses when using one of these
8217 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8218 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8219 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8220 on a router). For example:
8221 .code
8222 domains = @mx_any/ignore=127.0.0.1
8223 .endd
8224 This example matches any domain that has an MX record pointing to one of
8225 the local host's IP addresses other than 127.0.0.1.
8226
8227 The list of IP addresses is in fact processed by the same code that processes
8228 host lists, so it may contain CIDR-coded network specifications and it may also
8229 contain negative items.
8230
8231 Because the list of IP addresses is a sublist within a domain list, you have to
8232 be careful about delimiters if there is more than one address. Like any other
8233 list, the default delimiter can be changed. Thus, you might have:
8234 .code
8235 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8236           an.other.domain : ...
8237 .endd
8238 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8239 involved, it is easiest to change the delimiter for the main list as well:
8240 .code
8241 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8242           an.other.domain ? ...
8243 .endd
8244 .next
8245 .cindex "asterisk" "in domain list"
8246 .cindex "domain list" "asterisk in"
8247 .cindex "domain list" "matching &""ends with""&"
8248 If a pattern starts with an asterisk, the remaining characters of the pattern
8249 are compared with the terminating characters of the domain. The use of &"*"& in
8250 domain lists differs from its use in partial matching lookups. In a domain
8251 list, the character following the asterisk need not be a dot, whereas partial
8252 matching works only in terms of dot-separated components. For example, a domain
8253 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8254 &'cipher.key.ex'&.
8255
8256 .next
8257 .cindex "regular expressions" "in domain list"
8258 .cindex "domain list" "matching regular expression"
8259 If a pattern starts with a circumflex character, it is treated as a regular
8260 expression, and matched against the domain using a regular expression matching
8261 function. The circumflex is treated as part of the regular expression.
8262 Email domains are case-independent, so this regular expression match is by
8263 default case-independent, but you can make it case-dependent by starting it
8264 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8265 are given in chapter &<<CHAPregexp>>&.
8266
8267 &*Warning*&: Because domain lists are expanded before being processed, you
8268 must escape any backslash and dollar characters in the regular expression, or
8269 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8270 it is not to be expanded (unless you really do want to build a regular
8271 expression by expansion, of course).
8272 .next
8273 .cindex "lookup" "in domain list"
8274 .cindex "domain list" "matching by lookup"
8275 If a pattern starts with the name of a single-key lookup type followed by a
8276 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8277 must be a file name in a suitable format for the lookup type. For example, for
8278 &"cdb;"& it must be an absolute path:
8279 .code
8280 domains = cdb;/etc/mail/local_domains.cdb
8281 .endd
8282 The appropriate type of lookup is done on the file using the domain name as the
8283 key. In most cases, the data that is looked up is not used; Exim is interested
8284 only in whether or not the key is present in the file. However, when a lookup
8285 is used for the &%domains%& option on a router
8286 or a &%domains%& condition in an ACL statement, the data is preserved in the
8287 &$domain_data$& variable and can be referred to in other router options or
8288 other statements in the same ACL.
8289
8290 .next
8291 Any of the single-key lookup type names may be preceded by
8292 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8293 .code
8294 domains = partial-dbm;/partial/domains
8295 .endd
8296 This causes partial matching logic to be invoked; a description of how this
8297 works is given in section &<<SECTpartiallookup>>&.
8298
8299 .next
8300 .cindex "asterisk" "in lookup type"
8301 Any of the single-key lookup types may be followed by an asterisk. This causes
8302 a default lookup for a key consisting of a single asterisk to be done if the
8303 original lookup fails. This is not a useful feature when using a domain list to
8304 select particular domains (because any domain would match), but it might have
8305 value if the result of the lookup is being used via the &$domain_data$&
8306 expansion variable.
8307 .next
8308 If the pattern starts with the name of a query-style lookup type followed by a
8309 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8310 pattern must be an appropriate query for the lookup type, as described in
8311 chapter &<<CHAPfdlookup>>&. For example:
8312 .code
8313 hold_domains = mysql;select domain from holdlist \
8314   where domain = '${quote_mysql:$domain}';
8315 .endd
8316 In most cases, the data that is looked up is not used (so for an SQL query, for
8317 example, it doesn't matter what field you select). Exim is interested only in
8318 whether or not the query succeeds. However, when a lookup is used for the
8319 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8320 variable and can be referred to in other options.
8321 .next
8322 .cindex "domain list" "matching literal domain name"
8323 If none of the above cases apply, a caseless textual comparison is made
8324 between the pattern and the domain.
8325 .endlist
8326
8327 Here is an example that uses several different kinds of pattern:
8328 .code
8329 domainlist funny_domains = \
8330   @ : \
8331   lib.unseen.edu : \
8332   *.foundation.fict.example : \
8333   \N^[1-2]\d{3}\.fict\.example$\N : \
8334   partial-dbm;/opt/data/penguin/book : \
8335   nis;domains.byname : \
8336   nisplus;[name=$domain,status=local],domains.org_dir
8337 .endd
8338 There are obvious processing trade-offs among the various matching modes. Using
8339 an asterisk is faster than a regular expression, and listing a few names
8340 explicitly probably is too. The use of a file or database lookup is expensive,
8341 but may be the only option if hundreds of names are required. Because the
8342 patterns are tested in order, it makes sense to put the most commonly matched
8343 patterns earlier.
8344
8345
8346
8347 .section "Host lists" "SECThostlist"
8348 .cindex "host list" "patterns in"
8349 .cindex "list" "host list"
8350 Host lists are used to control what remote hosts are allowed to do. For
8351 example, some hosts may be allowed to use the local host as a relay, and some
8352 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8353 two different ways, by name or by IP address. In a host list, some types of
8354 pattern are matched to a host name, and some are matched to an IP address.
8355 You need to be particularly careful with this when single-key lookups are
8356 involved, to ensure that the right value is being used as the key.
8357
8358
8359 .section "Special host list patterns" "SECID80"
8360 .cindex "empty item in hosts list"
8361 .cindex "host list" "empty string in"
8362 If a host list item is the empty string, it matches only when no remote host is
8363 involved. This is the case when a message is being received from a local
8364 process using SMTP on the standard input, that is, when a TCP/IP connection is
8365 not used.
8366
8367 .cindex "asterisk" "in host list"
8368 The special pattern &"*"& in a host list matches any host or no host. Neither
8369 the IP address nor the name is actually inspected.
8370
8371
8372
8373 .section "Host list patterns that match by IP address" "SECThoslispatip"
8374 .cindex "host list" "matching IP addresses"
8375 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8376 the incoming address actually appears in the IPv6 host as
8377 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8378 list, it is converted into a traditional IPv4 address first. (Not all operating
8379 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8380 concerns.)
8381
8382 The following types of pattern in a host list check the remote host by
8383 inspecting its IP address:
8384
8385 .ilist
8386 If the pattern is a plain domain name (not a regular expression, not starting
8387 with *, not a lookup of any kind), Exim calls the operating system function
8388 to find the associated IP address(es). Exim uses the newer
8389 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8390 This typically causes a forward DNS lookup of the name. The result is compared
8391 with the IP address of the subject host.
8392
8393 If there is a temporary problem (such as a DNS timeout) with the host name
8394 lookup, a temporary error occurs. For example, if the list is being used in an
8395 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8396 temporary SMTP error code. If no IP address can be found for the host name,
8397 what happens is described in section &<<SECTbehipnot>>& below.
8398
8399 .next
8400 .cindex "@ in a host list"
8401 If the pattern is &"@"&, the primary host name is substituted and used as a
8402 domain name, as just described.
8403
8404 .next
8405 If the pattern is an IP address, it is matched against the IP address of the
8406 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8407 IPv6 addresses can be given in colon-separated format, but the colons have to
8408 be doubled so as not to be taken as item separators when the default list
8409 separator is used. IPv6 addresses are recognized even when Exim is compiled
8410 without IPv6 support. This means that if they appear in a host list on an
8411 IPv4-only host, Exim will not treat them as host names. They are just addresses
8412 that can never match a client host.
8413
8414 .next
8415 .cindex "@[] in a host list"
8416 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8417 the local host. For example, if the local host is an IPv4 host with one
8418 interface address 10.45.23.56, these two ACL statements have the same effect:
8419 .code
8420 accept hosts = 127.0.0.1 : 10.45.23.56
8421 accept hosts = @[]
8422 .endd
8423 .next
8424 .cindex "CIDR notation"
8425 If the pattern is an IP address followed by a slash and a mask length (for
8426 example 10.11.42.0/24), it is matched against the IP address of the subject
8427 host under the given mask. This allows, an entire network of hosts to be
8428 included (or excluded) by a single item. The mask uses CIDR notation; it
8429 specifies the number of address bits that must match, starting from the most
8430 significant end of the address.
8431
8432 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8433 of a range of addresses. It is the number of bits in the network portion of the
8434 address. The above example specifies a 24-bit netmask, so it matches all 256
8435 addresses in the 10.11.42.0 network. An item such as
8436 .code
8437 192.168.23.236/31
8438 .endd
8439 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8440 32 for an IPv4 address is the same as no mask at all; just a single address
8441 matches.
8442
8443 Here is another example which shows an IPv4 and an IPv6 network:
8444 .code
8445 recipient_unqualified_hosts = 192.168.0.0/16: \
8446                               3ffe::ffff::836f::::/48
8447 .endd
8448 The doubling of list separator characters applies only when these items
8449 appear inline in a host list. It is not required when indirecting via a file.
8450 For example:
8451 .code
8452 recipient_unqualified_hosts = /opt/exim/unqualnets
8453 .endd
8454 could make use of a file containing
8455 .code
8456 172.16.0.0/12
8457 3ffe:ffff:836f::/48
8458 .endd
8459 to have exactly the same effect as the previous example. When listing IPv6
8460 addresses inline, it is usually more convenient to use the facility for
8461 changing separator characters. This list contains the same two networks:
8462 .code
8463 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8464                                  3ffe:ffff:836f::/48
8465 .endd
8466 The separator is changed to semicolon by the leading &"<;"& at the start of the
8467 list.
8468 .endlist
8469
8470
8471
8472 .section "Host list patterns for single-key lookups by host address" &&&
8473          "SECThoslispatsikey"
8474 .cindex "host list" "lookup of IP address"
8475 When a host is to be identified by a single-key lookup of its complete IP
8476 address, the pattern takes this form:
8477 .display
8478 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8479 .endd
8480 For example:
8481 .code
8482 hosts_lookup = net-cdb;/hosts-by-ip.db
8483 .endd
8484 The text form of the IP address of the subject host is used as the lookup key.
8485 IPv6 addresses are converted to an unabbreviated form, using lower case
8486 letters, with dots as separators because colon is the key terminator in
8487 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8488 quoting the keys, but this is a facility that was added later.] The data
8489 returned by the lookup is not used.
8490
8491 .cindex "IP address" "masking"
8492 .cindex "host list" "masked IP address"
8493 Single-key lookups can also be performed using masked IP addresses, using
8494 patterns of this form:
8495 .display
8496 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8497 .endd
8498 For example:
8499 .code
8500 net24-dbm;/networks.db
8501 .endd
8502 The IP address of the subject host is masked using <&'number'&> as the mask
8503 length. A textual string is constructed from the masked value, followed by the
8504 mask, and this is used as the lookup key. For example, if the host's IP address
8505 is 192.168.34.6, the key that is looked up for the above example is
8506 &"192.168.34.0/24"&.
8507
8508 When an IPv6 address is converted to a string, dots are normally used instead
8509 of colons, so that keys in &(lsearch)& files need not contain colons (which
8510 terminate &(lsearch)& keys). This was implemented some time before the ability
8511 to quote keys was made available in &(lsearch)& files. However, the more
8512 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8513 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8514 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8515 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8516 addresses are always used.
8517
8518 Ideally, it would be nice to tidy up this anomalous situation by changing to
8519 colons in all cases, given that quoting is now available for &(lsearch)&.
8520 However, this would be an incompatible change that might break some existing
8521 configurations.
8522
8523 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8524 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8525 the former case the key strings include the mask value, whereas in the latter
8526 case the IP address is used on its own.
8527
8528
8529
8530 .section "Host list patterns that match by host name" "SECThoslispatnam"
8531 .cindex "host" "lookup failures"
8532 .cindex "unknown host name"
8533 .cindex "host list" "matching host name"
8534 There are several types of pattern that require Exim to know the name of the
8535 remote host. These are either wildcard patterns or lookups by name. (If a
8536 complete hostname is given without any wildcarding, it is used to find an IP
8537 address to match against, as described in section &<<SECThoslispatip>>&
8538 above.)
8539
8540 If the remote host name is not already known when Exim encounters one of these
8541 patterns, it has to be found from the IP address.
8542 Although many sites on the Internet are conscientious about maintaining reverse
8543 DNS data for their hosts, there are also many that do not do this.
8544 Consequently, a name cannot always be found, and this may lead to unwanted
8545 effects. Take care when configuring host lists with wildcarded name patterns.
8546 Consider what will happen if a name cannot be found.
8547
8548 Because of the problems of determining host names from IP addresses, matching
8549 against host names is not as common as matching against IP addresses.
8550
8551 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8552 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8553 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8554 are done can be changed by setting the &%host_lookup_order%& option. For
8555 security, once Exim has found one or more names, it looks up the IP addresses
8556 for these names and compares them with the IP address that it started with.
8557 Only those names whose IP addresses match are accepted. Any other names are
8558 discarded. If no names are left, Exim behaves as if the host name cannot be
8559 found. In the most common case there is only one name and one IP address.
8560
8561 There are some options that control what happens if a host name cannot be
8562 found. These are described in section &<<SECTbehipnot>>& below.
8563
8564 .cindex "host" "alias for"
8565 .cindex "alias for host"
8566 As a result of aliasing, hosts may have more than one name. When processing any
8567 of the following types of pattern, all the host's names are checked:
8568
8569 .ilist
8570 .cindex "asterisk" "in host list"
8571 If a pattern starts with &"*"& the remainder of the item must match the end of
8572 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8573 &'.b.c'&. This special simple form is provided because this is a very common
8574 requirement. Other kinds of wildcarding require the use of a regular
8575 expression.
8576 .next
8577 .cindex "regular expressions" "in host list"
8578 .cindex "host list" "regular expression in"
8579 If the item starts with &"^"& it is taken to be a regular expression which is
8580 matched against the host name. Host names are case-independent, so this regular
8581 expression match is by default case-independent, but you can make it
8582 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8583 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8584 example,
8585 .code
8586 ^(a|b)\.c\.d$
8587 .endd
8588 is a regular expression that matches either of the two hosts &'a.c.d'& or
8589 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8590 that backslash and dollar characters are not misinterpreted as part of the
8591 string expansion. The simplest way to do this is to use &`\N`& to mark that
8592 part of the string as non-expandable. For example:
8593 .code
8594 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8595 .endd
8596 &*Warning*&: If you want to match a complete host name, you must include the
8597 &`$`& terminating metacharacter in the regular expression, as in the above
8598 example. Without it, a match at the start of the host name is all that is
8599 required.
8600 .endlist
8601
8602
8603
8604
8605 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8606 .cindex "host" "lookup failures, permanent"
8607 While processing a host list, Exim may need to look up an IP address from a
8608 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8609 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8610 behaviour when it fails to find the information it is seeking is the same.
8611
8612 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8613 apply to temporary DNS errors, whose handling is described in the next section.
8614
8615 .cindex "&`+include_unknown`&"
8616 .cindex "&`+ignore_unknown`&"
8617 Exim parses a host list from left to right. If it encounters a permanent
8618 lookup failure in any item in the host list before it has found a match,
8619 Exim treats it as a failure and the default behavior is as if the host
8620 does not match the list. This may not always be what you want to happen.
8621 To change Exim's behaviour, the special items &`+include_unknown`& or
8622 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8623 not recognized in an indirected file).
8624
8625 .ilist
8626 If any item that follows &`+include_unknown`& requires information that
8627 cannot found, Exim behaves as if the host does match the list. For example,
8628 .code
8629 host_reject_connection = +include_unknown:*.enemy.ex
8630 .endd
8631 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8632 any hosts whose name it cannot find.
8633
8634 .next
8635 If any item that follows &`+ignore_unknown`& requires information that cannot
8636 be found, Exim ignores that item and proceeds to the rest of the list. For
8637 example:
8638 .code
8639 accept hosts = +ignore_unknown : friend.example : \
8640                192.168.4.5
8641 .endd
8642 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8643 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8644 name can be found for 192.168.4.5, it is rejected.
8645 .endlist
8646
8647 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8648 list. The effect of each one lasts until the next, or until the end of the
8649 list.
8650
8651 .section "Mixing wildcarded host names and addresses in host lists" &&&
8652          "SECTmixwilhos"
8653 .cindex "host list" "mixing names and addresses in"
8654
8655 This section explains the host/ip processing logic with the same concepts
8656 as the previous section, but specifically addresses what happens when a
8657 wildcarded hostname is one of the items in the hostlist.
8658
8659 .ilist
8660 If you have name lookups or wildcarded host names and
8661 IP addresses in the same host list, you should normally put the IP
8662 addresses first. For example, in an ACL you could have:
8663 .code
8664 accept hosts = 10.9.8.7 : *.friend.example
8665 .endd
8666 The reason you normally would order it this way lies in the
8667 left-to-right way that Exim processes lists.  It can test IP addresses
8668 without doing any DNS lookups, but when it reaches an item that requires
8669 a host name, it fails if it cannot find a host name to compare with the
8670 pattern. If the above list is given in the opposite order, the
8671 &%accept%& statement fails for a host whose name cannot be found, even
8672 if its IP address is 10.9.8.7.
8673
8674 .next
8675 If you really do want to do the name check first, and still recognize the IP
8676 address, you can rewrite the ACL like this:
8677 .code
8678 accept hosts = *.friend.example
8679 accept hosts = 10.9.8.7
8680 .endd
8681 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8682 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8683 &`+ignore_unknown`&, which was discussed in depth in the first example in
8684 this section.
8685 .endlist
8686
8687
8688 .section "Temporary DNS errors when looking up host information" &&&
8689          "SECTtemdnserr"
8690 .cindex "host" "lookup failures, temporary"
8691 .cindex "&`+include_defer`&"
8692 .cindex "&`+ignore_defer`&"
8693 A temporary DNS lookup failure normally causes a defer action (except when
8694 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8695 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8696 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8697 section. These options should be used with care, probably only in non-critical
8698 host lists such as whitelists.
8699
8700
8701
8702 .section "Host list patterns for single-key lookups by host name" &&&
8703          "SECThoslispatnamsk"
8704 .cindex "unknown host name"
8705 .cindex "host list" "matching host name"
8706 If a pattern is of the form
8707 .display
8708 <&'single-key-search-type'&>;<&'search-data'&>
8709 .endd
8710 for example
8711 .code
8712 dbm;/host/accept/list
8713 .endd
8714 a single-key lookup is performed, using the host name as its key. If the
8715 lookup succeeds, the host matches the item. The actual data that is looked up
8716 is not used.
8717
8718 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8719 keys in the file, not IP addresses. If you want to do lookups based on IP
8720 addresses, you must precede the search type with &"net-"& (see section
8721 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8722 two items in the same list, one doing an address lookup and one doing a name
8723 lookup, both using the same file.
8724
8725
8726
8727 .section "Host list patterns for query-style lookups" "SECID81"
8728 If a pattern is of the form
8729 .display
8730 <&'query-style-search-type'&>;<&'query'&>
8731 .endd
8732 the query is obeyed, and if it succeeds, the host matches the item. The actual
8733 data that is looked up is not used. The variables &$sender_host_address$& and
8734 &$sender_host_name$& can be used in the query. For example:
8735 .code
8736 hosts_lookup = pgsql;\
8737   select ip from hostlist where ip='$sender_host_address'
8738 .endd
8739 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8740 can use the &%sg%& expansion item to change this if you need to. If you want to
8741 use masked IP addresses in database queries, you can use the &%mask%& expansion
8742 operator.
8743
8744 If the query contains a reference to &$sender_host_name$&, Exim automatically
8745 looks up the host name if it has not already done so. (See section
8746 &<<SECThoslispatnam>>& for comments on finding host names.)
8747
8748 Historical note: prior to release 4.30, Exim would always attempt to find a
8749 host name before running the query, unless the search type was preceded by
8750 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8751 still recognized for query-style lookups, but its presence or absence has no
8752 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8753 See section &<<SECThoslispatsikey>>&.)
8754
8755
8756
8757
8758
8759 .section "Address lists" "SECTaddresslist"
8760 .cindex "list" "address list"
8761 .cindex "address list" "empty item"
8762 .cindex "address list" "patterns"
8763 Address lists contain patterns that are matched against mail addresses. There
8764 is one special case to be considered: the sender address of a bounce message is
8765 always empty. You can test for this by providing an empty item in an address
8766 list. For example, you can set up a router to process bounce messages by
8767 using this option setting:
8768 .code
8769 senders = :
8770 .endd
8771 The presence of the colon creates an empty item. If you do not provide any
8772 data, the list is empty and matches nothing. The empty sender can also be
8773 detected by a regular expression that matches an empty string,
8774 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8775
8776 Non-empty items in an address list can be straightforward email addresses. For
8777 example:
8778 .code
8779 senders = jbc@askone.example : hs@anacreon.example
8780 .endd
8781 A certain amount of wildcarding is permitted. If a pattern contains an @
8782 character, but is not a regular expression and does not begin with a
8783 semicolon-terminated lookup type (described below), the local part of the
8784 subject address is compared with the local part of the pattern, which may start
8785 with an asterisk. If the local parts match, the domain is checked in exactly
8786 the same way as for a pattern in a domain list. For example, the domain can be
8787 wildcarded, refer to a named list, or be a lookup:
8788 .code
8789 deny senders = *@*.spamming.site:\
8790                *@+hostile_domains:\
8791                bozo@partial-lsearch;/list/of/dodgy/sites:\
8792                *@dbm;/bad/domains.db
8793 .endd
8794 .cindex "local part" "starting with !"
8795 .cindex "address list" "local part starting with !"
8796 If a local part that begins with an exclamation mark is required, it has to be
8797 specified using a regular expression, because otherwise the exclamation mark is
8798 treated as a sign of negation, as is standard in lists.
8799
8800 If a non-empty pattern that is not a regular expression or a lookup does not
8801 contain an @ character, it is matched against the domain part of the subject
8802 address. The only two formats that are recognized this way are a literal
8803 domain, or a domain pattern that starts with *. In both these cases, the effect
8804 is the same as if &`*@`& preceded the pattern. For example:
8805 .code
8806 deny senders = enemy.domain : *.enemy.domain
8807 .endd
8808
8809 The following kinds of more complicated address list pattern can match any
8810 address, including the empty address that is characteristic of bounce message
8811 senders:
8812
8813 .ilist
8814 .cindex "regular expressions" "in address list"
8815 .cindex "address list" "regular expression in"
8816 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8817 done against the complete address, with the pattern as the regular expression.
8818 You must take care that backslash and dollar characters are not misinterpreted
8819 as part of the string expansion. The simplest way to do this is to use &`\N`&
8820 to mark that part of the string as non-expandable. For example:
8821 .code
8822 deny senders = \N^.*this.*@example\.com$\N : \
8823                \N^\d{8}.+@spamhaus.example$\N : ...
8824 .endd
8825 The &`\N`& sequences are removed by the expansion, so these items do indeed
8826 start with &"^"& by the time they are being interpreted as address patterns.
8827
8828 .next
8829 .cindex "address list" "lookup for complete address"
8830 Complete addresses can be looked up by using a pattern that starts with a
8831 lookup type terminated by a semicolon, followed by the data for the lookup. For
8832 example:
8833 .code
8834 deny senders = cdb;/etc/blocked.senders : \
8835   mysql;select address from blocked where \
8836   address='${quote_mysql:$sender_address}'
8837 .endd
8838 Both query-style and single-key lookup types can be used. For a single-key
8839 lookup type, Exim uses the complete address as the key. However, empty keys are
8840 not supported for single-key lookups, so a match against the empty address
8841 always fails. This restriction does not apply to query-style lookups.
8842
8843 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8844 cannot be used, and is ignored if specified, with an entry being written to the
8845 panic log.
8846 .cindex "*@ with single-key lookup"
8847 However, you can configure lookup defaults, as described in section
8848 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8849 default. For example, with this lookup:
8850 .code
8851 accept senders = lsearch*@;/some/file
8852 .endd
8853 the file could contains lines like this:
8854 .code
8855 user1@domain1.example
8856 *@domain2.example
8857 .endd
8858 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8859 that are tried is:
8860 .code
8861 nimrod@jaeger.example
8862 *@jaeger.example
8863 *
8864 .endd
8865 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8866 would mean that every address matches, thus rendering the test useless.
8867
8868 &*Warning 2*&: Do not confuse these two kinds of item:
8869 .code
8870 deny recipients = dbm*@;/some/file
8871 deny recipients = *@dbm;/some/file
8872 .endd
8873 The first does a whole address lookup, with defaulting, as just described,
8874 because it starts with a lookup type. The second matches the local part and
8875 domain independently, as described in a bullet point below.
8876 .endlist
8877
8878
8879 The following kinds of address list pattern can match only non-empty addresses.
8880 If the subject address is empty, a match against any of these pattern types
8881 always fails.
8882
8883
8884 .ilist
8885 .cindex "@@ with single-key lookup"
8886 .cindex "address list" "@@ lookup type"
8887 .cindex "address list" "split local part and domain"
8888 If a pattern starts with &"@@"& followed by a single-key lookup item
8889 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8890 split into a local part and a domain. The domain is looked up in the file. If
8891 it is not found, there is no match. If it is found, the data that is looked up
8892 from the file is treated as a colon-separated list of local part patterns, each
8893 of which is matched against the subject local part in turn.
8894
8895 .cindex "asterisk" "in address list"
8896 The lookup may be a partial one, and/or one involving a search for a default
8897 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8898 patterns that are looked up can be regular expressions or begin with &"*"&, or
8899 even be further lookups. They may also be independently negated. For example,
8900 with
8901 .code
8902 deny senders = @@dbm;/etc/reject-by-domain
8903 .endd
8904 the data from which the DBM file is built could contain lines like
8905 .code
8906 baddomain.com:  !postmaster : *
8907 .endd
8908 to reject all senders except &%postmaster%& from that domain.
8909
8910 .cindex "local part" "starting with !"
8911 If a local part that actually begins with an exclamation mark is required, it
8912 has to be specified using a regular expression. In &(lsearch)& files, an entry
8913 may be split over several lines by indenting the second and subsequent lines,
8914 but the separating colon must still be included at line breaks. White space
8915 surrounding the colons is ignored. For example:
8916 .code
8917 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8918   spammer3 : spammer4
8919 .endd
8920 As in all colon-separated lists in Exim, a colon can be included in an item by
8921 doubling.
8922
8923 If the last item in the list starts with a right angle-bracket, the remainder
8924 of the item is taken as a new key to look up in order to obtain a continuation
8925 list of local parts. The new key can be any sequence of characters. Thus one
8926 might have entries like
8927 .code
8928 aol.com: spammer1 : spammer 2 : >*
8929 xyz.com: spammer3 : >*
8930 *:       ^\d{8}$
8931 .endd
8932 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8933 local parts for all domains, in addition to the specific local parts listed for
8934 each domain. Of course, using this feature costs another lookup each time a
8935 chain is followed, but the effort needed to maintain the data is reduced.
8936
8937 .cindex "loop" "in lookups"
8938 It is possible to construct loops using this facility, and in order to catch
8939 them, the chains may be no more than fifty items long.
8940
8941 .next
8942 The @@<&'lookup'&> style of item can also be used with a query-style
8943 lookup, but in this case, the chaining facility is not available. The lookup
8944 can only return a single list of local parts.
8945 .endlist
8946
8947 &*Warning*&: There is an important difference between the address list items
8948 in these two examples:
8949 .code
8950 senders = +my_list
8951 senders = *@+my_list
8952 .endd
8953 In the first one, &`my_list`& is a named address list, whereas in the second
8954 example it is a named domain list.
8955
8956
8957
8958
8959 .section "Case of letters in address lists" "SECTcasletadd"
8960 .cindex "case of local parts"
8961 .cindex "address list" "case forcing"
8962 .cindex "case forcing in address lists"
8963 Domains in email addresses are always handled caselessly, but for local parts
8964 case may be significant on some systems (see &%caseful_local_part%& for how
8965 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8966 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8967 blocking lists should be done in a case-independent manner. Since most address
8968 lists in Exim are used for this kind of control, Exim attempts to do this by
8969 default.
8970
8971 The domain portion of an address is always lowercased before matching it to an
8972 address list. The local part is lowercased by default, and any string
8973 comparisons that take place are done caselessly. This means that the data in
8974 the address list itself, in files included as plain file names, and in any file
8975 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8976 keys in files that are looked up by a search type other than &(lsearch)& (which
8977 works caselessly) must be in lower case, because these lookups are not
8978 case-independent.
8979
8980 .cindex "&`+caseful`&"
8981 To allow for the possibility of caseful address list matching, if an item in
8982 an address list is the string &"+caseful"&, the original case of the local
8983 part is restored for any comparisons that follow, and string comparisons are no
8984 longer case-independent. This does not affect the domain, which remains in
8985 lower case. However, although independent matches on the domain alone are still
8986 performed caselessly, regular expressions that match against an entire address
8987 become case-sensitive after &"+caseful"& has been seen.
8988
8989
8990
8991 .section "Local part lists" "SECTlocparlis"
8992 .cindex "list" "local part list"
8993 .cindex "local part" "list"
8994 Case-sensitivity in local part lists is handled in the same way as for address
8995 lists, as just described. The &"+caseful"& item can be used if required. In a
8996 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8997 set false, the subject is lowercased and the matching is initially
8998 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8999 matching in the local part list, but not elsewhere in the router. If
9000 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9001 option is case-sensitive from the start.
9002
9003 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9004 comments are handled in the same way as address lists &-- they are recognized
9005 only if the # is preceded by white space or the start of the line.
9006 Otherwise, local part lists are matched in the same way as domain lists, except
9007 that the special items that refer to the local host (&`@`&, &`@[]`&,
9008 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9009 Refer to section &<<SECTdomainlist>>& for details of the other available item
9010 types.
9011 .ecindex IIDdohoadli
9012
9013
9014
9015
9016 . ////////////////////////////////////////////////////////////////////////////
9017 . ////////////////////////////////////////////////////////////////////////////
9018
9019 .chapter "String expansions" "CHAPexpand"
9020 .scindex IIDstrexp "expansion" "of strings"
9021 Many strings in Exim's run time configuration are expanded before use. Some of
9022 them are expanded every time they are used; others are expanded only once.
9023
9024 When a string is being expanded it is copied verbatim from left to right except
9025 when a dollar or backslash character is encountered. A dollar specifies the
9026 start of a portion of the string that is interpreted and replaced as described
9027 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9028 escape character, as described in the following section.
9029
9030 Whether a string is expanded depends upon the context.  Usually this is solely
9031 dependent upon the option for which a value is sought; in this documentation,
9032 options for which string expansion is performed are marked with &dagger; after
9033 the data type.  ACL rules always expand strings.  A couple of expansion
9034 conditions do not expand some of the brace-delimited branches, for security
9035 reasons.
9036
9037
9038
9039 .section "Literal text in expanded strings" "SECTlittext"
9040 .cindex "expansion" "including literal text"
9041 An uninterpreted dollar can be included in an expanded string by putting a
9042 backslash in front of it. A backslash can be used to prevent any special
9043 character being treated specially in an expansion, including backslash itself.
9044 If the string appears in quotes in the configuration file, two backslashes are
9045 required because the quotes themselves cause interpretation of backslashes when
9046 the string is read in (see section &<<SECTstrings>>&).
9047
9048 .cindex "expansion" "non-expandable substrings"
9049 A portion of the string can specified as non-expandable by placing it between
9050 two occurrences of &`\N`&. This is particularly useful for protecting regular
9051 expressions, which often contain backslashes and dollar signs. For example:
9052 .code
9053 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9054 .endd
9055 On encountering the first &`\N`&, the expander copies subsequent characters
9056 without interpretation until it reaches the next &`\N`& or the end of the
9057 string.
9058
9059
9060
9061 .section "Character escape sequences in expanded strings" "SECID82"
9062 .cindex "expansion" "escape sequences"
9063 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9064 expanded string is recognized as an escape sequence for the character newline,
9065 carriage return, or tab, respectively. A backslash followed by up to three
9066 octal digits is recognized as an octal encoding for a single character, and a
9067 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9068 encoding.
9069
9070 These escape sequences are also recognized in quoted strings when they are read
9071 in. Their interpretation in expansions as well is useful for unquoted strings,
9072 and for other cases such as looked-up strings that are then expanded.
9073
9074
9075 .section "Testing string expansions" "SECID83"
9076 .cindex "expansion" "testing"
9077 .cindex "testing" "string expansion"
9078 .oindex "&%-be%&"
9079 Many expansions can be tested by calling Exim with the &%-be%& option. This
9080 takes the command arguments, or lines from the standard input if there are no
9081 arguments, runs them through the string expansion code, and writes the results
9082 to the standard output. Variables based on configuration values are set up, but
9083 since no message is being processed, variables such as &$local_part$& have no
9084 value. Nevertheless the &%-be%& option can be useful for checking out file and
9085 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9086 and &%nhash%&.
9087
9088 Exim gives up its root privilege when it is called with the &%-be%& option, and
9089 instead runs under the uid and gid it was called with, to prevent users from
9090 using &%-be%& for reading files to which they do not have access.
9091
9092 .oindex "&%-bem%&"
9093 If you want to test expansions that include variables whose values are taken
9094 from a message, there are two other options that can be used. The &%-bem%&
9095 option is like &%-be%& except that it is followed by a file name. The file is
9096 read as a message before doing the test expansions. For example:
9097 .code
9098 exim -bem /tmp/test.message '$h_subject:'
9099 .endd
9100 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9101 Exim message identifier. For example:
9102 .code
9103 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9104 .endd
9105 This loads the message from Exim's spool before doing the test expansions, and
9106 is therefore restricted to admin users.
9107
9108
9109 .section "Forced expansion failure" "SECTforexpfai"
9110 .cindex "expansion" "forced failure"
9111 A number of expansions that are described in the following section have
9112 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9113 (which are sometimes called &"curly brackets"&). Which of the two strings is
9114 used depends on some condition that is evaluated as part of the expansion. If,
9115 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9116 the entire string expansion fails in a way that can be detected by the code
9117 that requested the expansion. This is called &"forced expansion failure"&, and
9118 its consequences depend on the circumstances. In some cases it is no different
9119 from any other expansion failure, but in others a different action may be
9120 taken. Such variations are mentioned in the documentation of the option that is
9121 being expanded.
9122
9123
9124
9125
9126 .section "Expansion items" "SECTexpansionitems"
9127 The following items are recognized in expanded strings. White space may be used
9128 between sub-items that are keywords or substrings enclosed in braces inside an
9129 outer set of braces, to improve readability. &*Warning*&: Within braces,
9130 white space is significant.
9131
9132 .vlist
9133 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9134 .cindex "expansion" "variables"
9135 Substitute the contents of the named variable, for example:
9136 .code
9137 $local_part
9138 ${domain}
9139 .endd
9140 The second form can be used to separate the name from subsequent alphanumeric
9141 characters. This form (using braces) is available only for variables; it does
9142 &'not'& apply to message headers. The names of the variables are given in
9143 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9144 given, the expansion fails.
9145
9146 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9147 .cindex "expansion" "operators"
9148 The string is first itself expanded, and then the operation specified by
9149 <&'op'&> is applied to it. For example:
9150 .code
9151 ${lc:$local_part}
9152 .endd
9153 The string starts with the first character after the colon, which may be
9154 leading white space. A list of operators is given in section &<<SECTexpop>>&
9155 below. The operator notation is used for simple expansion items that have just
9156 one argument, because it reduces the number of braces and therefore makes the
9157 string easier to understand.
9158
9159 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9160 This item inserts &"basic"& header lines. It is described with the &%header%&
9161 expansion item below.
9162
9163
9164 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9165 .cindex "expansion" "calling an acl"
9166 .cindex "&%acl%&" "call from expansion"
9167 The name and zero to nine argument strings are first expanded separately.  The expanded
9168 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9169 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9170 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9171 and may use the variables; if another acl expansion is used the values
9172 are restored after it returns.  If the ACL sets
9173 a value using a "message =" modifier and returns accept or deny, the value becomes
9174 the result of the expansion.
9175 If no message is set and the ACL returns accept or deny
9176 the expansion result is an empty string.
9177 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9178
9179
9180 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9181 .cindex authentication "results header"
9182 .cindex headers "authentication-results:"
9183 .cindex authentication "expansion item"
9184 This item returns a string suitable for insertion as an
9185 &'Authentication-Results"'&
9186 header line.
9187 The given <&'authserv-id'&> is included in the result; typically this
9188 will be a domain name identifying the system performing the authentications.
9189 Methods that might be present in the result include:
9190 .code
9191 none
9192 iprev
9193 auth
9194 spf
9195 dkim
9196 .endd
9197
9198 Example use (as an ACL modifier):
9199 .code
9200       add_header = :at_start:${authresults {$primary_hostname}}
9201 .endd
9202 This is safe even if no authentication results are available.
9203
9204
9205 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9206        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9207 .cindex "expansion" "extracting certificate fields"
9208 .cindex "&%certextract%&" "certificate fields"
9209 .cindex "certificate" "extracting fields"
9210 The <&'certificate'&> must be a variable of type certificate.
9211 The field name is expanded and used to retrieve the relevant field from
9212 the certificate.  Supported fields are:
9213 .display
9214 &`version        `&
9215 &`serial_number  `&
9216 &`subject        `& RFC4514 DN
9217 &`issuer         `& RFC4514 DN
9218 &`notbefore      `& time
9219 &`notafter       `& time
9220 &`sig_algorithm  `&
9221 &`signature      `&
9222 &`subj_altname   `& tagged list
9223 &`ocsp_uri       `& list
9224 &`crl_uri        `& list
9225 .endd
9226 If the field is found,
9227 <&'string2'&> is expanded, and replaces the whole item;
9228 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9229 variable &$value$& contains the value that has been extracted. Afterwards, it
9230 is restored to any previous value it might have had.
9231
9232 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9233 key is not found. If {<&'string2'&>} is also omitted, the value that was
9234 extracted is used.
9235
9236 Some field names take optional modifiers, appended and separated by commas.
9237
9238 The field selectors marked as "RFC4514" above
9239 output a Distinguished Name string which is
9240 not quite
9241 parseable by Exim as a comma-separated tagged list
9242 (the exceptions being elements containing commas).
9243 RDN elements of a single type may be selected by
9244 a modifier of the type label; if so the expansion
9245 result is a list (newline-separated by default).
9246 The separator may be changed by another modifier of
9247 a right angle-bracket followed immediately by the new separator.
9248 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9249
9250 The field selectors marked as "time" above
9251 take an optional modifier of "int"
9252 for which the result is the number of seconds since epoch.
9253 Otherwise the result is a human-readable string
9254 in the timezone selected by the main "timezone" option.
9255
9256 The field selectors marked as "list" above return a list,
9257 newline-separated by default,
9258 (embedded separator characters in elements are doubled).
9259 The separator may be changed by a modifier of
9260 a right angle-bracket followed immediately by the new separator.
9261
9262 The field selectors marked as "tagged" above
9263 prefix each list element with a type string and an equals sign.
9264 Elements of only one type may be selected by a modifier
9265 which is one of "dns", "uri" or "mail";
9266 if so the element tags are omitted.
9267
9268 If not otherwise noted field values are presented in human-readable form.
9269
9270 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9271        {*&<&'arg'&>&*}...}*&"
9272 .cindex &%dlfunc%&
9273 This expansion dynamically loads and then calls a locally-written C function.
9274 This functionality is available only if Exim is compiled with
9275 .code
9276 EXPAND_DLFUNC=yes
9277 .endd
9278 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9279 object so that it doesn't reload the same object file in the same Exim process
9280 (but of course Exim does start new processes frequently).
9281
9282 There may be from zero to eight arguments to the function. When compiling
9283 a local function that is to be called in this way, &_local_scan.h_& should be
9284 included. The Exim variables and functions that are defined by that API
9285 are also available for dynamically loaded functions. The function itself
9286 must have the following type:
9287 .code
9288 int dlfunction(uschar **yield, int argc, uschar *argv[])
9289 .endd
9290 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9291 function should return one of the following values:
9292
9293 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9294 into the expanded string that is being built.
9295
9296 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9297 from &'yield'&, if it is set.
9298
9299 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9300 taken from &'yield'& if it is set.
9301
9302 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9303
9304 When compiling a function that is to be used in this way with gcc,
9305 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9306 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9307
9308
9309 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9310 .cindex "expansion" "extracting value from environment"
9311 .cindex "environment" "values from"
9312 The key is first expanded separately, and leading and trailing white space
9313 removed.
9314 This is then searched for as a name in the environment.
9315 If a variable is found then its value is placed in &$value$&
9316 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9317
9318 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9319 appear, for example:
9320 .code
9321 ${env{USER}{$value} fail }
9322 .endd
9323 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9324 {<&'string1'&>} must be present for &"fail"& to be recognized.
9325
9326 If {<&'string2'&>} is omitted an empty string is substituted on
9327 search failure.
9328 If {<&'string1'&>} is omitted the search result is substituted on
9329 search success.
9330
9331 The environment is adjusted by the &%keep_environment%& and
9332 &%add_environment%& main section options.
9333
9334
9335 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9336        {*&<&'string3'&>&*}}*&"
9337 .cindex "expansion" "extracting substrings by key"
9338 .cindex "&%extract%&" "substrings by key"
9339 The key and <&'string1'&> are first expanded separately. Leading and trailing
9340 white space is removed from the key (but not from any of the strings). The key
9341 must not be empty and must not consist entirely of digits.
9342 The expanded <&'string1'&> must be of the form:
9343 .display
9344 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9345 .endd
9346 .vindex "&$value$&"
9347 where the equals signs and spaces (but not both) are optional. If any of the
9348 values contain white space, they must be enclosed in double quotes, and any
9349 values that are enclosed in double quotes are subject to escape processing as
9350 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9351 for the value that corresponds to the key. The search is case-insensitive. If
9352 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9353 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9354 variable &$value$& contains the value that has been extracted. Afterwards, it
9355 is restored to any previous value it might have had.
9356
9357 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9358 key is not found. If {<&'string2'&>} is also omitted, the value that was
9359 extracted is used. Thus, for example, these two expansions are identical, and
9360 yield &"2001"&:
9361 .code
9362 ${extract{gid}{uid=1984 gid=2001}}
9363 ${extract{gid}{uid=1984 gid=2001}{$value}}
9364 .endd
9365 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9366 appear, for example:
9367 .code
9368 ${extract{Z}{A=... B=...}{$value} fail }
9369 .endd
9370 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9371 {<&'string2'&>} must be present for &"fail"& to be recognized.
9372
9373
9374 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9375         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9376 .cindex "expansion" "extracting substrings by number"
9377 .cindex "&%extract%&" "substrings by number"
9378 The <&'number'&> argument must consist entirely of decimal digits,
9379 apart from leading and trailing white space, which is ignored.
9380 This is what distinguishes this form of &%extract%& from the previous kind. It
9381 behaves in the same way, except that, instead of extracting a named field, it
9382 extracts from <&'string1'&> the field whose number is given as the first
9383 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9384 <&'string3'&> as before.
9385
9386 The fields in the string are separated by any one of the characters in the
9387 separator string. These may include space or tab characters.
9388 The first field is numbered one. If the number is negative, the fields are
9389 counted from the end of the string, with the rightmost one numbered -1. If the
9390 number given is zero, the entire string is returned. If the modulus of the
9391 number is greater than the number of fields in the string, the result is the
9392 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9393 provided. For example:
9394 .code
9395 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9396 .endd
9397 yields &"42"&, and
9398 .code
9399 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9400 .endd
9401 yields &"99"&. Two successive separators mean that the field between them is
9402 empty (for example, the fifth field above).
9403
9404
9405 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9406 .cindex "list" "selecting by condition"
9407 .cindex "expansion" "selecting from list by condition"
9408 .vindex "&$item$&"
9409 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9410 default, but the separator can be changed in the usual way. For each item
9411 in this list, its value is place in &$item$&, and then the condition is
9412 evaluated. If the condition is true, &$item$& is added to the output as an
9413 item in a new list; if the condition is false, the item is discarded. The
9414 separator used for the output list is the same as the one used for the
9415 input, but a separator setting is not included in the output. For example:
9416 .code
9417 ${filter{a:b:c}{!eq{$item}{b}}}
9418 .endd
9419 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9420 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9421
9422
9423 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9424 .cindex "hash function" "textual"
9425 .cindex "expansion" "textual hash"
9426 This is a textual hashing function, and was the first to be implemented in
9427 early versions of Exim. In current releases, there are other hashing functions
9428 (numeric, MD5, and SHA-1), which are described below.
9429
9430 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9431 <&'n'&>. If you are using fixed values for these numbers, that is, if
9432 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9433 use the simpler operator notation that avoids some of the braces:
9434 .code
9435 ${hash_<n>_<m>:<string>}
9436 .endd
9437 The second number is optional (in both notations). If <&'n'&> is greater than
9438 or equal to the length of the string, the expansion item returns the string.
9439 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9440 function to the string. The new string consists of characters taken from the
9441 first <&'m'&> characters of the string
9442 .code
9443 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9444 .endd
9445 If <&'m'&> is not present the value 26 is used, so that only lower case
9446 letters appear. For example:
9447 .display
9448 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9449 &`$hash{5}{monty}}           `&   yields  &`monty`&
9450 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9451 .endd
9452
9453 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9454         &*$h_*&<&'header&~name'&>&*:*&" &&&
9455        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9456         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9457        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9458         &*$lh_*&<&'header&~name'&>&*:*&"
9459        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9460         &*$rh_*&<&'header&~name'&>&*:*&"
9461 .cindex "expansion" "header insertion"
9462 .vindex "&$header_$&"
9463 .vindex "&$bheader_$&"
9464 .vindex "&$lheader_$&"
9465 .vindex "&$rheader_$&"
9466 .cindex "header lines" "in expansion strings"
9467 .cindex "header lines" "character sets"
9468 .cindex "header lines" "decoding"
9469 Substitute the contents of the named message header line, for example
9470 .code
9471 $header_reply-to:
9472 .endd
9473 The newline that terminates a header line is not included in the expansion, but
9474 internal newlines (caused by splitting the header line over several physical
9475 lines) may be present.
9476
9477 The difference between the four pairs of expansions is in the way
9478 the data in the header line is interpreted.
9479
9480 .ilist
9481 .cindex "white space" "in header lines"
9482 &%rheader%& gives the original &"raw"& content of the header line, with no
9483 processing at all, and without the removal of leading and trailing white space.
9484
9485 .next
9486 .cindex "list" "of header lines"
9487 &%lheader%& gives a colon-separated list, one element per header when there
9488 are multiple headers with a given name.
9489 Any embedded colon characters within an element are doubled, so normal Exim
9490 list-processing facilities can be used.
9491 The terminating newline of each element is removed; in other respects
9492 the content is &"raw"&.
9493
9494 .next
9495 .cindex "base64 encoding" "in header lines"
9496 &%bheader%& removes leading and trailing white space, and then decodes base64
9497 or quoted-printable MIME &"words"& within the header text, but does no
9498 character set translation. If decoding of what looks superficially like a MIME
9499 &"word"& fails, the raw string is returned. If decoding
9500 .cindex "binary zero" "in header line"
9501 produces a binary zero character, it is replaced by a question mark &-- this is
9502 what Exim does for binary zeros that are actually received in header lines.
9503
9504 .next
9505 &%header%& tries to translate the string as decoded by &%bheader%& to a
9506 standard character set. This is an attempt to produce the same string as would
9507 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9508 returned. Translation is attempted only on operating systems that support the
9509 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9510 a system Makefile or in &_Local/Makefile_&.
9511 .endlist ilist
9512
9513 In a filter file, the target character set for &%header%& can be specified by a
9514 command of the following form:
9515 .code
9516 headers charset "UTF-8"
9517 .endd
9518 This command affects all references to &$h_$& (or &$header_$&) expansions in
9519 subsequently obeyed filter commands. In the absence of this command, the target
9520 character set in a filter is taken from the setting of the &%headers_charset%&
9521 option in the runtime configuration. The value of this option defaults to the
9522 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9523 ISO-8859-1.
9524
9525 Header names follow the syntax of RFC 2822, which states that they may contain
9526 any printing characters except space and colon. Consequently, curly brackets
9527 &'do not'& terminate header names, and should not be used to enclose them as
9528 if they were variables. Attempting to do so causes a syntax error.
9529
9530 Only header lines that are common to all copies of a message are visible to
9531 this mechanism. These are the original header lines that are received with the
9532 message, and any that are added by an ACL statement or by a system
9533 filter. Header lines that are added to a particular copy of a message by a
9534 router or transport are not accessible.
9535
9536 For incoming SMTP messages, no header lines are visible in
9537 ACLs that are obeyed before the data phase completes,
9538 because the header structure is not set up until the message is received.
9539 They are visible in DKIM, PRDR and DATA ACLs.
9540 Header lines that are added in a RCPT ACL (for example)
9541 are saved until the message's incoming header lines are available, at which
9542 point they are added.
9543 When any of the above ACLs ar
9544 running, however, header lines added by earlier ACLs are visible.
9545
9546 Upper case and lower case letters are synonymous in header names. If the
9547 following character is white space, the terminating colon may be omitted, but
9548 this is not recommended, because you may then forget it when it is needed. When
9549 white space terminates the header name, this white space is included in the
9550 expanded string.  If the message does not contain the given header, the
9551 expansion item is replaced by an empty string. (See the &%def%& condition in
9552 section &<<SECTexpcond>>& for a means of testing for the existence of a
9553 header.)
9554
9555 If there is more than one header with the same name, they are all concatenated
9556 to form the substitution string, up to a maximum length of 64K. Unless
9557 &%rheader%& is being used, leading and trailing white space is removed from
9558 each header before concatenation, and a completely empty header is ignored. A
9559 newline character is then inserted between non-empty headers, but there is no
9560 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9561 those headers that contain lists of addresses, a comma is also inserted at the
9562 junctions between headers. This does not happen for the &%rheader%& expansion.
9563
9564
9565 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9566 .cindex "expansion" "hmac hashing"
9567 .cindex &%hmac%&
9568 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9569 shared secret and some text into a message authentication code, as specified in
9570 RFC 2104. This differs from &`${md5:secret_text...}`& or
9571 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9572 cryptographic hash, allowing for authentication that is not possible with MD5
9573 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9574 present. For example:
9575 .code
9576 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9577 .endd
9578 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9579 produces:
9580 .code
9581 dd97e3ba5d1a61b5006108f8c8252953
9582 .endd
9583 As an example of how this might be used, you might put in the main part of
9584 an Exim configuration:
9585 .code
9586 SPAMSCAN_SECRET=cohgheeLei2thahw
9587 .endd
9588 In a router or a transport you could then have:
9589 .code
9590 headers_add = \
9591   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9592   ${hmac{md5}{SPAMSCAN_SECRET}\
9593   {${primary_hostname},${message_exim_id},$h_message-id:}}
9594 .endd
9595 Then given a message, you can check where it was scanned by looking at the
9596 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9597 this header line is authentic by recomputing the authentication code from the
9598 host name, message ID and the &'Message-id:'& header line. This can be done
9599 using Exim's &%-be%& option, or by other means, for example by using the
9600 &'hmac_md5_hex()'& function in Perl.
9601
9602
9603 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9604 .cindex "expansion" "conditional"
9605 .cindex "&%if%&, expansion item"
9606 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9607 item; otherwise <&'string2'&> is used. The available conditions are described
9608 in section &<<SECTexpcond>>& below. For example:
9609 .code
9610 ${if eq {$local_part}{postmaster} {yes}{no} }
9611 .endd
9612 The second string need not be present; if it is not and the condition is not
9613 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9614 be present instead of the second string (without any curly brackets). In this
9615 case, the expansion is forced to fail if the condition is not true (see section
9616 &<<SECTforexpfai>>&).
9617
9618 If both strings are omitted, the result is the string &`true`& if the condition
9619 is true, and the empty string if the condition is false. This makes it less
9620 cumbersome to write custom ACL and router conditions. For example, instead of
9621 .code
9622 condition = ${if >{$acl_m4}{3}{true}{false}}
9623 .endd
9624 you can use
9625 .code
9626 condition = ${if >{$acl_m4}{3}}
9627 .endd
9628
9629
9630
9631 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9632 .cindex expansion "imap folder"
9633 .cindex "&%imapfolder%& expansion item"
9634 This item converts a (possibly multilevel, or with non-ASCII characters)
9635 folder specification to a Maildir name for filesystem use.
9636 For information on internationalisation support see &<<SECTi18nMDA>>&.
9637
9638
9639
9640 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9641 .cindex "expansion" "string truncation"
9642 .cindex "&%length%& expansion item"
9643 The &%length%& item is used to extract the initial portion of a string. Both
9644 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9645 you are using a fixed value for the number, that is, if <&'string1'&> does not
9646 change when expanded, you can use the simpler operator notation that avoids
9647 some of the braces:
9648 .code
9649 ${length_<n>:<string>}
9650 .endd
9651 The result of this item is either the first <&'n'&> bytes or the whole
9652 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9653 &%strlen%&, which gives the length of a string.
9654 All measurement is done in bytes and is not UTF-8 aware.
9655
9656
9657 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9658         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9659 .cindex "expansion" "extracting list elements by number"
9660 .cindex "&%listextract%&" "extract list elements by number"
9661 .cindex "list" "extracting elements by number"
9662 The <&'number'&> argument must consist entirely of decimal digits,
9663 apart from an optional leading minus,
9664 and leading and trailing white space (which is ignored).
9665
9666 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9667 default, but the separator can be changed in the usual way.
9668
9669 The first field of the list is numbered one.
9670 If the number is negative, the fields are
9671 counted from the end of the list, with the rightmost one numbered -1.
9672 The numbered element of the list is extracted and placed in &$value$&,
9673 then <&'string2'&> is expanded as the result.
9674
9675 If the modulus of the
9676 number is zero or greater than the number of fields in the string,
9677 the result is the expansion of <&'string3'&>.
9678
9679 For example:
9680 .code
9681 ${listextract{2}{x:42:99}}
9682 .endd
9683 yields &"42"&, and
9684 .code
9685 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9686 .endd
9687 yields &"result: 42"&.
9688
9689 If {<&'string3'&>} is omitted, an empty string is used for string3.
9690 If {<&'string2'&>} is also omitted, the value that was
9691 extracted is used.
9692 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9693
9694
9695 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9696         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9697 This is the first of one of two different types of lookup item, which are both
9698 described in the next item.
9699
9700 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9701         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9702 .cindex "expansion" "lookup in"
9703 .cindex "file" "lookups"
9704 .cindex "lookup" "in expanded string"
9705 The two forms of lookup item specify data lookups in files and databases, as
9706 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9707 lookups, and the second is used for query-style lookups. The <&'key'&>,
9708 <&'file'&>, and <&'query'&> strings are expanded before use.
9709
9710 If there is any white space in a lookup item which is part of a filter command,
9711 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9712 other place where white space is significant, the lookup item must be enclosed
9713 in double quotes. The use of data lookups in users' filter files may be locked
9714 out by the system administrator.
9715
9716 .vindex "&$value$&"
9717 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9718 During its expansion, the variable &$value$& contains the data returned by the
9719 lookup. Afterwards it reverts to the value it had previously (at the outer
9720 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9721 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9722 string on failure. If <&'string2'&> is provided, it can itself be a nested
9723 lookup, thus providing a mechanism for looking up a default value when the
9724 original lookup fails.
9725
9726 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9727 data for the outer lookup while the parameters of the second lookup are
9728 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9729 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9730 appear, and in this case, if the lookup fails, the entire expansion is forced
9731 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9732 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9733 successful lookup, and nothing in the case of failure.
9734
9735 For single-key lookups, the string &"partial"& is permitted to precede the
9736 search type in order to do partial matching, and * or *@ may follow a search
9737 type to request default lookups if the key does not match (see sections
9738 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9739
9740 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9741 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9742 and non-wild parts of the key during the expansion of the replacement text.
9743 They return to their previous values at the end of the lookup item.
9744
9745 This example looks up the postmaster alias in the conventional alias file:
9746 .code
9747 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9748 .endd
9749 This example uses NIS+ to look up the full name of the user corresponding to
9750 the local part of an address, forcing the expansion to fail if it is not found:
9751 .code
9752 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9753   {$value}fail}
9754 .endd
9755
9756
9757 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9758 .cindex "expansion" "list creation"
9759 .vindex "&$item$&"
9760 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9761 default, but the separator can be changed in the usual way. For each item
9762 in this list, its value is place in &$item$&, and then <&'string2'&> is
9763 expanded and added to the output as an item in a new list. The separator used
9764 for the output list is the same as the one used for the input, but a separator
9765 setting is not included in the output. For example:
9766 .code
9767 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9768 .endd
9769 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9770 value of &$item$& is restored to what it was before. See also the &*filter*&
9771 and &*reduce*& expansion items.
9772
9773 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9774 .cindex "expansion" "numeric hash"
9775 .cindex "hash function" "numeric"
9776 The three strings are expanded; the first two must yield numbers. Call them
9777 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9778 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9779 can use the simpler operator notation that avoids some of the braces:
9780 .code
9781 ${nhash_<n>_<m>:<string>}
9782 .endd
9783 The second number is optional (in both notations). If there is only one number,
9784 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9785 processed by a div/mod hash function that returns two numbers, separated by a
9786 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9787 example,
9788 .code
9789 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9790 .endd
9791 returns the string &"6/33"&.
9792
9793
9794
9795 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9796 .cindex "Perl" "use in expanded string"
9797 .cindex "expansion" "calling Perl from"
9798 This item is available only if Exim has been built to include an embedded Perl
9799 interpreter. The subroutine name and the arguments are first separately
9800 expanded, and then the Perl subroutine is called with those arguments. No
9801 additional arguments need be given; the maximum number permitted, including the
9802 name of the subroutine, is nine.
9803
9804 The return value of the subroutine is inserted into the expanded string, unless
9805 the return value is &%undef%&. In that case, the expansion fails in the same
9806 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9807 Whatever you return is evaluated in a scalar context. For example, if you
9808 return the name of a Perl vector, the return value is the size of the vector,
9809 not its contents.
9810
9811 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9812 with the error message that was passed to &%die%&. More details of the embedded
9813 Perl facility are given in chapter &<<CHAPperl>>&.
9814
9815 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9816 out the use of this expansion item in filter files.
9817
9818
9819 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9820 .cindex "&%prvs%& expansion item"
9821 The first argument is a complete email address and the second is secret
9822 keystring. The third argument, specifying a key number, is optional. If absent,
9823 it defaults to 0. The result of the expansion is a prvs-signed email address,
9824 to be typically used with the &%return_path%& option on an &(smtp)& transport
9825 as part of a bounce address tag validation (BATV) scheme. For more discussion
9826 and an example, see section &<<SECTverifyPRVS>>&.
9827
9828 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9829         {*&<&'string'&>&*}}*&"
9830 .cindex "&%prvscheck%& expansion item"
9831 This expansion item is the complement of the &%prvs%& item. It is used for
9832 checking prvs-signed addresses. If the expansion of the first argument does not
9833 yield a syntactically valid prvs-signed address, the whole item expands to the
9834 empty string. When the first argument does expand to a syntactically valid
9835 prvs-signed address, the second argument is expanded, with the prvs-decoded
9836 version of the address and the key number extracted from the address in the
9837 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9838
9839 These two variables can be used in the expansion of the second argument to
9840 retrieve the secret. The validity of the prvs-signed address is then checked
9841 against the secret. The result is stored in the variable &$prvscheck_result$&,
9842 which is empty for failure or &"1"& for success.
9843
9844 The third argument is optional; if it is missing, it defaults to an empty
9845 string. This argument is now expanded. If the result is an empty string, the
9846 result of the expansion is the decoded version of the address. This is the case
9847 whether or not the signature was valid. Otherwise, the result of the expansion
9848 is the expansion of the third argument.
9849
9850 All three variables can be used in the expansion of the third argument.
9851 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9852 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9853
9854 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9855 .cindex "expansion" "inserting an entire file"
9856 .cindex "file" "inserting into expansion"
9857 .cindex "&%readfile%& expansion item"
9858 The file name and end-of-line string are first expanded separately. The file is
9859 then read, and its contents replace the entire item. All newline characters in
9860 the file are replaced by the end-of-line string if it is present. Otherwise,
9861 newlines are left in the string.
9862 String expansion is not applied to the contents of the file. If you want this,
9863 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9864 the string expansion fails.
9865
9866 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9867 locks out the use of this expansion item in filter files.
9868
9869
9870
9871 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9872         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9873 .cindex "expansion" "inserting from a socket"
9874 .cindex "socket, use of in expansion"
9875 .cindex "&%readsocket%& expansion item"
9876 This item inserts data from a Unix domain or TCP socket into the expanded
9877 string. The minimal way of using it uses just two arguments, as in these
9878 examples:
9879 .code
9880 ${readsocket{/socket/name}{request string}}
9881 ${readsocket{inet:some.host:1234}{request string}}
9882 .endd
9883 For a Unix domain socket, the first substring must be the path to the socket.
9884 For an Internet socket, the first substring must contain &`inet:`& followed by
9885 a host name or IP address, followed by a colon and a port, which can be a
9886 number or the name of a TCP port in &_/etc/services_&. An IP address may
9887 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9888 example:
9889 .code
9890 ${readsocket{inet:[::1]:1234}{request string}}
9891 .endd
9892 Only a single host name may be given, but if looking it up yields more than
9893 one IP address, they are each tried in turn until a connection is made. For
9894 both kinds of socket, Exim makes a connection, writes the request string
9895 unless it is an empty string; and no terminating NUL is ever sent)
9896 and reads from the socket until an end-of-file
9897 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9898 extend what can be done. Firstly, you can vary the timeout. For example:
9899 .code
9900 ${readsocket{/socket/name}{request string}{3s}}
9901 .endd
9902
9903 The third argument is a list of options, of which the first element is the timeout
9904 and must be present if the argument is given.
9905 Further elements are options of form &'name=value'&.
9906 Two option types is currently recognised: shutdown and tls.
9907 The first defines whether (the default)
9908 or not a shutdown is done on the connection after sending the request.
9909 Example, to not do so (preferred, eg. by some webservers):
9910 .code
9911 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
9912 .endd
9913 .new
9914 The second, tls, controls the use of TLS on the connection.  Example:
9915 .code
9916 ${readsocket{/socket/name}{request string}{3s:tls=yes}}
9917 .endd
9918 The default is to not use TLS.
9919 If it is enabled, a shutdown as descripbed above is never done.
9920 .wen
9921
9922 A fourth argument allows you to change any newlines that are in the data
9923 that is read, in the same way as for &%readfile%& (see above). This example
9924 turns them into spaces:
9925 .code
9926 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9927 .endd
9928 As with all expansions, the substrings are expanded before the processing
9929 happens. Errors in these sub-expansions cause the expansion to fail. In
9930 addition, the following errors can occur:
9931
9932 .ilist
9933 Failure to create a socket file descriptor;
9934 .next
9935 Failure to connect the socket;
9936 .next
9937 Failure to write the request string;
9938 .next
9939 Timeout on reading from the socket.
9940 .endlist
9941
9942 By default, any of these errors causes the expansion to fail. However, if
9943 you supply a fifth substring, it is expanded and used when any of the above
9944 errors occurs. For example:
9945 .code
9946 ${readsocket{/socket/name}{request string}{3s}{\n}\
9947   {socket failure}}
9948 .endd
9949 You can test for the existence of a Unix domain socket by wrapping this
9950 expansion in &`${if exists`&, but there is a race condition between that test
9951 and the actual opening of the socket, so it is safer to use the fifth argument
9952 if you want to be absolutely sure of avoiding an expansion error for a
9953 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9954
9955 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9956 locks out the use of this expansion item in filter files.
9957
9958
9959 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9960 .cindex "expansion" "reducing a list to a scalar"
9961 .cindex "list" "reducing to a scalar"
9962 .vindex "&$value$&"
9963 .vindex "&$item$&"
9964 This operation reduces a list to a single, scalar string. After expansion,
9965 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9966 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9967 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9968 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9969 them. The result of that expansion is assigned to &$value$& before the next
9970 iteration. When the end of the list is reached, the final value of &$value$& is
9971 added to the expansion output. The &*reduce*& expansion item can be used in a
9972 number of ways. For example, to add up a list of numbers:
9973 .code
9974 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9975 .endd
9976 The result of that expansion would be &`6`&. The maximum of a list of numbers
9977 can be found:
9978 .code
9979 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9980 .endd
9981 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9982 restored to what they were before. See also the &*filter*& and &*map*&
9983 expansion items.
9984
9985 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9986 This item inserts &"raw"& header lines. It is described with the &%header%&
9987 expansion item above.
9988
9989 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9990         {*&<&'string2'&>&*}}*&"
9991 .cindex "expansion" "running a command"
9992 .cindex "&%run%& expansion item"
9993 The command and its arguments are first expanded as one string. The string is
9994 split apart into individual arguments by spaces, and then the command is run
9995 in a separate process, but under the same uid and gid.  As in other command
9996 executions from Exim, a shell is not used by default. If the command requires
9997 a shell, you must explicitly code it.
9998
9999 Since the arguments are split by spaces, when there is a variable expansion
10000 which has an empty result, it will cause the situation that the argument will
10001 simply be omitted when the program is actually executed by Exim. If the
10002 script/program requires a specific number of arguments and the expanded
10003 variable could possibly result in this empty expansion, the variable must be
10004 quoted. This is more difficult if the expanded variable itself could result
10005 in a string containing quotes, because it would interfere with the quotes
10006 around the command arguments. A possible guard against this is to wrap the
10007 variable in the &%sg%& operator to change any quote marks to some other
10008 character.
10009
10010 The standard input for the command exists, but is empty. The standard output
10011 and standard error are set to the same file descriptor.
10012 .cindex "return code" "from &%run%& expansion"
10013 .vindex "&$value$&"
10014 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10015 and replaces the entire item; during this expansion, the standard output/error
10016 from the command is in the variable &$value$&. If the command fails,
10017 <&'string2'&>, if present, is expanded and used. Once again, during the
10018 expansion, the standard output/error from the command is in the variable
10019 &$value$&.
10020
10021 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10022 can be the word &"fail"& (not in braces) to force expansion failure if the
10023 command does not succeed. If both strings are omitted, the result is contents
10024 of the standard output/error on success, and nothing on failure.
10025
10026 .vindex "&$run_in_acl$&"
10027 The standard output/error of the command is put in the variable &$value$&.
10028 In this ACL example, the output of a command is logged for the admin to
10029 troubleshoot:
10030 .code
10031 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10032       log_message  = Output of id: $value
10033 .endd
10034 If the command requires shell idioms, such as the > redirect operator, the
10035 shell must be invoked directly, such as with:
10036 .code
10037 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10038 .endd
10039
10040 .vindex "&$runrc$&"
10041 The return code from the command is put in the variable &$runrc$&, and this
10042 remains set afterwards, so in a filter file you can do things like this:
10043 .code
10044 if "${run{x y z}{}}$runrc" is 1 then ...
10045   elif $runrc is 2 then ...
10046   ...
10047 endif
10048 .endd
10049 If execution of the command fails (for example, the command does not exist),
10050 the return code is 127 &-- the same code that shells use for non-existent
10051 commands.
10052
10053 &*Warning*&: In a router or transport, you cannot assume the order in which
10054 option values are expanded, except for those preconditions whose order of
10055 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10056 by the expansion of one option, and use it in another.
10057
10058 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10059 out the use of this expansion item in filter files.
10060
10061
10062 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10063 .cindex "expansion" "string substitution"
10064 .cindex "&%sg%& expansion item"
10065 This item works like Perl's substitution operator (s) with the global (/g)
10066 option; hence its name. However, unlike the Perl equivalent, Exim does not
10067 modify the subject string; instead it returns the modified string for insertion
10068 into the overall expansion. The item takes three arguments: the subject string,
10069 a regular expression, and a substitution string. For example:
10070 .code
10071 ${sg{abcdefabcdef}{abc}{xyz}}
10072 .endd
10073 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10074 if any $, } or \ characters are required in the regular expression or in the
10075 substitution string, they have to be escaped. For example:
10076 .code
10077 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10078 .endd
10079 yields &"defabc"&, and
10080 .code
10081 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10082 .endd
10083 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10084 the regular expression from string expansion.
10085
10086 The regular expression is compiled in 8-bit mode, working against bytes
10087 rather than any Unicode-aware character handling.
10088
10089
10090 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10091 .cindex sorting "a list"
10092 .cindex list sorting
10093 .cindex expansion "list sorting"
10094 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10095 default, but the separator can be changed in the usual way.
10096 The <&'comparator'&> argument is interpreted as the operator
10097 of a two-argument expansion condition.
10098 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10099 The comparison should return true when applied to two values
10100 if the first value should sort before the second value.
10101 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10102 the element being placed in &$item$&,
10103 to give values for comparison.
10104
10105 The item result is a sorted list,
10106 with the original list separator,
10107 of the list elements (in full) of the original.
10108
10109 Examples:
10110 .code
10111 ${sort{3:2:1:4}{<}{$item}}
10112 .endd
10113 sorts a list of numbers, and
10114 .code
10115 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10116 .endd
10117 will sort an MX lookup into priority order.
10118
10119
10120 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10121 .cindex "&%substr%& expansion item"
10122 .cindex "substring extraction"
10123 .cindex "expansion" "substring extraction"
10124 The three strings are expanded; the first two must yield numbers. Call them
10125 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10126 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10127 can use the simpler operator notation that avoids some of the braces:
10128 .code
10129 ${substr_<n>_<m>:<string>}
10130 .endd
10131 The second number is optional (in both notations).
10132 If it is absent in the simpler format, the preceding underscore must also be
10133 omitted.
10134
10135 The &%substr%& item can be used to extract more general substrings than
10136 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10137 length required. For example
10138 .code
10139 ${substr{3}{2}{$local_part}}
10140 .endd
10141 If the starting offset is greater than the string length the result is the
10142 null string; if the length plus starting offset is greater than the string
10143 length, the result is the right-hand part of the string, starting from the
10144 given offset. The first byte (character) in the string has offset zero.
10145
10146 The &%substr%& expansion item can take negative offset values to count
10147 from the right-hand end of its operand. The last byte (character) is offset -1,
10148 the second-last is offset -2, and so on. Thus, for example,
10149 .code
10150 ${substr{-5}{2}{1234567}}
10151 .endd
10152 yields &"34"&. If the absolute value of a negative offset is greater than the
10153 length of the string, the substring starts at the beginning of the string, and
10154 the length is reduced by the amount of overshoot. Thus, for example,
10155 .code
10156 ${substr{-5}{2}{12}}
10157 .endd
10158 yields an empty string, but
10159 .code
10160 ${substr{-3}{2}{12}}
10161 .endd
10162 yields &"1"&.
10163
10164 When the second number is omitted from &%substr%&, the remainder of the string
10165 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10166 string preceding the offset point are taken. For example, an offset of -1 and
10167 no length, as in these semantically identical examples:
10168 .code
10169 ${substr_-1:abcde}
10170 ${substr{-1}{abcde}}
10171 .endd
10172 yields all but the last character of the string, that is, &"abcd"&.
10173
10174 All measurement is done in bytes and is not UTF-8 aware.
10175
10176
10177
10178 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10179         {*&<&'replacements'&>&*}}*&"
10180 .cindex "expansion" "character translation"
10181 .cindex "&%tr%& expansion item"
10182 This item does single-character (in bytes) translation on its subject string. The second
10183 argument is a list of characters to be translated in the subject string. Each
10184 matching character is replaced by the corresponding character from the
10185 replacement list. For example
10186 .code
10187 ${tr{abcdea}{ac}{13}}
10188 .endd
10189 yields &`1b3de1`&. If there are duplicates in the second character string, the
10190 last occurrence is used. If the third string is shorter than the second, its
10191 last character is replicated. However, if it is empty, no translation takes
10192 place.
10193
10194 All character handling is done in bytes and is not UTF-8 aware.
10195
10196 .endlist
10197
10198
10199
10200 .section "Expansion operators" "SECTexpop"
10201 .cindex "expansion" "operators"
10202 For expansion items that perform transformations on a single argument string,
10203 the &"operator"& notation is used because it is simpler and uses fewer braces.
10204 The substring is first expanded before the operation is applied to it. The
10205 following operations can be performed:
10206
10207 .vlist
10208 .vitem &*${address:*&<&'string'&>&*}*&
10209 .cindex "expansion" "RFC 2822 address handling"
10210 .cindex "&%address%& expansion item"
10211 The string is interpreted as an RFC 2822 address, as it might appear in a
10212 header line, and the effective address is extracted from it. If the string does
10213 not parse successfully, the result is empty.
10214
10215 The parsing correctly handles SMTPUTF8 Unicode in the string.
10216
10217
10218 .vitem &*${addresses:*&<&'string'&>&*}*&
10219 .cindex "expansion" "RFC 2822 address handling"
10220 .cindex "&%addresses%& expansion item"
10221 The string (after expansion) is interpreted as a list of addresses in RFC
10222 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10223 operative address (&'local-part@domain'&) is extracted from each item, and the
10224 result of the expansion is a colon-separated list, with appropriate
10225 doubling of colons should any happen to be present in the email addresses.
10226 Syntactically invalid RFC2822 address items are omitted from the output.
10227
10228 It is possible to specify a character other than colon for the output
10229 separator by starting the string with > followed by the new separator
10230 character. For example:
10231 .code
10232 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10233 .endd
10234 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10235 first, so if the expanded string starts with >, it may change the output
10236 separator unintentionally. This can be avoided by setting the output
10237 separator explicitly:
10238 .code
10239 ${addresses:>:$h_from:}
10240 .endd
10241
10242 Compare the &*address*& (singular)
10243 expansion item, which extracts the working address from a single RFC2822
10244 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10245 processing lists.
10246
10247 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10248 a strict interpretation of header line formatting.  Exim parses the bare,
10249 unquoted portion of an email address and if it finds a comma, treats it as an
10250 email address separator. For the example header line:
10251 .code
10252 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10253 .endd
10254 The first example below demonstrates that Q-encoded email addresses are parsed
10255 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10256 It does not see the comma because it's still encoded as "=2C".  The second
10257 example below is passed the contents of &`$header_from:`&, meaning it gets
10258 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10259 The third example shows that the presence of a comma is skipped when it is
10260 quoted.  The fourth example shows SMTPUTF8 handling.
10261 .code
10262 # exim -be '${addresses:From: \
10263 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10264 user@example.com
10265 # exim -be '${addresses:From: Last, First <user@example.com>}'
10266 Last:user@example.com
10267 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10268 user@example.com
10269 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10270 フィリップ@example.jp
10271 .endd
10272
10273 .vitem &*${base32:*&<&'digits'&>&*}*&
10274 .cindex "&%base32%& expansion item"
10275 .cindex "expansion" "conversion to base 32"
10276 The string must consist entirely of decimal digits. The number is converted to
10277 base 32 and output as a (empty, for zero) string of characters.
10278 Only lowercase letters are used.
10279
10280 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10281 .cindex "&%base32d%& expansion item"
10282 .cindex "expansion" "conversion to base 32"
10283 The string must consist entirely of base-32 digits.
10284 The number is converted to decimal and output as a string.
10285
10286 .vitem &*${base62:*&<&'digits'&>&*}*&
10287 .cindex "&%base62%& expansion item"
10288 .cindex "expansion" "conversion to base 62"
10289 The string must consist entirely of decimal digits. The number is converted to
10290 base 62 and output as a string of six characters, including leading zeros. In
10291 the few operating environments where Exim uses base 36 instead of base 62 for
10292 its message identifiers (because those systems do not have case-sensitive file
10293 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
10294 be absolutely clear: this is &'not'& base64 encoding.
10295
10296 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10297 .cindex "&%base62d%& expansion item"
10298 .cindex "expansion" "conversion to base 62"
10299 The string must consist entirely of base-62 digits, or, in operating
10300 environments where Exim uses base 36 instead of base 62 for its message
10301 identifiers, base-36 digits. The number is converted to decimal and output as a
10302 string.
10303
10304 .vitem &*${base64:*&<&'string'&>&*}*&
10305 .cindex "expansion" "base64 encoding"
10306 .cindex "base64 encoding" "in string expansion"
10307 .cindex "&%base64%& expansion item"
10308 .cindex certificate "base64 of DER"
10309 This operator converts a string into one that is base64 encoded.
10310
10311 If the string is a single variable of type certificate,
10312 returns the base64 encoding of the DER form of the certificate.
10313
10314
10315 .vitem &*${base64d:*&<&'string'&>&*}*&
10316 .cindex "expansion" "base64 decoding"
10317 .cindex "base64 decoding" "in string expansion"
10318 .cindex "&%base64d%& expansion item"
10319 This operator converts a base64-encoded string into the un-coded form.
10320
10321
10322 .vitem &*${domain:*&<&'string'&>&*}*&
10323 .cindex "domain" "extraction"
10324 .cindex "expansion" "domain extraction"
10325 The string is interpreted as an RFC 2822 address and the domain is extracted
10326 from it. If the string does not parse successfully, the result is empty.
10327
10328
10329 .vitem &*${escape:*&<&'string'&>&*}*&
10330 .cindex "expansion" "escaping non-printing characters"
10331 .cindex "&%escape%& expansion item"
10332 If the string contains any non-printing characters, they are converted to
10333 escape sequences starting with a backslash. Whether characters with the most
10334 significant bit set (so-called &"8-bit characters"&) count as printing or not
10335 is controlled by the &%print_topbitchars%& option.
10336
10337 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10338 .cindex "expansion" "escaping 8-bit characters"
10339 .cindex "&%escape8bit%& expansion item"
10340 If the string contains and characters with the most significant bit set,
10341 they are converted to escape sequences starting with a backslash.
10342 Backslashes and DEL characters are also converted.
10343
10344
10345 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10346 .cindex "expansion" "expression evaluation"
10347 .cindex "expansion" "arithmetic expression"
10348 .cindex "&%eval%& expansion item"
10349 These items supports simple arithmetic and bitwise logical operations in
10350 expansion strings. The string (after expansion) must be a conventional
10351 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10352 logical operators, and parentheses. All operations are carried out using
10353 integer arithmetic. The operator priorities are as follows (the same as in the
10354 C programming language):
10355 .table2 70pt 300pt
10356 .irow &'highest:'& "not (~), negate (-)"
10357 .irow ""   "multiply (*), divide (/), remainder (%)"
10358 .irow ""   "plus (+), minus (-)"
10359 .irow ""   "shift-left (<<), shift-right (>>)"
10360 .irow ""   "and (&&)"
10361 .irow ""   "xor (^)"
10362 .irow &'lowest:'&  "or (|)"
10363 .endtable
10364 Binary operators with the same priority are evaluated from left to right. White
10365 space is permitted before or after operators.
10366
10367 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10368 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10369 decimal, even if they start with a leading zero; hexadecimal numbers are not
10370 permitted. This can be useful when processing numbers extracted from dates or
10371 times, which often do have leading zeros.
10372
10373 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10374 or 1024*1024*1024,
10375 respectively. Negative numbers are supported. The result of the computation is
10376 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10377
10378 .display
10379 &`${eval:1+1}            `&  yields 2
10380 &`${eval:1+2*3}          `&  yields 7
10381 &`${eval:(1+2)*3}        `&  yields 9
10382 &`${eval:2+42%5}         `&  yields 4
10383 &`${eval:0xc&amp;5}          `&  yields 4
10384 &`${eval:0xc|5}          `&  yields 13
10385 &`${eval:0xc^5}          `&  yields 9
10386 &`${eval:0xc>>1}         `&  yields 6
10387 &`${eval:0xc<<1}         `&  yields 24
10388 &`${eval:~255&amp;0x1234}    `&  yields 4608
10389 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10390 .endd
10391
10392 As a more realistic example, in an ACL you might have
10393 .code
10394 deny   message = Too many bad recipients
10395        condition =                    \
10396          ${if and {                   \
10397            {>{$rcpt_count}{10}}       \
10398            {                          \
10399            <                          \
10400              {$recipients_count}      \
10401              {${eval:$rcpt_count/2}}  \
10402            }                          \
10403          }{yes}{no}}
10404 .endd
10405 The condition is true if there have been more than 10 RCPT commands and
10406 fewer than half of them have resulted in a valid recipient.
10407
10408
10409 .vitem &*${expand:*&<&'string'&>&*}*&
10410 .cindex "expansion" "re-expansion of substring"
10411 The &%expand%& operator causes a string to be expanded for a second time. For
10412 example,
10413 .code
10414 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10415 .endd
10416 first looks up a string in a file while expanding the operand for &%expand%&,
10417 and then re-expands what it has found.
10418
10419
10420 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10421 .cindex "Unicode"
10422 .cindex "UTF-8" "conversion from"
10423 .cindex "expansion" "UTF-8 conversion"
10424 .cindex "&%from_utf8%& expansion item"
10425 The world is slowly moving towards Unicode, although there are no standards for
10426 email yet. However, other applications (including some databases) are starting
10427 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10428 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10429 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10430 the result is an undefined sequence of bytes.
10431
10432 Unicode code points with values less than 256 are compatible with ASCII and
10433 ISO-8859-1 (also known as Latin-1).
10434 For example, character 169 is the copyright symbol in both cases, though the
10435 way it is encoded is different. In UTF-8, more than one byte is needed for
10436 characters with code values greater than 127, whereas ISO-8859-1 is a
10437 single-byte encoding (but thereby limited to 256 characters). This makes
10438 translation from UTF-8 to ISO-8859-1 straightforward.
10439
10440
10441 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10442 .cindex "hash function" "textual"
10443 .cindex "expansion" "textual hash"
10444 The &%hash%& operator is a simpler interface to the hashing function that can
10445 be used when the two parameters are fixed numbers (as opposed to strings that
10446 change when expanded). The effect is the same as
10447 .code
10448 ${hash{<n>}{<m>}{<string>}}
10449 .endd
10450 See the description of the general &%hash%& item above for details. The
10451 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10452
10453
10454
10455 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10456 .cindex "base64 encoding" "conversion from hex"
10457 .cindex "expansion" "hex to base64"
10458 .cindex "&%hex2b64%& expansion item"
10459 This operator converts a hex string into one that is base64 encoded. This can
10460 be useful for processing the output of the various hashing functions.
10461
10462
10463
10464 .vitem &*${hexquote:*&<&'string'&>&*}*&
10465 .cindex "quoting" "hex-encoded unprintable characters"
10466 .cindex "&%hexquote%& expansion item"
10467 This operator converts non-printable characters in a string into a hex
10468 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10469 as is, and other byte values are converted to &`\xNN`&, for example a
10470 byte value 127 is converted to &`\x7f`&.
10471
10472
10473 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10474 .cindex "&%ipv6denorm%& expansion item"
10475 .cindex "IP address" normalisation
10476 This expands an IPv6 address to a full eight-element colon-separated set
10477 of hex digits including leading zeroes.
10478 A trailing ipv4-style dotted-decimal set is converted to hex.
10479 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10480
10481 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10482 .cindex "&%ipv6norm%& expansion item"
10483 .cindex "IP address" normalisation
10484 .cindex "IP address" "canonical form"
10485 This converts an IPv6 address to canonical form.
10486 Leading zeroes of groups are omitted, and the longest
10487 set of zero-valued groups is replaced with a double colon.
10488 A trailing ipv4-style dotted-decimal set is converted to hex.
10489 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10490
10491
10492 .vitem &*${lc:*&<&'string'&>&*}*&
10493 .cindex "case forcing in strings"
10494 .cindex "string" "case forcing"
10495 .cindex "lower casing"
10496 .cindex "expansion" "case forcing"
10497 .cindex "&%lc%& expansion item"
10498 This forces the letters in the string into lower-case, for example:
10499 .code
10500 ${lc:$local_part}
10501 .endd
10502 Case is defined per the system C locale.
10503
10504 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10505 .cindex "expansion" "string truncation"
10506 .cindex "&%length%& expansion item"
10507 The &%length%& operator is a simpler interface to the &%length%& function that
10508 can be used when the parameter is a fixed number (as opposed to a string that
10509 changes when expanded). The effect is the same as
10510 .code
10511 ${length{<number>}{<string>}}
10512 .endd
10513 See the description of the general &%length%& item above for details. Note that
10514 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10515 when &%length%& is used as an operator.
10516 All measurement is done in bytes and is not UTF-8 aware.
10517
10518
10519 .vitem &*${listcount:*&<&'string'&>&*}*&
10520 .cindex "expansion" "list item count"
10521 .cindex "list" "item count"
10522 .cindex "list" "count of items"
10523 .cindex "&%listcount%& expansion item"
10524 The string is interpreted as a list and the number of items is returned.
10525
10526
10527 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10528 .cindex "expansion" "named list"
10529 .cindex "&%listnamed%& expansion item"
10530 The name is interpreted as a named list and the content of the list is returned,
10531 expanding any referenced lists, re-quoting as needed for colon-separation.
10532 If the optional type is given it must be one of "a", "d", "h" or "l"
10533 and selects address-, domain-, host- or localpart- lists to search among respectively.
10534 Otherwise all types are searched in an undefined order and the first
10535 matching list is returned.
10536
10537
10538 .vitem &*${local_part:*&<&'string'&>&*}*&
10539 .cindex "expansion" "local part extraction"
10540 .cindex "&%local_part%& expansion item"
10541 The string is interpreted as an RFC 2822 address and the local part is
10542 extracted from it. If the string does not parse successfully, the result is
10543 empty.
10544 The parsing correctly handles SMTPUTF8 Unicode in the string.
10545
10546
10547 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10548 .cindex "masked IP address"
10549 .cindex "IP address" "masking"
10550 .cindex "CIDR notation"
10551 .cindex "expansion" "IP address masking"
10552 .cindex "&%mask%& expansion item"
10553 If the form of the string to be operated on is not an IP address followed by a
10554 slash and an integer (that is, a network address in CIDR notation), the
10555 expansion fails. Otherwise, this operator converts the IP address to binary,
10556 masks off the least significant bits according to the bit count, and converts
10557 the result back to text, with mask appended. For example,
10558 .code
10559 ${mask:10.111.131.206/28}
10560 .endd
10561 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10562 be mostly used for looking up masked addresses in files, the result for an IPv6
10563 address uses dots to separate components instead of colons, because colon
10564 terminates a key string in lsearch files. So, for example,
10565 .code
10566 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10567 .endd
10568 returns the string
10569 .code
10570 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10571 .endd
10572 Letters in IPv6 addresses are always output in lower case.
10573
10574
10575 .vitem &*${md5:*&<&'string'&>&*}*&
10576 .cindex "MD5 hash"
10577 .cindex "expansion" "MD5 hash"
10578 .cindex certificate fingerprint
10579 .cindex "&%md5%& expansion item"
10580 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10581 as a 32-digit hexadecimal number, in which any letters are in lower case.
10582
10583 If the string is a single variable of type certificate,
10584 returns the MD5 hash fingerprint of the certificate.
10585
10586
10587 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10588 .cindex "expansion" "numeric hash"
10589 .cindex "hash function" "numeric"
10590 The &%nhash%& operator is a simpler interface to the numeric hashing function
10591 that can be used when the two parameters are fixed numbers (as opposed to
10592 strings that change when expanded). The effect is the same as
10593 .code
10594 ${nhash{<n>}{<m>}{<string>}}
10595 .endd
10596 See the description of the general &%nhash%& item above for details.
10597
10598
10599 .vitem &*${quote:*&<&'string'&>&*}*&
10600 .cindex "quoting" "in string expansions"
10601 .cindex "expansion" "quoting"
10602 .cindex "&%quote%& expansion item"
10603 The &%quote%& operator puts its argument into double quotes if it
10604 is an empty string or
10605 contains anything other than letters, digits, underscores, dots, and hyphens.
10606 Any occurrences of double quotes and backslashes are escaped with a backslash.
10607 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10608 respectively For example,
10609 .code
10610 ${quote:ab"*"cd}
10611 .endd
10612 becomes
10613 .code
10614 "ab\"*\"cd"
10615 .endd
10616 The place where this is useful is when the argument is a substitution from a
10617 variable or a message header.
10618
10619 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10620 .cindex "&%quote_local_part%& expansion item"
10621 This operator is like &%quote%&, except that it quotes the string only if
10622 required to do so by the rules of RFC 2822 for quoting local parts. For
10623 example, a plus sign would not cause quoting (but it would for &%quote%&).
10624 If you are creating a new email address from the contents of &$local_part$&
10625 (or any other unknown data), you should always use this operator.
10626
10627 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
10628 will likely use the quoting form.
10629 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
10630
10631
10632 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10633 .cindex "quoting" "lookup-specific"
10634 This operator applies lookup-specific quoting rules to the string. Each
10635 query-style lookup type has its own quoting rules which are described with
10636 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10637 .code
10638 ${quote_ldap:two * two}
10639 .endd
10640 returns
10641 .code
10642 two%20%5C2A%20two
10643 .endd
10644 For single-key lookup types, no quoting is ever necessary and this operator
10645 yields an unchanged string.
10646
10647
10648 .vitem &*${randint:*&<&'n'&>&*}*&
10649 .cindex "random number"
10650 This operator returns a somewhat random number which is less than the
10651 supplied number and is at least 0.  The quality of this randomness depends
10652 on how Exim was built; the values are not suitable for keying material.
10653 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10654 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10655 for versions of GnuTLS with that function.
10656 Otherwise, the implementation may be arc4random(), random() seeded by
10657 srandomdev() or srandom(), or a custom implementation even weaker than
10658 random().
10659
10660
10661 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10662 .cindex "expansion" "IP address"
10663 This operator reverses an IP address; for IPv4 addresses, the result is in
10664 dotted-quad decimal form, while for IPv6 addresses the result is in
10665 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10666 for DNS.  For example,
10667 .code
10668 ${reverse_ip:192.0.2.4}
10669 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10670 .endd
10671 returns
10672 .code
10673 4.2.0.192
10674 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
10675 .endd
10676
10677
10678 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10679 .cindex "expansion" "RFC 2047"
10680 .cindex "RFC 2047" "expansion operator"
10681 .cindex "&%rfc2047%& expansion item"
10682 This operator encodes text according to the rules of RFC 2047. This is an
10683 encoding that is used in header lines to encode non-ASCII characters. It is
10684 assumed that the input string is in the encoding specified by the
10685 &%headers_charset%& option, which gets its default at build time. If the string
10686 contains only characters in the range 33&--126, and no instances of the
10687 characters
10688 .code
10689 ? = ( ) < > @ , ; : \ " . [ ] _
10690 .endd
10691 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10692 string, using as many &"encoded words"& as necessary to encode all the
10693 characters.
10694
10695
10696 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10697 .cindex "expansion" "RFC 2047"
10698 .cindex "RFC 2047" "decoding"
10699 .cindex "&%rfc2047d%& expansion item"
10700 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10701 bytes are replaced by question marks. Characters are converted into the
10702 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10703 not recognized unless &%check_rfc2047_length%& is set false.
10704
10705 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10706 access a header line, RFC 2047 decoding is done automatically. You do not need
10707 to use this operator as well.
10708
10709
10710
10711 .vitem &*${rxquote:*&<&'string'&>&*}*&
10712 .cindex "quoting" "in regular expressions"
10713 .cindex "regular expressions" "quoting"
10714 .cindex "&%rxquote%& expansion item"
10715 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10716 characters in its argument. This is useful when substituting the values of
10717 variables or headers inside regular expressions.
10718
10719
10720 .vitem &*${sha1:*&<&'string'&>&*}*&
10721 .cindex "SHA-1 hash"
10722 .cindex "expansion" "SHA-1 hashing"
10723 .cindex certificate fingerprint
10724 .cindex "&%sha1%& expansion item"
10725 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10726 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10727
10728 If the string is a single variable of type certificate,
10729 returns the SHA-1 hash fingerprint of the certificate.
10730
10731
10732 .vitem &*${sha256:*&<&'string'&>&*}*&
10733 .cindex "SHA-256 hash"
10734 .cindex certificate fingerprint
10735 .cindex "expansion" "SHA-256 hashing"
10736 .cindex "&%sha256%& expansion item"
10737 The &%sha256%& operator computes the SHA-256 hash value of the string
10738 and returns
10739 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10740
10741 If the string is a single variable of type certificate,
10742 returns the SHA-256 hash fingerprint of the certificate.
10743
10744
10745 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
10746        &*${sha3_<n>:*&<&'string'&>&*}*&
10747 .cindex "SHA3 hash"
10748 .cindex "expansion" "SHA3 hashing"
10749 .cindex "&%sha3%& expansion item"
10750 The &%sha3%& operator computes the SHA3-256 hash value of the string
10751 and returns
10752 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10753
10754 If a number is appended, separated by an underbar, it specifies
10755 the output length.  Values of 224, 256, 384 and 512 are accepted;
10756 with 256 being the default.
10757
10758 The &%sha3%& expansion item is only supported if Exim has been
10759 compiled with GnuTLS 3.5.0 or later,
10760 or OpenSSL 1.1.1 or later.
10761 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
10762
10763
10764 .vitem &*${stat:*&<&'string'&>&*}*&
10765 .cindex "expansion" "statting a file"
10766 .cindex "file" "extracting characteristics"
10767 .cindex "&%stat%& expansion item"
10768 The string, after expansion, must be a file path. A call to the &[stat()]&
10769 function is made for this path. If &[stat()]& fails, an error occurs and the
10770 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10771 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10772 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10773 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10774 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10775 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10776 can extract individual fields using the &%extract%& expansion item.
10777
10778 The use of the &%stat%& expansion in users' filter files can be locked out by
10779 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10780 systems for files larger than 2GB.
10781
10782 .vitem &*${str2b64:*&<&'string'&>&*}*&
10783 .cindex "&%str2b64%& expansion item"
10784 Now deprecated, a synonym for the &%base64%& expansion operator.
10785
10786
10787
10788 .vitem &*${strlen:*&<&'string'&>&*}*&
10789 .cindex "expansion" "string length"
10790 .cindex "string" "length in expansion"
10791 .cindex "&%strlen%& expansion item"
10792 The item is replace by the length of the expanded string, expressed as a
10793 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10794 All measurement is done in bytes and is not UTF-8 aware.
10795
10796
10797 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10798 .cindex "&%substr%& expansion item"
10799 .cindex "substring extraction"
10800 .cindex "expansion" "substring expansion"
10801 The &%substr%& operator is a simpler interface to the &%substr%& function that
10802 can be used when the two parameters are fixed numbers (as opposed to strings
10803 that change when expanded). The effect is the same as
10804 .code
10805 ${substr{<start>}{<length>}{<string>}}
10806 .endd
10807 See the description of the general &%substr%& item above for details. The
10808 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10809 All measurement is done in bytes and is not UTF-8 aware.
10810
10811 .vitem &*${time_eval:*&<&'string'&>&*}*&
10812 .cindex "&%time_eval%& expansion item"
10813 .cindex "time interval" "decoding"
10814 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10815 seconds.
10816
10817 .vitem &*${time_interval:*&<&'string'&>&*}*&
10818 .cindex "&%time_interval%& expansion item"
10819 .cindex "time interval" "formatting"
10820 The argument (after sub-expansion) must be a sequence of decimal digits that
10821 represents an interval of time as a number of seconds. It is converted into a
10822 number of larger units and output in Exim's normal time format, for example,
10823 &`1w3d4h2m6s`&.
10824
10825 .vitem &*${uc:*&<&'string'&>&*}*&
10826 .cindex "case forcing in strings"
10827 .cindex "string" "case forcing"
10828 .cindex "upper casing"
10829 .cindex "expansion" "case forcing"
10830 .cindex "&%uc%& expansion item"
10831 This forces the letters in the string into upper-case.
10832 Case is defined per the system C locale.
10833
10834 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10835 .cindex "correction of invalid utf-8 sequences in strings"
10836 .cindex "utf-8" "utf-8 sequences"
10837 .cindex "incorrect utf-8"
10838 .cindex "expansion" "utf-8 forcing"
10839 .cindex "&%utf8clean%& expansion item"
10840 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10841 .new
10842 In versions of Exim before 4.92, this did not correctly do so for a truncated
10843 final codepoint's encoding, and the character would be silently dropped.
10844 If you must handle detection of this scenario across both sets of Exim behavior,
10845 the complexity will depend upon the task.
10846 For instance, to detect if the first character is multibyte and a 1-byte
10847 extraction can be successfully used as a path component (as is common for
10848 dividing up delivery folders), you might use:
10849 .code
10850 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
10851 .endd
10852 (which will false-positive if the first character of the local part is a
10853 literal question mark).
10854 .wen
10855
10856 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
10857        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
10858        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
10859        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
10860 .cindex expansion UTF-8
10861 .cindex UTF-8 expansion
10862 .cindex EAI
10863 .cindex internationalisation
10864 .cindex "&%utf8_domain_to_alabel%& expansion item"
10865 .cindex "&%utf8_domain_from_alabel%& expansion item"
10866 .cindex "&%utf8_localpart_to_alabel%& expansion item"
10867 .cindex "&%utf8_localpart_from_alabel%& expansion item"
10868 These convert EAI mail name components between UTF-8 and a-label forms.
10869 For information on internationalisation support see &<<SECTi18nMTA>>&.
10870 .endlist
10871
10872
10873
10874
10875
10876
10877 .section "Expansion conditions" "SECTexpcond"
10878 .scindex IIDexpcond "expansion" "conditions"
10879 The following conditions are available for testing by the &%${if%& construct
10880 while expanding strings:
10881
10882 .vlist
10883 .vitem &*!*&<&'condition'&>
10884 .cindex "expansion" "negating a condition"
10885 .cindex "negation" "in expansion condition"
10886 Preceding any condition with an exclamation mark negates the result of the
10887 condition.
10888
10889 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10890 .cindex "numeric comparison"
10891 .cindex "expansion" "numeric comparison"
10892 There are a number of symbolic operators for doing numeric comparisons. They
10893 are:
10894 .display
10895 &`=   `&   equal
10896 &`==  `&   equal
10897 &`>   `&   greater
10898 &`>=  `&   greater or equal
10899 &`<   `&   less
10900 &`<=  `&   less or equal
10901 .endd
10902 For example:
10903 .code
10904 ${if >{$message_size}{10M} ...
10905 .endd
10906 Note that the general negation operator provides for inequality testing. The
10907 two strings must take the form of optionally signed decimal integers,
10908 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10909 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10910 As a special case, the numerical value of an empty string is taken as
10911 zero.
10912
10913 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10914 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10915 10M, not if 10M is larger than &$message_size$&.
10916
10917
10918 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10919         {*&<&'arg2'&>&*}...}*&
10920 .cindex "expansion" "calling an acl"
10921 .cindex "&%acl%&" "expansion condition"
10922 The name and zero to nine argument strings are first expanded separately.  The expanded
10923 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10924 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10925 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10926 and may use the variables; if another acl expansion is used the values
10927 are restored after it returns.  If the ACL sets
10928 a value using a "message =" modifier the variable $value becomes
10929 the result of the expansion, otherwise it is empty.
10930 If the ACL returns accept the condition is true; if deny, false.
10931 If the ACL returns defer the result is a forced-fail.
10932
10933 .vitem &*bool&~{*&<&'string'&>&*}*&
10934 .cindex "expansion" "boolean parsing"
10935 .cindex "&%bool%& expansion condition"
10936 This condition turns a string holding a true or false representation into
10937 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10938 (case-insensitively); also integer numbers map to true if non-zero,
10939 false if zero.
10940 An empty string is treated as false.
10941 Leading and trailing whitespace is ignored;
10942 thus a string consisting only of whitespace is false.
10943 All other string values will result in expansion failure.
10944
10945 When combined with ACL variables, this expansion condition will let you
10946 make decisions in one place and act on those decisions in another place.
10947 For example:
10948 .code
10949 ${if bool{$acl_m_privileged_sender} ...
10950 .endd
10951
10952
10953 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10954 .cindex "expansion" "boolean parsing"
10955 .cindex "&%bool_lax%& expansion condition"
10956 Like &%bool%&, this condition turns a string into a boolean state.  But
10957 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10958 loose definition that the Router &%condition%& option uses.  The empty string
10959 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10960 true.  Leading and trailing whitespace is ignored.
10961
10962 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10963
10964 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10965 .cindex "expansion" "encrypted comparison"
10966 .cindex "encrypted strings, comparing"
10967 .cindex "&%crypteq%& expansion condition"
10968 This condition is included in the Exim binary if it is built to support any
10969 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10970 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10971 included in the binary.
10972
10973 The &%crypteq%& condition has two arguments. The first is encrypted and
10974 compared against the second, which is already encrypted. The second string may
10975 be in the LDAP form for storing encrypted strings, which starts with the
10976 encryption type in curly brackets, followed by the data. If the second string
10977 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10978 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10979 Typically this will be a field from a password file. An example of an encrypted
10980 string in LDAP form is:
10981 .code
10982 {md5}CY9rzUYh03PK3k6DJie09g==
10983 .endd
10984 If such a string appears directly in an expansion, the curly brackets have to
10985 be quoted, because they are part of the expansion syntax. For example:
10986 .code
10987 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10988 .endd
10989 The following encryption types (whose names are matched case-independently) are
10990 supported:
10991
10992 .ilist
10993 .cindex "MD5 hash"
10994 .cindex "base64 encoding" "in encrypted password"
10995 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10996 printable characters to compare with the remainder of the second string. If the
10997 length of the comparison string is 24, Exim assumes that it is base64 encoded
10998 (as in the above example). If the length is 32, Exim assumes that it is a
10999 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11000 comparison fails.
11001
11002 .next
11003 .cindex "SHA-1 hash"
11004 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11005 printable characters to compare with the remainder of the second string. If the
11006 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11007 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11008 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11009
11010 .next
11011 .cindex "&[crypt()]&"
11012 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11013 only the first eight characters of the password. However, in modern operating
11014 systems this is no longer true, and in many cases the entire password is used,
11015 whatever its length.
11016
11017 .next
11018 .cindex "&[crypt16()]&"
11019 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11020 use up to 16 characters of the password in some operating systems. Again, in
11021 modern operating systems, more characters may be used.
11022 .endlist
11023 Exim has its own version of &[crypt16()]&, which is just a double call to
11024 &[crypt()]&. For operating systems that have their own version, setting
11025 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11026 operating system version instead of its own. This option is set by default in
11027 the OS-dependent &_Makefile_& for those operating systems that are known to
11028 support &[crypt16()]&.
11029
11030 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11031 it was not using the same algorithm as some operating systems' versions. It
11032 turns out that as well as &[crypt16()]& there is a function called
11033 &[bigcrypt()]& in some operating systems. This may or may not use the same
11034 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11035
11036 However, since there is now a move away from the traditional &[crypt()]&
11037 functions towards using SHA1 and other algorithms, tidying up this area of
11038 Exim is seen as very low priority.
11039
11040 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11041 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11042 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11043 default is &`{crypt}`&. Whatever the default, you can always use either
11044 function by specifying it explicitly in curly brackets.
11045
11046 .vitem &*def:*&<&'variable&~name'&>
11047 .cindex "expansion" "checking for empty variable"
11048 .cindex "&%def%& expansion condition"
11049 The &%def%& condition must be followed by the name of one of the expansion
11050 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11051 variable does not contain the empty string. For example:
11052 .code
11053 ${if def:sender_ident {from $sender_ident}}
11054 .endd
11055 Note that the variable name is given without a leading &%$%& character. If the
11056 variable does not exist, the expansion fails.
11057
11058 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11059         &~&*def:h_*&<&'header&~name'&>&*:*&"
11060 .cindex "expansion" "checking header line existence"
11061 This condition is true if a message is being processed and the named header
11062 exists in the message. For example,
11063 .code
11064 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11065 .endd
11066 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11067 the header name must be terminated by a colon if white space does not follow.
11068
11069 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11070        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11071 .cindex "string" "comparison"
11072 .cindex "expansion" "string comparison"
11073 .cindex "&%eq%& expansion condition"
11074 .cindex "&%eqi%& expansion condition"
11075 The two substrings are first expanded. The condition is true if the two
11076 resulting strings are identical. For &%eq%& the comparison includes the case of
11077 letters, whereas for &%eqi%& the comparison is case-independent, where
11078 case is defined per the system C locale.
11079
11080 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11081 .cindex "expansion" "file existence test"
11082 .cindex "file" "existence test"
11083 .cindex "&%exists%&, expansion condition"
11084 The substring is first expanded and then interpreted as an absolute path. The
11085 condition is true if the named file (or directory) exists. The existence test
11086 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11087 users' filter files may be locked out by the system administrator.
11088
11089 .vitem &*first_delivery*&
11090 .cindex "delivery" "first"
11091 .cindex "first delivery"
11092 .cindex "expansion" "first delivery test"
11093 .cindex "&%first_delivery%& expansion condition"
11094 This condition, which has no data, is true during a message's first delivery
11095 attempt. It is false during any subsequent delivery attempts.
11096
11097
11098 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11099        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11100 .cindex "list" "iterative conditions"
11101 .cindex "expansion" "&*forall*& condition"
11102 .cindex "expansion" "&*forany*& condition"
11103 .vindex "&$item$&"
11104 These conditions iterate over a list. The first argument is expanded to form
11105 the list. By default, the list separator is a colon, but it can be changed by
11106 the normal method. The second argument is interpreted as a condition that is to
11107 be applied to each item in the list in turn. During the interpretation of the
11108 condition, the current list item is placed in a variable called &$item$&.
11109 .ilist
11110 For &*forany*&, interpretation stops if the condition is true for any item, and
11111 the result of the whole condition is true. If the condition is false for all
11112 items in the list, the overall condition is false.
11113 .next
11114 For &*forall*&, interpretation stops if the condition is false for any item,
11115 and the result of the whole condition is false. If the condition is true for
11116 all items in the list, the overall condition is true.
11117 .endlist
11118 Note that negation of &*forany*& means that the condition must be false for all
11119 items for the overall condition to succeed, and negation of &*forall*& means
11120 that the condition must be false for at least one item. In this example, the
11121 list separator is changed to a comma:
11122 .code
11123 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11124 .endd
11125 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
11126 being processed, to enable these expansion items to be nested.
11127
11128 To scan a named list, expand it with the &*listnamed*& operator.
11129
11130
11131 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11132        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11133 .cindex "string" "comparison"
11134 .cindex "expansion" "string comparison"
11135 .cindex "&%ge%& expansion condition"
11136 .cindex "&%gei%& expansion condition"
11137 The two substrings are first expanded. The condition is true if the first
11138 string is lexically greater than or equal to the second string. For &%ge%& the
11139 comparison includes the case of letters, whereas for &%gei%& the comparison is
11140 case-independent.
11141 Case and collation order are defined per the system C locale.
11142
11143 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11144        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11145 .cindex "string" "comparison"
11146 .cindex "expansion" "string comparison"
11147 .cindex "&%gt%& expansion condition"
11148 .cindex "&%gti%& expansion condition"
11149 The two substrings are first expanded. The condition is true if the first
11150 string is lexically greater than the second string. For &%gt%& the comparison
11151 includes the case of letters, whereas for &%gti%& the comparison is
11152 case-independent.
11153 Case and collation order are defined per the system C locale.
11154
11155 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11156        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11157 .cindex "string" "comparison"
11158 .cindex "list" "iterative conditions"
11159 Both strings are expanded; the second string is treated as a list of simple
11160 strings; if the first string is a member of the second, then the condition
11161 is true.
11162 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11163
11164 These are simpler to use versions of the more powerful &*forany*& condition.
11165 Examples, and the &*forany*& equivalents:
11166 .code
11167 ${if inlist{needle}{foo:needle:bar}}
11168   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11169 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11170   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11171 .endd
11172
11173 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11174        &*isip4&~{*&<&'string'&>&*}*& &&&
11175        &*isip6&~{*&<&'string'&>&*}*&
11176 .cindex "IP address" "testing string format"
11177 .cindex "string" "testing for IP address"
11178 .cindex "&%isip%& expansion condition"
11179 .cindex "&%isip4%& expansion condition"
11180 .cindex "&%isip6%& expansion condition"
11181 The substring is first expanded, and then tested to see if it has the form of
11182 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11183 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11184
11185 For an IPv4 address, the test is for four dot-separated components, each of
11186 which consists of from one to three digits. For an IPv6 address, up to eight
11187 colon-separated components are permitted, each containing from one to four
11188 hexadecimal digits. There may be fewer than eight components if an empty
11189 component (adjacent colons) is present. Only one empty component is permitted.
11190
11191 &*Note*&: The checks used to be just on the form of the address; actual numerical
11192 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11193 check.
11194 This is no longer the case.
11195
11196 The main use of these tests is to distinguish between IP addresses and
11197 host names, or between IPv4 and IPv6 addresses. For example, you could use
11198 .code
11199 ${if isip4{$sender_host_address}...
11200 .endd
11201 to test which IP version an incoming SMTP connection is using.
11202
11203 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11204 .cindex "LDAP" "use for authentication"
11205 .cindex "expansion" "LDAP authentication test"
11206 .cindex "&%ldapauth%& expansion condition"
11207 This condition supports user authentication using LDAP. See section
11208 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11209 queries. For this use, the query must contain a user name and password. The
11210 query itself is not used, and can be empty. The condition is true if the
11211 password is not empty, and the user name and password are accepted by the LDAP
11212 server. An empty password is rejected without calling LDAP because LDAP binds
11213 with an empty password are considered anonymous regardless of the username, and
11214 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11215 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11216 this can be used.
11217
11218
11219 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11220        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11221 .cindex "string" "comparison"
11222 .cindex "expansion" "string comparison"
11223 .cindex "&%le%& expansion condition"
11224 .cindex "&%lei%& expansion condition"
11225 The two substrings are first expanded. The condition is true if the first
11226 string is lexically less than or equal to the second string. For &%le%& the
11227 comparison includes the case of letters, whereas for &%lei%& the comparison is
11228 case-independent.
11229 Case and collation order are defined per the system C locale.
11230
11231 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11232        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11233 .cindex "string" "comparison"
11234 .cindex "expansion" "string comparison"
11235 .cindex "&%lt%& expansion condition"
11236 .cindex "&%lti%& expansion condition"
11237 The two substrings are first expanded. The condition is true if the first
11238 string is lexically less than the second string. For &%lt%& the comparison
11239 includes the case of letters, whereas for &%lti%& the comparison is
11240 case-independent.
11241 Case and collation order are defined per the system C locale.
11242
11243
11244 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11245 .cindex "expansion" "regular expression comparison"
11246 .cindex "regular expressions" "match in expanded string"
11247 .cindex "&%match%& expansion condition"
11248 The two substrings are first expanded. The second is then treated as a regular
11249 expression and applied to the first. Because of the pre-expansion, if the
11250 regular expression contains dollar, or backslash characters, they must be
11251 escaped. Care must also be taken if the regular expression contains braces
11252 (curly brackets). A closing brace must be escaped so that it is not taken as a
11253 premature termination of <&'string2'&>. The easiest approach is to use the
11254 &`\N`& feature to disable expansion of the regular expression.
11255 For example,
11256 .code
11257 ${if match {$local_part}{\N^\d{3}\N} ...
11258 .endd
11259 If the whole expansion string is in double quotes, further escaping of
11260 backslashes is also required.
11261
11262 The condition is true if the regular expression match succeeds.
11263 The regular expression is not required to begin with a circumflex
11264 metacharacter, but if there is no circumflex, the expression is not anchored,
11265 and it may match anywhere in the subject, not just at the start. If you want
11266 the pattern to match at the end of the subject, you must include the &`$`&
11267 metacharacter at an appropriate point.
11268 All character handling is done in bytes and is not UTF-8 aware,
11269 but we might change this in a future Exim release.
11270
11271 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11272 At the start of an &%if%& expansion the values of the numeric variable
11273 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11274 succeeds causes them to be reset to the substrings of that condition and they
11275 will have these values during the expansion of the success string. At the end
11276 of the &%if%& expansion, the previous values are restored. After testing a
11277 combination of conditions using &%or%&, the subsequent values of the numeric
11278 variables are those of the condition that succeeded.
11279
11280 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11281 .cindex "&%match_address%& expansion condition"
11282 See &*match_local_part*&.
11283
11284 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11285 .cindex "&%match_domain%& expansion condition"
11286 See &*match_local_part*&.
11287
11288 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11289 .cindex "&%match_ip%& expansion condition"
11290 This condition matches an IP address to a list of IP address patterns. It must
11291 be followed by two argument strings. The first (after expansion) must be an IP
11292 address or an empty string. The second (not expanded) is a restricted host
11293 list that can match only an IP address, not a host name. For example:
11294 .code
11295 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11296 .endd
11297 The specific types of host list item that are permitted in the list are:
11298
11299 .ilist
11300 An IP address, optionally with a CIDR mask.
11301 .next
11302 A single asterisk, which matches any IP address.
11303 .next
11304 An empty item, which matches only if the IP address is empty. This could be
11305 useful for testing for a locally submitted message or one from specific hosts
11306 in a single test such as
11307 . ==== As this is a nested list, any displays it contains must be indented
11308 . ==== as otherwise they are too far to the left. This comment applies to
11309 . ==== the use of xmlto plus fop. There's no problem when formatting with
11310 . ==== sdop, with or without the extra indent.
11311 .code
11312   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11313 .endd
11314 where the first item in the list is the empty string.
11315 .next
11316 The item @[] matches any of the local host's interface addresses.
11317 .next
11318 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11319 even if &`net-`& is not specified. There is never any attempt to turn the IP
11320 address into a host name. The most common type of linear search for
11321 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11322 masks. For example:
11323 .code
11324   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11325 .endd
11326 It is of course possible to use other kinds of lookup, and in such a case, you
11327 do need to specify the &`net-`& prefix if you want to specify a specific
11328 address mask, for example:
11329 .code
11330   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11331 .endd
11332 However, unless you are combining a &%match_ip%& condition with others, it is
11333 just as easy to use the fact that a lookup is itself a condition, and write:
11334 .code
11335   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11336 .endd
11337 .endlist ilist
11338
11339 Note that <&'string2'&> is not itself subject to string expansion, unless
11340 Exim was built with the EXPAND_LISTMATCH_RHS option.
11341
11342 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11343
11344 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11345 .cindex "domain list" "in expansion condition"
11346 .cindex "address list" "in expansion condition"
11347 .cindex "local part" "list, in expansion condition"
11348 .cindex "&%match_local_part%& expansion condition"
11349 This condition, together with &%match_address%& and &%match_domain%&, make it
11350 possible to test domain, address, and local part lists within expansions. Each
11351 condition requires two arguments: an item and a list to match. A trivial
11352 example is:
11353 .code
11354 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11355 .endd
11356 In each case, the second argument may contain any of the allowable items for a
11357 list of the appropriate type. Also, because the second argument
11358 is a standard form of list, it is possible to refer to a named list.
11359 Thus, you can use conditions like this:
11360 .code
11361 ${if match_domain{$domain}{+local_domains}{...
11362 .endd
11363 .cindex "&`+caseful`&"
11364 For address lists, the matching starts off caselessly, but the &`+caseful`&
11365 item can be used, as in all address lists, to cause subsequent items to
11366 have their local parts matched casefully. Domains are always matched
11367 caselessly.
11368
11369 Note that <&'string2'&> is not itself subject to string expansion, unless
11370 Exim was built with the EXPAND_LISTMATCH_RHS option.
11371
11372 &*Note*&: Host lists are &'not'& supported in this way. This is because
11373 hosts have two identities: a name and an IP address, and it is not clear
11374 how to specify cleanly how such a test would work. However, IP addresses can be
11375 matched using &%match_ip%&.
11376
11377 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11378 .cindex "PAM authentication"
11379 .cindex "AUTH" "with PAM"
11380 .cindex "Solaris" "PAM support"
11381 .cindex "expansion" "PAM authentication test"
11382 .cindex "&%pam%& expansion condition"
11383 &'Pluggable Authentication Modules'&
11384 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11385 available in the latest releases of Solaris and in some GNU/Linux
11386 distributions. The Exim support, which is intended for use in conjunction with
11387 the SMTP AUTH command, is available only if Exim is compiled with
11388 .code
11389 SUPPORT_PAM=yes
11390 .endd
11391 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11392 in some releases of GNU/Linux &%-ldl%& is also needed.
11393
11394 The argument string is first expanded, and the result must be a
11395 colon-separated list of strings. Leading and trailing white space is ignored.
11396 The PAM module is initialized with the service name &"exim"& and the user name
11397 taken from the first item in the colon-separated data string (<&'string1'&>).
11398 The remaining items in the data string are passed over in response to requests
11399 from the authentication function. In the simple case there will only be one
11400 request, for a password, so the data consists of just two strings.
11401
11402 There can be problems if any of the strings are permitted to contain colon
11403 characters. In the usual way, these have to be doubled to avoid being taken as
11404 separators. If the data is being inserted from a variable, the &%sg%& expansion
11405 item can be used to double any existing colons. For example, the configuration
11406 of a LOGIN authenticator might contain this setting:
11407 .code
11408 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11409 .endd
11410 For a PLAIN authenticator you could use:
11411 .code
11412 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11413 .endd
11414 In some operating systems, PAM authentication can be done only from a process
11415 running as root. Since Exim is running as the Exim user when receiving
11416 messages, this means that PAM cannot be used directly in those systems.
11417 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11418
11419
11420 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11421 .cindex "&'pwcheck'& daemon"
11422 .cindex "Cyrus"
11423 .cindex "expansion" "&'pwcheck'& authentication test"
11424 .cindex "&%pwcheck%& expansion condition"
11425 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11426 This is one way of making it possible for passwords to be checked by a process
11427 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11428 deprecated. Its replacement is &'saslauthd'& (see below).
11429
11430 The pwcheck support is not included in Exim by default. You need to specify
11431 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11432 building Exim. For example:
11433 .code
11434 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11435 .endd
11436 You do not need to install the full Cyrus software suite in order to use
11437 the pwcheck daemon. You can compile and install just the daemon alone
11438 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11439 access to the &_/var/pwcheck_& directory.
11440
11441 The &%pwcheck%& condition takes one argument, which must be the user name and
11442 password, separated by a colon. For example, in a LOGIN authenticator
11443 configuration, you might have this:
11444 .code
11445 server_condition = ${if pwcheck{$auth1:$auth2}}
11446 .endd
11447 Again, for a PLAIN authenticator configuration, this would be:
11448 .code
11449 server_condition = ${if pwcheck{$auth2:$auth3}}
11450 .endd
11451 .vitem &*queue_running*&
11452 .cindex "queue runner" "detecting when delivering from"
11453 .cindex "expansion" "queue runner test"
11454 .cindex "&%queue_running%& expansion condition"
11455 This condition, which has no data, is true during delivery attempts that are
11456 initiated by queue runner processes, and false otherwise.
11457
11458
11459 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11460 .cindex "Radius"
11461 .cindex "expansion" "Radius authentication"
11462 .cindex "&%radius%& expansion condition"
11463 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11464 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11465 the Radius client configuration file in order to build Exim with Radius
11466 support.
11467
11468 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11469 library, using the original API. If you are using release 0.4.0 or later of
11470 this library, you need to set
11471 .code
11472 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11473 .endd
11474 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11475 &%libradius%& library that comes with FreeBSD. To do this, set
11476 .code
11477 RADIUS_LIB_TYPE=RADLIB
11478 .endd
11479 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11480 You may also have to supply a suitable setting in EXTRALIBS so that the
11481 Radius library can be found when Exim is linked.
11482
11483 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11484 Radius client library, which calls the Radius server. The condition is true if
11485 the authentication is successful. For example:
11486 .code
11487 server_condition = ${if radius{<arguments>}}
11488 .endd
11489
11490
11491 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11492         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11493 .cindex "&'saslauthd'& daemon"
11494 .cindex "Cyrus"
11495 .cindex "expansion" "&'saslauthd'& authentication test"
11496 .cindex "&%saslauthd%& expansion condition"
11497 This condition supports user authentication using the Cyrus &'saslauthd'&
11498 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11499 Using this daemon is one way of making it possible for passwords to be checked
11500 by a process that is not running as root.
11501
11502 The saslauthd support is not included in Exim by default. You need to specify
11503 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11504 building Exim. For example:
11505 .code
11506 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11507 .endd
11508 You do not need to install the full Cyrus software suite in order to use
11509 the saslauthd daemon. You can compile and install just the daemon alone
11510 from the Cyrus SASL library.
11511
11512 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11513 two are mandatory. For example:
11514 .code
11515 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11516 .endd
11517 The service and the realm are optional (which is why the arguments are enclosed
11518 in their own set of braces). For details of the meaning of the service and
11519 realm, and how to run the daemon, consult the Cyrus documentation.
11520 .endlist vlist
11521
11522
11523
11524 .section "Combining expansion conditions" "SECID84"
11525 .cindex "expansion" "combining conditions"
11526 Several conditions can be tested at once by combining them using the &%and%&
11527 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11528 conditions on their own, and precede their lists of sub-conditions. Each
11529 sub-condition must be enclosed in braces within the overall braces that contain
11530 the list. No repetition of &%if%& is used.
11531
11532
11533 .vlist
11534 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11535 .cindex "&""or""& expansion condition"
11536 .cindex "expansion" "&""or""& of conditions"
11537 The sub-conditions are evaluated from left to right. The condition is true if
11538 any one of the sub-conditions is true.
11539 For example,
11540 .code
11541 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11542 .endd
11543 When a true sub-condition is found, the following ones are parsed but not
11544 evaluated. If there are several &"match"& sub-conditions the values of the
11545 numeric variables afterwards are taken from the first one that succeeds.
11546
11547 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11548 .cindex "&""and""& expansion condition"
11549 .cindex "expansion" "&""and""& of conditions"
11550 The sub-conditions are evaluated from left to right. The condition is true if
11551 all of the sub-conditions are true. If there are several &"match"&
11552 sub-conditions, the values of the numeric variables afterwards are taken from
11553 the last one. When a false sub-condition is found, the following ones are
11554 parsed but not evaluated.
11555 .endlist
11556 .ecindex IIDexpcond
11557
11558
11559
11560
11561 .section "Expansion variables" "SECTexpvar"
11562 .cindex "expansion" "variables, list of"
11563 This section contains an alphabetical list of all the expansion variables. Some
11564 of them are available only when Exim is compiled with specific options such as
11565 support for TLS or the content scanning extension.
11566
11567 .vlist
11568 .vitem "&$0$&, &$1$&, etc"
11569 .cindex "numerical variables (&$1$& &$2$& etc)"
11570 When a &%match%& expansion condition succeeds, these variables contain the
11571 captured substrings identified by the regular expression during subsequent
11572 processing of the success string of the containing &%if%& expansion item.
11573 In the expansion condition case
11574 they do not retain their values afterwards; in fact, their previous
11575 values are restored at the end of processing an &%if%& item. The numerical
11576 variables may also be set externally by some other matching process which
11577 precedes the expansion of the string. For example, the commands available in
11578 Exim filter files include an &%if%& command with its own regular expression
11579 matching condition.
11580
11581 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11582 Within an acl condition, expansion condition or expansion item
11583 any arguments are copied to these variables,
11584 any unused variables being made empty.
11585
11586 .vitem "&$acl_c...$&"
11587 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11588 can be given any name that starts with &$acl_c$& and is at least six characters
11589 long, but the sixth character must be either a digit or an underscore. For
11590 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11591 variables persist throughout the lifetime of an SMTP connection. They can be
11592 used to pass information between ACLs and between different invocations of the
11593 same ACL. When a message is received, the values of these variables are saved
11594 with the message, and can be accessed by filters, routers, and transports
11595 during subsequent delivery.
11596
11597 .vitem "&$acl_m...$&"
11598 These variables are like the &$acl_c...$& variables, except that their values
11599 are reset after a message has been received. Thus, if several messages are
11600 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11601 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11602 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11603 message is received, the values of these variables are saved with the message,
11604 and can be accessed by filters, routers, and transports during subsequent
11605 delivery.
11606
11607 .vitem &$acl_narg$&
11608 Within an acl condition, expansion condition or expansion item
11609 this variable has the number of arguments.
11610
11611 .vitem &$acl_verify_message$&
11612 .vindex "&$acl_verify_message$&"
11613 After an address verification has failed, this variable contains the failure
11614 message. It retains its value for use in subsequent modifiers. The message can
11615 be preserved by coding like this:
11616 .code
11617 warn !verify = sender
11618      set acl_m0 = $acl_verify_message
11619 .endd
11620 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11621 &%log_message%& modifiers, to include information about the verification
11622 failure.
11623
11624 .vitem &$address_data$&
11625 .vindex "&$address_data$&"
11626 This variable is set by means of the &%address_data%& option in routers. The
11627 value then remains with the address while it is processed by subsequent routers
11628 and eventually a transport. If the transport is handling multiple addresses,
11629 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11630 for more details. &*Note*&: The contents of &$address_data$& are visible in
11631 user filter files.
11632
11633 If &$address_data$& is set when the routers are called from an ACL to verify
11634 a recipient address, the final value is still in the variable for subsequent
11635 conditions and modifiers of the ACL statement. If routing the address caused it
11636 to be redirected to just one address, the child address is also routed as part
11637 of the verification, and in this case the final value of &$address_data$& is
11638 from the child's routing.
11639
11640 If &$address_data$& is set when the routers are called from an ACL to verify a
11641 sender address, the final value is also preserved, but this time in
11642 &$sender_address_data$&, to distinguish it from data from a recipient
11643 address.
11644
11645 In both cases (recipient and sender verification), the value does not persist
11646 after the end of the current ACL statement. If you want to preserve
11647 these values for longer, you can save them in ACL variables.
11648
11649 .vitem &$address_file$&
11650 .vindex "&$address_file$&"
11651 When, as a result of aliasing, forwarding, or filtering, a message is directed
11652 to a specific file, this variable holds the name of the file when the transport
11653 is running. At other times, the variable is empty. For example, using the
11654 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11655 .code
11656 /home/r2d2/savemail
11657 .endd
11658 then when the &(address_file)& transport is running, &$address_file$&
11659 contains the text string &`/home/r2d2/savemail`&.
11660 .cindex "Sieve filter" "value of &$address_file$&"
11661 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11662 then up to the transport configuration to generate an appropriate absolute path
11663 to the relevant file.
11664
11665 .vitem &$address_pipe$&
11666 .vindex "&$address_pipe$&"
11667 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11668 this variable holds the pipe command when the transport is running.
11669
11670 .vitem "&$auth1$& &-- &$auth3$&"
11671 .vindex "&$auth1$&, &$auth2$&, etc"
11672 These variables are used in SMTP authenticators (see chapters
11673 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11674
11675 .vitem &$authenticated_id$&
11676 .cindex "authentication" "id"
11677 .vindex "&$authenticated_id$&"
11678 When a server successfully authenticates a client it may be configured to
11679 preserve some of the authentication information in the variable
11680 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11681 user/password authenticator configuration might preserve the user name for use
11682 in the routers. Note that this is not the same information that is saved in
11683 &$sender_host_authenticated$&.
11684
11685 When a message is submitted locally (that is, not over a TCP connection)
11686 the value of &$authenticated_id$& is normally the login name of the calling
11687 process. However, a trusted user can override this by means of the &%-oMai%&
11688 command line option.
11689 This second case also sets up inforamtion used by the
11690 &$authresults$& expansion item.
11691
11692 .vitem &$authenticated_fail_id$&
11693 .cindex "authentication" "fail" "id"
11694 .vindex "&$authenticated_fail_id$&"
11695 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11696 will contain the failed authentication id. If more than one authentication
11697 id is attempted, it will contain only the last one. The variable is
11698 available for processing in the ACL's, generally the quit or notquit ACL.
11699 A message to a local recipient could still be accepted without requiring
11700 authentication, which means this variable could also be visible in all of
11701 the ACL's as well.
11702
11703
11704 .vitem &$authenticated_sender$&
11705 .cindex "sender" "authenticated"
11706 .cindex "authentication" "sender"
11707 .cindex "AUTH" "on MAIL command"
11708 .vindex "&$authenticated_sender$&"
11709 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11710 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11711 described in section &<<SECTauthparamail>>&. Unless the data is the string
11712 &"<>"&, it is set as the authenticated sender of the message, and the value is
11713 available during delivery in the &$authenticated_sender$& variable. If the
11714 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11715
11716 .vindex "&$qualify_domain$&"
11717 When a message is submitted locally (that is, not over a TCP connection), the
11718 value of &$authenticated_sender$& is an address constructed from the login
11719 name of the calling process and &$qualify_domain$&, except that a trusted user
11720 can override this by means of the &%-oMas%& command line option.
11721
11722
11723 .vitem &$authentication_failed$&
11724 .cindex "authentication" "failure"
11725 .vindex "&$authentication_failed$&"
11726 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11727 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11728 possible to distinguish between &"did not try to authenticate"&
11729 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11730 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11731 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11732 negative response to an AUTH command, including (for example) an attempt to use
11733 an undefined mechanism.
11734
11735 .vitem &$av_failed$&
11736 .cindex "content scanning" "AV scanner failure"
11737 This variable is available when Exim is compiled with the content-scanning
11738 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11739 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11740 the ACL malware condition.
11741
11742 .vitem &$body_linecount$&
11743 .cindex "message body" "line count"
11744 .cindex "body of message" "line count"
11745 .vindex "&$body_linecount$&"
11746 When a message is being received or delivered, this variable contains the
11747 number of lines in the message's body. See also &$message_linecount$&.
11748
11749 .vitem &$body_zerocount$&
11750 .cindex "message body" "binary zero count"
11751 .cindex "body of message" "binary zero count"
11752 .cindex "binary zero" "in message body"
11753 .vindex "&$body_zerocount$&"
11754 When a message is being received or delivered, this variable contains the
11755 number of binary zero bytes (ASCII NULs) in the message's body.
11756
11757 .vitem &$bounce_recipient$&
11758 .vindex "&$bounce_recipient$&"
11759 This is set to the recipient address of a bounce message while Exim is creating
11760 it. It is useful if a customized bounce message text file is in use (see
11761 chapter &<<CHAPemsgcust>>&).
11762
11763 .vitem &$bounce_return_size_limit$&
11764 .vindex "&$bounce_return_size_limit$&"
11765 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11766 up to a multiple of 1000. It is useful when a customized error message text
11767 file is in use (see chapter &<<CHAPemsgcust>>&).
11768
11769 .vitem &$caller_gid$&
11770 .cindex "gid (group id)" "caller"
11771 .vindex "&$caller_gid$&"
11772 The real group id under which the process that called Exim was running. This is
11773 not the same as the group id of the originator of a message (see
11774 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11775 incarnation normally contains the Exim gid.
11776
11777 .vitem &$caller_uid$&
11778 .cindex "uid (user id)" "caller"
11779 .vindex "&$caller_uid$&"
11780 The real user id under which the process that called Exim was running. This is
11781 not the same as the user id of the originator of a message (see
11782 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11783 incarnation normally contains the Exim uid.
11784
11785 .vitem &$callout_address$&
11786 .vindex "&$callout_address$&"
11787 After a callout for verification, spamd or malware daemon service, the
11788 address that was connected to.
11789
11790 .vitem &$compile_number$&
11791 .vindex "&$compile_number$&"
11792 The building process for Exim keeps a count of the number
11793 of times it has been compiled. This serves to distinguish different
11794 compilations of the same version of the program.
11795
11796 .vitem &$config_dir$&
11797 .vindex "&$config_dir$&"
11798 The directory name of the main configuration file. That is, the content of
11799 &$config_file$& with the last component stripped. The value does not
11800 contain the trailing slash. If &$config_file$& does not contain a slash,
11801 &$config_dir$& is ".".
11802
11803 .vitem &$config_file$&
11804 .vindex "&$config_file$&"
11805 The name of the main configuration file Exim is using.
11806
11807 .vitem &$dkim_verify_status$&
11808 Results of DKIM verification.
11809 For details see section &<<SECDKIMVFY>>&.
11810
11811 .vitem &$dkim_cur_signer$& &&&
11812        &$dkim_verify_reason$& &&&
11813        &$dkim_domain$& &&&
11814        &$dkim_identity$& &&&
11815        &$dkim_selector$& &&&
11816        &$dkim_algo$& &&&
11817        &$dkim_canon_body$& &&&
11818        &$dkim_canon_headers$& &&&
11819        &$dkim_copiedheaders$& &&&
11820        &$dkim_bodylength$& &&&
11821        &$dkim_created$& &&&
11822        &$dkim_expires$& &&&
11823        &$dkim_headernames$& &&&
11824        &$dkim_key_testing$& &&&
11825        &$dkim_key_nosubdomains$& &&&
11826        &$dkim_key_srvtype$& &&&
11827        &$dkim_key_granularity$& &&&
11828        &$dkim_key_notes$& &&&
11829        &$dkim_key_length$&
11830 These variables are only available within the DKIM ACL.
11831 For details see section &<<SECDKIMVFY>>&.
11832
11833 .vitem &$dkim_signers$&
11834 .vindex &$dkim_signers$&
11835 When a message has been received this variable contains
11836 a colon-separated list of signer domains and identities for the message.
11837 For details see section &<<SECDKIMVFY>>&.
11838
11839 .vitem &$dnslist_domain$& &&&
11840        &$dnslist_matched$& &&&
11841        &$dnslist_text$& &&&
11842        &$dnslist_value$&
11843 .vindex "&$dnslist_domain$&"
11844 .vindex "&$dnslist_matched$&"
11845 .vindex "&$dnslist_text$&"
11846 .vindex "&$dnslist_value$&"
11847 .cindex "black list (DNS)"
11848 When a DNS (black) list lookup succeeds, these variables are set to contain
11849 the following data from the lookup: the list's domain name, the key that was
11850 looked up, the contents of any associated TXT record, and the value from the
11851 main A record. See section &<<SECID204>>& for more details.
11852
11853 .vitem &$domain$&
11854 .vindex "&$domain$&"
11855 When an address is being routed, or delivered on its own, this variable
11856 contains the domain. Uppercase letters in the domain are converted into lower
11857 case for &$domain$&.
11858
11859 Global address rewriting happens when a message is received, so the value of
11860 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11861 is set during user filtering, but not during system filtering, because a
11862 message may have many recipients and the system filter is called just once.
11863
11864 When more than one address is being delivered at once (for example, several
11865 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11866 have the same domain. Transports can be restricted to handling only one domain
11867 at a time if the value of &$domain$& is required at transport time &-- this is
11868 the default for local transports. For further details of the environment in
11869 which local transports are run, see chapter &<<CHAPenvironment>>&.
11870
11871 .oindex "&%delay_warning_condition%&"
11872 At the end of a delivery, if all deferred addresses have the same domain, it is
11873 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11874
11875 The &$domain$& variable is also used in some other circumstances:
11876
11877 .ilist
11878 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11879 the recipient address. The domain of the &'sender'& address is in
11880 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11881 normally set during the running of the MAIL ACL. However, if the sender address
11882 is verified with a callout during the MAIL ACL, the sender domain is placed in
11883 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11884 the &(smtp)& transport.
11885
11886 .next
11887 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11888 &$domain$& contains the domain portion of the address that is being rewritten;
11889 it can be used in the expansion of the replacement address, for example, to
11890 rewrite domains by file lookup.
11891
11892 .next
11893 With one important exception, whenever a domain list is being scanned,
11894 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11895 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11896 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11897 that, in a RCPT ACL, the sender domain list can be dependent on the
11898 recipient domain (which is what is in &$domain$& at this time).
11899
11900 .next
11901 .cindex "ETRN" "value of &$domain$&"
11902 .oindex "&%smtp_etrn_command%&"
11903 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11904 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11905 .endlist
11906
11907
11908 .vitem &$domain_data$&
11909 .vindex "&$domain_data$&"
11910 When the &%domains%& option on a router matches a domain by
11911 means of a lookup, the data read by the lookup is available during the running
11912 of the router as &$domain_data$&. In addition, if the driver routes the
11913 address to a transport, the value is available in that transport. If the
11914 transport is handling multiple addresses, the value from the first address is
11915 used.
11916
11917 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11918 domain by means of a lookup. The data read by the lookup is available during
11919 the rest of the ACL statement. In all other situations, this variable expands
11920 to nothing.
11921
11922 .vitem &$exim_gid$&
11923 .vindex "&$exim_gid$&"
11924 This variable contains the numerical value of the Exim group id.
11925
11926 .vitem &$exim_path$&
11927 .vindex "&$exim_path$&"
11928 This variable contains the path to the Exim binary.
11929
11930 .vitem &$exim_uid$&
11931 .vindex "&$exim_uid$&"
11932 This variable contains the numerical value of the Exim user id.
11933
11934 .vitem &$exim_version$&
11935 .vindex "&$exim_version$&"
11936 This variable contains the version string of the Exim build.
11937 The first character is a major version number, currently 4.
11938 Then after a dot, the next group of digits is a minor version number.
11939 There may be other characters following the minor version.
11940
11941 .vitem &$header_$&<&'name'&>
11942 This is not strictly an expansion variable. It is expansion syntax for
11943 inserting the message header line with the given name. Note that the name must
11944 be terminated by colon or white space, because it may contain a wide variety of
11945 characters. Note also that braces must &'not'& be used.
11946
11947 .vitem &$headers_added$&
11948 .vindex "&$headers_added$&"
11949 Within an ACL this variable contains the headers added so far by
11950 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11951 The headers are a newline-separated list.
11952
11953 .vitem &$home$&
11954 .vindex "&$home$&"
11955 When the &%check_local_user%& option is set for a router, the user's home
11956 directory is placed in &$home$& when the check succeeds. In particular, this
11957 means it is set during the running of users' filter files. A router may also
11958 explicitly set a home directory for use by a transport; this can be overridden
11959 by a setting on the transport itself.
11960
11961 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11962 of the environment variable HOME, which is subject to the
11963 &%keep_environment%& and &%add_environment%& main config options.
11964
11965 .vitem &$host$&
11966 .vindex "&$host$&"
11967 If a router assigns an address to a transport (any transport), and passes a
11968 list of hosts with the address, the value of &$host$& when the transport starts
11969 to run is the name of the first host on the list. Note that this applies both
11970 to local and remote transports.
11971
11972 .cindex "transport" "filter"
11973 .cindex "filter" "transport filter"
11974 For the &(smtp)& transport, if there is more than one host, the value of
11975 &$host$& changes as the transport works its way through the list. In
11976 particular, when the &(smtp)& transport is expanding its options for encryption
11977 using TLS, or for specifying a transport filter (see chapter
11978 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11979 is connected.
11980
11981 When used in the client part of an authenticator configuration (see chapter
11982 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11983 client is connected.
11984
11985
11986 .vitem &$host_address$&
11987 .vindex "&$host_address$&"
11988 This variable is set to the remote host's IP address whenever &$host$& is set
11989 for a remote connection. It is also set to the IP address that is being checked
11990 when the &%ignore_target_hosts%& option is being processed.
11991
11992 .vitem &$host_data$&
11993 .vindex "&$host_data$&"
11994 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11995 result of the lookup is made available in the &$host_data$& variable. This
11996 allows you, for example, to do things like this:
11997 .code
11998 deny  hosts = net-lsearch;/some/file
11999 message = $host_data
12000 .endd
12001 .vitem &$host_lookup_deferred$&
12002 .cindex "host name" "lookup, failure of"
12003 .vindex "&$host_lookup_deferred$&"
12004 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12005 message comes from a remote host and there is an attempt to look up the host's
12006 name from its IP address, and the attempt is not successful, one of these
12007 variables is set to &"1"&.
12008
12009 .ilist
12010 If the lookup receives a definite negative response (for example, a DNS lookup
12011 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12012
12013 .next
12014 If there is any kind of problem during the lookup, such that Exim cannot
12015 tell whether or not the host name is defined (for example, a timeout for a DNS
12016 lookup), &$host_lookup_deferred$& is set to &"1"&.
12017 .endlist ilist
12018
12019 Looking up a host's name from its IP address consists of more than just a
12020 single reverse lookup. Exim checks that a forward lookup of at least one of the
12021 names it receives from a reverse lookup yields the original IP address. If this
12022 is not the case, Exim does not accept the looked up name(s), and
12023 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12024 IP address (for example, the existence of a PTR record in the DNS) is not
12025 sufficient on its own for the success of a host name lookup. If the reverse
12026 lookup succeeds, but there is a lookup problem such as a timeout when checking
12027 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12028 &"1"&. See also &$sender_host_name$&.
12029
12030 .cindex authentication "expansion item"
12031 Performing these checks sets up information used by the
12032 &$authresults$& expansion item.
12033
12034
12035 .vitem &$host_lookup_failed$&
12036 .vindex "&$host_lookup_failed$&"
12037 See &$host_lookup_deferred$&.
12038
12039 .vitem &$host_port$&
12040 .vindex "&$host_port$&"
12041 This variable is set to the remote host's TCP port whenever &$host$& is set
12042 for an outbound connection.
12043
12044 .vitem &$initial_cwd$&
12045 .vindex "&$initial_cwd$&
12046 This variable contains the full path name of the initial working
12047 directory of the current Exim process. This may differ from the current
12048 working directory, as Exim changes this to "/" during early startup, and
12049 to &$spool_directory$& later.
12050
12051 .vitem &$inode$&
12052 .vindex "&$inode$&"
12053 The only time this variable is set is while expanding the &%directory_file%&
12054 option in the &(appendfile)& transport. The variable contains the inode number
12055 of the temporary file which is about to be renamed. It can be used to construct
12056 a unique name for the file.
12057
12058 .vitem &$interface_address$&
12059 .vindex "&$interface_address$&"
12060 This is an obsolete name for &$received_ip_address$&.
12061
12062 .vitem &$interface_port$&
12063 .vindex "&$interface_port$&"
12064 This is an obsolete name for &$received_port$&.
12065
12066 .vitem &$item$&
12067 .vindex "&$item$&"
12068 This variable is used during the expansion of &*forall*& and &*forany*&
12069 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12070 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12071 empty.
12072
12073 .vitem &$ldap_dn$&
12074 .vindex "&$ldap_dn$&"
12075 This variable, which is available only when Exim is compiled with LDAP support,
12076 contains the DN from the last entry in the most recently successful LDAP
12077 lookup.
12078
12079 .vitem &$load_average$&
12080 .vindex "&$load_average$&"
12081 This variable contains the system load average, multiplied by 1000 so that it
12082 is an integer. For example, if the load average is 0.21, the value of the
12083 variable is 210. The value is recomputed every time the variable is referenced.
12084
12085 .vitem &$local_part$&
12086 .vindex "&$local_part$&"
12087 When an address is being routed, or delivered on its own, this
12088 variable contains the local part. When a number of addresses are being
12089 delivered together (for example, multiple RCPT commands in an SMTP
12090 session), &$local_part$& is not set.
12091
12092 Global address rewriting happens when a message is received, so the value of
12093 &$local_part$& during routing and delivery is the value after rewriting.
12094 &$local_part$& is set during user filtering, but not during system filtering,
12095 because a message may have many recipients and the system filter is called just
12096 once.
12097
12098 .vindex "&$local_part_prefix$&"
12099 .vindex "&$local_part_suffix$&"
12100 If a local part prefix or suffix has been recognized, it is not included in the
12101 value of &$local_part$& during routing and subsequent delivery. The values of
12102 any prefix or suffix are in &$local_part_prefix$& and
12103 &$local_part_suffix$&, respectively.
12104
12105 When a message is being delivered to a file, pipe, or autoreply transport as a
12106 result of aliasing or forwarding, &$local_part$& is set to the local part of
12107 the parent address, not to the file name or command (see &$address_file$& and
12108 &$address_pipe$&).
12109
12110 When an ACL is running for a RCPT command, &$local_part$& contains the
12111 local part of the recipient address.
12112
12113 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12114 &$local_part$& contains the local part of the address that is being rewritten;
12115 it can be used in the expansion of the replacement address, for example.
12116
12117 In all cases, all quoting is removed from the local part. For example, for both
12118 the addresses
12119 .code
12120 "abc:xyz"@test.example
12121 abc\:xyz@test.example
12122 .endd
12123 the value of &$local_part$& is
12124 .code
12125 abc:xyz
12126 .endd
12127 If you use &$local_part$& to create another address, you should always wrap it
12128 inside a quoting operator. For example, in a &(redirect)& router you could
12129 have:
12130 .code
12131 data = ${quote_local_part:$local_part}@new.domain.example
12132 .endd
12133 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12134 to process local parts in a case-dependent manner in a router, you can set the
12135 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12136
12137 .vitem &$local_part_data$&
12138 .vindex "&$local_part_data$&"
12139 When the &%local_parts%& option on a router matches a local part by means of a
12140 lookup, the data read by the lookup is available during the running of the
12141 router as &$local_part_data$&. In addition, if the driver routes the address
12142 to a transport, the value is available in that transport. If the transport is
12143 handling multiple addresses, the value from the first address is used.
12144
12145 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12146 matches a local part by means of a lookup. The data read by the lookup is
12147 available during the rest of the ACL statement. In all other situations, this
12148 variable expands to nothing.
12149
12150 .vitem &$local_part_prefix$&
12151 .vindex "&$local_part_prefix$&"
12152 When an address is being routed or delivered, and a
12153 specific prefix for the local part was recognized, it is available in this
12154 variable, having been removed from &$local_part$&.
12155
12156 .vitem &$local_part_suffix$&
12157 .vindex "&$local_part_suffix$&"
12158 When an address is being routed or delivered, and a
12159 specific suffix for the local part was recognized, it is available in this
12160 variable, having been removed from &$local_part$&.
12161
12162 .vitem &$local_scan_data$&
12163 .vindex "&$local_scan_data$&"
12164 This variable contains the text returned by the &[local_scan()]& function when
12165 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12166
12167 .vitem &$local_user_gid$&
12168 .vindex "&$local_user_gid$&"
12169 See &$local_user_uid$&.
12170
12171 .vitem &$local_user_uid$&
12172 .vindex "&$local_user_uid$&"
12173 This variable and &$local_user_gid$& are set to the uid and gid after the
12174 &%check_local_user%& router precondition succeeds. This means that their values
12175 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12176 and &%condition%&), for the &%address_data%& expansion, and for any
12177 router-specific expansions. At all other times, the values in these variables
12178 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12179
12180 .vitem &$localhost_number$&
12181 .vindex "&$localhost_number$&"
12182 This contains the expanded value of the
12183 &%localhost_number%& option. The expansion happens after the main options have
12184 been read.
12185
12186 .vitem &$log_inodes$&
12187 .vindex "&$log_inodes$&"
12188 The number of free inodes in the disk partition where Exim's
12189 log files are being written. The value is recalculated whenever the variable is
12190 referenced. If the relevant file system does not have the concept of inodes,
12191 the value of is -1. See also the &%check_log_inodes%& option.
12192
12193 .vitem &$log_space$&
12194 .vindex "&$log_space$&"
12195 The amount of free space (as a number of kilobytes) in the disk
12196 partition where Exim's log files are being written. The value is recalculated
12197 whenever the variable is referenced. If the operating system does not have the
12198 ability to find the amount of free space (only true for experimental systems),
12199 the space value is -1. See also the &%check_log_space%& option.
12200
12201
12202 .vitem &$lookup_dnssec_authenticated$&
12203 .vindex "&$lookup_dnssec_authenticated$&"
12204 This variable is set after a DNS lookup done by
12205 a dnsdb lookup expansion, dnslookup router or smtp transport.
12206 .cindex "DNS" "DNSSEC"
12207 It will be empty if &(DNSSEC)& was not requested,
12208 &"no"& if the result was not labelled as authenticated data
12209 and &"yes"& if it was.
12210 Results that are labelled as authoritative answer that match
12211 the &%dns_trust_aa%& configuration variable count also
12212 as authenticated data.
12213
12214 .vitem &$mailstore_basename$&
12215 .vindex "&$mailstore_basename$&"
12216 This variable is set only when doing deliveries in &"mailstore"& format in the
12217 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12218 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12219 contains the basename of the files that are being written, that is, the name
12220 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12221 variable is empty.
12222
12223 .vitem &$malware_name$&
12224 .vindex "&$malware_name$&"
12225 This variable is available when Exim is compiled with the
12226 content-scanning extension. It is set to the name of the virus that was found
12227 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12228
12229 .vitem &$max_received_linelength$&
12230 .vindex "&$max_received_linelength$&"
12231 .cindex "maximum" "line length"
12232 .cindex "line length" "maximum"
12233 This variable contains the number of bytes in the longest line that was
12234 received as part of the message, not counting the line termination
12235 character(s).
12236 It is not valid if the &%spool_files_wireformat%& option is used.
12237
12238 .vitem &$message_age$&
12239 .cindex "message" "age of"
12240 .vindex "&$message_age$&"
12241 This variable is set at the start of a delivery attempt to contain the number
12242 of seconds since the message was received. It does not change during a single
12243 delivery attempt.
12244
12245 .vitem &$message_body$&
12246 .cindex "body of message" "expansion variable"
12247 .cindex "message body" "in expansion"
12248 .cindex "binary zero" "in message body"
12249 .vindex "&$message_body$&"
12250 .oindex "&%message_body_visible%&"
12251 This variable contains the initial portion of a message's body while it is
12252 being delivered, and is intended mainly for use in filter files. The maximum
12253 number of characters of the body that are put into the variable is set by the
12254 &%message_body_visible%& configuration option; the default is 500.
12255
12256 .oindex "&%message_body_newlines%&"
12257 By default, newlines are converted into spaces in &$message_body$&, to make it
12258 easier to search for phrases that might be split over a line break. However,
12259 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12260 zeros are always converted into spaces.
12261
12262 .vitem &$message_body_end$&
12263 .cindex "body of message" "expansion variable"
12264 .cindex "message body" "in expansion"
12265 .vindex "&$message_body_end$&"
12266 This variable contains the final portion of a message's
12267 body while it is being delivered. The format and maximum size are as for
12268 &$message_body$&.
12269
12270 .vitem &$message_body_size$&
12271 .cindex "body of message" "size"
12272 .cindex "message body" "size"
12273 .vindex "&$message_body_size$&"
12274 When a message is being delivered, this variable contains the size of the body
12275 in bytes. The count starts from the character after the blank line that
12276 separates the body from the header. Newlines are included in the count. See
12277 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12278
12279 If the spool file is wireformat
12280 (see the &%spool_files_wireformat%& main option)
12281 the CRLF line-terminators are included in the count.
12282
12283 .vitem &$message_exim_id$&
12284 .vindex "&$message_exim_id$&"
12285 When a message is being received or delivered, this variable contains the
12286 unique message id that is generated and used by Exim to identify the message.
12287 An id is not created for a message until after its header has been successfully
12288 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12289 line; it is the local id that Exim assigns to the message, for example:
12290 &`1BXTIK-0001yO-VA`&.
12291
12292 .vitem &$message_headers$&
12293 .vindex &$message_headers$&
12294 This variable contains a concatenation of all the header lines when a message
12295 is being processed, except for lines added by routers or transports. The header
12296 lines are separated by newline characters. Their contents are decoded in the
12297 same way as a header line that is inserted by &%bheader%&.
12298
12299 .vitem &$message_headers_raw$&
12300 .vindex &$message_headers_raw$&
12301 This variable is like &$message_headers$& except that no processing of the
12302 contents of header lines is done.
12303
12304 .vitem &$message_id$&
12305 This is an old name for &$message_exim_id$&. It is now deprecated.
12306
12307 .vitem &$message_linecount$&
12308 .vindex "&$message_linecount$&"
12309 This variable contains the total number of lines in the header and body of the
12310 message. Compare &$body_linecount$&, which is the count for the body only.
12311 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12312 number of lines received. Before delivery happens (that is, before filters,
12313 routers, and transports run) the count is increased to include the
12314 &'Received:'& header line that Exim standardly adds, and also any other header
12315 lines that are added by ACLs. The blank line that separates the message header
12316 from the body is not counted.
12317
12318 As with the special case of &$message_size$&, during the expansion of the
12319 appendfile transport's maildir_tag option in maildir format, the value of
12320 &$message_linecount$& is the precise size of the number of newlines in the
12321 file that has been written (minus one for the blank line between the
12322 header and the body).
12323
12324 Here is an example of the use of this variable in a DATA ACL:
12325 .code
12326 deny message   = Too many lines in message header
12327      condition = \
12328       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12329 .endd
12330 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12331 message has not yet been received.
12332
12333 This variable is not valid if the &%spool_files_wireformat%& option is used.
12334
12335 .vitem &$message_size$&
12336 .cindex "size" "of message"
12337 .cindex "message" "size"
12338 .vindex "&$message_size$&"
12339 When a message is being processed, this variable contains its size in bytes. In
12340 most cases, the size includes those headers that were received with the
12341 message, but not those (such as &'Envelope-to:'&) that are added to individual
12342 deliveries as they are written. However, there is one special case: during the
12343 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12344 doing a delivery in maildir format, the value of &$message_size$& is the
12345 precise size of the file that has been written. See also
12346 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12347
12348 .cindex "RCPT" "value of &$message_size$&"
12349 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12350 contains the size supplied on the MAIL command, or -1 if no size was given. The
12351 value may not, of course, be truthful.
12352
12353 .vitem &$mime_$&&'xxx'&
12354 A number of variables whose names start with &$mime$& are
12355 available when Exim is compiled with the content-scanning extension. For
12356 details, see section &<<SECTscanmimepart>>&.
12357
12358 .vitem "&$n0$& &-- &$n9$&"
12359 These variables are counters that can be incremented by means
12360 of the &%add%& command in filter files.
12361
12362 .vitem &$original_domain$&
12363 .vindex "&$domain$&"
12364 .vindex "&$original_domain$&"
12365 When a top-level address is being processed for delivery, this contains the
12366 same value as &$domain$&. However, if a &"child"& address (for example,
12367 generated by an alias, forward, or filter file) is being processed, this
12368 variable contains the domain of the original address (lower cased). This
12369 differs from &$parent_domain$& only when there is more than one level of
12370 aliasing or forwarding. When more than one address is being delivered in a
12371 single transport run, &$original_domain$& is not set.
12372
12373 If a new address is created by means of a &%deliver%& command in a system
12374 filter, it is set up with an artificial &"parent"& address. This has the local
12375 part &'system-filter'& and the default qualify domain.
12376
12377 .vitem &$original_local_part$&
12378 .vindex "&$local_part$&"
12379 .vindex "&$original_local_part$&"
12380 When a top-level address is being processed for delivery, this contains the
12381 same value as &$local_part$&, unless a prefix or suffix was removed from the
12382 local part, because &$original_local_part$& always contains the full local
12383 part. When a &"child"& address (for example, generated by an alias, forward, or
12384 filter file) is being processed, this variable contains the full local part of
12385 the original address.
12386
12387 If the router that did the redirection processed the local part
12388 case-insensitively, the value in &$original_local_part$& is in lower case.
12389 This variable differs from &$parent_local_part$& only when there is more than
12390 one level of aliasing or forwarding. When more than one address is being
12391 delivered in a single transport run, &$original_local_part$& is not set.
12392
12393 If a new address is created by means of a &%deliver%& command in a system
12394 filter, it is set up with an artificial &"parent"& address. This has the local
12395 part &'system-filter'& and the default qualify domain.
12396
12397 .vitem &$originator_gid$&
12398 .cindex "gid (group id)" "of originating user"
12399 .cindex "sender" "gid"
12400 .vindex "&$caller_gid$&"
12401 .vindex "&$originator_gid$&"
12402 This variable contains the value of &$caller_gid$& that was set when the
12403 message was received. For messages received via the command line, this is the
12404 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12405 normally the gid of the Exim user.
12406
12407 .vitem &$originator_uid$&
12408 .cindex "uid (user id)" "of originating user"
12409 .cindex "sender" "uid"
12410 .vindex "&$caller_uid$&"
12411 .vindex "&$originator_uid$&"
12412 The value of &$caller_uid$& that was set when the message was received. For
12413 messages received via the command line, this is the uid of the sending user.
12414 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12415 user.
12416
12417 .vitem &$parent_domain$&
12418 .vindex "&$parent_domain$&"
12419 This variable is similar to &$original_domain$& (see
12420 above), except that it refers to the immediately preceding parent address.
12421
12422 .vitem &$parent_local_part$&
12423 .vindex "&$parent_local_part$&"
12424 This variable is similar to &$original_local_part$&
12425 (see above), except that it refers to the immediately preceding parent address.
12426
12427 .vitem &$pid$&
12428 .cindex "pid (process id)" "of current process"
12429 .vindex "&$pid$&"
12430 This variable contains the current process id.
12431
12432 .vitem &$pipe_addresses$&
12433 .cindex "filter" "transport filter"
12434 .cindex "transport" "filter"
12435 .vindex "&$pipe_addresses$&"
12436 This is not an expansion variable, but is mentioned here because the string
12437 &`$pipe_addresses`& is handled specially in the command specification for the
12438 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12439 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12440 It cannot be used in general expansion strings, and provokes an &"unknown
12441 variable"& error if encountered.
12442
12443 .vitem &$primary_hostname$&
12444 .vindex "&$primary_hostname$&"
12445 This variable contains the value set by &%primary_hostname%& in the
12446 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12447 a single-component name, Exim calls &[gethostbyname()]& (or
12448 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12449 qualified host name. See also &$smtp_active_hostname$&.
12450
12451
12452 .vitem &$proxy_external_address$& &&&
12453        &$proxy_external_port$& &&&
12454        &$proxy_local_address$& &&&
12455        &$proxy_local_port$& &&&
12456        &$proxy_session$&
12457 These variables are only available when built with Proxy Protocol
12458 or SOCKS5 support.
12459 For details see chapter &<<SECTproxyInbound>>&.
12460
12461 .vitem &$prdr_requested$&
12462 .cindex "PRDR" "variable for"
12463 This variable is set to &"yes"& if PRDR was requested by the client for the
12464 current message, otherwise &"no"&.
12465
12466 .vitem &$prvscheck_address$&
12467 This variable is used in conjunction with the &%prvscheck%& expansion item,
12468 which is described in sections &<<SECTexpansionitems>>& and
12469 &<<SECTverifyPRVS>>&.
12470
12471 .vitem &$prvscheck_keynum$&
12472 This variable is used in conjunction with the &%prvscheck%& expansion item,
12473 which is described in sections &<<SECTexpansionitems>>& and
12474 &<<SECTverifyPRVS>>&.
12475
12476 .vitem &$prvscheck_result$&
12477 This variable is used in conjunction with the &%prvscheck%& expansion item,
12478 which is described in sections &<<SECTexpansionitems>>& and
12479 &<<SECTverifyPRVS>>&.
12480
12481 .vitem &$qualify_domain$&
12482 .vindex "&$qualify_domain$&"
12483 The value set for the &%qualify_domain%& option in the configuration file.
12484
12485 .vitem &$qualify_recipient$&
12486 .vindex "&$qualify_recipient$&"
12487 The value set for the &%qualify_recipient%& option in the configuration file,
12488 or if not set, the value of &$qualify_domain$&.
12489
12490 .vitem &$queue_name$&
12491 .vindex &$queue_name$&
12492 .cindex "named queues"
12493 .cindex queues named
12494 The name of the spool queue in use; empty for the default queue.
12495
12496 .vitem &$rcpt_count$&
12497 .vindex "&$rcpt_count$&"
12498 When a message is being received by SMTP, this variable contains the number of
12499 RCPT commands received for the current message. If this variable is used in a
12500 RCPT ACL, its value includes the current command.
12501
12502 .vitem &$rcpt_defer_count$&
12503 .vindex "&$rcpt_defer_count$&"
12504 .cindex "4&'xx'& responses" "count of"
12505 When a message is being received by SMTP, this variable contains the number of
12506 RCPT commands in the current message that have previously been rejected with a
12507 temporary (4&'xx'&) response.
12508
12509 .vitem &$rcpt_fail_count$&
12510 .vindex "&$rcpt_fail_count$&"
12511 When a message is being received by SMTP, this variable contains the number of
12512 RCPT commands in the current message that have previously been rejected with a
12513 permanent (5&'xx'&) response.
12514
12515 .vitem &$received_count$&
12516 .vindex "&$received_count$&"
12517 This variable contains the number of &'Received:'& header lines in the message,
12518 including the one added by Exim (so its value is always greater than zero). It
12519 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12520 delivering.
12521
12522 .vitem &$received_for$&
12523 .vindex "&$received_for$&"
12524 If there is only a single recipient address in an incoming message, this
12525 variable contains that address when the &'Received:'& header line is being
12526 built. The value is copied after recipient rewriting has happened, but before
12527 the &[local_scan()]& function is run.
12528
12529 .vitem &$received_ip_address$&
12530 .vindex "&$received_ip_address$&"
12531 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12532 variable is set to the address of the local IP interface, and &$received_port$&
12533 is set to the local port number. (The remote IP address and port are in
12534 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12535 the port value is -1 unless it has been set using the &%-oMi%& command line
12536 option.
12537
12538 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12539 could be used, for example, to make the file name for a TLS certificate depend
12540 on which interface and/or port is being used for the incoming connection. The
12541 values of &$received_ip_address$& and &$received_port$& are saved with any
12542 messages that are received, thus making these variables available at delivery
12543 time.
12544 For outbound connections see &$sending_ip_address$&.
12545
12546 .vitem &$received_port$&
12547 .vindex "&$received_port$&"
12548 See &$received_ip_address$&.
12549
12550 .vitem &$received_protocol$&
12551 .vindex "&$received_protocol$&"
12552 When a message is being processed, this variable contains the name of the
12553 protocol by which it was received. Most of the names used by Exim are defined
12554 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12555 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12556 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12557 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12558 connection and the client was successfully authenticated.
12559
12560 Exim uses the protocol name &"smtps"& for the case when encryption is
12561 automatically set up on connection without the use of STARTTLS (see
12562 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12563 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12564 where the client initially uses EHLO, sets up an encrypted connection using
12565 STARTTLS, and then uses HELO afterwards.
12566
12567 The &%-oMr%& option provides a way of specifying a custom protocol name for
12568 messages that are injected locally by trusted callers. This is commonly used to
12569 identify messages that are being re-injected after some kind of scanning.
12570
12571 .vitem &$received_time$&
12572 .vindex "&$received_time$&"
12573 This variable contains the date and time when the current message was received,
12574 as a number of seconds since the start of the Unix epoch.
12575
12576 .vitem &$recipient_data$&
12577 .vindex "&$recipient_data$&"
12578 This variable is set after an indexing lookup success in an ACL &%recipients%&
12579 condition. It contains the data from the lookup, and the value remains set
12580 until the next &%recipients%& test. Thus, you can do things like this:
12581 .display
12582 &`require recipients  = cdb*@;/some/file`&
12583 &`deny    `&&'some further test involving'& &`$recipient_data`&
12584 .endd
12585 &*Warning*&: This variable is set only when a lookup is used as an indexing
12586 method in the address list, using the semicolon syntax as in the example above.
12587 The variable is not set for a lookup that is used as part of the string
12588 expansion that all such lists undergo before being interpreted.
12589
12590 .vitem &$recipient_verify_failure$&
12591 .vindex "&$recipient_verify_failure$&"
12592 In an ACL, when a recipient verification fails, this variable contains
12593 information about the failure. It is set to one of the following words:
12594
12595 .ilist
12596 &"qualify"&: The address was unqualified (no domain), and the message
12597 was neither local nor came from an exempted host.
12598
12599 .next
12600 &"route"&: Routing failed.
12601
12602 .next
12603 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12604 or before the MAIL command (that is, on initial connection, HELO, or
12605 MAIL).
12606
12607 .next
12608 &"recipient"&: The RCPT command in a callout was rejected.
12609 .next
12610
12611 &"postmaster"&: The postmaster check in a callout was rejected.
12612 .endlist
12613
12614 The main use of this variable is expected to be to distinguish between
12615 rejections of MAIL and rejections of RCPT.
12616
12617 .vitem &$recipients$&
12618 .vindex "&$recipients$&"
12619 This variable contains a list of envelope recipients for a message. A comma and
12620 a space separate the addresses in the replacement text. However, the variable
12621 is not generally available, to prevent exposure of Bcc recipients in
12622 unprivileged users' filter files. You can use &$recipients$& only in these
12623 cases:
12624
12625 .olist
12626 In a system filter file.
12627 .next
12628 In the ACLs associated with the DATA command and with non-SMTP messages, that
12629 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12630 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12631 &%acl_not_smtp_mime%&.
12632 .next
12633 From within a &[local_scan()]& function.
12634 .endlist
12635
12636
12637 .vitem &$recipients_count$&
12638 .vindex "&$recipients_count$&"
12639 When a message is being processed, this variable contains the number of
12640 envelope recipients that came with the message. Duplicates are not excluded
12641 from the count. While a message is being received over SMTP, the number
12642 increases for each accepted recipient. It can be referenced in an ACL.
12643
12644
12645 .vitem &$regex_match_string$&
12646 .vindex "&$regex_match_string$&"
12647 This variable is set to contain the matching regular expression after a
12648 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12649
12650 .vitem "&$regex1$&, &$regex2$&, etc"
12651 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12652 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12653 these variables contain the
12654 captured substrings identified by the regular expression.
12655
12656
12657 .vitem &$reply_address$&
12658 .vindex "&$reply_address$&"
12659 When a message is being processed, this variable contains the contents of the
12660 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12661 contents of the &'From:'& header line. Apart from the removal of leading
12662 white space, the value is not processed in any way. In particular, no RFC 2047
12663 decoding or character code translation takes place.
12664
12665 .vitem &$return_path$&
12666 .vindex "&$return_path$&"
12667 When a message is being delivered, this variable contains the return path &--
12668 the sender field that will be sent as part of the envelope. It is not enclosed
12669 in <> characters. At the start of routing an address, &$return_path$& has the
12670 same value as &$sender_address$&, but if, for example, an incoming message to a
12671 mailing list has been expanded by a router which specifies a different address
12672 for bounce messages, &$return_path$& subsequently contains the new bounce
12673 address, whereas &$sender_address$& always contains the original sender address
12674 that was received with the message. In other words, &$sender_address$& contains
12675 the incoming envelope sender, and &$return_path$& contains the outgoing
12676 envelope sender.
12677
12678 .vitem &$return_size_limit$&
12679 .vindex "&$return_size_limit$&"
12680 This is an obsolete name for &$bounce_return_size_limit$&.
12681
12682 .vitem &$router_name$&
12683 .cindex "router" "name"
12684 .cindex "name" "of router"
12685 .vindex "&$router_name$&"
12686 During the running of a router this variable contains its name.
12687
12688 .vitem &$runrc$&
12689 .cindex "return code" "from &%run%& expansion"
12690 .vindex "&$runrc$&"
12691 This variable contains the return code from a command that is run by the
12692 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12693 assume the order in which option values are expanded, except for those
12694 preconditions whose order of testing is documented. Therefore, you cannot
12695 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12696 another.
12697
12698 .vitem &$self_hostname$&
12699 .oindex "&%self%&" "value of host name"
12700 .vindex "&$self_hostname$&"
12701 When an address is routed to a supposedly remote host that turns out to be the
12702 local host, what happens is controlled by the &%self%& generic router option.
12703 One of its values causes the address to be passed to another router. When this
12704 happens, &$self_hostname$& is set to the name of the local host that the
12705 original router encountered. In other circumstances its contents are null.
12706
12707 .vitem &$sender_address$&
12708 .vindex "&$sender_address$&"
12709 When a message is being processed, this variable contains the sender's address
12710 that was received in the message's envelope. The case of letters in the address
12711 is retained, in both the local part and the domain. For bounce messages, the
12712 value of this variable is the empty string. See also &$return_path$&.
12713
12714 .vitem &$sender_address_data$&
12715 .vindex "&$address_data$&"
12716 .vindex "&$sender_address_data$&"
12717 If &$address_data$& is set when the routers are called from an ACL to verify a
12718 sender address, the final value is preserved in &$sender_address_data$&, to
12719 distinguish it from data from a recipient address. The value does not persist
12720 after the end of the current ACL statement. If you want to preserve it for
12721 longer, you can save it in an ACL variable.
12722
12723 .vitem &$sender_address_domain$&
12724 .vindex "&$sender_address_domain$&"
12725 The domain portion of &$sender_address$&.
12726
12727 .vitem &$sender_address_local_part$&
12728 .vindex "&$sender_address_local_part$&"
12729 The local part portion of &$sender_address$&.
12730
12731 .vitem &$sender_data$&
12732 .vindex "&$sender_data$&"
12733 This variable is set after a lookup success in an ACL &%senders%& condition or
12734 in a router &%senders%& option. It contains the data from the lookup, and the
12735 value remains set until the next &%senders%& test. Thus, you can do things like
12736 this:
12737 .display
12738 &`require senders      = cdb*@;/some/file`&
12739 &`deny    `&&'some further test involving'& &`$sender_data`&
12740 .endd
12741 &*Warning*&: This variable is set only when a lookup is used as an indexing
12742 method in the address list, using the semicolon syntax as in the example above.
12743 The variable is not set for a lookup that is used as part of the string
12744 expansion that all such lists undergo before being interpreted.
12745
12746 .vitem &$sender_fullhost$&
12747 .vindex "&$sender_fullhost$&"
12748 When a message is received from a remote host, this variable contains the host
12749 name and IP address in a single string. It ends with the IP address in square
12750 brackets, followed by a colon and a port number if the logging of ports is
12751 enabled. The format of the rest of the string depends on whether the host
12752 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12753 looking up its IP address. (Looking up the IP address can be forced by the
12754 &%host_lookup%& option, independent of verification.) A plain host name at the
12755 start of the string is a verified host name; if this is not present,
12756 verification either failed or was not requested. A host name in parentheses is
12757 the argument of a HELO or EHLO command. This is omitted if it is identical to
12758 the verified host name or to the host's IP address in square brackets.
12759
12760 .vitem &$sender_helo_dnssec$&
12761 .vindex "&$sender_helo_dnssec$&"
12762 This boolean variable is true if a successful HELO verification was
12763 .cindex "DNS" "DNSSEC"
12764 done using DNS information the resolver library stated was authenticated data.
12765
12766 .vitem &$sender_helo_name$&
12767 .vindex "&$sender_helo_name$&"
12768 When a message is received from a remote host that has issued a HELO or EHLO
12769 command, the argument of that command is placed in this variable. It is also
12770 set if HELO or EHLO is used when a message is received using SMTP locally via
12771 the &%-bs%& or &%-bS%& options.
12772
12773 .vitem &$sender_host_address$&
12774 .vindex "&$sender_host_address$&"
12775 When a message is received from a remote host using SMTP,
12776 this variable contains that
12777 host's IP address. For locally non-SMTP submitted messages, it is empty.
12778
12779 .vitem &$sender_host_authenticated$&
12780 .vindex "&$sender_host_authenticated$&"
12781 This variable contains the name (not the public name) of the authenticator
12782 driver that successfully authenticated the client from which the message was
12783 received. It is empty if there was no successful authentication. See also
12784 &$authenticated_id$&.
12785
12786 .vitem &$sender_host_dnssec$&
12787 .vindex "&$sender_host_dnssec$&"
12788 If an attempt to populate &$sender_host_name$& has been made
12789 (by reference, &%hosts_lookup%& or
12790 otherwise) then this boolean will have been set true if, and only if, the
12791 resolver library states that both
12792 the reverse and forward DNS were authenticated data.  At all
12793 other times, this variable is false.
12794
12795 .cindex "DNS" "DNSSEC"
12796 It is likely that you will need to coerce DNSSEC support on in the resolver
12797 library, by setting:
12798 .code
12799 dns_dnssec_ok = 1
12800 .endd
12801
12802 Exim does not perform DNSSEC validation itself, instead leaving that to a
12803 validating resolver (e.g. unbound, or bind with suitable configuration).
12804
12805 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12806 mechanism in the list, then this variable will be false.
12807
12808 This requires that your system resolver library support EDNS0 (and that
12809 DNSSEC flags exist in the system headers).  If the resolver silently drops
12810 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
12811 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
12812
12813
12814 .vitem &$sender_host_name$&
12815 .vindex "&$sender_host_name$&"
12816 When a message is received from a remote host, this variable contains the
12817 host's name as obtained by looking up its IP address. For messages received by
12818 other means, this variable is empty.
12819
12820 .vindex "&$host_lookup_failed$&"
12821 If the host name has not previously been looked up, a reference to
12822 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12823 A looked up name is accepted only if it leads back to the original IP address
12824 via a forward lookup. If either the reverse or the forward lookup fails to find
12825 any data, or if the forward lookup does not yield the original IP address,
12826 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12827
12828 .vindex "&$host_lookup_deferred$&"
12829 However, if either of the lookups cannot be completed (for example, there is a
12830 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12831 &$host_lookup_failed$& remains set to &"0"&.
12832
12833 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12834 host name again if there is a subsequent reference to &$sender_host_name$&
12835 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12836 is set to &"1"&.
12837
12838 Exim does not automatically look up every calling host's name. If you want
12839 maximum efficiency, you should arrange your configuration so that it avoids
12840 these lookups altogether. The lookup happens only if one or more of the
12841 following are true:
12842
12843 .ilist
12844 A string containing &$sender_host_name$& is expanded.
12845 .next
12846 The calling host matches the list in &%host_lookup%&. In the default
12847 configuration, this option is set to *, so it must be changed if lookups are
12848 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12849 .next
12850 Exim needs the host name in order to test an item in a host list. The items
12851 that require this are described in sections &<<SECThoslispatnam>>& and
12852 &<<SECThoslispatnamsk>>&.
12853 .next
12854 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12855 In this case, the host name is required to compare with the name quoted in any
12856 EHLO or HELO commands that the client issues.
12857 .next
12858 The remote host issues a EHLO or HELO command that quotes one of the
12859 domains in &%helo_lookup_domains%&. The default value of this option is
12860 . ==== As this is a nested list, any displays it contains must be indented
12861 . ==== as otherwise they are too far to the left.
12862 .code
12863   helo_lookup_domains = @ : @[]
12864 .endd
12865 which causes a lookup if a remote host (incorrectly) gives the server's name or
12866 IP address in an EHLO or HELO command.
12867 .endlist
12868
12869
12870 .vitem &$sender_host_port$&
12871 .vindex "&$sender_host_port$&"
12872 When a message is received from a remote host, this variable contains the port
12873 number that was used on the remote host.
12874
12875 .vitem &$sender_ident$&
12876 .vindex "&$sender_ident$&"
12877 When a message is received from a remote host, this variable contains the
12878 identification received in response to an RFC 1413 request. When a message has
12879 been received locally, this variable contains the login name of the user that
12880 called Exim.
12881
12882 .vitem &$sender_rate_$&&'xxx'&
12883 A number of variables whose names begin &$sender_rate_$& are set as part of the
12884 &%ratelimit%& ACL condition. Details are given in section
12885 &<<SECTratelimiting>>&.
12886
12887 .vitem &$sender_rcvhost$&
12888 .cindex "DNS" "reverse lookup"
12889 .cindex "reverse DNS lookup"
12890 .vindex "&$sender_rcvhost$&"
12891 This is provided specifically for use in &'Received:'& headers. It starts with
12892 either the verified host name (as obtained from a reverse DNS lookup) or, if
12893 there is no verified host name, the IP address in square brackets. After that
12894 there may be text in parentheses. When the first item is a verified host name,
12895 the first thing in the parentheses is the IP address in square brackets,
12896 followed by a colon and a port number if port logging is enabled. When the
12897 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12898 the parentheses.
12899
12900 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12901 was used and its argument was not identical to the real host name or IP
12902 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12903 all three items are present in the parentheses, a newline and tab are inserted
12904 into the string, to improve the formatting of the &'Received:'& header.
12905
12906 .vitem &$sender_verify_failure$&
12907 .vindex "&$sender_verify_failure$&"
12908 In an ACL, when a sender verification fails, this variable contains information
12909 about the failure. The details are the same as for
12910 &$recipient_verify_failure$&.
12911
12912 .vitem &$sending_ip_address$&
12913 .vindex "&$sending_ip_address$&"
12914 This variable is set whenever an outgoing SMTP connection to another host has
12915 been set up. It contains the IP address of the local interface that is being
12916 used. This is useful if a host that has more than one IP address wants to take
12917 on different personalities depending on which one is being used. For incoming
12918 connections, see &$received_ip_address$&.
12919
12920 .vitem &$sending_port$&
12921 .vindex "&$sending_port$&"
12922 This variable is set whenever an outgoing SMTP connection to another host has
12923 been set up. It contains the local port that is being used. For incoming
12924 connections, see &$received_port$&.
12925
12926 .vitem &$smtp_active_hostname$&
12927 .vindex "&$smtp_active_hostname$&"
12928 During an incoming SMTP session, this variable contains the value of the active
12929 host name, as specified by the &%smtp_active_hostname%& option. The value of
12930 &$smtp_active_hostname$& is saved with any message that is received, so its
12931 value can be consulted during routing and delivery.
12932
12933 .vitem &$smtp_command$&
12934 .vindex "&$smtp_command$&"
12935 During the processing of an incoming SMTP command, this variable contains the
12936 entire command. This makes it possible to distinguish between HELO and EHLO in
12937 the HELO ACL, and also to distinguish between commands such as these:
12938 .code
12939 MAIL FROM:<>
12940 MAIL FROM: <>
12941 .endd
12942 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12943 command, the address in &$smtp_command$& is the original address before any
12944 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12945 the address after SMTP-time rewriting.
12946
12947 .vitem &$smtp_command_argument$&
12948 .cindex "SMTP" "command, argument for"
12949 .vindex "&$smtp_command_argument$&"
12950 While an ACL is running to check an SMTP command, this variable contains the
12951 argument, that is, the text that follows the command name, with leading white
12952 space removed. Following the introduction of &$smtp_command$&, this variable is
12953 somewhat redundant, but is retained for backwards compatibility.
12954
12955 .vitem &$smtp_command_history$&
12956 .cindex SMTP "command history"
12957 .vindex "&$smtp_command_history$&"
12958 A comma-separated list (with no whitespace) of the most-recent SMTP commands
12959 received, in time-order left to right.  Only a limited number of commands
12960 are remembered.
12961
12962 .vitem &$smtp_count_at_connection_start$&
12963 .vindex "&$smtp_count_at_connection_start$&"
12964 This variable is set greater than zero only in processes spawned by the Exim
12965 daemon for handling incoming SMTP connections. The name is deliberately long,
12966 in order to emphasize what the contents are. When the daemon accepts a new
12967 connection, it increments this variable. A copy of the variable is passed to
12968 the child process that handles the connection, but its value is fixed, and
12969 never changes. It is only an approximation of how many incoming connections
12970 there actually are, because many other connections may come and go while a
12971 single connection is being processed. When a child process terminates, the
12972 daemon decrements its copy of the variable.
12973
12974 .vitem "&$sn0$& &-- &$sn9$&"
12975 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12976 that were current at the end of the system filter file. This allows a system
12977 filter file to set values that can be tested in users' filter files. For
12978 example, a system filter could set a value indicating how likely it is that a
12979 message is junk mail.
12980
12981 .vitem &$spam_$&&'xxx'&
12982 A number of variables whose names start with &$spam$& are available when Exim
12983 is compiled with the content-scanning extension. For details, see section
12984 &<<SECTscanspamass>>&.
12985
12986 .vitem &$spf_header_comment$& &&&
12987        &$spf_received$& &&&
12988        &$spf_result$& &&&
12989        &$spf_result_guessed$& &&&
12990        &$spf_smtp_comment$&
12991 These variables are only available if Exim is built with SPF support.
12992 For details see section &<<SECSPF>>&.
12993
12994 .vitem &$spool_directory$&
12995 .vindex "&$spool_directory$&"
12996 The name of Exim's spool directory.
12997
12998 .vitem &$spool_inodes$&
12999 .vindex "&$spool_inodes$&"
13000 The number of free inodes in the disk partition where Exim's spool files are
13001 being written. The value is recalculated whenever the variable is referenced.
13002 If the relevant file system does not have the concept of inodes, the value of
13003 is -1. See also the &%check_spool_inodes%& option.
13004
13005 .vitem &$spool_space$&
13006 .vindex "&$spool_space$&"
13007 The amount of free space (as a number of kilobytes) in the disk partition where
13008 Exim's spool files are being written. The value is recalculated whenever the
13009 variable is referenced. If the operating system does not have the ability to
13010 find the amount of free space (only true for experimental systems), the space
13011 value is -1. For example, to check in an ACL that there is at least 50
13012 megabytes free on the spool, you could write:
13013 .code
13014 condition = ${if > {$spool_space}{50000}}
13015 .endd
13016 See also the &%check_spool_space%& option.
13017
13018
13019 .vitem &$thisaddress$&
13020 .vindex "&$thisaddress$&"
13021 This variable is set only during the processing of the &%foranyaddress%&
13022 command in a filter file. Its use is explained in the description of that
13023 command, which can be found in the separate document entitled &'Exim's
13024 interfaces to mail filtering'&.
13025
13026 .vitem &$tls_in_bits$&
13027 .vindex "&$tls_in_bits$&"
13028 Contains an approximation of the TLS cipher's bit-strength
13029 on the inbound connection; the meaning of
13030 this depends upon the TLS implementation used.
13031 If TLS has not been negotiated, the value will be 0.
13032 The value of this is automatically fed into the Cyrus SASL authenticator
13033 when acting as a server, to specify the "external SSF" (a SASL term).
13034
13035 The deprecated &$tls_bits$& variable refers to the inbound side
13036 except when used in the context of an outbound SMTP delivery, when it refers to
13037 the outbound.
13038
13039 .vitem &$tls_out_bits$&
13040 .vindex "&$tls_out_bits$&"
13041 Contains an approximation of the TLS cipher's bit-strength
13042 on an outbound SMTP connection; the meaning of
13043 this depends upon the TLS implementation used.
13044 If TLS has not been negotiated, the value will be 0.
13045
13046 .vitem &$tls_in_ourcert$&
13047 .vindex "&$tls_in_ourcert$&"
13048 .cindex certificate variables
13049 This variable refers to the certificate presented to the peer of an
13050 inbound connection when the message was received.
13051 It is only useful as the argument of a
13052 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13053 or a &%def%& condition.
13054
13055 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13056 when a list of more than one
13057 file is used for &%tls_certificate%&, this variable is not reliable.
13058
13059 .vitem &$tls_in_peercert$&
13060 .vindex "&$tls_in_peercert$&"
13061 This variable refers to the certificate presented by the peer of an
13062 inbound connection when the message was received.
13063 It is only useful as the argument of a
13064 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13065 or a &%def%& condition.
13066 If certificate verification fails it may refer to a failing chain element
13067 which is not the leaf.
13068
13069 .vitem &$tls_out_ourcert$&
13070 .vindex "&$tls_out_ourcert$&"
13071 This variable refers to the certificate presented to the peer of an
13072 outbound connection.  It is only useful as the argument of a
13073 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13074 or a &%def%& condition.
13075
13076 .vitem &$tls_out_peercert$&
13077 .vindex "&$tls_out_peercert$&"
13078 This variable refers to the certificate presented by the peer of an
13079 outbound connection.  It is only useful as the argument of a
13080 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13081 or a &%def%& condition.
13082 If certificate verification fails it may refer to a failing chain element
13083 which is not the leaf.
13084
13085 .vitem &$tls_in_certificate_verified$&
13086 .vindex "&$tls_in_certificate_verified$&"
13087 This variable is set to &"1"& if a TLS certificate was verified when the
13088 message was received, and &"0"& otherwise.
13089
13090 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13091 except when used in the context of an outbound SMTP delivery, when it refers to
13092 the outbound.
13093
13094 .vitem &$tls_out_certificate_verified$&
13095 .vindex "&$tls_out_certificate_verified$&"
13096 This variable is set to &"1"& if a TLS certificate was verified when an
13097 outbound SMTP connection was made,
13098 and &"0"& otherwise.
13099
13100 .vitem &$tls_in_cipher$&
13101 .vindex "&$tls_in_cipher$&"
13102 .vindex "&$tls_cipher$&"
13103 When a message is received from a remote host over an encrypted SMTP
13104 connection, this variable is set to the cipher suite that was negotiated, for
13105 example DES-CBC3-SHA. In other circumstances, in particular, for message
13106 received over unencrypted connections, the variable is empty. Testing
13107 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13108 non-encrypted connections during ACL processing.
13109
13110 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13111 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13112 becomes the same as &$tls_out_cipher$&.
13113
13114 .vitem &$tls_out_cipher$&
13115 .vindex "&$tls_out_cipher$&"
13116 This variable is
13117 cleared before any outgoing SMTP connection is made,
13118 and then set to the outgoing cipher suite if one is negotiated. See chapter
13119 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13120 details of the &(smtp)& transport.
13121
13122 .vitem &$tls_out_dane$&
13123 .vindex &$tls_out_dane$&
13124 DANE active status.  See section &<<SECDANE>>&.
13125
13126 .vitem &$tls_in_ocsp$&
13127 .vindex "&$tls_in_ocsp$&"
13128 When a message is received from a remote client connection
13129 the result of any OCSP request from the client is encoded in this variable:
13130 .code
13131 0 OCSP proof was not requested (default value)
13132 1 No response to request
13133 2 Response not verified
13134 3 Verification failed
13135 4 Verification succeeded
13136 .endd
13137
13138 .vitem &$tls_out_ocsp$&
13139 .vindex "&$tls_out_ocsp$&"
13140 When a message is sent to a remote host connection
13141 the result of any OCSP request made is encoded in this variable.
13142 See &$tls_in_ocsp$& for values.
13143
13144 .vitem &$tls_in_peerdn$&
13145 .vindex "&$tls_in_peerdn$&"
13146 .vindex "&$tls_peerdn$&"
13147 .cindex certificate "extracting fields"
13148 When a message is received from a remote host over an encrypted SMTP
13149 connection, and Exim is configured to request a certificate from the client,
13150 the value of the Distinguished Name of the certificate is made available in the
13151 &$tls_in_peerdn$& during subsequent processing.
13152 If certificate verification fails it may refer to a failing chain element
13153 which is not the leaf.
13154
13155 The deprecated &$tls_peerdn$& variable refers to the inbound side
13156 except when used in the context of an outbound SMTP delivery, when it refers to
13157 the outbound.
13158
13159 .vitem &$tls_out_peerdn$&
13160 .vindex "&$tls_out_peerdn$&"
13161 When a message is being delivered to a remote host over an encrypted SMTP
13162 connection, and Exim is configured to request a certificate from the server,
13163 the value of the Distinguished Name of the certificate is made available in the
13164 &$tls_out_peerdn$& during subsequent processing.
13165 If certificate verification fails it may refer to a failing chain element
13166 which is not the leaf.
13167
13168 .vitem &$tls_in_sni$&
13169 .vindex "&$tls_in_sni$&"
13170 .vindex "&$tls_sni$&"
13171 .cindex "TLS" "Server Name Indication"
13172 When a TLS session is being established, if the client sends the Server
13173 Name Indication extension, the value will be placed in this variable.
13174 If the variable appears in &%tls_certificate%& then this option and
13175 some others, described in &<<SECTtlssni>>&,
13176 will be re-expanded early in the TLS session, to permit
13177 a different certificate to be presented (and optionally a different key to be
13178 used) to the client, based upon the value of the SNI extension.
13179
13180 The deprecated &$tls_sni$& variable refers to the inbound side
13181 except when used in the context of an outbound SMTP delivery, when it refers to
13182 the outbound.
13183
13184 .vitem &$tls_out_sni$&
13185 .vindex "&$tls_out_sni$&"
13186 .cindex "TLS" "Server Name Indication"
13187 During outbound
13188 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13189 the transport.
13190
13191 .vitem &$tls_out_tlsa_usage$&
13192 .vindex &$tls_out_tlsa_usage$&
13193 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13194
13195 .vitem &$tod_bsdinbox$&
13196 .vindex "&$tod_bsdinbox$&"
13197 The time of day and the date, in the format required for BSD-style mailbox
13198 files, for example: Thu Oct 17 17:14:09 1995.
13199
13200 .vitem &$tod_epoch$&
13201 .vindex "&$tod_epoch$&"
13202 The time and date as a number of seconds since the start of the Unix epoch.
13203
13204 .vitem &$tod_epoch_l$&
13205 .vindex "&$tod_epoch_l$&"
13206 The time and date as a number of microseconds since the start of the Unix epoch.
13207
13208 .vitem &$tod_full$&
13209 .vindex "&$tod_full$&"
13210 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13211 +0100. The timezone is always given as a numerical offset from UTC, with
13212 positive values used for timezones that are ahead (east) of UTC, and negative
13213 values for those that are behind (west).
13214
13215 .vitem &$tod_log$&
13216 .vindex "&$tod_log$&"
13217 The time and date in the format used for writing Exim's log files, for example:
13218 1995-10-12 15:32:29, but without a timezone.
13219
13220 .vitem &$tod_logfile$&
13221 .vindex "&$tod_logfile$&"
13222 This variable contains the date in the format yyyymmdd. This is the format that
13223 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13224 flag.
13225
13226 .vitem &$tod_zone$&
13227 .vindex "&$tod_zone$&"
13228 This variable contains the numerical value of the local timezone, for example:
13229 -0500.
13230
13231 .vitem &$tod_zulu$&
13232 .vindex "&$tod_zulu$&"
13233 This variable contains the UTC date and time in &"Zulu"& format, as specified
13234 by ISO 8601, for example: 20030221154023Z.
13235
13236 .vitem &$transport_name$&
13237 .cindex "transport" "name"
13238 .cindex "name" "of transport"
13239 .vindex "&$transport_name$&"
13240 During the running of a transport, this variable contains its name.
13241
13242 .vitem &$value$&
13243 .vindex "&$value$&"
13244 This variable contains the result of an expansion lookup, extraction operation,
13245 or external command, as described above. It is also used during a
13246 &*reduce*& expansion.
13247
13248 .vitem &$verify_mode$&
13249 .vindex "&$verify_mode$&"
13250 While a router or transport is being run in verify mode or for cutthrough delivery,
13251 contains "S" for sender-verification or "R" for recipient-verification.
13252 Otherwise, empty.
13253
13254 .vitem &$version_number$&
13255 .vindex "&$version_number$&"
13256 The version number of Exim.
13257
13258 .vitem &$warn_message_delay$&
13259 .vindex "&$warn_message_delay$&"
13260 This variable is set only during the creation of a message warning about a
13261 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13262
13263 .vitem &$warn_message_recipients$&
13264 .vindex "&$warn_message_recipients$&"
13265 This variable is set only during the creation of a message warning about a
13266 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13267 .endlist
13268 .ecindex IIDstrexp
13269
13270
13271
13272 . ////////////////////////////////////////////////////////////////////////////
13273 . ////////////////////////////////////////////////////////////////////////////
13274
13275 .chapter "Embedded Perl" "CHAPperl"
13276 .scindex IIDperl "Perl" "calling from Exim"
13277 Exim can be built to include an embedded Perl interpreter. When this is done,
13278 Perl subroutines can be called as part of the string expansion process. To make
13279 use of the Perl support, you need version 5.004 or later of Perl installed on
13280 your system. To include the embedded interpreter in the Exim binary, include
13281 the line
13282 .code
13283 EXIM_PERL = perl.o
13284 .endd
13285 in your &_Local/Makefile_& and then build Exim in the normal way.
13286
13287
13288 .section "Setting up so Perl can be used" "SECID85"
13289 .oindex "&%perl_startup%&"
13290 Access to Perl subroutines is via a global configuration option called
13291 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13292 no &%perl_startup%& option in the Exim configuration file then no Perl
13293 interpreter is started and there is almost no overhead for Exim (since none of
13294 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13295 option then the associated value is taken to be Perl code which is executed in
13296 a newly created Perl interpreter.
13297
13298 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13299 need backslashes before any characters to escape special meanings. The option
13300 should usually be something like
13301 .code
13302 perl_startup = do '/etc/exim.pl'
13303 .endd
13304 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13305 use from Exim. Exim can be configured either to start up a Perl interpreter as
13306 soon as it is entered, or to wait until the first time it is needed. Starting
13307 the interpreter at the beginning ensures that it is done while Exim still has
13308 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13309 fact used in a particular run. Also, note that this does not mean that Exim is
13310 necessarily running as root when Perl is called at a later time. By default,
13311 the interpreter is started only when it is needed, but this can be changed in
13312 two ways:
13313
13314 .ilist
13315 .oindex "&%perl_at_start%&"
13316 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13317 a startup when Exim is entered.
13318 .next
13319 The command line option &%-ps%& also requests a startup when Exim is entered,
13320 overriding the setting of &%perl_at_start%&.
13321 .endlist
13322
13323 There is also a command line option &%-pd%& (for delay) which suppresses the
13324 initial startup, even if &%perl_at_start%& is set.
13325
13326 .ilist
13327 .oindex "&%perl_taintmode%&"
13328 .cindex "Perl" "taintmode"
13329 To provide more security executing Perl code via the embedded Perl
13330 interpreter, the &%perl_taintmode%& option can be set. This enables the
13331 taint mode of the Perl interpreter. You are encouraged to set this
13332 option to a true value. To avoid breaking existing installations, it
13333 defaults to false.
13334
13335
13336 .section "Calling Perl subroutines" "SECID86"
13337 When the configuration file includes a &%perl_startup%& option you can make use
13338 of the string expansion item to call the Perl subroutines that are defined
13339 by the &%perl_startup%& code. The operator is used in any of the following
13340 forms:
13341 .code
13342 ${perl{foo}}
13343 ${perl{foo}{argument}}
13344 ${perl{foo}{argument1}{argument2} ... }
13345 .endd
13346 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13347 arguments may be passed. Passing more than this results in an expansion failure
13348 with an error message of the form
13349 .code
13350 Too many arguments passed to Perl subroutine "foo" (max is 8)
13351 .endd
13352 The return value of the Perl subroutine is evaluated in a scalar context before
13353 it is passed back to Exim to be inserted into the expanded string. If the
13354 return value is &'undef'&, the expansion is forced to fail in the same way as
13355 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13356 by obeying Perl's &%die%& function, the expansion fails with the error message
13357 that was passed to &%die%&.
13358
13359
13360 .section "Calling Exim functions from Perl" "SECID87"
13361 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13362 is available to call back into Exim's string expansion function. For example,
13363 the Perl code
13364 .code
13365 my $lp = Exim::expand_string('$local_part');
13366 .endd
13367 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13368 Note those are single quotes and not double quotes to protect against
13369 &$local_part$& being interpolated as a Perl variable.
13370
13371 If the string expansion is forced to fail by a &"fail"& item, the result of
13372 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13373 expansion string, the Perl call from the original expansion string fails with
13374 an appropriate error message, in the same way as if &%die%& were used.
13375
13376 .cindex "debugging" "from embedded Perl"
13377 .cindex "log" "writing from embedded Perl"
13378 Two other Exim functions are available for use from within Perl code.
13379 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13380 debugging is enabled. If you want a newline at the end, you must supply it.
13381 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13382 timestamp. In this case, you should not supply a terminating newline.
13383
13384
13385 .section "Use of standard output and error by Perl" "SECID88"
13386 .cindex "Perl" "standard output and error"
13387 You should not write to the standard error or output streams from within your
13388 Perl code, as it is not defined how these are set up. In versions of Exim
13389 before 4.50, it is possible for the standard output or error to refer to the
13390 SMTP connection during message reception via the daemon. Writing to this stream
13391 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13392 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13393 avoided, but the output is lost.
13394
13395 .cindex "Perl" "use of &%warn%&"
13396 The Perl &%warn%& statement writes to the standard error stream by default.
13397 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13398 you have no control. When Exim starts up the Perl interpreter, it arranges for
13399 output from the &%warn%& statement to be written to the Exim main log. You can
13400 change this by including appropriate Perl magic somewhere in your Perl code.
13401 For example, to discard &%warn%& output completely, you need this:
13402 .code
13403 $SIG{__WARN__} = sub { };
13404 .endd
13405 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13406 example, the code for the subroutine is empty, so it does nothing, but you can
13407 include any Perl code that you like. The text of the &%warn%& message is passed
13408 as the first subroutine argument.
13409 .ecindex IIDperl
13410
13411
13412 . ////////////////////////////////////////////////////////////////////////////
13413 . ////////////////////////////////////////////////////////////////////////////
13414
13415 .chapter "Starting the daemon and the use of network interfaces" &&&
13416          "CHAPinterfaces" &&&
13417          "Starting the daemon"
13418 .cindex "daemon" "starting"
13419 .cindex "interface" "listening"
13420 .cindex "network interface"
13421 .cindex "interface" "network"
13422 .cindex "IP address" "for listening"
13423 .cindex "daemon" "listening IP addresses"
13424 .cindex "TCP/IP" "setting listening interfaces"
13425 .cindex "TCP/IP" "setting listening ports"
13426 A host that is connected to a TCP/IP network may have one or more physical
13427 hardware network interfaces. Each of these interfaces may be configured as one
13428 or more &"logical"& interfaces, which are the entities that a program actually
13429 works with. Each of these logical interfaces is associated with an IP address.
13430 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13431 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13432 knowledge about the host's interfaces for use in three different circumstances:
13433
13434 .olist
13435 When a listening daemon is started, Exim needs to know which interfaces
13436 and ports to listen on.
13437 .next
13438 When Exim is routing an address, it needs to know which IP addresses
13439 are associated with local interfaces. This is required for the correct
13440 processing of MX lists by removing the local host and others with the
13441 same or higher priority values. Also, Exim needs to detect cases
13442 when an address is routed to an IP address that in fact belongs to the
13443 local host. Unless the &%self%& router option or the &%allow_localhost%&
13444 option of the smtp transport is set (as appropriate), this is treated
13445 as an error situation.
13446 .next
13447 When Exim connects to a remote host, it may need to know which interface to use
13448 for the outgoing connection.
13449 .endlist
13450
13451
13452 Exim's default behaviour is likely to be appropriate in the vast majority
13453 of cases. If your host has only one interface, and you want all its IP
13454 addresses to be treated in the same way, and you are using only the
13455 standard SMTP port, you should not need to take any special action. The
13456 rest of this chapter does not apply to you.
13457
13458 In a more complicated situation you may want to listen only on certain
13459 interfaces, or on different ports, and for this reason there are a number of
13460 options that can be used to influence Exim's behaviour. The rest of this
13461 chapter describes how they operate.
13462
13463 When a message is received over TCP/IP, the interface and port that were
13464 actually used are set in &$received_ip_address$& and &$received_port$&.
13465
13466
13467
13468 .section "Starting a listening daemon" "SECID89"
13469 When a listening daemon is started (by means of the &%-bd%& command line
13470 option), the interfaces and ports on which it listens are controlled by the
13471 following options:
13472
13473 .ilist
13474 &%daemon_smtp_ports%& contains a list of default ports
13475 or service names.
13476 (For backward compatibility, this option can also be specified in the singular.)
13477 .next
13478 &%local_interfaces%& contains list of interface IP addresses on which to
13479 listen. Each item may optionally also specify a port.
13480 .endlist
13481
13482 The default list separator in both cases is a colon, but this can be changed as
13483 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
13484 it is usually best to change the separator to avoid having to double all the
13485 colons. For example:
13486 .code
13487 local_interfaces = <; 127.0.0.1 ; \
13488                       192.168.23.65 ; \
13489                       ::1 ; \
13490                       3ffe:ffff:836f::fe86:a061
13491 .endd
13492 There are two different formats for specifying a port along with an IP address
13493 in &%local_interfaces%&:
13494
13495 .olist
13496 The port is added onto the address with a dot separator. For example, to listen
13497 on port 1234 on two different IP addresses:
13498 .code
13499 local_interfaces = <; 192.168.23.65.1234 ; \
13500                       3ffe:ffff:836f::fe86:a061.1234
13501 .endd
13502 .next
13503 The IP address is enclosed in square brackets, and the port is added
13504 with a colon separator, for example:
13505 .code
13506 local_interfaces = <; [192.168.23.65]:1234 ; \
13507                       [3ffe:ffff:836f::fe86:a061]:1234
13508 .endd
13509 .endlist
13510
13511 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13512 default setting contains just one port:
13513 .code
13514 daemon_smtp_ports = smtp
13515 .endd
13516 If more than one port is listed, each interface that does not have its own port
13517 specified listens on all of them. Ports that are listed in
13518 &%daemon_smtp_ports%& can be identified either by name (defined in
13519 &_/etc/services_&) or by number. However, when ports are given with individual
13520 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13521
13522
13523
13524 .section "Special IP listening addresses" "SECID90"
13525 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13526 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13527 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13528 instead of setting up separate listening sockets for each interface. The
13529 default value of &%local_interfaces%& is
13530 .code
13531 local_interfaces = 0.0.0.0
13532 .endd
13533 when Exim is built without IPv6 support; otherwise it is:
13534 .code
13535 local_interfaces = <; ::0 ; 0.0.0.0
13536 .endd
13537 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13538
13539
13540
13541 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13542 The &%-oX%& command line option can be used to override the values of
13543 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13544 instance. Another way of doing this would be to use macros and the &%-D%&
13545 option. However, &%-oX%& can be used by any admin user, whereas modification of
13546 the runtime configuration by &%-D%& is allowed only when the caller is root or
13547 exim.
13548
13549 The value of &%-oX%& is a list of items. The default colon separator can be
13550 changed in the usual way if required. If there are any items that do not
13551 contain dots or colons (that is, are not IP addresses), the value of
13552 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13553 items that do contain dots or colons, the value of &%local_interfaces%& is
13554 replaced by those items. Thus, for example,
13555 .code
13556 -oX 1225
13557 .endd
13558 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13559 whereas
13560 .code
13561 -oX 192.168.34.5.1125
13562 .endd
13563 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13564 (However, since &%local_interfaces%& now contains no items without ports, the
13565 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13566
13567
13568
13569 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
13570 .cindex "submissions protocol"
13571 .cindex "ssmtp protocol"
13572 .cindex "smtps protocol"
13573 .cindex "SMTP" "ssmtp protocol"
13574 .cindex "SMTP" "smtps protocol"
13575 Exim supports the use of TLS-on-connect, used by mail clients in the
13576 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
13577 For some years, IETF Standards Track documents only blessed the
13578 STARTTLS-based Submission service (port 587) while common practice was to support
13579 the same feature set on port 465, but using TLS-on-connect.
13580 If your installation needs to provide service to mail clients
13581 (Mail User Agents, MUAs) then you should provide service on both the 587 and
13582 the 465 TCP ports.
13583
13584 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
13585 service names, connections to those ports must first establish TLS, before
13586 proceeding to the application layer use of the SMTP protocol.
13587
13588 The common use of this option is expected to be
13589 .code
13590 tls_on_connect_ports = 465
13591 .endd
13592 per RFC 8314.
13593 There is also a command line option &%-tls-on-connect%&, which forces all ports
13594 to behave in this way when a daemon is started.
13595
13596 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13597 daemon to listen on those ports. You must still specify them in
13598 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13599 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13600 connections via the daemon.)
13601
13602
13603
13604
13605 .section "IPv6 address scopes" "SECID92"
13606 .cindex "IPv6" "address scopes"
13607 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13608 can, in principle, have the same link-local IPv6 address on different
13609 interfaces. Thus, additional information is needed, over and above the IP
13610 address, to distinguish individual interfaces. A convention of using a
13611 percent sign followed by something (often the interface name) has been
13612 adopted in some cases, leading to addresses like this:
13613 .code
13614 fe80::202:b3ff:fe03:45c1%eth0
13615 .endd
13616 To accommodate this usage, a percent sign followed by an arbitrary string is
13617 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13618 to convert a textual IPv6 address for actual use. This function recognizes the
13619 percent convention in operating systems that support it, and it processes the
13620 address appropriately. Unfortunately, some older libraries have problems with
13621 &[getaddrinfo()]&. If
13622 .code
13623 IPV6_USE_INET_PTON=yes
13624 .endd
13625 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13626 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13627 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13628 function.) Of course, this means that the additional functionality of
13629 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13630
13631 .section "Disabling IPv6" "SECID93"
13632 .cindex "IPv6" "disabling"
13633 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13634 run on a host whose kernel does not support IPv6. The binary will fall back to
13635 using IPv4, but it may waste resources looking up AAAA records, and trying to
13636 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13637 .oindex "&%disable_ipv6%&"
13638 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13639 activities take place. AAAA records are never looked up, and any IPv6 addresses
13640 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13641 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13642 to handle IPv6 literal addresses.
13643
13644 On the other hand, when IPv6 is in use, there may be times when you want to
13645 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13646 option to globally suppress the lookup of AAAA records for specified domains,
13647 and you can use the &%ignore_target_hosts%& generic router option to ignore
13648 IPv6 addresses in an individual router.
13649
13650
13651
13652 .section "Examples of starting a listening daemon" "SECID94"
13653 The default case in an IPv6 environment is
13654 .code
13655 daemon_smtp_ports = smtp
13656 local_interfaces = <; ::0 ; 0.0.0.0
13657 .endd
13658 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13659 Either one or two sockets may be used, depending on the characteristics of
13660 the TCP/IP stack. (This is complicated and messy; for more information,
13661 read the comments in the &_daemon.c_& source file.)
13662
13663 To specify listening on ports 25 and 26 on all interfaces:
13664 .code
13665 daemon_smtp_ports = 25 : 26
13666 .endd
13667 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13668 .code
13669 local_interfaces = <; ::0.25     ; ::0.26 \
13670                       0.0.0.0.25 ; 0.0.0.0.26
13671 .endd
13672 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13673 IPv4 loopback address only:
13674 .code
13675 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13676 .endd
13677 To specify listening on the default port on specific interfaces only:
13678 .code
13679 local_interfaces = 10.0.0.67 : 192.168.34.67
13680 .endd
13681 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13682
13683
13684
13685 .section "Recognizing the local host" "SECTreclocipadd"
13686 The &%local_interfaces%& option is also used when Exim needs to determine
13687 whether or not an IP address refers to the local host. That is, the IP
13688 addresses of all the interfaces on which a daemon is listening are always
13689 treated as local.
13690
13691 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13692 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13693 available interfaces from the operating system, and extracts the relevant
13694 (that is, IPv4 or IPv6) addresses to use for checking.
13695
13696 Some systems set up large numbers of virtual interfaces in order to provide
13697 many virtual web servers. In this situation, you may want to listen for
13698 email on only a few of the available interfaces, but nevertheless treat all
13699 interfaces as local when routing. You can do this by setting
13700 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13701 &"all"& wildcard values. These addresses are recognized as local, but are not
13702 used for listening. Consider this example:
13703 .code
13704 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13705                       192.168.53.235 ; \
13706                       3ffe:2101:12:1:a00:20ff:fe86:a061
13707
13708 extra_local_interfaces = <; ::0 ; 0.0.0.0
13709 .endd
13710 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13711 address, but all available interface addresses are treated as local when
13712 Exim is routing.
13713
13714 In some environments the local host name may be in an MX list, but with an IP
13715 address that is not assigned to any local interface. In other cases it may be
13716 desirable to treat other host names as if they referred to the local host. Both
13717 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13718 This contains host names rather than IP addresses. When a host is referenced
13719 during routing, either via an MX record or directly, it is treated as the local
13720 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13721 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13722
13723
13724
13725 .section "Delivering to a remote host" "SECID95"
13726 Delivery to a remote host is handled by the smtp transport. By default, it
13727 allows the system's TCP/IP functions to choose which interface to use (if
13728 there is more than one) when connecting to a remote host. However, the
13729 &%interface%& option can be set to specify which interface is used. See the
13730 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13731 details.
13732
13733
13734
13735
13736 . ////////////////////////////////////////////////////////////////////////////
13737 . ////////////////////////////////////////////////////////////////////////////
13738
13739 .chapter "Main configuration" "CHAPmainconfig"
13740 .scindex IIDconfima "configuration file" "main section"
13741 .scindex IIDmaiconf "main configuration"
13742 The first part of the run time configuration file contains three types of item:
13743
13744 .ilist
13745 Macro definitions: These lines start with an upper case letter. See section
13746 &<<SECTmacrodefs>>& for details of macro processing.
13747 .next
13748 Named list definitions: These lines start with one of the words &"domainlist"&,
13749 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13750 section &<<SECTnamedlists>>&.
13751 .next
13752 Main configuration settings: Each setting occupies one line of the file
13753 (with possible continuations). If any setting is preceded by the word
13754 &"hide"&, the &%-bP%& command line option displays its value to admin users
13755 only. See section &<<SECTcos>>& for a description of the syntax of these option
13756 settings.
13757 .endlist
13758
13759 This chapter specifies all the main configuration options, along with their
13760 types and default values. For ease of finding a particular option, they appear
13761 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13762 are now so many options, they are first listed briefly in functional groups, as
13763 an aid to finding the name of the option you are looking for. Some options are
13764 listed in more than one group.
13765
13766 .section "Miscellaneous" "SECID96"
13767 .table2
13768 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13769 .row &%debug_store%&                 "do extra internal checks"
13770 .row &%disable_ipv6%&                "do no IPv6 processing"
13771 .row &%keep_malformed%&              "for broken files &-- should not happen"
13772 .row &%localhost_number%&            "for unique message ids in clusters"
13773 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13774 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13775 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13776 .row &%print_topbitchars%&           "top-bit characters are printing"
13777 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
13778 .row &%timezone%&                    "force time zone"
13779 .endtable
13780
13781
13782 .section "Exim parameters" "SECID97"
13783 .table2
13784 .row &%exim_group%&                  "override compiled-in value"
13785 .row &%exim_path%&                   "override compiled-in value"
13786 .row &%exim_user%&                   "override compiled-in value"
13787 .row &%primary_hostname%&            "default from &[uname()]&"
13788 .row &%split_spool_directory%&       "use multiple directories"
13789 .row &%spool_directory%&             "override compiled-in value"
13790 .endtable
13791
13792
13793
13794 .section "Privilege controls" "SECID98"
13795 .table2
13796 .row &%admin_groups%&                "groups that are Exim admin users"
13797 .row &%commandline_checks_require_admin%& "require admin for various checks"
13798 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13799 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13800 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13801 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13802 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13803 .row &%never_users%&                 "do not run deliveries as these"
13804 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13805 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13806 .row &%trusted_groups%&              "groups that are trusted"
13807 .row &%trusted_users%&               "users that are trusted"
13808 .endtable
13809
13810
13811
13812 .section "Logging" "SECID99"
13813 .table2
13814 .row &%event_action%&                "custom logging"
13815 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13816 .row &%log_file_path%&               "override compiled-in value"
13817 .row &%log_selector%&                "set/unset optional logging"
13818 .row &%log_timezone%&                "add timezone to log lines"
13819 .row &%message_logs%&                "create per-message logs"
13820 .row &%preserve_message_logs%&       "after message completion"
13821 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13822 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13823 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13824 .row &%syslog_facility%&             "set syslog &""facility""& field"
13825 .row &%syslog_pid%&                  "pid in syslog lines"
13826 .row &%syslog_processname%&          "set syslog &""ident""& field"
13827 .row &%syslog_timestamp%&            "timestamp syslog lines"
13828 .row &%write_rejectlog%&             "control use of message log"
13829 .endtable
13830
13831
13832
13833 .section "Frozen messages" "SECID100"
13834 .table2
13835 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13836 .row &%freeze_tell%&                 "send message when freezing"
13837 .row &%move_frozen_messages%&        "to another directory"
13838 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13839 .endtable
13840
13841
13842
13843 .section "Data lookups" "SECID101"
13844 .table2
13845 .row &%ibase_servers%&               "InterBase servers"
13846 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13847 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13848 .row &%ldap_cert_file%&              "client cert file for LDAP"
13849 .row &%ldap_cert_key%&               "client key file for LDAP"
13850 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13851 .row &%ldap_default_servers%&        "used if no server in query"
13852 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13853 .row &%ldap_start_tls%&              "require TLS within LDAP"
13854 .row &%ldap_version%&                "set protocol version"
13855 .row &%lookup_open_max%&             "lookup files held open"
13856 .row &%mysql_servers%&               "default MySQL servers"
13857 .row &%oracle_servers%&              "Oracle servers"
13858 .row &%pgsql_servers%&               "default PostgreSQL servers"
13859 .row &%sqlite_lock_timeout%&         "as it says"
13860 .endtable
13861
13862
13863
13864 .section "Message ids" "SECID102"
13865 .table2
13866 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13867 .row &%message_id_header_text%&      "ditto"
13868 .endtable
13869
13870
13871
13872 .section "Embedded Perl Startup" "SECID103"
13873 .table2
13874 .row &%perl_at_start%&               "always start the interpreter"
13875 .row &%perl_startup%&                "code to obey when starting Perl"
13876 .row &%perl_taintmode%&              "enable taint mode in Perl"
13877 .endtable
13878
13879
13880
13881 .section "Daemon" "SECID104"
13882 .table2
13883 .row &%daemon_smtp_ports%&           "default ports"
13884 .row &%daemon_startup_retries%&      "number of times to retry"
13885 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13886 .row &%extra_local_interfaces%&      "not necessarily listened on"
13887 .row &%local_interfaces%&            "on which to listen, with optional ports"
13888 .row &%pid_file_path%&               "override compiled-in value"
13889 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13890 .endtable
13891
13892
13893
13894 .section "Resource control" "SECID105"
13895 .table2
13896 .row &%check_log_inodes%&            "before accepting a message"
13897 .row &%check_log_space%&             "before accepting a message"
13898 .row &%check_spool_inodes%&          "before accepting a message"
13899 .row &%check_spool_space%&           "before accepting a message"
13900 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13901 .row &%queue_only_load%&             "queue incoming if load high"
13902 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13903 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13904 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13905 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13906 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13907 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13908 .row &%smtp_accept_max_per_connection%& "messages per connection"
13909 .row &%smtp_accept_max_per_host%&    "connections from one host"
13910 .row &%smtp_accept_queue%&           "queue mail if more connections"
13911 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13912                                            connection"
13913 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13914 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13915 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13916 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13917 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13918 .endtable
13919
13920
13921
13922 .section "Policy controls" "SECID106"
13923 .table2
13924 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13925 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13926 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13927 .row &%acl_smtp_auth%&               "ACL for AUTH"
13928 .row &%acl_smtp_connect%&            "ACL for connection"
13929 .row &%acl_smtp_data%&               "ACL for DATA"
13930 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13931 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13932 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13933 .row &%acl_smtp_expn%&               "ACL for EXPN"
13934 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13935 .row &%acl_smtp_mail%&               "ACL for MAIL"
13936 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13937 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13938 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13939 .row &%acl_smtp_predata%&            "ACL for start of data"
13940 .row &%acl_smtp_quit%&               "ACL for QUIT"
13941 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13942 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13943 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13944 .row &%av_scanner%&                  "specify virus scanner"
13945 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13946                                       words""&"
13947 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
13948 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13949 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13950 .row &%header_maxsize%&              "total size of message header"
13951 .row &%header_line_maxsize%&         "individual header line limit"
13952 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13953 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13954 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13955 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13956 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13957 .row &%host_lookup%&                 "host name looked up for these hosts"
13958 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13959 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
13960 .row &%host_reject_connection%&      "reject connection from these hosts"
13961 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13962 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13963 .row &%message_size_limit%&          "for all messages"
13964 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13965 .row &%spamd_address%&               "set interface to SpamAssassin"
13966 .row &%strict_acl_vars%&             "object to unset ACL variables"
13967 .endtable
13968
13969
13970
13971 .section "Callout cache" "SECID107"
13972 .table2
13973 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13974                                          item"
13975 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13976                                          item"
13977 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13978 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13979 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13980 .endtable
13981
13982
13983
13984 .section "TLS" "SECID108"
13985 .table2
13986 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13987 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13988 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13989 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13990 .row &%tls_certificate%&             "location of server certificate"
13991 .row &%tls_crl%&                     "certificate revocation list"
13992 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13993 .row &%tls_dhparam%&                 "DH parameters for server"
13994 .row &%tls_eccurve%&                 "EC curve selection for server"
13995 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13996 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13997 .row &%tls_privatekey%&              "location of server private key"
13998 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13999 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14000 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14001 .row &%tls_verify_certificates%&     "expected client certificates"
14002 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14003 .endtable
14004
14005
14006
14007 .section "Local user handling" "SECID109"
14008 .table2
14009 .row &%finduser_retries%&            "useful in NIS environments"
14010 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14011 .row &%gecos_pattern%&               "ditto"
14012 .row &%max_username_length%&         "for systems that truncate"
14013 .row &%unknown_login%&               "used when no login name found"
14014 .row &%unknown_username%&            "ditto"
14015 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14016 .row &%uucp_from_sender%&            "ditto"
14017 .endtable
14018
14019
14020
14021 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14022 .table2
14023 .row &%header_maxsize%&              "total size of message header"
14024 .row &%header_line_maxsize%&         "individual header line limit"
14025 .row &%message_size_limit%&          "applies to all messages"
14026 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14027 .row &%received_header_text%&        "expanded to make &'Received:'&"
14028 .row &%received_headers_max%&        "for mail loop detection"
14029 .row &%recipients_max%&              "limit per message"
14030 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14031 .endtable
14032
14033
14034
14035
14036 .section "Non-SMTP incoming messages" "SECID111"
14037 .table2
14038 .row &%receive_timeout%&             "for non-SMTP messages"
14039 .endtable
14040
14041
14042
14043
14044
14045 .section "Incoming SMTP messages" "SECID112"
14046 See also the &'Policy controls'& section above.
14047
14048 .table2
14049 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
14050 .row &%host_lookup%&                 "host name looked up for these hosts"
14051 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14052 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14053 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14054 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14055 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14056 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14057 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14058 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14059 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14060 .row &%smtp_accept_max_per_connection%& "messages per connection"
14061 .row &%smtp_accept_max_per_host%&    "connections from one host"
14062 .row &%smtp_accept_queue%&           "queue mail if more connections"
14063 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14064                                            connection"
14065 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14066 .row &%smtp_active_hostname%&        "host name to use in messages"
14067 .row &%smtp_banner%&                 "text for welcome banner"
14068 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14069 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14070 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14071 .row &%smtp_etrn_command%&           "what to run for ETRN"
14072 .row &%smtp_etrn_serialize%&         "only one at once"
14073 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14074 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14075 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14076 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14077 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14078 .row &%smtp_receive_timeout%&        "per command or data line"
14079 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14080 .row &%smtp_return_error_details%&   "give detail on rejections"
14081 .endtable
14082
14083
14084
14085 .section "SMTP extensions" "SECID113"
14086 .table2
14087 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14088 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14089 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14090 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14091 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14092 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14093 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14094 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14095 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14096 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14097 .endtable
14098
14099
14100
14101 .section "Processing messages" "SECID114"
14102 .table2
14103 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14104 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14105 .row &%allow_utf8_domains%&          "in addresses"
14106 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14107                                       words""&"
14108 .row &%delivery_date_remove%&        "from incoming messages"
14109 .row &%envelope_to_remove%&          "from incoming messages"
14110 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14111 .row &%headers_charset%&             "default for translations"
14112 .row &%qualify_domain%&              "default for senders"
14113 .row &%qualify_recipient%&           "default for recipients"
14114 .row &%return_path_remove%&          "from incoming messages"
14115 .row &%strip_excess_angle_brackets%& "in addresses"
14116 .row &%strip_trailing_dot%&          "at end of addresses"
14117 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14118 .endtable
14119
14120
14121
14122 .section "System filter" "SECID115"
14123 .table2
14124 .row &%system_filter%&               "locate system filter"
14125 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14126                                             directory"
14127 .row &%system_filter_file_transport%& "transport for delivery to a file"
14128 .row &%system_filter_group%&         "group for filter running"
14129 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14130 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14131 .row &%system_filter_user%&          "user for filter running"
14132 .endtable
14133
14134
14135
14136 .section "Routing and delivery" "SECID116"
14137 .table2
14138 .row &%disable_ipv6%&                "do no IPv6 processing"
14139 .row &%dns_again_means_nonexist%&    "for broken domains"
14140 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14141 .row &%dns_dnssec_ok%&               "parameter for resolver"
14142 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14143 .row &%dns_retrans%&                 "parameter for resolver"
14144 .row &%dns_retry%&                   "parameter for resolver"
14145 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14146 .row &%dns_use_edns0%&               "parameter for resolver"
14147 .row &%hold_domains%&                "hold delivery for these domains"
14148 .row &%local_interfaces%&            "for routing checks"
14149 .row &%queue_domains%&               "no immediate delivery for these"
14150 .row &%queue_only%&                  "no immediate delivery at all"
14151 .row &%queue_only_file%&             "no immediate delivery if file exists"
14152 .row &%queue_only_load%&             "no immediate delivery if load is high"
14153 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14154 .row &%queue_only_override%&         "allow command line to override"
14155 .row &%queue_run_in_order%&          "order of arrival"
14156 .row &%queue_run_max%&               "of simultaneous queue runners"
14157 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14158 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14159 .row &%remote_sort_domains%&         "order of remote deliveries"
14160 .row &%retry_data_expire%&           "timeout for retry data"
14161 .row &%retry_interval_max%&          "safety net for retry rules"
14162 .endtable
14163
14164
14165
14166 .section "Bounce and warning messages" "SECID117"
14167 .table2
14168 .row &%bounce_message_file%&         "content of bounce"
14169 .row &%bounce_message_text%&         "content of bounce"
14170 .row &%bounce_return_body%&          "include body if returning message"
14171 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14172 .row &%bounce_return_message%&       "include original message in bounce"
14173 .row &%bounce_return_size_limit%&    "limit on returned message"
14174 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14175 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14176 .row &%errors_copy%&                 "copy bounce messages"
14177 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14178 .row &%delay_warning%&               "time schedule"
14179 .row &%delay_warning_condition%&     "condition for warning messages"
14180 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14181 .row &%smtp_return_error_details%&   "give detail on rejections"
14182 .row &%warn_message_file%&           "content of warning message"
14183 .endtable
14184
14185
14186
14187 .section "Alphabetical list of main options" "SECTalomo"
14188 Those options that undergo string expansion before use are marked with
14189 &dagger;.
14190
14191 .option accept_8bitmime main boolean true
14192 .cindex "8BITMIME"
14193 .cindex "8-bit characters"
14194 .cindex "log" "selectors"
14195 .cindex "log" "8BITMIME"
14196 This option causes Exim to send 8BITMIME in its response to an SMTP
14197 EHLO command, and to accept the BODY= parameter on MAIL commands.
14198 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14199 takes no steps to do anything special with messages received by this route.
14200
14201 Historically Exim kept this option off by default, but the maintainers
14202 feel that in today's Internet, this causes more problems than it solves.
14203 It now defaults to true.
14204 A more detailed analysis of the issues is provided by Dan Bernstein:
14205 .display
14206 &url(https://cr.yp.to/smtp/8bitmime.html)
14207 .endd
14208
14209 To log received 8BITMIME status use
14210 .code
14211 log_selector = +8bitmime
14212 .endd
14213
14214 .option acl_not_smtp main string&!! unset
14215 .cindex "&ACL;" "for non-SMTP messages"
14216 .cindex "non-SMTP messages" "ACLs for"
14217 This option defines the ACL that is run when a non-SMTP message has been
14218 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14219 further details.
14220
14221 .option acl_not_smtp_mime main string&!! unset
14222 This option defines the ACL that is run for individual MIME parts of non-SMTP
14223 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14224 SMTP messages.
14225
14226 .option acl_not_smtp_start main string&!! unset
14227 .cindex "&ACL;" "at start of non-SMTP message"
14228 .cindex "non-SMTP messages" "ACLs for"
14229 This option defines the ACL that is run before Exim starts reading a
14230 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14231
14232 .option acl_smtp_auth main string&!! unset
14233 .cindex "&ACL;" "setting up for SMTP commands"
14234 .cindex "AUTH" "ACL for"
14235 This option defines the ACL that is run when an SMTP AUTH command is
14236 received. See chapter &<<CHAPACL>>& for further details.
14237
14238 .option acl_smtp_connect main string&!! unset
14239 .cindex "&ACL;" "on SMTP connection"
14240 This option defines the ACL that is run when an SMTP connection is received.
14241 See chapter &<<CHAPACL>>& for further details.
14242
14243 .option acl_smtp_data main string&!! unset
14244 .cindex "DATA" "ACL for"
14245 This option defines the ACL that is run after an SMTP DATA command has been
14246 processed and the message itself has been received, but before the final
14247 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14248
14249 .option acl_smtp_data_prdr main string&!! accept
14250 .cindex "PRDR" "ACL for"
14251 .cindex "DATA" "PRDR ACL for"
14252 .cindex "&ACL;" "PRDR-related"
14253 .cindex "&ACL;" "per-user data processing"
14254 This option defines the ACL that,
14255 if the PRDR feature has been negotiated,
14256 is run for each recipient after an SMTP DATA command has been
14257 processed and the message itself has been received, but before the
14258 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14259
14260 .option acl_smtp_dkim main string&!! unset
14261 .cindex DKIM "ACL for"
14262 This option defines the ACL that is run for each DKIM signature
14263 (by default, or as specified in the dkim_verify_signers option)
14264 of a received message.
14265 See section &<<SECDKIMVFY>>& for further details.
14266
14267 .option acl_smtp_etrn main string&!! unset
14268 .cindex "ETRN" "ACL for"
14269 This option defines the ACL that is run when an SMTP ETRN command is
14270 received. See chapter &<<CHAPACL>>& for further details.
14271
14272 .option acl_smtp_expn main string&!! unset
14273 .cindex "EXPN" "ACL for"
14274 This option defines the ACL that is run when an SMTP EXPN command is
14275 received. See chapter &<<CHAPACL>>& for further details.
14276
14277 .option acl_smtp_helo main string&!! unset
14278 .cindex "EHLO" "ACL for"
14279 .cindex "HELO" "ACL for"
14280 This option defines the ACL that is run when an SMTP EHLO or HELO
14281 command is received. See chapter &<<CHAPACL>>& for further details.
14282
14283
14284 .option acl_smtp_mail main string&!! unset
14285 .cindex "MAIL" "ACL for"
14286 This option defines the ACL that is run when an SMTP MAIL command is
14287 received. See chapter &<<CHAPACL>>& for further details.
14288
14289 .option acl_smtp_mailauth main string&!! unset
14290 .cindex "AUTH" "on MAIL command"
14291 This option defines the ACL that is run when there is an AUTH parameter on
14292 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14293 &<<CHAPSMTPAUTH>>& for details of authentication.
14294
14295 .option acl_smtp_mime main string&!! unset
14296 .cindex "MIME content scanning" "ACL for"
14297 This option is available when Exim is built with the content-scanning
14298 extension. It defines the ACL that is run for each MIME part in a message. See
14299 section &<<SECTscanmimepart>>& for details.
14300
14301 .option acl_smtp_notquit main string&!! unset
14302 .cindex "not-QUIT, ACL for"
14303 This option defines the ACL that is run when an SMTP session
14304 ends without a QUIT command being received.
14305 See chapter &<<CHAPACL>>& for further details.
14306
14307 .option acl_smtp_predata main string&!! unset
14308 This option defines the ACL that is run when an SMTP DATA command is
14309 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14310 further details.
14311
14312 .option acl_smtp_quit main string&!! unset
14313 .cindex "QUIT, ACL for"
14314 This option defines the ACL that is run when an SMTP QUIT command is
14315 received. See chapter &<<CHAPACL>>& for further details.
14316
14317 .option acl_smtp_rcpt main string&!! unset
14318 .cindex "RCPT" "ACL for"
14319 This option defines the ACL that is run when an SMTP RCPT command is
14320 received. See chapter &<<CHAPACL>>& for further details.
14321
14322 .option acl_smtp_starttls main string&!! unset
14323 .cindex "STARTTLS, ACL for"
14324 This option defines the ACL that is run when an SMTP STARTTLS command is
14325 received. See chapter &<<CHAPACL>>& for further details.
14326
14327 .option acl_smtp_vrfy main string&!! unset
14328 .cindex "VRFY" "ACL for"
14329 This option defines the ACL that is run when an SMTP VRFY command is
14330 received. See chapter &<<CHAPACL>>& for further details.
14331
14332 .option add_environment main "string list" empty
14333 .cindex "environment" "set values"
14334 This option allows to set individual environment variables that the
14335 currently linked libraries and programs in child processes use.
14336 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14337
14338 .option admin_groups main "string list&!!" unset
14339 .cindex "admin user"
14340 This option is expanded just once, at the start of Exim's processing. If the
14341 current group or any of the supplementary groups of an Exim caller is in this
14342 colon-separated list, the caller has admin privileges. If all your system
14343 programmers are in a specific group, for example, you can give them all Exim
14344 admin privileges by putting that group in &%admin_groups%&. However, this does
14345 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14346 To permit this, you have to add individuals to the Exim group.
14347
14348 .option allow_domain_literals main boolean false
14349 .cindex "domain literal"
14350 If this option is set, the RFC 2822 domain literal format is permitted in
14351 email addresses. The option is not set by default, because the domain literal
14352 format is not normally required these days, and few people know about it. It
14353 has, however, been exploited by mail abusers.
14354
14355 Unfortunately, it seems that some DNS black list maintainers are using this
14356 format to report black listing to postmasters. If you want to accept messages
14357 addressed to your hosts by IP address, you need to set
14358 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14359 domains (defined in the named domain list &%local_domains%& in the default
14360 configuration). This &"magic string"& matches the domain literal form of all
14361 the local host's IP addresses.
14362
14363
14364 .option allow_mx_to_ip main boolean false
14365 .cindex "MX record" "pointing to IP address"
14366 It appears that more and more DNS zone administrators are breaking the rules
14367 and putting domain names that look like IP addresses on the right hand side of
14368 MX records. Exim follows the rules and rejects this, giving an error message
14369 that explains the misconfiguration. However, some other MTAs support this
14370 practice, so to avoid &"Why can't Exim do this?"& complaints,
14371 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14372 recommended, except when you have no other choice.
14373
14374 .option allow_utf8_domains main boolean false
14375 .cindex "domain" "UTF-8 characters in"
14376 .cindex "UTF-8" "in domain name"
14377 Lots of discussion is going on about internationalized domain names. One
14378 camp is strongly in favour of just using UTF-8 characters, and it seems
14379 that at least two other MTAs permit this. This option allows Exim users to
14380 experiment if they wish.
14381
14382 If it is set true, Exim's domain parsing function allows valid
14383 UTF-8 multicharacters to appear in domain name components, in addition to
14384 letters, digits, and hyphens. However, just setting this option is not
14385 enough; if you want to look up these domain names in the DNS, you must also
14386 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14387 suitable setting is:
14388 .code
14389 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14390   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14391 .endd
14392 Alternatively, you can just disable this feature by setting
14393 .code
14394 dns_check_names_pattern =
14395 .endd
14396 That is, set the option to an empty string so that no check is done.
14397
14398
14399 .option auth_advertise_hosts main "host list&!!" *
14400 .cindex "authentication" "advertising"
14401 .cindex "AUTH" "advertising"
14402 If any server authentication mechanisms are configured, Exim advertises them in
14403 response to an EHLO command only if the calling host matches this list.
14404 Otherwise, Exim does not advertise AUTH.
14405 Exim does not accept AUTH commands from clients to which it has not
14406 advertised the availability of AUTH. The advertising of individual
14407 authentication mechanisms can be controlled by the use of the
14408 &%server_advertise_condition%& generic authenticator option on the individual
14409 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14410
14411 Certain mail clients (for example, Netscape) require the user to provide a name
14412 and password for authentication if AUTH is advertised, even though it may
14413 not be needed (the host may accept messages from hosts on its local LAN without
14414 authentication, for example). The &%auth_advertise_hosts%& option can be used
14415 to make these clients more friendly by excluding them from the set of hosts to
14416 which Exim advertises AUTH.
14417
14418 .cindex "AUTH" "advertising when encrypted"
14419 If you want to advertise the availability of AUTH only when the connection
14420 is encrypted using TLS, you can make use of the fact that the value of this
14421 option is expanded, with a setting like this:
14422 .code
14423 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14424 .endd
14425 .vindex "&$tls_in_cipher$&"
14426 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14427 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14428 expansion is *, which matches all hosts.
14429
14430
14431 .option auto_thaw main time 0s
14432 .cindex "thawing messages"
14433 .cindex "unfreezing messages"
14434 If this option is set to a time greater than zero, a queue runner will try a
14435 new delivery attempt on any frozen message, other than a bounce message, if
14436 this much time has passed since it was frozen. This may result in the message
14437 being re-frozen if nothing has changed since the last attempt. It is a way of
14438 saying &"keep on trying, even though there are big problems"&.
14439
14440 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14441 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14442 thought to be very useful any more, and its use should probably be avoided.
14443
14444
14445 .option av_scanner main string "see below"
14446 This option is available if Exim is built with the content-scanning extension.
14447 It specifies which anti-virus scanner to use. The default value is:
14448 .code
14449 sophie:/var/run/sophie
14450 .endd
14451 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14452 before use. See section &<<SECTscanvirus>>& for further details.
14453
14454
14455 .option bi_command main string unset
14456 .oindex "&%-bi%&"
14457 This option supplies the name of a command that is run when Exim is called with
14458 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14459 just the command name, it is not a complete command line. If an argument is
14460 required, it must come from the &%-oA%& command line option.
14461
14462
14463 .option bounce_message_file main string unset
14464 .cindex "bounce message" "customizing"
14465 .cindex "customizing" "bounce message"
14466 This option defines a template file containing paragraphs of text to be used
14467 for constructing bounce messages.  Details of the file's contents are given in
14468 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14469
14470
14471 .option bounce_message_text main string unset
14472 When this option is set, its contents are included in the default bounce
14473 message immediately after &"This message was created automatically by mail
14474 delivery software."& It is not used if &%bounce_message_file%& is set.
14475
14476 .option bounce_return_body main boolean true
14477 .cindex "bounce message" "including body"
14478 This option controls whether the body of an incoming message is included in a
14479 bounce message when &%bounce_return_message%& is true. The default setting
14480 causes the entire message, both header and body, to be returned (subject to the
14481 value of &%bounce_return_size_limit%&). If this option is false, only the
14482 message header is included. In the case of a non-SMTP message containing an
14483 error that is detected during reception, only those header lines preceding the
14484 point at which the error was detected are returned.
14485 .cindex "bounce message" "including original"
14486
14487 .option bounce_return_linesize_limit main integer 998
14488 .cindex "size" "of bounce lines, limit"
14489 .cindex "bounce message" "line length limit"
14490 .cindex "limit" "bounce message line length"
14491 This option sets a limit in bytes on the line length of messages
14492 that are returned to senders due to delivery problems,
14493 when &%bounce_return_message%& is true.
14494 The default value corresponds to RFC limits.
14495 If the message being returned has lines longer than this value it is
14496 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14497
14498 The option also applies to bounces returned when an error is detected
14499 during reception of a message.
14500 In this case lines from the original are truncated.
14501
14502 The option does not apply to messages generated by an &(autoreply)& transport.
14503
14504
14505 .option bounce_return_message main boolean true
14506 If this option is set false, none of the original message is included in
14507 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14508 &%bounce_return_body%&.
14509
14510
14511 .option bounce_return_size_limit main integer 100K
14512 .cindex "size" "of bounce, limit"
14513 .cindex "bounce message" "size limit"
14514 .cindex "limit" "bounce message size"
14515 This option sets a limit in bytes on the size of messages that are returned to
14516 senders as part of bounce messages when &%bounce_return_message%& is true. The
14517 limit should be less than the value of the global &%message_size_limit%& and of
14518 any &%message_size_limit%& settings on transports, to allow for the bounce text
14519 that Exim generates. If this option is set to zero there is no limit.
14520
14521 When the body of any message that is to be included in a bounce message is
14522 greater than the limit, it is truncated, and a comment pointing this out is
14523 added at the top. The actual cutoff may be greater than the value given, owing
14524 to the use of buffering for transferring the message in chunks (typically 8K in
14525 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14526 messages.
14527
14528 .option bounce_sender_authentication main string unset
14529 .cindex "bounce message" "sender authentication"
14530 .cindex "authentication" "bounce message"
14531 .cindex "AUTH" "on bounce message"
14532 This option provides an authenticated sender address that is sent with any
14533 bounce messages generated by Exim that are sent over an authenticated SMTP
14534 connection. A typical setting might be:
14535 .code
14536 bounce_sender_authentication = mailer-daemon@my.domain.example
14537 .endd
14538 which would cause bounce messages to be sent using the SMTP command:
14539 .code
14540 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14541 .endd
14542 The value of &%bounce_sender_authentication%& must always be a complete email
14543 address.
14544
14545 .option callout_domain_negative_expire main time 3h
14546 .cindex "caching" "callout timeouts"
14547 .cindex "callout" "caching timeouts"
14548 This option specifies the expiry time for negative callout cache data for a
14549 domain. See section &<<SECTcallver>>& for details of callout verification, and
14550 section &<<SECTcallvercache>>& for details of the caching.
14551
14552
14553 .option callout_domain_positive_expire main time 7d
14554 This option specifies the expiry time for positive callout cache data for a
14555 domain. See section &<<SECTcallver>>& for details of callout verification, and
14556 section &<<SECTcallvercache>>& for details of the caching.
14557
14558
14559 .option callout_negative_expire main time 2h
14560 This option specifies the expiry time for negative callout cache data for an
14561 address. See section &<<SECTcallver>>& for details of callout verification, and
14562 section &<<SECTcallvercache>>& for details of the caching.
14563
14564
14565 .option callout_positive_expire main time 24h
14566 This option specifies the expiry time for positive callout cache data for an
14567 address. See section &<<SECTcallver>>& for details of callout verification, and
14568 section &<<SECTcallvercache>>& for details of the caching.
14569
14570
14571 .option callout_random_local_part main string&!! "see below"
14572 This option defines the &"random"& local part that can be used as part of
14573 callout verification. The default value is
14574 .code
14575 $primary_hostname-$tod_epoch-testing
14576 .endd
14577 See section &<<CALLaddparcall>>& for details of how this value is used.
14578
14579
14580 .option check_log_inodes main integer 100
14581 See &%check_spool_space%& below.
14582
14583
14584 .option check_log_space main integer 10M
14585 See &%check_spool_space%& below.
14586
14587 .oindex "&%check_rfc2047_length%&"
14588 .cindex "RFC 2047" "disabling length check"
14589 .option check_rfc2047_length main boolean true
14590 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14591 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14592 word; strings to be encoded that exceed this length are supposed to use
14593 multiple encoded words. By default, Exim does not recognize encoded words that
14594 exceed the maximum length. However, it seems that some software, in violation
14595 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14596 set false, Exim recognizes encoded words of any length.
14597
14598
14599 .option check_spool_inodes main integer 100
14600 See &%check_spool_space%& below.
14601
14602
14603 .option check_spool_space main integer 10M
14604 .cindex "checking disk space"
14605 .cindex "disk space, checking"
14606 .cindex "spool directory" "checking space"
14607 The four &%check_...%& options allow for checking of disk resources before a
14608 message is accepted.
14609
14610 .vindex "&$log_inodes$&"
14611 .vindex "&$log_space$&"
14612 .vindex "&$spool_inodes$&"
14613 .vindex "&$spool_space$&"
14614 When any of these options are nonzero, they apply to all incoming messages. If you
14615 want to apply different checks to different kinds of message, you can do so by
14616 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14617 &$spool_space$& in an ACL with appropriate additional conditions.
14618
14619
14620 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14621 either value is greater than zero, for example:
14622 .code
14623 check_spool_space = 100M
14624 check_spool_inodes = 100
14625 .endd
14626 The spool partition is the one that contains the directory defined by
14627 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14628 transit.
14629
14630 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14631 files are written if either is greater than zero. These should be set only if
14632 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14633
14634 If there is less space or fewer inodes than requested, Exim refuses to accept
14635 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14636 error response to the MAIL command. If ESMTP is in use and there was a
14637 SIZE parameter on the MAIL command, its value is added to the
14638 &%check_spool_space%& value, and the check is performed even if
14639 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14640
14641 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14642 number of kilobytes (though specified in bytes).
14643 If a non-multiple of 1024 is specified, it is rounded up.
14644
14645 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14646 failure a message is written to stderr and Exim exits with a non-zero code, as
14647 it obviously cannot send an error message of any kind.
14648
14649 There is a slight performance penalty for these checks.
14650 Versions of Exim preceding 4.88 had these disabled by default;
14651 high-rate installations confident they will never run out of resources
14652 may wish to deliberately disable them.
14653
14654 .option chunking_advertise_hosts main "host list&!!" *
14655 .cindex CHUNKING advertisement
14656 .cindex "RFC 3030" "CHUNKING"
14657 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
14658 these hosts.
14659 Hosts may use the BDAT command as an alternate to DATA.
14660
14661 .option commandline_checks_require_admin main boolean &`false`&
14662 .cindex "restricting access to features"
14663 This option restricts various basic checking features to require an
14664 administrative user.
14665 This affects most of the &%-b*%& options, such as &%-be%&.
14666
14667 .option debug_store main boolean &`false`&
14668 .cindex debugging "memory corruption"
14669 .cindex memory debugging
14670 This option, when true, enables extra checking in Exim's internal memory
14671 management.  For use when a memory corruption issue is being investigated,
14672 it should normally be left as default.
14673
14674 .option daemon_smtp_ports main string &`smtp`&
14675 .cindex "port" "for daemon"
14676 .cindex "TCP/IP" "setting listening ports"
14677 This option specifies one or more default SMTP ports on which the Exim daemon
14678 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14679 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14680
14681 .option daemon_startup_retries main integer 9
14682 .cindex "daemon startup, retrying"
14683 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14684 the daemon at startup when it cannot immediately bind a listening socket
14685 (typically because the socket is already in use): &%daemon_startup_retries%&
14686 defines the number of retries after the first failure, and
14687 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14688
14689 .option daemon_startup_sleep main time 30s
14690 See &%daemon_startup_retries%&.
14691
14692 .option delay_warning main "time list" 24h
14693 .cindex "warning of delay"
14694 .cindex "delay warning, specifying"
14695 .cindex "queue" "delay warning"
14696 When a message is delayed, Exim sends a warning message to the sender at
14697 intervals specified by this option. The data is a colon-separated list of times
14698 after which to send warning messages. If the value of the option is an empty
14699 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14700 message has been on the queue for longer than the last time, the last interval
14701 between the times is used to compute subsequent warning times. For example,
14702 with
14703 .code
14704 delay_warning = 4h:8h:24h
14705 .endd
14706 the first message is sent after 4 hours, the second after 8 hours, and
14707 the third one after 24 hours. After that, messages are sent every 16 hours,
14708 because that is the interval between the last two times on the list. If you set
14709 just one time, it specifies the repeat interval. For example, with:
14710 .code
14711 delay_warning = 6h
14712 .endd
14713 messages are repeated every six hours. To stop warnings after a given time, set
14714 a very large time at the end of the list. For example:
14715 .code
14716 delay_warning = 2h:12h:99d
14717 .endd
14718 Note that the option is only evaluated at the time a delivery attempt fails,
14719 which depends on retry and queue-runner configuration.
14720 Typically retries will be configured more frequently than warning messages.
14721
14722 .option delay_warning_condition main string&!! "see below"
14723 .vindex "&$domain$&"
14724 The string is expanded at the time a warning message might be sent. If all the
14725 deferred addresses have the same domain, it is set in &$domain$& during the
14726 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14727 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14728 &"false"& (the comparison being done caselessly) then the warning message is
14729 not sent. The default is:
14730 .code
14731 delay_warning_condition = ${if or {\
14732   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14733   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14734   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14735   } {no}{yes}}
14736 .endd
14737 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14738 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14739 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14740 &"auto-replied"& in an &'Auto-Submitted:'& header.
14741
14742 .option deliver_drop_privilege main boolean false
14743 .cindex "unprivileged delivery"
14744 .cindex "delivery" "unprivileged"
14745 If this option is set true, Exim drops its root privilege at the start of a
14746 delivery process, and runs as the Exim user throughout. This severely restricts
14747 the kinds of local delivery that are possible, but is viable in certain types
14748 of configuration. There is a discussion about the use of root privilege in
14749 chapter &<<CHAPsecurity>>&.
14750
14751 .option deliver_queue_load_max main fixed-point unset
14752 .cindex "load average"
14753 .cindex "queue runner" "abandoning"
14754 When this option is set, a queue run is abandoned if the system load average
14755 becomes greater than the value of the option. The option has no effect on
14756 ancient operating systems on which Exim cannot determine the load average.
14757 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14758
14759
14760 .option delivery_date_remove main boolean true
14761 .cindex "&'Delivery-date:'& header line"
14762 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14763 message when it is delivered, in exactly the same way as &'Return-path:'& is
14764 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14765 should not be present in incoming messages, and this option causes them to be
14766 removed at the time the message is received, to avoid any problems that might
14767 occur when a delivered message is subsequently sent on to some other recipient.
14768
14769 .option disable_fsync main boolean false
14770 .cindex "&[fsync()]&, disabling"
14771 This option is available only if Exim was built with the compile-time option
14772 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14773 a runtime configuration generates an &"unknown option"& error. You should not
14774 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14775 really, really, really understand what you are doing. &'No pre-compiled
14776 distributions of Exim should ever make this option available.'&
14777
14778 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14779 updated files' data to be written to disc before continuing. Unexpected events
14780 such as crashes and power outages may cause data to be lost or scrambled.
14781 Here be Dragons. &*Beware.*&
14782
14783
14784 .option disable_ipv6 main boolean false
14785 .cindex "IPv6" "disabling"
14786 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14787 activities take place. AAAA records are never looked up, and any IPv6 addresses
14788 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14789 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14790 to handle IPv6 literal addresses.
14791
14792
14793 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14794 .cindex DKIM "controlling calls to the ACL"
14795 This option gives a list of DKIM domains for which the DKIM ACL is run.
14796 It is expanded after the message is received; by default it runs
14797 the ACL once for each signature in the message.
14798 See section &<<SECDKIMVFY>>&.
14799
14800
14801 .option dns_again_means_nonexist main "domain list&!!" unset
14802 .cindex "DNS" "&""try again""& response; overriding"
14803 DNS lookups give a &"try again"& response for the DNS errors
14804 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14805 keep trying to deliver a message, or to give repeated temporary errors to
14806 incoming mail. Sometimes the effect is caused by a badly set up name server and
14807 may persist for a long time. If a domain which exhibits this problem matches
14808 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14809 This option should be used with care. You can make it apply to reverse lookups
14810 by a setting such as this:
14811 .code
14812 dns_again_means_nonexist = *.in-addr.arpa
14813 .endd
14814 This option applies to all DNS lookups that Exim does. It also applies when the
14815 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14816 since these are most likely to be caused by DNS lookup problems. The
14817 &(dnslookup)& router has some options of its own for controlling what happens
14818 when lookups for MX or SRV records give temporary errors. These more specific
14819 options are applied after this global option.
14820
14821 .option dns_check_names_pattern main string "see below"
14822 .cindex "DNS" "pre-check of name syntax"
14823 When this option is set to a non-empty string, it causes Exim to check domain
14824 names for characters that are not allowed in host names before handing them to
14825 the DNS resolver, because some resolvers give temporary errors for names that
14826 contain unusual characters. If a domain name contains any unwanted characters,
14827 a &"not found"& result is forced, and the resolver is not called. The check is
14828 done by matching the domain name against a regular expression, which is the
14829 value of this option. The default pattern is
14830 .code
14831 dns_check_names_pattern = \
14832   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14833 .endd
14834 which permits only letters, digits, slashes, and hyphens in components, but
14835 they must start and end with a letter or digit. Slashes are not, in fact,
14836 permitted in host names, but they are found in certain NS records (which can be
14837 accessed in Exim by using a &%dnsdb%& lookup). If you set
14838 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14839 empty string.
14840
14841 .option dns_csa_search_limit main integer 5
14842 This option controls the depth of parental searching for CSA SRV records in the
14843 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14844
14845 .option dns_csa_use_reverse main boolean true
14846 This option controls whether or not an IP address, given as a CSA domain, is
14847 reversed and looked up in the reverse DNS, as described in more detail in
14848 section &<<SECTverifyCSA>>&.
14849
14850 .new
14851 .option dns_cname_loops main integer 1
14852 .cindex DNS "CNAME following"
14853 This option controls the following of CNAME chains, needed if the resolver does
14854 not do it internally.
14855 As of 2018 most should, and the default can be left.
14856 If you have an ancient one, a value of 10 is likely needed.
14857
14858 The default value of one CNAME-follow is needed
14859 thanks to the observed return for an MX request,
14860 given no MX presence but a CNAME to an A, of the CNAME.
14861 .wen
14862
14863
14864 .option dns_dnssec_ok main integer -1
14865 .cindex "DNS" "resolver options"
14866 .cindex "DNS" "DNSSEC"
14867 If this option is set to a non-negative number then Exim will initialise the
14868 DNS resolver library to either use or not use DNSSEC, overriding the system
14869 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14870
14871 If the resolver library does not support DNSSEC then this option has no effect.
14872
14873
14874 .option dns_ipv4_lookup main "domain list&!!" unset
14875 .cindex "IPv6" "DNS lookup for AAAA records"
14876 .cindex "DNS" "IPv6 lookup for AAAA records"
14877 .cindex DNS "IPv6 disabling"
14878 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14879 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14880 (A records) when trying to find IP addresses for hosts, unless the host's
14881 domain matches this list.
14882
14883 This is a fudge to help with name servers that give big delays or otherwise do
14884 not work for the AAAA record type. In due course, when the world's name
14885 servers have all been upgraded, there should be no need for this option.
14886
14887
14888 .option dns_retrans main time 0s
14889 .cindex "DNS" "resolver options"
14890 .cindex timeout "dns lookup"
14891 .cindex "DNS" timeout
14892 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14893 retransmission and retry parameters for DNS lookups. Values of zero (the
14894 defaults) leave the system default settings unchanged. The first value is the
14895 time between retries, and the second is the number of retries. It isn't
14896 totally clear exactly how these settings affect the total time a DNS lookup may
14897 take. I haven't found any documentation about timeouts on DNS lookups; these
14898 parameter values are available in the external resolver interface structure,
14899 but nowhere does it seem to describe how they are used or what you might want
14900 to set in them.
14901 See also the &%slow_lookup_log%& option.
14902
14903
14904 .option dns_retry main integer 0
14905 See &%dns_retrans%& above.
14906
14907
14908 .option dns_trust_aa main "domain list&!!" unset
14909 .cindex "DNS" "resolver options"
14910 .cindex "DNS" "DNSSEC"
14911 If this option is set then lookup results marked with the AA bit
14912 (Authoritative Answer) are trusted the same way as if they were
14913 DNSSEC-verified. The authority section's name of the answer must
14914 match with this expanded domain list.
14915
14916 Use this option only if you talk directly to a resolver that is
14917 authoritative for some zones and does not set the AD (Authentic Data)
14918 bit in the answer. Some DNS servers may have an configuration option to
14919 mark the answers from their own zones as verified (they set the AD bit).
14920 Others do not have this option. It is considered as poor practice using
14921 a resolver that is an authoritative server for some zones.
14922
14923 Use this option only if you really have to (e.g. if you want
14924 to use DANE for remote delivery to a server that is listed in the DNS
14925 zones that your resolver is authoritative for).
14926
14927 If the DNS answer packet has the AA bit set and contains resource record
14928 in the answer section, the name of the first NS record appearing in the
14929 authority section is compared against the list. If the answer packet is
14930 authoritative but the answer section is empty, the name of the first SOA
14931 record in the authoritative section is used instead.
14932
14933 .cindex "DNS" "resolver options"
14934 .option dns_use_edns0 main integer -1
14935 .cindex "DNS" "resolver options"
14936 .cindex "DNS" "EDNS0"
14937 .cindex "DNS" "OpenBSD
14938 If this option is set to a non-negative number then Exim will initialise the
14939 DNS resolver library to either use or not use EDNS0 extensions, overriding
14940 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14941 on.
14942
14943 If the resolver library does not support EDNS0 then this option has no effect.
14944
14945 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
14946 means that DNSSEC will not work with Exim on that platform either, unless Exim
14947 is linked against an alternative DNS client library.
14948
14949
14950 .option drop_cr main boolean false
14951 This is an obsolete option that is now a no-op. It used to affect the way Exim
14952 handled CR and LF characters in incoming messages. What happens now is
14953 described in section &<<SECTlineendings>>&.
14954
14955 .option dsn_advertise_hosts main "host list&!!" unset
14956 .cindex "bounce messages" "success"
14957 .cindex "DSN" "success"
14958 .cindex "Delivery Status Notification" "success"
14959 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14960 and accepted from, these hosts.
14961 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14962 and RET and ORCPT options on MAIL FROM commands.
14963 A NOTIFY=SUCCESS option requests success-DSN messages.
14964 A NOTIFY= option with no argument requests that no delay or failure DSNs
14965 are sent.
14966
14967 .option dsn_from main "string&!!" "see below"
14968 .cindex "&'From:'& header line" "in bounces"
14969 .cindex "bounce messages" "&'From:'& line, specifying"
14970 This option can be used to vary the contents of &'From:'& header lines in
14971 bounces and other automatically generated messages (&"Delivery Status
14972 Notifications"& &-- hence the name of the option). The default setting is:
14973 .code
14974 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14975 .endd
14976 The value is expanded every time it is needed. If the expansion fails, a
14977 panic is logged, and the default value is used.
14978
14979 .option envelope_to_remove main boolean true
14980 .cindex "&'Envelope-to:'& header line"
14981 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14982 message when it is delivered, in exactly the same way as &'Return-path:'& is
14983 handled. &'Envelope-to:'& records the original recipient address from the
14984 message's envelope that caused the delivery to happen. Such headers should not
14985 be present in incoming messages, and this option causes them to be removed at
14986 the time the message is received, to avoid any problems that might occur when a
14987 delivered message is subsequently sent on to some other recipient.
14988
14989
14990 .option errors_copy main "string list&!!" unset
14991 .cindex "bounce message" "copy to other address"
14992 .cindex "copy of bounce message"
14993 Setting this option causes Exim to send bcc copies of bounce messages that it
14994 generates to other addresses. &*Note*&: This does not apply to bounce messages
14995 coming from elsewhere. The value of the option is a colon-separated list of
14996 items. Each item consists of a pattern, terminated by white space, followed by
14997 a comma-separated list of email addresses. If a pattern contains spaces, it
14998 must be enclosed in double quotes.
14999
15000 Each pattern is processed in the same way as a single item in an address list
15001 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15002 the bounce message, the message is copied to the addresses on the list. The
15003 items are scanned in order, and once a matching one is found, no further items
15004 are examined. For example:
15005 .code
15006 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15007               rqps@mydomain   hostmaster@mydomain.example,\
15008                               postmaster@mydomain.example
15009 .endd
15010 .vindex "&$domain$&"
15011 .vindex "&$local_part$&"
15012 The address list is expanded before use. The expansion variables &$local_part$&
15013 and &$domain$& are set from the original recipient of the error message, and if
15014 there was any wildcard matching in the pattern, the expansion
15015 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15016 variables &$0$&, &$1$&, etc. are set in the normal way.
15017
15018
15019 .option errors_reply_to main string unset
15020 .cindex "bounce message" "&'Reply-to:'& in"
15021 By default, Exim's bounce and delivery warning messages contain the header line
15022 .display
15023 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15024 .endd
15025 .oindex &%quota_warn_message%&
15026 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15027 A warning message that is generated by the &%quota_warn_message%& option in an
15028 &(appendfile)& transport may contain its own &'From:'& header line that
15029 overrides the default.
15030
15031 Experience shows that people reply to bounce messages. If the
15032 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15033 and warning messages. For example:
15034 .code
15035 errors_reply_to = postmaster@my.domain.example
15036 .endd
15037 The value of the option is not expanded. It must specify a valid RFC 2822
15038 address. However, if a warning message that is generated by the
15039 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15040 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15041 not used.
15042
15043
15044 .option event_action main string&!! unset
15045 .cindex events
15046 This option declares a string to be expanded for Exim's events mechanism.
15047 For details see chapter &<<CHAPevents>>&.
15048
15049
15050 .option exim_group main string "compile-time configured"
15051 .cindex "gid (group id)" "Exim's own"
15052 .cindex "Exim group"
15053 This option changes the gid under which Exim runs when it gives up root
15054 privilege. The default value is compiled into the binary. The value of this
15055 option is used only when &%exim_user%& is also set. Unless it consists entirely
15056 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15057 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15058 security issues.
15059
15060
15061 .option exim_path main string "see below"
15062 .cindex "Exim binary, path name"
15063 This option specifies the path name of the Exim binary, which is used when Exim
15064 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15065 the directory configured at compile time by the BIN_DIRECTORY setting. It
15066 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15067 other place.
15068 &*Warning*&: Do not use a macro to define the value of this option, because
15069 you will break those Exim utilities that scan the configuration file to find
15070 where the binary is. (They then use the &%-bP%& option to extract option
15071 settings such as the value of &%spool_directory%&.)
15072
15073
15074 .option exim_user main string "compile-time configured"
15075 .cindex "uid (user id)" "Exim's own"
15076 .cindex "Exim user"
15077 This option changes the uid under which Exim runs when it gives up root
15078 privilege. The default value is compiled into the binary. Ownership of the run
15079 time configuration file and the use of the &%-C%& and &%-D%& command line
15080 options is checked against the values in the binary, not what is set here.
15081
15082 Unless it consists entirely of digits, the string is looked up using
15083 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15084 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15085 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15086
15087
15088 .option extra_local_interfaces main "string list" unset
15089 This option defines network interfaces that are to be considered local when
15090 routing, but which are not used for listening by the daemon. See section
15091 &<<SECTreclocipadd>>& for details.
15092
15093
15094 . Allow this long option name to split; give it unsplit as a fifth argument
15095 . for the automatic .oindex that is generated by .option.
15096
15097 .option "extract_addresses_remove_arguments" main boolean true &&&
15098          extract_addresses_remove_arguments
15099 .oindex "&%-t%&"
15100 .cindex "command line" "addresses with &%-t%&"
15101 .cindex "Sendmail compatibility" "&%-t%& option"
15102 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15103 are present on the command line when the &%-t%& option is used to build an
15104 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15105 line addresses are removed from the recipients list. This is also how Smail
15106 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15107 command line addresses are added to those obtained from the header lines. When
15108 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15109 argument headers. If it is set false, Exim adds rather than removes argument
15110 addresses.
15111
15112
15113 .option finduser_retries main integer 0
15114 .cindex "NIS, retrying user lookups"
15115 On systems running NIS or other schemes in which user and group information is
15116 distributed from a remote system, there can be times when &[getpwnam()]& and
15117 related functions fail, even when given valid data, because things time out.
15118 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15119 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15120 many extra times to find a user or a group, waiting for one second between
15121 retries.
15122
15123 .cindex "&_/etc/passwd_&" "multiple reading of"
15124 You should not set this option greater than zero if your user information is in
15125 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15126 search the file multiple times for non-existent users, and also cause delay.
15127
15128
15129
15130 .option freeze_tell main "string list, comma separated" unset
15131 .cindex "freezing messages" "sending a message when freezing"
15132 On encountering certain errors, or when configured to do so in a system filter,
15133 ACL, or special router, Exim freezes a message. This means that no further
15134 delivery attempts take place until an administrator thaws the message, or the
15135 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15136 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15137 warning message whenever it freezes something, unless the message it is
15138 freezing is a locally-generated bounce message. (Without this exception there
15139 is the possibility of looping.) The warning message is sent to the addresses
15140 supplied as the comma-separated value of this option. If several of the
15141 message's addresses cause freezing, only a single message is sent. If the
15142 freezing was automatic, the reason(s) for freezing can be found in the message
15143 log. If you configure freezing in a filter or ACL, you must arrange for any
15144 logging that you require.
15145
15146
15147 .option gecos_name main string&!! unset
15148 .cindex "HP-UX"
15149 .cindex "&""gecos""& field, parsing"
15150 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15151 password file to hold other information in addition to users' real names. Exim
15152 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15153 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15154 of the field are used unchanged, except that, if an ampersand is encountered,
15155 it is replaced by the user's login name with the first character forced to
15156 upper case, since this is a convention that is observed on many systems.
15157
15158 When these options are set, &%gecos_pattern%& is treated as a regular
15159 expression that is to be applied to the field (again with && replaced by the
15160 login name), and if it matches, &%gecos_name%& is expanded and used as the
15161 user's name.
15162
15163 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15164 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15165 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15166 name terminates at the first comma, the following can be used:
15167 .code
15168 gecos_pattern = ([^,]*)
15169 gecos_name = $1
15170 .endd
15171
15172 .option gecos_pattern main string unset
15173 See &%gecos_name%& above.
15174
15175
15176 .option gnutls_compat_mode main boolean unset
15177 This option controls whether GnuTLS is used in compatibility mode in an Exim
15178 server. This reduces security slightly, but improves interworking with older
15179 implementations of TLS.
15180
15181
15182 .option gnutls_allow_auto_pkcs11 main boolean unset
15183 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15184 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15185
15186 See
15187 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15188 for documentation.
15189
15190
15191
15192 .option headers_charset main string "see below"
15193 This option sets a default character set for translating from encoded MIME
15194 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15195 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15196 ultimate default is ISO-8859-1. For more details see the description of header
15197 insertions in section &<<SECTexpansionitems>>&.
15198
15199
15200
15201 .option header_maxsize main integer "see below"
15202 .cindex "header section" "maximum size of"
15203 .cindex "limit" "size of message header section"
15204 This option controls the overall maximum size of a message's header
15205 section. The default is the value of HEADER_MAXSIZE in
15206 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15207 sections are rejected.
15208
15209
15210 .option header_line_maxsize main integer 0
15211 .cindex "header lines" "maximum size of"
15212 .cindex "limit" "size of one header line"
15213 This option limits the length of any individual header line in a message, after
15214 all the continuations have been joined together. Messages with individual
15215 header lines that are longer than the limit are rejected. The default value of
15216 zero means &"no limit"&.
15217
15218
15219
15220
15221 .option helo_accept_junk_hosts main "host list&!!" unset
15222 .cindex "HELO" "accepting junk data"
15223 .cindex "EHLO" "accepting junk data"
15224 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15225 mail, and gives an error response for invalid data. Unfortunately, there are
15226 some SMTP clients that send syntactic junk. They can be accommodated by setting
15227 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15228 if you want to do semantic checking.
15229 See also &%helo_allow_chars%& for a way of extending the permitted character
15230 set.
15231
15232
15233 .option helo_allow_chars main string unset
15234 .cindex "HELO" "underscores in"
15235 .cindex "EHLO" "underscores in"
15236 .cindex "underscore in EHLO/HELO"
15237 This option can be set to a string of rogue characters that are permitted in
15238 all EHLO and HELO names in addition to the standard letters, digits,
15239 hyphens, and dots. If you really must allow underscores, you can set
15240 .code
15241 helo_allow_chars = _
15242 .endd
15243 Note that the value is one string, not a list.
15244
15245
15246 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15247 .cindex "HELO" "forcing reverse lookup"
15248 .cindex "EHLO" "forcing reverse lookup"
15249 If the domain given by a client in a HELO or EHLO command matches this
15250 list, a reverse lookup is done in order to establish the host's true name. The
15251 default forces a lookup if the client host gives the server's name or any of
15252 its IP addresses (in brackets), something that broken clients have been seen to
15253 do.
15254
15255
15256 .option helo_try_verify_hosts main "host list&!!" unset
15257 .cindex "HELO verifying" "optional"
15258 .cindex "EHLO" "verifying, optional"
15259 By default, Exim just checks the syntax of HELO and EHLO commands (see
15260 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15261 to do more extensive checking of the data supplied by these commands. The ACL
15262 condition &`verify = helo`& is provided to make this possible.
15263 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15264 to force the check to occur. From release 4.53 onwards, this is no longer
15265 necessary. If the check has not been done before &`verify = helo`& is
15266 encountered, it is done at that time. Consequently, this option is obsolete.
15267 Its specification is retained here for backwards compatibility.
15268
15269 When an EHLO or HELO command is received, if the calling host matches
15270 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15271 EHLO command either:
15272
15273 .ilist
15274 is an IP literal matching the calling address of the host, or
15275 .next
15276 .cindex "DNS" "reverse lookup"
15277 .cindex "reverse DNS lookup"
15278 matches the host name that Exim obtains by doing a reverse lookup of the
15279 calling host address, or
15280 .next
15281 when looked up in DNS yields the calling host address.
15282 .endlist
15283
15284 However, the EHLO or HELO command is not rejected if any of the checks
15285 fail. Processing continues, but the result of the check is remembered, and can
15286 be detected later in an ACL by the &`verify = helo`& condition.
15287
15288 If DNS was used for successful verification, the variable
15289 .cindex "DNS" "DNSSEC"
15290 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15291
15292 .option helo_verify_hosts main "host list&!!" unset
15293 .cindex "HELO verifying" "mandatory"
15294 .cindex "EHLO" "verifying, mandatory"
15295 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15296 backwards compatibility. For hosts that match this option, Exim checks the host
15297 name given in the HELO or EHLO in the same way as for
15298 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15299 rejected with a 550 error, and entries are written to the main and reject logs.
15300 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15301 error.
15302
15303 .option hold_domains main "domain list&!!" unset
15304 .cindex "domain" "delaying delivery"
15305 .cindex "delivery" "delaying certain domains"
15306 This option allows mail for particular domains to be held on the queue
15307 manually. The option is overridden if a message delivery is forced with the
15308 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15309 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15310 item in &%hold_domains%&, no routing or delivery for that address is done, and
15311 it is deferred every time the message is looked at.
15312
15313 This option is intended as a temporary operational measure for delaying the
15314 delivery of mail while some problem is being sorted out, or some new
15315 configuration tested. If you just want to delay the processing of some
15316 domains until a queue run occurs, you should use &%queue_domains%& or
15317 &%queue_smtp_domains%&, not &%hold_domains%&.
15318
15319 A setting of &%hold_domains%& does not override Exim's code for removing
15320 messages from the queue if they have been there longer than the longest retry
15321 time in any retry rule. If you want to hold messages for longer than the normal
15322 retry times, insert a dummy retry rule with a long retry time.
15323
15324
15325 .option host_lookup main "host list&!!" unset
15326 .cindex "host name" "lookup, forcing"
15327 Exim does not look up the name of a calling host from its IP address unless it
15328 is required to compare against some host list, or the host matches
15329 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15330 option (which normally contains IP addresses rather than host names). The
15331 default configuration file contains
15332 .code
15333 host_lookup = *
15334 .endd
15335 which causes a lookup to happen for all hosts. If the expense of these lookups
15336 is felt to be too great, the setting can be changed or removed.
15337
15338 After a successful reverse lookup, Exim does a forward lookup on the name it
15339 has obtained, to verify that it yields the IP address that it started with. If
15340 this check fails, Exim behaves as if the name lookup failed.
15341
15342 .vindex "&$host_lookup_failed$&"
15343 .vindex "&$sender_host_name$&"
15344 After any kind of failure, the host name (in &$sender_host_name$&) remains
15345 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15346 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15347 &`verify = reverse_host_lookup`& in ACLs.
15348
15349
15350 .option host_lookup_order main "string list" &`bydns:byaddr`&
15351 This option specifies the order of different lookup methods when Exim is trying
15352 to find a host name from an IP address. The default is to do a DNS lookup
15353 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15354 if that fails. You can change the order of these lookups, or omit one entirely,
15355 if you want.
15356
15357 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15358 multiple PTR records in the DNS and the IP address is not listed in
15359 &_/etc/hosts_&. Different operating systems give different results in this
15360 case. That is why the default tries a DNS lookup first.
15361
15362
15363
15364 .option host_reject_connection main "host list&!!" unset
15365 .cindex "host" "rejecting connections from"
15366 If this option is set, incoming SMTP calls from the hosts listed are rejected
15367 as soon as the connection is made.
15368 This option is obsolete, and retained only for backward compatibility, because
15369 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15370 connections immediately.
15371
15372 The ability to give an immediate rejection (either by this option or using an
15373 ACL) is provided for use in unusual cases. Many hosts will just try again,
15374 sometimes without much delay. Normally, it is better to use an ACL to reject
15375 incoming messages at a later stage, such as after RCPT commands. See
15376 chapter &<<CHAPACL>>&.
15377
15378
15379 .option hosts_connection_nolog main "host list&!!" unset
15380 .cindex "host" "not logging connections from"
15381 This option defines a list of hosts for which connection logging does not
15382 happen, even though the &%smtp_connection%& log selector is set. For example,
15383 you might want not to log SMTP connections from local processes, or from
15384 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15385 the daemon; you should therefore strive to restrict its value to a short inline
15386 list of IP addresses and networks. To disable logging SMTP connections from
15387 local processes, you must create a host list with an empty item. For example:
15388 .code
15389 hosts_connection_nolog = :
15390 .endd
15391 If the &%smtp_connection%& log selector is not set, this option has no effect.
15392
15393
15394
15395 .option hosts_proxy main "host list&!!" unset
15396 .cindex proxy "proxy protocol"
15397 This option enables use of Proxy Protocol proxies for incoming
15398 connections.  For details see section &<<SECTproxyInbound>>&.
15399
15400
15401 .option hosts_treat_as_local main "domain list&!!" unset
15402 .cindex "local host" "domains treated as"
15403 .cindex "host" "treated as local"
15404 If this option is set, any host names that match the domain list are treated as
15405 if they were the local host when Exim is scanning host lists obtained from MX
15406 records
15407 or other sources. Note that the value of this option is a domain list, not a
15408 host list, because it is always used to check host names, not IP addresses.
15409
15410 This option also applies when Exim is matching the special items
15411 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15412 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15413 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15414 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15415 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15416 interfaces and recognizing the local host.
15417
15418
15419 .option ibase_servers main "string list" unset
15420 .cindex "InterBase" "server list"
15421 This option provides a list of InterBase servers and associated connection data,
15422 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15423 The option is available only if Exim has been built with InterBase support.
15424
15425
15426
15427 .option ignore_bounce_errors_after main time 10w
15428 .cindex "bounce message" "discarding"
15429 .cindex "discarding bounce message"
15430 This option affects the processing of bounce messages that cannot be delivered,
15431 that is, those that suffer a permanent delivery failure. (Bounce messages that
15432 suffer temporary delivery failures are of course retried in the usual way.)
15433
15434 After a permanent delivery failure, bounce messages are frozen,
15435 because there is no sender to whom they can be returned. When a frozen bounce
15436 message has been on the queue for more than the given time, it is unfrozen at
15437 the next queue run, and a further delivery is attempted. If delivery fails
15438 again, the bounce message is discarded. This makes it possible to keep failed
15439 bounce messages around for a shorter time than the normal maximum retry time
15440 for frozen messages. For example,
15441 .code
15442 ignore_bounce_errors_after = 12h
15443 .endd
15444 retries failed bounce message deliveries after 12 hours, discarding any further
15445 failures. If the value of this option is set to a zero time period, bounce
15446 failures are discarded immediately. Setting a very long time (as in the default
15447 value) has the effect of disabling this option. For ways of automatically
15448 dealing with other kinds of frozen message, see &%auto_thaw%& and
15449 &%timeout_frozen_after%&.
15450
15451
15452 .option ignore_fromline_hosts main "host list&!!" unset
15453 .cindex "&""From""& line"
15454 .cindex "UUCP" "&""From""& line"
15455 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15456 the headers of a message. By default this is treated as the start of the
15457 message's body, which means that any following headers are not recognized as
15458 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15459 match those hosts that insist on sending it. If the sender is actually a local
15460 process rather than a remote host, and is using &%-bs%& to inject the messages,
15461 &%ignore_fromline_local%& must be set to achieve this effect.
15462
15463
15464 .option ignore_fromline_local main boolean false
15465 See &%ignore_fromline_hosts%& above.
15466
15467 .option keep_environment main "string list" unset
15468 .cindex "environment" "values from"
15469 This option contains a string list of environment variables to keep.
15470 You have to trust these variables or you have to be sure that
15471 these variables do not impose any security risk. Keep in mind that
15472 during the startup phase Exim is running with an effective UID 0 in most
15473 installations. As the default value is an empty list, the default
15474 environment for using libraries, running embedded Perl code, or running
15475 external binaries is empty, and does not not even contain PATH or HOME.
15476
15477 Actually the list is interpreted as a list of patterns
15478 (&<<SECTlistexpand>>&), except that it is not expanded first.
15479
15480 WARNING: Macro substitution is still done first, so having a macro
15481 FOO and having FOO_HOME in your &%keep_environment%& option may have
15482 unexpected results. You may work around this using a regular expression
15483 that does not match the macro name: ^[F]OO_HOME$.
15484
15485 Current versions of Exim issue a warning during startup if you do not mention
15486 &%keep_environment%& in your runtime configuration file and if your
15487 current environment is not empty. Future versions may not issue that warning
15488 anymore.
15489
15490 See the &%add_environment%& main config option for a way to set
15491 environment variables to a fixed value.  The environment for &(pipe)&
15492 transports is handled separately, see section &<<SECTpipeenv>>& for
15493 details.
15494
15495
15496 .option keep_malformed main time 4d
15497 This option specifies the length of time to keep messages whose spool files
15498 have been corrupted in some way. This should, of course, never happen. At the
15499 next attempt to deliver such a message, it gets removed. The incident is
15500 logged.
15501
15502
15503 .option ldap_ca_cert_dir main string unset
15504 .cindex "LDAP", "TLS CA certificate directory"
15505 .cindex certificate "directory for LDAP"
15506 This option indicates which directory contains CA certificates for verifying
15507 a TLS certificate presented by an LDAP server.
15508 While Exim does not provide a default value, your SSL library may.
15509 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15510 and constrained to be a directory.
15511
15512
15513 .option ldap_ca_cert_file main string unset
15514 .cindex "LDAP", "TLS CA certificate file"
15515 .cindex certificate "file for LDAP"
15516 This option indicates which file contains CA certificates for verifying
15517 a TLS certificate presented by an LDAP server.
15518 While Exim does not provide a default value, your SSL library may.
15519 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15520 and constrained to be a file.
15521
15522
15523 .option ldap_cert_file main string unset
15524 .cindex "LDAP" "TLS client certificate file"
15525 .cindex certificate "file for LDAP"
15526 This option indicates which file contains an TLS client certificate which
15527 Exim should present to the LDAP server during TLS negotiation.
15528 Should be used together with &%ldap_cert_key%&.
15529
15530
15531 .option ldap_cert_key main string unset
15532 .cindex "LDAP" "TLS client key file"
15533 .cindex certificate "key for LDAP"
15534 This option indicates which file contains the secret/private key to use
15535 to prove identity to the LDAP server during TLS negotiation.
15536 Should be used together with &%ldap_cert_file%&, which contains the
15537 identity to be proven.
15538
15539
15540 .option ldap_cipher_suite main string unset
15541 .cindex "LDAP" "TLS cipher suite"
15542 This controls the TLS cipher-suite negotiation during TLS negotiation with
15543 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15544 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15545
15546
15547 .option ldap_default_servers main "string list" unset
15548 .cindex "LDAP" "default servers"
15549 This option provides a list of LDAP servers which are tried in turn when an
15550 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15551 details of LDAP queries. This option is available only when Exim has been built
15552 with LDAP support.
15553
15554
15555 .option ldap_require_cert main string unset.
15556 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15557 This should be one of the values "hard", "demand", "allow", "try" or "never".
15558 A value other than one of these is interpreted as "never".
15559 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15560 Although Exim does not set a default, the LDAP library probably defaults
15561 to hard/demand.
15562
15563
15564 .option ldap_start_tls main boolean false
15565 .cindex "LDAP" "whether or not to negotiate TLS"
15566 If set, Exim will attempt to negotiate TLS with the LDAP server when
15567 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15568 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15569 of SSL-on-connect.
15570 In the event of failure to negotiate TLS, the action taken is controlled
15571 by &%ldap_require_cert%&.
15572 This option is ignored for &`ldapi`& connections.
15573
15574
15575 .option ldap_version main integer unset
15576 .cindex "LDAP" "protocol version, forcing"
15577 This option can be used to force Exim to set a specific protocol version for
15578 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15579 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15580 the LDAP headers; otherwise it is 2. This option is available only when Exim
15581 has been built with LDAP support.
15582
15583
15584
15585 .option local_from_check main boolean true
15586 .cindex "&'Sender:'& header line" "disabling addition of"
15587 .cindex "&'From:'& header line" "disabling checking of"
15588 When a message is submitted locally (that is, not over a TCP/IP connection) by
15589 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15590 checks that the &'From:'& header line matches the login of the calling user and
15591 the domain specified by &%qualify_domain%&.
15592
15593 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15594 locally submitted message is automatically qualified by Exim, unless the
15595 &%-bnq%& command line option is used.
15596
15597 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15598 on the local part. If the &'From:'& header line does not match, Exim adds a
15599 &'Sender:'& header with an address constructed from the calling user's login
15600 and the default qualify domain.
15601
15602 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15603 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15604 &'Sender:'& header lines supplied by untrusted users, you must also set
15605 &%local_sender_retain%& to be true.
15606
15607 .cindex "envelope sender"
15608 These options affect only the header lines in the message. The envelope sender
15609 is still forced to be the login id at the qualify domain unless
15610 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15611
15612 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15613 request similar header line checking. See section &<<SECTthesenhea>>&, which
15614 has more details about &'Sender:'& processing.
15615
15616
15617
15618
15619 .option local_from_prefix main string unset
15620 When Exim checks the &'From:'& header line of locally submitted messages for
15621 matching the login id (see &%local_from_check%& above), it can be configured to
15622 ignore certain prefixes and suffixes in the local part of the address. This is
15623 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15624 appropriate lists, in the same form as the &%local_part_prefix%& and
15625 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15626 example, if
15627 .code
15628 local_from_prefix = *-
15629 .endd
15630 is set, a &'From:'& line containing
15631 .code
15632 From: anything-user@your.domain.example
15633 .endd
15634 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15635 matches the actual sender address that is constructed from the login name and
15636 qualify domain.
15637
15638
15639 .option local_from_suffix main string unset
15640 See &%local_from_prefix%& above.
15641
15642
15643 .option local_interfaces main "string list" "see below"
15644 This option controls which network interfaces are used by the daemon for
15645 listening; they are also used to identify the local host when routing. Chapter
15646 &<<CHAPinterfaces>>& contains a full description of this option and the related
15647 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15648 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15649 &%local_interfaces%& is
15650 .code
15651 local_interfaces = 0.0.0.0
15652 .endd
15653 when Exim is built without IPv6 support; otherwise it is
15654 .code
15655 local_interfaces = <; ::0 ; 0.0.0.0
15656 .endd
15657
15658 .option local_scan_timeout main time 5m
15659 .cindex "timeout" "for &[local_scan()]& function"
15660 .cindex "&[local_scan()]& function" "timeout"
15661 This timeout applies to the &[local_scan()]& function (see chapter
15662 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15663 the incoming message is rejected with a temporary error if it is an SMTP
15664 message. For a non-SMTP message, the message is dropped and Exim ends with a
15665 non-zero code. The incident is logged on the main and reject logs.
15666
15667
15668
15669 .option local_sender_retain main boolean false
15670 .cindex "&'Sender:'& header line" "retaining from local submission"
15671 When a message is submitted locally (that is, not over a TCP/IP connection) by
15672 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15673 do not want this to happen, you must set &%local_sender_retain%&, and you must
15674 also set &%local_from_check%& to be false (Exim will complain if you do not).
15675 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15676 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15677
15678
15679
15680
15681 .option localhost_number main string&!! unset
15682 .cindex "host" "locally unique number for"
15683 .cindex "message ids" "with multiple hosts"
15684 .vindex "&$localhost_number$&"
15685 Exim's message ids are normally unique only within the local host. If
15686 uniqueness among a set of hosts is required, each host must set a different
15687 value for the &%localhost_number%& option. The string is expanded immediately
15688 after reading the configuration file (so that a number can be computed from the
15689 host name, for example) and the result of the expansion must be a number in the
15690 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15691 systems). This is available in subsequent string expansions via the variable
15692 &$localhost_number$&. When &%localhost_number is set%&, the final two
15693 characters of the message id, instead of just being a fractional part of the
15694 time, are computed from the time and the local host number as described in
15695 section &<<SECTmessiden>>&.
15696
15697
15698
15699 .option log_file_path main "string list&!!" "set at compile time"
15700 .cindex "log" "file path for"
15701 This option sets the path which is used to determine the names of Exim's log
15702 files, or indicates that logging is to be to syslog, or both. It is expanded
15703 when Exim is entered, so it can, for example, contain a reference to the host
15704 name. If no specific path is set for the log files at compile or run time,
15705 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15706 they are written in a sub-directory called &_log_& in Exim's spool directory.
15707 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15708 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15709 used. If this string is fixed at your installation (contains no expansion
15710 variables) it is recommended that you do not set this option in the
15711 configuration file, but instead supply the path using LOG_FILE_PATH in
15712 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15713 early on &-- in particular, failure to read the configuration file.
15714
15715
15716 .option log_selector main string unset
15717 .cindex "log" "selectors"
15718 This option can be used to reduce or increase the number of things that Exim
15719 writes to its log files. Its argument is made up of names preceded by plus or
15720 minus characters. For example:
15721 .code
15722 log_selector = +arguments -retry_defer
15723 .endd
15724 A list of possible names and what they control is given in the chapter on
15725 logging, in section &<<SECTlogselector>>&.
15726
15727
15728 .option log_timezone main boolean false
15729 .cindex "log" "timezone for entries"
15730 .vindex "&$tod_log$&"
15731 .vindex "&$tod_zone$&"
15732 By default, the timestamps on log lines are in local time without the
15733 timezone. This means that if your timezone changes twice a year, the timestamps
15734 in log lines are ambiguous for an hour when the clocks go back. One way of
15735 avoiding this problem is to set the timezone to UTC. An alternative is to set
15736 &%log_timezone%& true. This turns on the addition of the timezone offset to
15737 timestamps in log lines. Turning on this option can add quite a lot to the size
15738 of log files because each line is extended by 6 characters. Note that the
15739 &$tod_log$& variable contains the log timestamp without the zone, but there is
15740 another variable called &$tod_zone$& that contains just the timezone offset.
15741
15742
15743 .option lookup_open_max main integer 25
15744 .cindex "too many open files"
15745 .cindex "open files, too many"
15746 .cindex "file" "too many open"
15747 .cindex "lookup" "maximum open files"
15748 .cindex "limit" "open files for lookups"
15749 This option limits the number of simultaneously open files for single-key
15750 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15751 Exim normally keeps these files open during routing, because often the same
15752 file is required several times. If the limit is reached, Exim closes the least
15753 recently used file. Note that if you are using the &'ndbm'& library, it
15754 actually opens two files for each logical DBM database, though it still counts
15755 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15756 open files"& errors with NDBM, you need to reduce the value of
15757 &%lookup_open_max%&.
15758
15759
15760 .option max_username_length main integer 0
15761 .cindex "length of login name"
15762 .cindex "user name" "maximum length"
15763 .cindex "limit" "user name length"
15764 Some operating systems are broken in that they truncate long arguments to
15765 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15766 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15767 an argument that is longer behaves as if &[getpwnam()]& failed.
15768
15769
15770 .option message_body_newlines main bool false
15771 .cindex "message body" "newlines in variables"
15772 .cindex "newline" "in message body variables"
15773 .vindex "&$message_body$&"
15774 .vindex "&$message_body_end$&"
15775 By default, newlines in the message body are replaced by spaces when setting
15776 the &$message_body$& and &$message_body_end$& expansion variables. If this
15777 option is set true, this no longer happens.
15778
15779
15780 .option message_body_visible main integer 500
15781 .cindex "body of message" "visible size"
15782 .cindex "message body" "visible size"
15783 .vindex "&$message_body$&"
15784 .vindex "&$message_body_end$&"
15785 This option specifies how much of a message's body is to be included in the
15786 &$message_body$& and &$message_body_end$& expansion variables.
15787
15788
15789 .option message_id_header_domain main string&!! unset
15790 .cindex "&'Message-ID:'& header line"
15791 If this option is set, the string is expanded and used as the right hand side
15792 (domain) of the &'Message-ID:'& header that Exim creates if a
15793 locally-originated incoming message does not have one. &"Locally-originated"&
15794 means &"not received over TCP/IP."&
15795 Otherwise, the primary host name is used.
15796 Only letters, digits, dot and hyphen are accepted; any other characters are
15797 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15798 empty string, the option is ignored.
15799
15800
15801 .option message_id_header_text main string&!! unset
15802 If this variable is set, the string is expanded and used to augment the text of
15803 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15804 message does not have one. The text of this header is required by RFC 2822 to
15805 take the form of an address. By default, Exim uses its internal message id as
15806 the local part, and the primary host name as the domain. If this option is set,
15807 it is expanded, and provided the expansion is not forced to fail, and does not
15808 yield an empty string, the result is inserted into the header immediately
15809 before the @, separated from the internal message id by a dot. Any characters
15810 that are illegal in an address are automatically converted into hyphens. This
15811 means that variables such as &$tod_log$& can be used, because the spaces and
15812 colons will become hyphens.
15813
15814
15815 .option message_logs main boolean true
15816 .cindex "message logs" "disabling"
15817 .cindex "log" "message log; disabling"
15818 If this option is turned off, per-message log files are not created in the
15819 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15820 Exim, by reducing the number of files involved in handling a message from a
15821 minimum of four (header spool file, body spool file, delivery journal, and
15822 per-message log) to three. The other major I/O activity is Exim's main log,
15823 which is not affected by this option.
15824
15825
15826 .option message_size_limit main string&!! 50M
15827 .cindex "message" "size limit"
15828 .cindex "limit" "message size"
15829 .cindex "size" "of message, limit"
15830 This option limits the maximum size of message that Exim will process. The
15831 value is expanded for each incoming connection so, for example, it can be made
15832 to depend on the IP address of the remote host for messages arriving via
15833 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15834 optionally followed by K or M.
15835
15836 &*Note*&: This limit cannot be made to depend on a message's sender or any
15837 other properties of an individual message, because it has to be advertised in
15838 the server's response to EHLO. String expansion failure causes a temporary
15839 error. A value of zero means no limit, but its use is not recommended. See also
15840 &%bounce_return_size_limit%&.
15841
15842 Incoming SMTP messages are failed with a 552 error if the limit is
15843 exceeded; locally-generated messages either get a stderr message or a delivery
15844 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15845 an oversized message is logged in both the main and the reject logs. See also
15846 the generic transport option &%message_size_limit%&, which limits the size of
15847 message that an individual transport can process.
15848
15849 If you use a virus-scanner and set this option to to a value larger than the
15850 maximum size that your virus-scanner is configured to support, you may get
15851 failures triggered by large mails.  The right size to configure for the
15852 virus-scanner depends upon what data is passed and the options in use but it's
15853 probably safest to just set it to a little larger than this value.  E.g., with a
15854 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15855 some problems may result.
15856
15857 A value of 0 will disable size limit checking; Exim will still advertise the
15858 SIZE extension in an EHLO response, but without a limit, so as to permit
15859 SMTP clients to still indicate the message size along with the MAIL verb.
15860
15861
15862 .option move_frozen_messages main boolean false
15863 .cindex "frozen messages" "moving"
15864 This option, which is available only if Exim has been built with the setting
15865 .code
15866 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15867 .endd
15868 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15869 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15870 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15871 standard utilities for handling such moved messages, and they do not show up in
15872 lists generated by &%-bp%& or by the Exim monitor.
15873
15874
15875 .option mua_wrapper main boolean false
15876 Setting this option true causes Exim to run in a very restrictive mode in which
15877 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15878 contains a full description of this facility.
15879
15880
15881
15882 .option mysql_servers main "string list" unset
15883 .cindex "MySQL" "server list"
15884 This option provides a list of MySQL servers and associated connection data, to
15885 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15886 option is available only if Exim has been built with MySQL support.
15887
15888
15889 .option never_users main "string list&!!" unset
15890 This option is expanded just once, at the start of Exim's processing. Local
15891 message deliveries are normally run in processes that are setuid to the
15892 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15893 It is usually desirable to prevent any deliveries from running as root, as a
15894 safety precaution.
15895
15896 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15897 list of users that must not be used for local deliveries. This list is fixed in
15898 the binary and cannot be overridden by the configuration file. By default, it
15899 contains just the single user name &"root"&. The &%never_users%& runtime option
15900 can be used to add more users to the fixed list.
15901
15902 If a message is to be delivered as one of the users on the fixed list or the
15903 &%never_users%& list, an error occurs, and delivery is deferred. A common
15904 example is
15905 .code
15906 never_users = root:daemon:bin
15907 .endd
15908 Including root is redundant if it is also on the fixed list, but it does no
15909 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15910 transport driver.
15911
15912
15913 .option openssl_options main "string list" "+no_sslv2 +single_dh_use +no_ticket"
15914 .cindex "OpenSSL "compatibility options"
15915 This option allows an administrator to adjust the SSL options applied
15916 by OpenSSL to connections.  It is given as a space-separated list of items,
15917 each one to be +added or -subtracted from the current value.
15918
15919 This option is only available if Exim is built against OpenSSL.  The values
15920 available for this option vary according to the age of your OpenSSL install.
15921 The &"all"& value controls a subset of flags which are available, typically
15922 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15923 list the values known on your system and Exim should support all the
15924 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15925 names lose the leading &"SSL_OP_"& and are lower-cased.
15926
15927 Note that adjusting the options can have severe impact upon the security of
15928 SSL as used by Exim.  It is possible to disable safety checks and shoot
15929 yourself in the foot in various unpleasant ways.  This option should not be
15930 adjusted lightly.  An unrecognised item will be detected at startup, by
15931 invoking Exim with the &%-bV%& flag.
15932
15933 The option affects Exim operating both as a server and as a client.
15934
15935 Historical note: prior to release 4.80, Exim defaulted this value to
15936 "+dont_insert_empty_fragments", which may still be needed for compatibility
15937 with some clients, but which lowers security by increasing exposure to
15938 some now infamous attacks.
15939
15940 Examples:
15941 .code
15942 # Make both old MS and old Eudora happy:
15943 openssl_options = -all +microsoft_big_sslv3_buffer \
15944                        +dont_insert_empty_fragments
15945
15946 # Disable older protocol versions:
15947 openssl_options = +no_sslv2 +no_sslv3
15948 .endd
15949
15950 Possible options may include:
15951 .ilist
15952 &`all`&
15953 .next
15954 &`allow_unsafe_legacy_renegotiation`&
15955 .next
15956 &`cipher_server_preference`&
15957 .next
15958 &`dont_insert_empty_fragments`&
15959 .next
15960 &`ephemeral_rsa`&
15961 .next
15962 &`legacy_server_connect`&
15963 .next
15964 &`microsoft_big_sslv3_buffer`&
15965 .next
15966 &`microsoft_sess_id_bug`&
15967 .next
15968 &`msie_sslv2_rsa_padding`&
15969 .next
15970 &`netscape_challenge_bug`&
15971 .next
15972 &`netscape_reuse_cipher_change_bug`&
15973 .next
15974 &`no_compression`&
15975 .next
15976 &`no_session_resumption_on_renegotiation`&
15977 .next
15978 &`no_sslv2`&
15979 .next
15980 &`no_sslv3`&
15981 .next
15982 &`no_ticket`&
15983 .next
15984 &`no_tlsv1`&
15985 .next
15986 &`no_tlsv1_1`&
15987 .next
15988 &`no_tlsv1_2`&
15989 .next
15990 &`safari_ecdhe_ecdsa_bug`&
15991 .next
15992 &`single_dh_use`&
15993 .next
15994 &`single_ecdh_use`&
15995 .next
15996 &`ssleay_080_client_dh_bug`&
15997 .next
15998 &`sslref2_reuse_cert_type_bug`&
15999 .next
16000 &`tls_block_padding_bug`&
16001 .next
16002 &`tls_d5_bug`&
16003 .next
16004 &`tls_rollback_bug`&
16005 .endlist
16006
16007 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16008 all clients connecting using the MacOS SecureTransport TLS facility prior
16009 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16010 to negotiate TLS then this option value might help, provided that your OpenSSL
16011 release is new enough to contain this work-around.  This may be a situation
16012 where you have to upgrade OpenSSL to get buggy clients working.
16013
16014
16015 .option oracle_servers main "string list" unset
16016 .cindex "Oracle" "server list"
16017 This option provides a list of Oracle servers and associated connection data,
16018 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16019 The option is available only if Exim has been built with Oracle support.
16020
16021
16022 .option percent_hack_domains main "domain list&!!" unset
16023 .cindex "&""percent hack""&"
16024 .cindex "source routing" "in email address"
16025 .cindex "address" "source-routed"
16026 The &"percent hack"& is the convention whereby a local part containing a
16027 percent sign is re-interpreted as a new email address, with the percent
16028 replaced by @. This is sometimes called &"source routing"&, though that term is
16029 also applied to RFC 2822 addresses that begin with an @ character. If this
16030 option is set, Exim implements the percent facility for those domains listed,
16031 but no others. This happens before an incoming SMTP address is tested against
16032 an ACL.
16033
16034 &*Warning*&: The &"percent hack"& has often been abused by people who are
16035 trying to get round relaying restrictions. For this reason, it is best avoided
16036 if at all possible. Unfortunately, a number of less security-conscious MTAs
16037 implement it unconditionally. If you are running Exim on a gateway host, and
16038 routing mail through to internal MTAs without processing the local parts, it is
16039 a good idea to reject recipient addresses with percent characters in their
16040 local parts. Exim's default configuration does this.
16041
16042
16043 .option perl_at_start main boolean false
16044 .cindex "Perl"
16045 This option is available only when Exim is built with an embedded Perl
16046 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16047
16048
16049 .option perl_startup main string unset
16050 .cindex "Perl"
16051 This option is available only when Exim is built with an embedded Perl
16052 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16053
16054 .option perl_startup main boolean false
16055 .cindex "Perl"
16056 This Option enables the taint mode of the embedded Perl interpreter.
16057
16058
16059 .option pgsql_servers main "string list" unset
16060 .cindex "PostgreSQL lookup type" "server list"
16061 This option provides a list of PostgreSQL servers and associated connection
16062 data, to be used in conjunction with &(pgsql)& lookups (see section
16063 &<<SECID72>>&). The option is available only if Exim has been built with
16064 PostgreSQL support.
16065
16066
16067 .option pid_file_path main string&!! "set at compile time"
16068 .cindex "daemon" "pid file path"
16069 .cindex "pid file, path for"
16070 This option sets the name of the file to which the Exim daemon writes its
16071 process id. The string is expanded, so it can contain, for example, references
16072 to the host name:
16073 .code
16074 pid_file_path = /var/log/$primary_hostname/exim.pid
16075 .endd
16076 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16077 spool directory.
16078 The value set by the option can be overridden by the &%-oP%& command line
16079 option. A pid file is not written if a &"non-standard"& daemon is run by means
16080 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16081
16082
16083 .option pipelining_advertise_hosts main "host list&!!" *
16084 .cindex "PIPELINING" "suppressing advertising"
16085 This option can be used to suppress the advertisement of the SMTP
16086 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16087 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16088 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16089 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16090 that clients will use it; &"out of order"& commands that are &"expected"& do
16091 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16092
16093
16094 .option prdr_enable main boolean false
16095 .cindex "PRDR" "enabling on server"
16096 This option can be used to enable the Per-Recipient Data Response extension
16097 to SMTP, defined by Eric Hall.
16098 If the option is set, PRDR is advertised by Exim when operating as a server.
16099 If the client requests PRDR, and more than one recipient, for a message
16100 an additional ACL is called for each recipient after the message content
16101 is received.  See section &<<SECTPRDRACL>>&.
16102
16103 .option preserve_message_logs main boolean false
16104 .cindex "message logs" "preserving"
16105 If this option is set, message log files are not deleted when messages are
16106 completed. Instead, they are moved to a sub-directory of the spool directory
16107 called &_msglog.OLD_&, where they remain available for statistical or debugging
16108 purposes. This is a dangerous option to set on systems with any appreciable
16109 volume of mail. Use with care!
16110
16111
16112 .option primary_hostname main string "see below"
16113 .cindex "name" "of local host"
16114 .cindex "host" "name of local"
16115 .cindex "local host" "name of"
16116 .vindex "&$primary_hostname$&"
16117 This specifies the name of the current host. It is used in the default EHLO or
16118 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16119 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16120 The value is also used by default in some SMTP response messages from an Exim
16121 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16122
16123 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16124 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16125 contains only one component, Exim passes it to &[gethostbyname()]& (or
16126 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16127 version. The variable &$primary_hostname$& contains the host name, whether set
16128 explicitly by this option, or defaulted.
16129
16130
16131 .option print_topbitchars main boolean false
16132 .cindex "printing characters"
16133 .cindex "8-bit characters"
16134 By default, Exim considers only those characters whose codes lie in the range
16135 32&--126 to be printing characters. In a number of circumstances (for example,
16136 when writing log entries) non-printing characters are converted into escape
16137 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16138 is set, code values of 128 and above are also considered to be printing
16139 characters.
16140
16141 This option also affects the header syntax checks performed by the
16142 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16143 the user's full name when constructing From: and Sender: addresses (as
16144 described in section &<<SECTconstr>>&). Setting this option can cause
16145 Exim to generate eight bit message headers that do not conform to the
16146 standards.
16147
16148
16149 .option process_log_path main string unset
16150 .cindex "process log path"
16151 .cindex "log" "process log"
16152 .cindex "&'exiwhat'&"
16153 This option sets the name of the file to which an Exim process writes its
16154 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16155 utility script. If this option is unset, the file called &_exim-process.info_&
16156 in Exim's spool directory is used. The ability to specify the name explicitly
16157 can be useful in environments where two different Exims are running, using
16158 different spool directories.
16159
16160
16161 .option prod_requires_admin main boolean true
16162 .cindex "restricting access to features"
16163 .oindex "&%-M%&"
16164 .oindex "&%-R%&"
16165 .oindex "&%-q%&"
16166 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16167 admin user unless &%prod_requires_admin%& is set false. See also
16168 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16169
16170
16171 .option qualify_domain main string "see below"
16172 .cindex "domain" "for qualifying addresses"
16173 .cindex "address" "qualification"
16174 This option specifies the domain name that is added to any envelope sender
16175 addresses that do not have a domain qualification. It also applies to
16176 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16177 are accepted by default only for locally-generated messages. Qualification is
16178 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16179 locally-generated messages, unless the &%-bnq%& command line option is used.
16180
16181 Messages from external sources must always contain fully qualified addresses,
16182 unless the sending host matches &%sender_unqualified_hosts%& or
16183 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16184 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16185 necessary. Internally, Exim always works with fully qualified envelope
16186 addresses. If &%qualify_domain%& is not set, it defaults to the
16187 &%primary_hostname%& value.
16188
16189
16190 .option qualify_recipient main string "see below"
16191 This option allows you to specify a different domain for qualifying recipient
16192 addresses to the one that is used for senders. See &%qualify_domain%& above.
16193
16194
16195
16196 .option queue_domains main "domain list&!!" unset
16197 .cindex "domain" "specifying non-immediate delivery"
16198 .cindex "queueing incoming messages"
16199 .cindex "message" "queueing certain domains"
16200 This option lists domains for which immediate delivery is not required.
16201 A delivery process is started whenever a message is received, but only those
16202 domains that do not match are processed. All other deliveries wait until the
16203 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16204
16205
16206 .option queue_list_requires_admin main boolean true
16207 .cindex "restricting access to features"
16208 .oindex "&%-bp%&"
16209 The &%-bp%& command-line option, which lists the messages that are on the
16210 queue, requires the caller to be an admin user unless
16211 &%queue_list_requires_admin%& is set false.
16212 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16213
16214
16215 .option queue_only main boolean false
16216 .cindex "queueing incoming messages"
16217 .cindex "message" "queueing unconditionally"
16218 If &%queue_only%& is set, a delivery process is not automatically started
16219 whenever a message is received. Instead, the message waits on the queue for the
16220 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16221 delivered immediately when certain conditions (such as heavy load) occur.
16222
16223 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16224 and &%-odi%& command line options override &%queue_only%& unless
16225 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16226 &%queue_only_load%&, and &%smtp_accept_queue%&.
16227
16228
16229 .option queue_only_file main string unset
16230 .cindex "queueing incoming messages"
16231 .cindex "message" "queueing by file existence"
16232 This option can be set to a colon-separated list of absolute path names, each
16233 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16234 it tests for the existence of each listed path using a call to &[stat()]&. For
16235 each path that exists, the corresponding queueing option is set.
16236 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16237 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16238 .code
16239 queue_only_file = smtp/some/file
16240 .endd
16241 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16242 &_/some/file_& exists.
16243
16244
16245 .option queue_only_load main fixed-point unset
16246 .cindex "load average"
16247 .cindex "queueing incoming messages"
16248 .cindex "message" "queueing by load"
16249 If the system load average is higher than this value, incoming messages from
16250 all sources are queued, and no automatic deliveries are started. If this
16251 happens during local or remote SMTP input, all subsequent messages received on
16252 the same SMTP connection are queued by default, whatever happens to the load in
16253 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16254 false.
16255
16256 Deliveries will subsequently be performed by queue runner processes. This
16257 option has no effect on ancient operating systems on which Exim cannot
16258 determine the load average. See also &%deliver_queue_load_max%& and
16259 &%smtp_load_reserve%&.
16260
16261
16262 .option queue_only_load_latch main boolean true
16263 .cindex "load average" "re-evaluating per message"
16264 When this option is true (the default), once one message has been queued
16265 because the load average is higher than the value set by &%queue_only_load%&,
16266 all subsequent messages received on the same SMTP connection are also queued.
16267 This is a deliberate choice; even though the load average may fall below the
16268 threshold, it doesn't seem right to deliver later messages on the same
16269 connection when not delivering earlier ones. However, there are special
16270 circumstances such as very long-lived connections from scanning appliances
16271 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16272 should be set false. This causes the value of the load average to be
16273 re-evaluated for each message.
16274
16275
16276 .option queue_only_override main boolean true
16277 .cindex "queueing incoming messages"
16278 When this option is true, the &%-od%&&'x'& command line options override the
16279 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16280 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16281 to override; they are accepted, but ignored.
16282
16283
16284 .option queue_run_in_order main boolean false
16285 .cindex "queue runner" "processing messages in order"
16286 If this option is set, queue runs happen in order of message arrival instead of
16287 in an arbitrary order. For this to happen, a complete list of the entire queue
16288 must be set up before the deliveries start. When the queue is all held in a
16289 single directory (the default), a single list is created for both the ordered
16290 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16291 single list is not created when &%queue_run_in_order%& is false. In this case,
16292 the sub-directories are processed one at a time (in a random order), and this
16293 avoids setting up one huge list for the whole queue. Thus, setting
16294 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16295 when the queue is large, because of the extra work in setting up the single,
16296 large list. In most situations, &%queue_run_in_order%& should not be set.
16297
16298
16299
16300 .option queue_run_max main integer&!! 5
16301 .cindex "queue runner" "maximum number of"
16302 This controls the maximum number of queue runner processes that an Exim daemon
16303 can run simultaneously. This does not mean that it starts them all at once,
16304 but rather that if the maximum number are still running when the time comes to
16305 start another one, it refrains from starting another one. This can happen with
16306 very large queues and/or very sluggish deliveries. This option does not,
16307 however, interlock with other processes, so additional queue runners can be
16308 started by other means, or by killing and restarting the daemon.
16309
16310 Setting this option to zero does not suppress queue runs; rather, it disables
16311 the limit, allowing any number of simultaneous queue runner processes to be
16312 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16313 the daemon's command line.
16314
16315 .cindex queues named
16316 .cindex "named queues"
16317 To set limits for different named queues use
16318 an expansion depending on the &$queue_name$& variable.
16319
16320 .option queue_smtp_domains main "domain list&!!" unset
16321 .cindex "queueing incoming messages"
16322 .cindex "message" "queueing remote deliveries"
16323 When this option is set, a delivery process is started whenever a message is
16324 received, routing is performed, and local deliveries take place.
16325 However, if any SMTP deliveries are required for domains that match
16326 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16327 message waits on the queue for the next queue run. Since routing of the message
16328 has taken place, Exim knows to which remote hosts it must be delivered, and so
16329 when the queue run happens, multiple messages for the same host are delivered
16330 over a single SMTP connection. The &%-odqs%& command line option causes all
16331 SMTP deliveries to be queued in this way, and is equivalent to setting
16332 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16333 &%queue_domains%&.
16334
16335
16336 .option receive_timeout main time 0s
16337 .cindex "timeout" "for non-SMTP input"
16338 This option sets the timeout for accepting a non-SMTP message, that is, the
16339 maximum time that Exim waits when reading a message on the standard input. If
16340 the value is zero, it will wait for ever. This setting is overridden by the
16341 &%-or%& command line option. The timeout for incoming SMTP messages is
16342 controlled by &%smtp_receive_timeout%&.
16343
16344 .option received_header_text main string&!! "see below"
16345 .cindex "customizing" "&'Received:'& header"
16346 .cindex "&'Received:'& header line" "customizing"
16347 This string defines the contents of the &'Received:'& message header that is
16348 added to each message, except for the timestamp, which is automatically added
16349 on at the end (preceded by a semicolon). The string is expanded each time it is
16350 used. If the expansion yields an empty string, no &'Received:'& header line is
16351 added to the message. Otherwise, the string should start with the text
16352 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16353 header lines. The default setting is:
16354
16355 .code
16356 received_header_text = Received: \
16357   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16358   {${if def:sender_ident \
16359   {from ${quote_local_part:$sender_ident} }}\
16360   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16361   by $primary_hostname \
16362   ${if def:received_protocol {with $received_protocol}} \
16363   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
16364   (Exim $version_number)\n\t\
16365   ${if def:sender_address \
16366   {(envelope-from <$sender_address>)\n\t}}\
16367   id $message_exim_id\
16368   ${if def:received_for {\n\tfor $received_for}}
16369 .endd
16370
16371 The reference to the TLS cipher is omitted when Exim is built without TLS
16372 support. The use of conditional expansions ensures that this works for both
16373 locally generated messages and messages received from remote hosts, giving
16374 header lines such as the following:
16375 .code
16376 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16377 by marley.carol.example with esmtp (Exim 4.00)
16378 (envelope-from <bob@carol.example>)
16379 id 16IOWa-00019l-00
16380 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16381 Received: by scrooge.carol.example with local (Exim 4.00)
16382 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16383 .endd
16384 Until the body of the message has been received, the timestamp is the time when
16385 the message started to be received. Once the body has arrived, and all policy
16386 checks have taken place, the timestamp is updated to the time at which the
16387 message was accepted.
16388
16389
16390 .option received_headers_max main integer 30
16391 .cindex "loop" "prevention"
16392 .cindex "mail loop prevention"
16393 .cindex "&'Received:'& header line" "counting"
16394 When a message is to be delivered, the number of &'Received:'& headers is
16395 counted, and if it is greater than this parameter, a mail loop is assumed to
16396 have occurred, the delivery is abandoned, and an error message is generated.
16397 This applies to both local and remote deliveries.
16398
16399
16400 .option recipient_unqualified_hosts main "host list&!!" unset
16401 .cindex "unqualified addresses"
16402 .cindex "host" "unqualified addresses from"
16403 This option lists those hosts from which Exim is prepared to accept unqualified
16404 recipient addresses in message envelopes. The addresses are made fully
16405 qualified by the addition of the &%qualify_recipient%& value. This option also
16406 affects message header lines. Exim does not reject unqualified recipient
16407 addresses in headers, but it qualifies them only if the message came from a
16408 host that matches &%recipient_unqualified_hosts%&,
16409 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16410 option was not set.
16411
16412
16413 .option recipients_max main integer 0
16414 .cindex "limit" "number of recipients"
16415 .cindex "recipient" "maximum number"
16416 If this option is set greater than zero, it specifies the maximum number of
16417 original recipients for any message. Additional recipients that are generated
16418 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16419 all recipients over the limit; earlier recipients are delivered as normal.
16420 Non-SMTP messages with too many recipients are failed, and no deliveries are
16421 done.
16422
16423 .cindex "RCPT" "maximum number of incoming"
16424 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16425 RCPT commands in a single message.
16426
16427
16428 .option recipients_max_reject main boolean false
16429 If this option is set true, Exim rejects SMTP messages containing too many
16430 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16431 error to the eventual DATA command. Otherwise (the default) it gives a 452
16432 error to the surplus RCPT commands and accepts the message on behalf of the
16433 initial set of recipients. The remote server should then re-send the message
16434 for the remaining recipients at a later time.
16435
16436
16437 .option remote_max_parallel main integer 2
16438 .cindex "delivery" "parallelism for remote"
16439 This option controls parallel delivery of one message to a number of remote
16440 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16441 does all the remote deliveries for a message one by one. Otherwise, if a single
16442 message has to be delivered to more than one remote host, or if several copies
16443 have to be sent to the same remote host, up to &%remote_max_parallel%&
16444 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16445 deliveries are required, the maximum number of processes are started, and as
16446 each one finishes, another is begun. The order of starting processes is the
16447 same as if sequential delivery were being done, and can be controlled by the
16448 &%remote_sort_domains%& option. If parallel delivery takes place while running
16449 with debugging turned on, the debugging output from each delivery process is
16450 tagged with its process id.
16451
16452 This option controls only the maximum number of parallel deliveries for one
16453 message in one Exim delivery process. Because Exim has no central queue
16454 manager, there is no way of controlling the total number of simultaneous
16455 deliveries if the configuration allows a delivery attempt as soon as a message
16456 is received.
16457
16458 .cindex "number of deliveries"
16459 .cindex "delivery" "maximum number of"
16460 If you want to control the total number of deliveries on the system, you
16461 need to set the &%queue_only%& option. This ensures that all incoming messages
16462 are added to the queue without starting a delivery process. Then set up an Exim
16463 daemon to start queue runner processes at appropriate intervals (probably
16464 fairly often, for example, every minute), and limit the total number of queue
16465 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16466 delivers only one message at a time, the maximum number of deliveries that can
16467 then take place at once is &%queue_run_max%& multiplied by
16468 &%remote_max_parallel%&.
16469
16470 If it is purely remote deliveries you want to control, use
16471 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16472 doing the SMTP routing before queueing, so that several messages for the same
16473 host will eventually get delivered down the same connection.
16474
16475
16476 .option remote_sort_domains main "domain list&!!" unset
16477 .cindex "sorting remote deliveries"
16478 .cindex "delivery" "sorting remote"
16479 When there are a number of remote deliveries for a message, they are sorted by
16480 domain into the order given by this list. For example,
16481 .code
16482 remote_sort_domains = *.cam.ac.uk:*.uk
16483 .endd
16484 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16485 then to those in the &%uk%& domain, then to any others.
16486
16487
16488 .option retry_data_expire main time 7d
16489 .cindex "hints database" "data expiry"
16490 This option sets a &"use before"& time on retry information in Exim's hints
16491 database. Any older retry data is ignored. This means that, for example, once a
16492 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16493 past failures.
16494
16495
16496 .option retry_interval_max main time 24h
16497 .cindex "retry" "limit on interval"
16498 .cindex "limit" "on retry interval"
16499 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16500 intervals between delivery attempts for messages that cannot be delivered
16501 straight away. This option sets an overall limit to the length of time between
16502 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16503 the default value.
16504
16505
16506 .option return_path_remove main boolean true
16507 .cindex "&'Return-path:'& header line" "removing"
16508 RFC 2821, section 4.4, states that an SMTP server must insert a
16509 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16510 The &'Return-path:'& header preserves the sender address as received in the
16511 MAIL command. This description implies that this header should not be present
16512 in an incoming message. If &%return_path_remove%& is true, any existing
16513 &'Return-path:'& headers are removed from messages at the time they are
16514 received. Exim's transports have options for adding &'Return-path:'& headers at
16515 the time of delivery. They are normally used only for final local deliveries.
16516
16517
16518 .option return_size_limit main integer 100K
16519 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16520
16521
16522 .option rfc1413_hosts main "host list&!!" @[]
16523 .cindex "RFC 1413"
16524 .cindex "host" "for RFC 1413 calls"
16525 RFC 1413 identification calls are made to any client host which matches
16526 an item in the list.
16527 The default value specifies just this host, being any local interface
16528 for the system.
16529
16530 .option rfc1413_query_timeout main time 0s
16531 .cindex "RFC 1413" "query timeout"
16532 .cindex "timeout" "for RFC 1413 call"
16533 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16534 no RFC 1413 calls are ever made.
16535
16536
16537 .option sender_unqualified_hosts main "host list&!!" unset
16538 .cindex "unqualified addresses"
16539 .cindex "host" "unqualified addresses from"
16540 This option lists those hosts from which Exim is prepared to accept unqualified
16541 sender addresses. The addresses are made fully qualified by the addition of
16542 &%qualify_domain%&. This option also affects message header lines. Exim does
16543 not reject unqualified addresses in headers that contain sender addresses, but
16544 it qualifies them only if the message came from a host that matches
16545 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16546 using TCP/IP), and the &%-bnq%& option was not set.
16547
16548 .option set_environment main "string list" empty
16549 .cindex "environment"
16550 This option allows to set individual environment variables that the
16551 currently linked libraries and programs in child processes use. The
16552 default list is empty,
16553
16554
16555 .option slow_lookup_log main integer 0
16556 .cindex "logging" "slow lookups"
16557 .cindex "dns" "logging slow lookups"
16558 This option controls logging of slow lookups.
16559 If the value is nonzero it is taken as a number of milliseconds
16560 and lookups taking longer than this are logged.
16561 Currently this applies only to DNS lookups.
16562
16563
16564
16565 .option smtp_accept_keepalive main boolean true
16566 .cindex "keepalive" "on incoming connection"
16567 This option controls the setting of the SO_KEEPALIVE option on incoming
16568 TCP/IP socket connections. When set, it causes the kernel to probe idle
16569 connections periodically, by sending packets with &"old"& sequence numbers. The
16570 other end of the connection should send an acknowledgment if the connection is
16571 still okay or a reset if the connection has been aborted. The reason for doing
16572 this is that it has the beneficial effect of freeing up certain types of
16573 connection that can get stuck when the remote host is disconnected without
16574 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16575 hours to detect unreachable hosts.
16576
16577
16578
16579 .option smtp_accept_max main integer 20
16580 .cindex "limit" "incoming SMTP connections"
16581 .cindex "SMTP" "incoming connection count"
16582 .cindex "inetd"
16583 This option specifies the maximum number of simultaneous incoming SMTP calls
16584 that Exim will accept. It applies only to the listening daemon; there is no
16585 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16586 value is set to zero, no limit is applied. However, it is required to be
16587 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16588 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16589
16590 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16591 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16592 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16593 and &%smtp_load_reserve%& are then checked before accepting the connection.
16594
16595
16596 .option smtp_accept_max_nonmail main integer 10
16597 .cindex "limit" "non-mail SMTP commands"
16598 .cindex "SMTP" "limiting non-mail commands"
16599 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16600 the connection if there are too many. This option defines &"too many"&. The
16601 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16602 client looping sending EHLO, for example. The check is applied only if the
16603 client host matches &%smtp_accept_max_nonmail_hosts%&.
16604
16605 When a new message is expected, one occurrence of RSET is not counted. This
16606 allows a client to send one RSET between messages (this is not necessary,
16607 but some clients do it). Exim also allows one uncounted occurrence of HELO
16608 or EHLO, and one occurrence of STARTTLS between messages. After
16609 starting up a TLS session, another EHLO is expected, and so it too is not
16610 counted. The first occurrence of AUTH in a connection, or immediately
16611 following STARTTLS is not counted. Otherwise, all commands other than
16612 MAIL, RCPT, DATA, and QUIT are counted.
16613
16614
16615 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16616 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16617 check by setting this option. The default value makes it apply to all hosts. By
16618 changing the value, you can exclude any badly-behaved hosts that you have to
16619 live with.
16620
16621
16622 . Allow this long option name to split; give it unsplit as a fifth argument
16623 . for the automatic .oindex that is generated by .option.
16624 . We insert " &~&~" which is both pretty nasty visually and results in
16625 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16626 . zero-width-space, which would be nicer visually and results in (at least)
16627 . html that Firefox will split on when it's forced to reflow (rather than
16628 . inserting a horizontal scrollbar).  However, the text is still not
16629 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16630 . the option name to split.
16631
16632 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16633          smtp_accept_max_per_connection
16634 .cindex "SMTP" "limiting incoming message count"
16635 .cindex "limit" "messages per SMTP connection"
16636 The value of this option limits the number of MAIL commands that Exim is
16637 prepared to accept over a single SMTP connection, whether or not each command
16638 results in the transfer of a message. After the limit is reached, a 421
16639 response is given to subsequent MAIL commands. This limit is a safety
16640 precaution against a client that goes mad (incidents of this type have been
16641 seen).
16642
16643
16644 .option smtp_accept_max_per_host main string&!! unset
16645 .cindex "limit" "SMTP connections from one host"
16646 .cindex "host" "limiting SMTP connections from"
16647 This option restricts the number of simultaneous IP connections from a single
16648 host (strictly, from a single IP address) to the Exim daemon. The option is
16649 expanded, to enable different limits to be applied to different hosts by
16650 reference to &$sender_host_address$&. Once the limit is reached, additional
16651 connection attempts from the same host are rejected with error code 421. This
16652 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16653 of zero imposes no limit. If this option is set greater than zero, it is
16654 required that &%smtp_accept_max%& be non-zero.
16655
16656 &*Warning*&: When setting this option you should not use any expansion
16657 constructions that take an appreciable amount of time. The expansion and test
16658 happen in the main daemon loop, in order to reject additional connections
16659 without forking additional processes (otherwise a denial-of-service attack
16660 could cause a vast number or processes to be created). While the daemon is
16661 doing this processing, it cannot accept any other incoming connections.
16662
16663
16664
16665 .option smtp_accept_queue main integer 0
16666 .cindex "SMTP" "incoming connection count"
16667 .cindex "queueing incoming messages"
16668 .cindex "message" "queueing by SMTP connection count"
16669 If the number of simultaneous incoming SMTP connections being handled via the
16670 listening daemon exceeds this value, messages received by SMTP are just placed
16671 on the queue; no delivery processes are started automatically. The count is
16672 fixed at the start of an SMTP connection. It cannot be updated in the
16673 subprocess that receives messages, and so the queueing or not queueing applies
16674 to all messages received in the same connection.
16675
16676 A value of zero implies no limit, and clearly any non-zero value is useful only
16677 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16678 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16679 various &%-od%&&'x'& command line options.
16680
16681
16682 . See the comment on smtp_accept_max_per_connection
16683
16684 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16685          smtp_accept_queue_per_connection
16686 .cindex "queueing incoming messages"
16687 .cindex "message" "queueing by message count"
16688 This option limits the number of delivery processes that Exim starts
16689 automatically when receiving messages via SMTP, whether via the daemon or by
16690 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16691 and the number of messages received in a single SMTP session exceeds this
16692 number, subsequent messages are placed on the queue, but no delivery processes
16693 are started. This helps to limit the number of Exim processes when a server
16694 restarts after downtime and there is a lot of mail waiting for it on other
16695 systems. On large systems, the default should probably be increased, and on
16696 dial-in client systems it should probably be set to zero (that is, disabled).
16697
16698
16699 .option smtp_accept_reserve main integer 0
16700 .cindex "SMTP" "incoming call count"
16701 .cindex "host" "reserved"
16702 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16703 number of SMTP connections that are reserved for connections from the hosts
16704 that are specified in &%smtp_reserve_hosts%&. The value set in
16705 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16706 restricted to this number of connections; the option specifies a minimum number
16707 of connection slots for them, not a maximum. It is a guarantee that this group
16708 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16709 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16710 individual host.
16711
16712 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16713 set to 5, once there are 45 active connections (from any hosts), new
16714 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16715 provided the other criteria for acceptance are met.
16716
16717
16718 .option smtp_active_hostname main string&!! unset
16719 .cindex "host" "name in SMTP responses"
16720 .cindex "SMTP" "host name in responses"
16721 .vindex "&$primary_hostname$&"
16722 This option is provided for multi-homed servers that want to masquerade as
16723 several different hosts. At the start of an incoming SMTP connection, its value
16724 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16725 responses. For example, it is used as domain name in the response to an
16726 incoming HELO or EHLO command.
16727
16728 .vindex "&$smtp_active_hostname$&"
16729 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16730 is saved with any messages that are received. It is therefore available for use
16731 in routers and transports when the message is later delivered.
16732
16733 If this option is unset, or if its expansion is forced to fail, or if the
16734 expansion results in an empty string, the value of &$primary_hostname$& is
16735 used. Other expansion failures cause a message to be written to the main and
16736 panic logs, and the SMTP command receives a temporary error. Typically, the
16737 value of &%smtp_active_hostname%& depends on the incoming interface address.
16738 For example:
16739 .code
16740 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16741   {cox.mydomain}{box.mydomain}}
16742 .endd
16743
16744 Although &$smtp_active_hostname$& is primarily concerned with incoming
16745 messages, it is also used as the default for HELO commands in callout
16746 verification if there is no remote transport from which to obtain a
16747 &%helo_data%& value.
16748
16749 .option smtp_banner main string&!! "see below"
16750 .cindex "SMTP" "welcome banner"
16751 .cindex "banner for SMTP"
16752 .cindex "welcome banner for SMTP"
16753 .cindex "customizing" "SMTP banner"
16754 This string, which is expanded every time it is used, is output as the initial
16755 positive response to an SMTP connection. The default setting is:
16756 .code
16757 smtp_banner = $smtp_active_hostname ESMTP Exim \
16758   $version_number $tod_full
16759 .endd
16760 Failure to expand the string causes a panic error. If you want to create a
16761 multiline response to the initial SMTP connection, use &"\n"& in the string at
16762 appropriate points, but not at the end. Note that the 220 code is not included
16763 in this string. Exim adds it automatically (several times in the case of a
16764 multiline response).
16765
16766
16767 .option smtp_check_spool_space main boolean true
16768 .cindex "checking disk space"
16769 .cindex "disk space, checking"
16770 .cindex "spool directory" "checking space"
16771 When this option is set, if an incoming SMTP session encounters the SIZE
16772 option on a MAIL command, it checks that there is enough space in the
16773 spool directory's partition to accept a message of that size, while still
16774 leaving free the amount specified by &%check_spool_space%& (even if that value
16775 is zero). If there isn't enough space, a temporary error code is returned.
16776
16777
16778 .option smtp_connect_backlog main integer 20
16779 .cindex "connection backlog"
16780 .cindex "SMTP" "connection backlog"
16781 .cindex "backlog of connections"
16782 This option specifies a maximum number of waiting SMTP connections. Exim passes
16783 this value to the TCP/IP system when it sets up its listener. Once this number
16784 of connections are waiting for the daemon's attention, subsequent connection
16785 attempts are refused at the TCP/IP level. At least, that is what the manuals
16786 say; in some circumstances such connection attempts have been observed to time
16787 out instead. For large systems it is probably a good idea to increase the
16788 value (to 50, say). It also gives some protection against denial-of-service
16789 attacks by SYN flooding.
16790
16791
16792 .option smtp_enforce_sync main boolean true
16793 .cindex "SMTP" "synchronization checking"
16794 .cindex "synchronization checking in SMTP"
16795 The SMTP protocol specification requires the client to wait for a response from
16796 the server at certain points in the dialogue. Without PIPELINING these
16797 synchronization points are after every command; with PIPELINING they are
16798 fewer, but they still exist.
16799
16800 Some spamming sites send out a complete set of SMTP commands without waiting
16801 for any response. Exim protects against this by rejecting a message if the
16802 client has sent further input when it should not have. The error response &"554
16803 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16804 for this error cannot be perfect because of transmission delays (unexpected
16805 input may be on its way but not yet received when Exim checks). However, it
16806 does detect many instances.
16807
16808 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16809 If you want to disable the check selectively (for example, only for certain
16810 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16811 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16812
16813
16814
16815 .option smtp_etrn_command main string&!! unset
16816 .cindex "ETRN" "command to be run"
16817 .vindex "&$domain$&"
16818 If this option is set, the given command is run whenever an SMTP ETRN
16819 command is received from a host that is permitted to issue such commands (see
16820 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16821 are independently expanded. The expansion variable &$domain$& is set to the
16822 argument of the ETRN command, and no syntax checking is done on it. For
16823 example:
16824 .code
16825 smtp_etrn_command = /etc/etrn_command $domain \
16826                     $sender_host_address
16827 .endd
16828 A new process is created to run the command, but Exim does not wait for it to
16829 complete. Consequently, its status cannot be checked. If the command cannot be
16830 run, a line is written to the panic log, but the ETRN caller still receives
16831 a 250 success response. Exim is normally running under its own uid when
16832 receiving SMTP, so it is not possible for it to change the uid before running
16833 the command.
16834
16835
16836 .option smtp_etrn_serialize main boolean true
16837 .cindex "ETRN" "serializing"
16838 When this option is set, it prevents the simultaneous execution of more than
16839 one identical command as a result of ETRN in an SMTP connection. See
16840 section &<<SECTETRN>>& for details.
16841
16842
16843 .option smtp_load_reserve main fixed-point unset
16844 .cindex "load average"
16845 If the system load average ever gets higher than this, incoming SMTP calls are
16846 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16847 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16848 the load is over the limit. The option has no effect on ancient operating
16849 systems on which Exim cannot determine the load average. See also
16850 &%deliver_queue_load_max%& and &%queue_only_load%&.
16851
16852
16853
16854 .option smtp_max_synprot_errors main integer 3
16855 .cindex "SMTP" "limiting syntax and protocol errors"
16856 .cindex "limit" "SMTP syntax and protocol errors"
16857 Exim rejects SMTP commands that contain syntax or protocol errors. In
16858 particular, a syntactically invalid email address, as in this command:
16859 .code
16860 RCPT TO:<abc xyz@a.b.c>
16861 .endd
16862 causes immediate rejection of the command, before any other tests are done.
16863 (The ACL cannot be run if there is no valid address to set up for it.) An
16864 example of a protocol error is receiving RCPT before MAIL. If there are
16865 too many syntax or protocol errors in one SMTP session, the connection is
16866 dropped. The limit is set by this option.
16867
16868 .cindex "PIPELINING" "expected errors"
16869 When the PIPELINING extension to SMTP is in use, some protocol errors are
16870 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16871 Exim assumes that PIPELINING will be used if it advertises it (see
16872 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16873 not count towards the limit.
16874
16875
16876
16877 .option smtp_max_unknown_commands main integer 3
16878 .cindex "SMTP" "limiting unknown commands"
16879 .cindex "limit" "unknown SMTP commands"
16880 If there are too many unrecognized commands in an incoming SMTP session, an
16881 Exim server drops the connection. This is a defence against some kinds of abuse
16882 that subvert web
16883 clients
16884 into making connections to SMTP ports; in these circumstances, a number of
16885 non-SMTP command lines are sent first.
16886
16887
16888
16889 .option smtp_ratelimit_hosts main "host list&!!" unset
16890 .cindex "SMTP" "rate limiting"
16891 .cindex "limit" "rate of message arrival"
16892 .cindex "RCPT" "rate limiting"
16893 Some sites find it helpful to be able to limit the rate at which certain hosts
16894 can send them messages, and the rate at which an individual message can specify
16895 recipients.
16896
16897 Exim has two rate-limiting facilities. This section describes the older
16898 facility, which can limit rates within a single connection. The newer
16899 &%ratelimit%& ACL condition can limit rates across all connections. See section
16900 &<<SECTratelimiting>>& for details of the newer facility.
16901
16902 When a host matches &%smtp_ratelimit_hosts%&, the values of
16903 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16904 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16905 respectively. Each option, if set, must contain a set of four comma-separated
16906 values:
16907
16908 .ilist
16909 A threshold, before which there is no rate limiting.
16910 .next
16911 An initial time delay. Unlike other times in Exim, numbers with decimal
16912 fractional parts are allowed here.
16913 .next
16914 A factor by which to increase the delay each time.
16915 .next
16916 A maximum value for the delay. This should normally be less than 5 minutes,
16917 because after that time, the client is liable to timeout the SMTP command.
16918 .endlist
16919
16920 For example, these settings have been used successfully at the site which
16921 first suggested this feature, for controlling mail from their customers:
16922 .code
16923 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16924 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16925 .endd
16926 The first setting specifies delays that are applied to MAIL commands after
16927 two have been received over a single connection. The initial delay is 0.5
16928 seconds, increasing by a factor of 1.05 each time. The second setting applies
16929 delays to RCPT commands when more than four occur in a single message.
16930
16931
16932 .option smtp_ratelimit_mail main string unset
16933 See &%smtp_ratelimit_hosts%& above.
16934
16935
16936 .option smtp_ratelimit_rcpt main string unset
16937 See &%smtp_ratelimit_hosts%& above.
16938
16939
16940 .option smtp_receive_timeout main time&!! 5m
16941 .cindex "timeout" "for SMTP input"
16942 .cindex "SMTP" "input timeout"
16943 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16944 input, including batch SMTP. If a line of input (either an SMTP command or a
16945 data line) is not received within this time, the SMTP connection is dropped and
16946 the message is abandoned.
16947 A line is written to the log containing one of the following messages:
16948 .code
16949 SMTP command timeout on connection from...
16950 SMTP data timeout on connection from...
16951 .endd
16952 The former means that Exim was expecting to read an SMTP command; the latter
16953 means that it was in the DATA phase, reading the contents of a message.
16954
16955 If the first character of the option is a &"$"& the option is
16956 expanded before use and may depend on
16957 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16958
16959
16960 .oindex "&%-os%&"
16961 The value set by this option can be overridden by the
16962 &%-os%& command-line option. A setting of zero time disables the timeout, but
16963 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16964 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16965 timeout is controlled by &%receive_timeout%& and &%-or%&.
16966
16967
16968 .option smtp_reserve_hosts main "host list&!!" unset
16969 This option defines hosts for which SMTP connections are reserved; see
16970 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16971
16972
16973 .option smtp_return_error_details main boolean false
16974 .cindex "SMTP" "details policy failures"
16975 .cindex "policy control" "rejection, returning details"
16976 In the default state, Exim uses bland messages such as
16977 &"Administrative prohibition"& when it rejects SMTP commands for policy
16978 reasons. Many sysadmins like this because it gives away little information
16979 to spammers. However, some other sysadmins who are applying strict checking
16980 policies want to give out much fuller information about failures. Setting
16981 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16982 example, instead of &"Administrative prohibition"&, it might give:
16983 .code
16984 550-Rejected after DATA: '>' missing at end of address:
16985 550 failing address in "From" header is: <user@dom.ain
16986 .endd
16987
16988
16989 .option smtputf8_advertise_hosts main "host list&!!" *
16990 .cindex "SMTPUTF8" "advertising"
16991 When Exim is built with support for internationalised mail names,
16992 the availability thereof is advertised in
16993 response to EHLO only to those client hosts that match this option. See
16994 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
16995
16996
16997 .option spamd_address main string "127.0.0.1 783"
16998 This option is available when Exim is compiled with the content-scanning
16999 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17000 See section &<<SECTscanspamass>>& for more details.
17001
17002
17003
17004 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17005 This option is available when Exim is compiled with SPF support.
17006 See section &<<SECSPF>>& for more details.
17007
17008
17009
17010 .option split_spool_directory main boolean false
17011 .cindex "multiple spool directories"
17012 .cindex "spool directory" "split"
17013 .cindex "directories, multiple"
17014 If this option is set, it causes Exim to split its input directory into 62
17015 subdirectories, each with a single alphanumeric character as its name. The
17016 sixth character of the message id is used to allocate messages to
17017 subdirectories; this is the least significant base-62 digit of the time of
17018 arrival of the message.
17019
17020 Splitting up the spool in this way may provide better performance on systems
17021 where there are long mail queues, by reducing the number of files in any one
17022 directory. The msglog directory is also split up in a similar way to the input
17023 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17024 are still placed in the single directory &_msglog.OLD_&.
17025
17026 It is not necessary to take any special action for existing messages when
17027 changing &%split_spool_directory%&. Exim notices messages that are in the
17028 &"wrong"& place, and continues to process them. If the option is turned off
17029 after a period of being on, the subdirectories will eventually empty and be
17030 automatically deleted.
17031
17032 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17033 changes. Instead of creating a list of all messages in the queue, and then
17034 trying to deliver each one in turn, it constructs a list of those in one
17035 sub-directory and tries to deliver them, before moving on to the next
17036 sub-directory. The sub-directories are processed in a random order. This
17037 spreads out the scanning of the input directories, and uses less memory. It is
17038 particularly beneficial when there are lots of messages on the queue. However,
17039 if &%queue_run_in_order%& is set, none of this new processing happens. The
17040 entire queue has to be scanned and sorted before any deliveries can start.
17041
17042
17043 .option spool_directory main string&!! "set at compile time"
17044 .cindex "spool directory" "path to"
17045 This defines the directory in which Exim keeps its spool, that is, the messages
17046 it is waiting to deliver. The default value is taken from the compile-time
17047 configuration setting, if there is one. If not, this option must be set. The
17048 string is expanded, so it can contain, for example, a reference to
17049 &$primary_hostname$&.
17050
17051 If the spool directory name is fixed on your installation, it is recommended
17052 that you set it at build time rather than from this option, particularly if the
17053 log files are being written to the spool directory (see &%log_file_path%&).
17054 Otherwise log files cannot be used for errors that are detected early on, such
17055 as failures in the configuration file.
17056
17057 By using this option to override the compiled-in path, it is possible to run
17058 tests of Exim without using the standard spool.
17059
17060 .option spool_wireformat main boolean false
17061 .cindex "spool directory" "file formats"
17062 If this option is set, Exim may for some messages use an alternative format
17063 for data-files in the spool which matches the wire format.
17064 Doing this permits more efficient message reception and transmission.
17065 Currently it is only done for messages received using the ESMTP CHUNKING
17066 option.
17067
17068 The following variables will not have useful values:
17069 .code
17070 $max_received_linelength
17071 $body_linecount
17072 $body_zerocount
17073 .endd
17074
17075 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17076 and any external programs which are passed a reference to a message data file
17077 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17078 will need to be aware of the different formats potentially available.
17079
17080 Using any of the ACL conditions noted will negate the reception benefit
17081 (as a Unix-mbox-format file is constructed for them).
17082 The transmission benefit is maintained.
17083
17084 .option sqlite_lock_timeout main time 5s
17085 .cindex "sqlite lookup type" "lock timeout"
17086 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17087 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17088
17089 .option strict_acl_vars main boolean false
17090 .cindex "&ACL;" "variables, handling unset"
17091 This option controls what happens if a syntactically valid but undefined ACL
17092 variable is referenced. If it is false (the default), an empty string
17093 is substituted; if it is true, an error is generated. See section
17094 &<<SECTaclvariables>>& for details of ACL variables.
17095
17096 .option strip_excess_angle_brackets main boolean false
17097 .cindex "angle brackets, excess"
17098 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17099 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17100 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17101 passed on to another MTA, the excess angle brackets are not passed on. If this
17102 option is not set, multiple pairs of angle brackets cause a syntax error.
17103
17104
17105 .option strip_trailing_dot main boolean false
17106 .cindex "trailing dot on domain"
17107 .cindex "dot" "trailing on domain"
17108 If this option is set, a trailing dot at the end of a domain in an address is
17109 ignored. If this is in the envelope and the message is passed on to another
17110 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17111 domain causes a syntax error.
17112 However, addresses in header lines are checked only when an ACL requests header
17113 syntax checking.
17114
17115
17116 .option syslog_duplication main boolean true
17117 .cindex "syslog" "duplicate log lines; suppressing"
17118 When Exim is logging to syslog, it writes the log lines for its three
17119 separate logs at different syslog priorities so that they can in principle
17120 be separated on the logging hosts. Some installations do not require this
17121 separation, and in those cases, the duplication of certain log lines is a
17122 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17123 particular log line is written to syslog. For lines that normally go to
17124 both the main log and the reject log, the reject log version (possibly
17125 containing message header lines) is written, at LOG_NOTICE priority.
17126 Lines that normally go to both the main and the panic log are written at
17127 the LOG_ALERT priority.
17128
17129
17130 .option syslog_facility main string unset
17131 .cindex "syslog" "facility; setting"
17132 This option sets the syslog &"facility"& name, used when Exim is logging to
17133 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17134 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17135 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17136 details of Exim's logging.
17137
17138
17139 .option syslog_pid main boolean true
17140 .cindex "syslog" "pid"
17141 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17142 omitted when these lines are sent to syslog. (Syslog normally prefixes
17143 the log lines with the PID of the logging process automatically.) You need
17144 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17145 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17146
17147
17148
17149 .option syslog_processname main string &`exim`&
17150 .cindex "syslog" "process name; setting"
17151 This option sets the syslog &"ident"& name, used when Exim is logging to
17152 syslog. The value must be no longer than 32 characters. See chapter
17153 &<<CHAPlog>>& for details of Exim's logging.
17154
17155
17156
17157 .option syslog_timestamp main boolean true
17158 .cindex "syslog" "timestamps"
17159 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17160 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17161 details of Exim's logging.
17162
17163
17164 .option system_filter main string&!! unset
17165 .cindex "filter" "system filter"
17166 .cindex "system filter" "specifying"
17167 .cindex "Sieve filter" "not available for system filter"
17168 This option specifies an Exim filter file that is applied to all messages at
17169 the start of each delivery attempt, before any routing is done. System filters
17170 must be Exim filters; they cannot be Sieve filters. If the system filter
17171 generates any deliveries to files or pipes, or any new mail messages, the
17172 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17173 which transports are to be used. Details of this facility are given in chapter
17174 &<<CHAPsystemfilter>>&.
17175 A forced expansion failure results in no filter operation.
17176
17177
17178 .option system_filter_directory_transport main string&!! unset
17179 .vindex "&$address_file$&"
17180 This sets the name of the transport driver that is to be used when the
17181 &%save%& command in a system message filter specifies a path ending in &"/"&,
17182 implying delivery of each message into a separate file in some directory.
17183 During the delivery, the variable &$address_file$& contains the path name.
17184
17185
17186 .option system_filter_file_transport main string&!! unset
17187 .cindex "file" "transport for system filter"
17188 This sets the name of the transport driver that is to be used when the &%save%&
17189 command in a system message filter specifies a path not ending in &"/"&. During
17190 the delivery, the variable &$address_file$& contains the path name.
17191
17192 .option system_filter_group main string unset
17193 .cindex "gid (group id)" "system filter"
17194 This option is used only when &%system_filter_user%& is also set. It sets the
17195 gid under which the system filter is run, overriding any gid that is associated
17196 with the user. The value may be numerical or symbolic.
17197
17198 .option system_filter_pipe_transport main string&!! unset
17199 .cindex "&(pipe)& transport" "for system filter"
17200 .vindex "&$address_pipe$&"
17201 This specifies the transport driver that is to be used when a &%pipe%& command
17202 is used in a system filter. During the delivery, the variable &$address_pipe$&
17203 contains the pipe command.
17204
17205
17206 .option system_filter_reply_transport main string&!! unset
17207 .cindex "&(autoreply)& transport" "for system filter"
17208 This specifies the transport driver that is to be used when a &%mail%& command
17209 is used in a system filter.
17210
17211
17212 .option system_filter_user main string unset
17213 .cindex "uid (user id)" "system filter"
17214 If this option is set to root, the system filter is run in the main Exim
17215 delivery process, as root.  Otherwise, the system filter runs in a separate
17216 process, as the given user, defaulting to the Exim run-time user.
17217 Unless the string consists entirely of digits, it
17218 is looked up in the password data. Failure to find the named user causes a
17219 configuration error. The gid is either taken from the password data, or
17220 specified by &%system_filter_group%&. When the uid is specified numerically,
17221 &%system_filter_group%& is required to be set.
17222
17223 If the system filter generates any pipe, file, or reply deliveries, the uid
17224 under which the filter is run is used when transporting them, unless a
17225 transport option overrides.
17226
17227
17228 .option tcp_nodelay main boolean true
17229 .cindex "daemon" "TCP_NODELAY on sockets"
17230 .cindex "Nagle algorithm"
17231 .cindex "TCP_NODELAY on listening sockets"
17232 If this option is set false, it stops the Exim daemon setting the
17233 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17234 turns off the &"Nagle algorithm"&, which is a way of improving network
17235 performance in interactive (character-by-character) situations. Turning it off
17236 should improve Exim's performance a bit, so that is what happens by default.
17237 However, it appears that some broken clients cannot cope, and time out. Hence
17238 this option. It affects only those sockets that are set up for listening by the
17239 daemon. Sockets created by the smtp transport for delivering mail always set
17240 TCP_NODELAY.
17241
17242
17243 .option timeout_frozen_after main time 0s
17244 .cindex "frozen messages" "timing out"
17245 .cindex "timeout" "frozen messages"
17246 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17247 message of any kind that has been on the queue for longer than the given time
17248 is automatically cancelled at the next queue run. If the frozen message is a
17249 bounce message, it is just discarded; otherwise, a bounce is sent to the
17250 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17251 If you want to timeout frozen bounce messages earlier than other kinds of
17252 frozen message, see &%ignore_bounce_errors_after%&.
17253
17254 &*Note:*& the default value of zero means no timeouts; with this setting,
17255 frozen messages remain on the queue forever (except for any frozen bounce
17256 messages that are released by &%ignore_bounce_errors_after%&).
17257
17258
17259 .option timezone main string unset
17260 .cindex "timezone, setting"
17261 .cindex "environment" "values from"
17262 The value of &%timezone%& is used to set the environment variable TZ while
17263 running Exim (if it is different on entry). This ensures that all timestamps
17264 created by Exim are in the required timezone. If you want all your timestamps
17265 to be in UTC (aka GMT) you should set
17266 .code
17267 timezone = UTC
17268 .endd
17269 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17270 or, if that is not set, from the value of the TZ environment variable when Exim
17271 is built. If &%timezone%& is set to the empty string, either at build or run
17272 time, any existing TZ variable is removed from the environment when Exim
17273 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17274 unfortunately not all, operating systems.
17275
17276
17277 .option tls_advertise_hosts main "host list&!!" *
17278 .cindex "TLS" "advertising"
17279 .cindex "encryption" "on SMTP connection"
17280 .cindex "SMTP" "encrypted connection"
17281 When Exim is built with support for TLS encrypted connections, the availability
17282 of the STARTTLS command to set up an encrypted session is advertised in
17283 response to EHLO only to those client hosts that match this option. See
17284 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17285 Note that the default value requires that a certificate be supplied
17286 using the &%tls_certificate%& option.  If TLS support for incoming connections
17287 is not required the &%tls_advertise_hosts%& option should be set empty.
17288
17289
17290 .option tls_certificate main string list&!! unset
17291 .cindex "TLS" "server certificate; location of"
17292 .cindex "certificate" "server, location of"
17293 The value of this option is expanded, and must then be a list of absolute paths to
17294 files which contains the server's certificates.  Commonly only one file is
17295 needed.
17296 The server's private key is also
17297 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17298 &<<CHAPTLS>>& for further details.
17299
17300 &*Note*&: The certificates defined by this option are used only when Exim is
17301 receiving incoming messages as a server. If you want to supply certificates for
17302 use when sending messages as a client, you must set the &%tls_certificate%&
17303 option in the relevant &(smtp)& transport.
17304
17305 &*Note*&: If you use filenames based on IP addresses, change the list
17306 separator in the usual way to avoid confusion under IPv6.
17307
17308 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
17309 when a list of more than one
17310 file is used, the &$tls_in_ourcert$& variable is unreliable.
17311
17312 &*Note*&: OCSP stapling is not usable under OpenSSL
17313 when a list of more than one file is used.
17314
17315 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17316 if the OpenSSL build supports TLS extensions and the TLS client sends the
17317 Server Name Indication extension, then this option and others documented in
17318 &<<SECTtlssni>>& will be re-expanded.
17319
17320 If this option is unset or empty a fresh self-signed certificate will be
17321 generated for every connection.
17322
17323 .option tls_crl main string&!! unset
17324 .cindex "TLS" "server certificate revocation list"
17325 .cindex "certificate" "revocation list for server"
17326 This option specifies a certificate revocation list. The expanded value must
17327 be the name of a file that contains CRLs in PEM format.
17328
17329 Under OpenSSL the option can specify a directory with CRL files.
17330
17331 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
17332 for each signing element of the certificate chain (i.e. all but the leaf).
17333 For the file variant this can be multiple PEM blocks in the one file.
17334
17335 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17336
17337
17338 .option tls_dh_max_bits main integer 2236
17339 .cindex "TLS" "D-H bit count"
17340 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17341 the chosen TLS library.  That value might prove to be too high for
17342 interoperability.  This option provides a maximum clamp on the value
17343 suggested, trading off security for interoperability.
17344
17345 The value must be at least 1024.
17346
17347 The value 2236 was chosen because, at time of adding the option, it was the
17348 hard-coded maximum value supported by the NSS cryptographic library, as used
17349 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17350
17351 If you prefer more security and are willing to break some clients, raise this
17352 number.
17353
17354 Note that the value passed to GnuTLS for *generating* a new prime may be a
17355 little less than this figure, because GnuTLS is inexact and may produce a
17356 larger prime than requested.
17357
17358
17359 .option tls_dhparam main string&!! unset
17360 .cindex "TLS" "D-H parameters for server"
17361 The value of this option is expanded and indicates the source of DH parameters
17362 to be used by Exim.
17363
17364 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
17365 local DH parameters*&, which has been supported across all versions of Exim.  The
17366 other specific constants available are a fallback so that even when
17367 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17368
17369 If &%tls_dhparam%& is a filename starting with a &`/`&,
17370 then it names a file from which DH
17371 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17372 PKCS#3 representation of the DH prime.  If the file does not exist, for
17373 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17374 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17375 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17376 and treated as though the &%tls_dhparam%& were set to "none".
17377
17378 If this option expands to the string "none", then no DH parameters will be
17379 loaded by Exim.
17380
17381 If this option expands to the string "historic" and Exim is using GnuTLS, then
17382 Exim will attempt to load a file from inside the spool directory.  If the file
17383 does not exist, Exim will attempt to create it.
17384 See section &<<SECTgnutlsparam>>& for further details.
17385
17386 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17387 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17388
17389 In older versions of Exim the default was the 2048 bit prime described in section
17390 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17391 in IKE is assigned number 23.
17392
17393 Otherwise, the option must expand to the name used by Exim for any of a number
17394 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17395 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17396 the number used by IKE, or "default" which corresponds to
17397 &`exim.dev.20160529.3`&.
17398
17399 The available standard primes are:
17400 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17401 &`ike1`&, &`ike2`&, &`ike5`&,
17402 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17403 &`ike22`&, &`ike23`& and &`ike24`&.
17404
17405 The available additional primes are:
17406 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17407
17408 Some of these will be too small to be accepted by clients.
17409 Some may be too large to be accepted by clients.
17410 The open cryptographic community has suspicions about the integrity of some
17411 of the later IKE values, which led into RFC7919 providing new fixed constants
17412 (the "ffdhe" identifiers).
17413
17414 At this point, all of the "ike" values should be considered obsolete;
17415 they're still in Exim to avoid breaking unusual configurations, but are
17416 candidates for removal the next time we have backwards-incompatible changes.
17417
17418 The TLS protocol does not negotiate an acceptable size for this; clients tend
17419 to hard-drop connections if what is offered by the server is unacceptable,
17420 whether too large or too small, and there's no provision for the client to
17421 tell the server what these constraints are.  Thus, as a server operator, you
17422 need to make an educated guess as to what is most likely to work for your
17423 userbase.
17424
17425 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17426 is most likely to maximise interoperability.  The upper bound comes from
17427 applications using the Mozilla Network Security Services (NSS) library, which
17428 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17429 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17430 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17431 acceptable bound from 1024 to 2048.
17432
17433
17434 .option tls_eccurve main string&!! &`auto`&
17435 .cindex TLS "EC cryptography"
17436 This option selects a EC curve for use by Exim when used with OpenSSL.
17437 It has no effect when Exim is used with GnuTLS.
17438
17439 After expansion it must contain a valid EC curve parameter, such as
17440 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17441 for valid selections.
17442
17443 For OpenSSL versions before (and not including) 1.0.2, the string
17444 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17445 &`auto`& tells the library to choose.
17446
17447 If the option expands to an empty string, no EC curves will be enabled.
17448
17449
17450 .option tls_ocsp_file main string&!! unset
17451 .cindex TLS "certificate status"
17452 .cindex TLS "OCSP proof file"
17453 This option
17454 must if set expand to the absolute path to a file which contains a current
17455 status proof for the server's certificate, as obtained from the
17456 Certificate Authority.
17457
17458 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17459
17460 For GnuTLS 3.5.6 or later the expanded value of this option can be a list
17461 of files, to match a list given for the &%tls_certificate%& option.
17462 The ordering of the two lists must match.
17463
17464
17465 .option tls_on_connect_ports main "string list" unset
17466 .cindex SSMTP
17467 .cindex SMTPS
17468 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17469 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
17470 set up without waiting for the client to issue a STARTTLS command. For
17471 further details, see section &<<SECTsupobssmt>>&.
17472
17473
17474
17475 .option tls_privatekey main string list&!! unset
17476 .cindex "TLS" "server private key; location of"
17477 The value of this option is expanded, and must then be a list of absolute paths to
17478 files which contains the server's private keys.
17479 If this option is unset, or if
17480 the expansion is forced to fail, or the result is an empty string, the private
17481 key is assumed to be in the same file as the server's certificates. See chapter
17482 &<<CHAPTLS>>& for further details.
17483
17484 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17485
17486
17487 .option tls_remember_esmtp main boolean false
17488 .cindex "TLS" "esmtp state; remembering"
17489 .cindex "TLS" "broken clients"
17490 If this option is set true, Exim violates the RFCs by remembering that it is in
17491 &"esmtp"& state after successfully negotiating a TLS session. This provides
17492 support for broken clients that fail to send a new EHLO after starting a
17493 TLS session.
17494
17495
17496 .option tls_require_ciphers main string&!! unset
17497 .cindex "TLS" "requiring specific ciphers"
17498 .cindex "cipher" "requiring specific"
17499 This option controls which ciphers can be used for incoming TLS connections.
17500 The &(smtp)& transport has an option of the same name for controlling outgoing
17501 connections. This option is expanded for each connection, so can be varied for
17502 different clients if required. The value of this option must be a list of
17503 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17504 in somewhat different ways. If GnuTLS is being used, the client controls the
17505 preference order of the available ciphers. Details are given in sections
17506 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17507
17508
17509 .option tls_try_verify_hosts main "host list&!!" unset
17510 .cindex "TLS" "client certificate verification"
17511 .cindex "certificate" "verification of client"
17512 See &%tls_verify_hosts%& below.
17513
17514
17515 .option tls_verify_certificates main string&!! system
17516 .cindex "TLS" "client certificate verification"
17517 .cindex "certificate" "verification of client"
17518 The value of this option is expanded, and must then be either the
17519 word "system"
17520 or the absolute path to
17521 a file or directory containing permitted certificates for clients that
17522 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17523
17524 The "system" value for the option will use a
17525 system default location compiled into the SSL library.
17526 This is not available for GnuTLS versions preceding 3.0.20,
17527 and will be taken as empty; an explicit location
17528 must be specified.
17529
17530 The use of a directory for the option value is not available for GnuTLS versions
17531 preceding 3.3.6 and a single file must be used.
17532
17533 With OpenSSL the certificates specified
17534 explicitly
17535 either by file or directory
17536 are added to those given by the system default location.
17537
17538 These certificates should be for the certificate authorities trusted, rather
17539 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17540 the value is a file then the certificates are sent by Exim as a server to
17541 connecting clients, defining the list of accepted certificate authorities.
17542 Thus the values defined should be considered public data.  To avoid this,
17543 use the explicit directory version.
17544
17545 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17546
17547 A forced expansion failure or setting to an empty string is equivalent to
17548 being unset.
17549
17550
17551 .option tls_verify_hosts main "host list&!!" unset
17552 .cindex "TLS" "client certificate verification"
17553 .cindex "certificate" "verification of client"
17554 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17555 certificates from clients. The expected certificates are defined by
17556 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17557 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17558 &%tls_verify_certificates%& is not set.
17559
17560 Any client that matches &%tls_verify_hosts%& is constrained by
17561 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17562 present one of the listed certificates. If it does not, the connection is
17563 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17564 the host to use TLS. It can still send SMTP commands through unencrypted
17565 connections. Forcing a client to use TLS has to be done separately using an
17566 ACL to reject inappropriate commands when the connection is not encrypted.
17567
17568 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17569 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17570 certificate and checks it against &%tls_verify_certificates%&, but does not
17571 abort the connection if there is no certificate or if it does not match. This
17572 state can be detected in an ACL, which makes it possible to implement policies
17573 such as &"accept for relay only if a verified certificate has been received,
17574 but accept for local delivery if encrypted, even without a verified
17575 certificate"&.
17576
17577 Client hosts that match neither of these lists are not asked to present
17578 certificates.
17579
17580
17581 .option trusted_groups main "string list&!!" unset
17582 .cindex "trusted groups"
17583 .cindex "groups" "trusted"
17584 This option is expanded just once, at the start of Exim's processing. If this
17585 option is set, any process that is running in one of the listed groups, or
17586 which has one of them as a supplementary group, is trusted. The groups can be
17587 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17588 details of what trusted callers are permitted to do. If neither
17589 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17590 are trusted.
17591
17592 .option trusted_users main "string list&!!" unset
17593 .cindex "trusted users"
17594 .cindex "user" "trusted"
17595 This option is expanded just once, at the start of Exim's processing. If this
17596 option is set, any process that is running as one of the listed users is
17597 trusted. The users can be specified numerically or by name. See section
17598 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17599 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17600 Exim user are trusted.
17601
17602 .option unknown_login main string&!! unset
17603 .cindex "uid (user id)" "unknown caller"
17604 .vindex "&$caller_uid$&"
17605 This is a specialized feature for use in unusual configurations. By default, if
17606 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17607 gives up. The &%unknown_login%& option can be used to set a login name to be
17608 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17609 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17610 is used for the user's real name (gecos field), unless this has been set by the
17611 &%-F%& option.
17612
17613 .option unknown_username main string unset
17614 See &%unknown_login%&.
17615
17616 .option untrusted_set_sender main "address list&!!" unset
17617 .cindex "trusted users"
17618 .cindex "sender" "setting by untrusted user"
17619 .cindex "untrusted user setting sender"
17620 .cindex "user" "untrusted setting sender"
17621 .cindex "envelope sender"
17622 When an untrusted user submits a message to Exim using the standard input, Exim
17623 normally creates an envelope sender address from the user's login and the
17624 default qualification domain. Data from the &%-f%& option (for setting envelope
17625 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17626 is used) is ignored.
17627
17628 However, untrusted users are permitted to set an empty envelope sender address,
17629 to declare that a message should never generate any bounces. For example:
17630 .code
17631 exim -f '<>' user@domain.example
17632 .endd
17633 .vindex "&$sender_ident$&"
17634 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17635 other envelope sender addresses in a controlled way. When it is set, untrusted
17636 users are allowed to set envelope sender addresses that match any of the
17637 patterns in the list. Like all address lists, the string is expanded. The
17638 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17639 users to setting senders that start with their login ids
17640 followed by a hyphen
17641 by a setting like this:
17642 .code
17643 untrusted_set_sender = ^$sender_ident-
17644 .endd
17645 If you want to allow untrusted users to set envelope sender addresses without
17646 restriction, you can use
17647 .code
17648 untrusted_set_sender = *
17649 .endd
17650 The &%untrusted_set_sender%& option applies to all forms of local input, but
17651 only to the setting of the envelope sender. It does not permit untrusted users
17652 to use the other options which trusted user can use to override message
17653 parameters. Furthermore, it does not stop Exim from removing an existing
17654 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17655 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17656 overriding these actions. The handling of the &'Sender:'& header is also
17657 described in section &<<SECTthesenhea>>&.
17658
17659 The log line for a message's arrival shows the envelope sender following
17660 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17661 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17662 envelope sender address, the user's login is shown in parentheses after the
17663 sender address.
17664
17665
17666 .option uucp_from_pattern main string "see below"
17667 .cindex "&""From""& line"
17668 .cindex "UUCP" "&""From""& line"
17669 Some applications that pass messages to an MTA via a command line interface use
17670 an initial line starting with &"From&~"& to pass the envelope sender. In
17671 particular, this is used by UUCP software. Exim recognizes such a line by means
17672 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17673 matches, the sender address is constructed by expanding the contents of
17674 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17675 default pattern recognizes lines in the following two forms:
17676 .code
17677 From ph10 Fri Jan  5 12:35 GMT 1996
17678 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17679 .endd
17680 The pattern can be seen by running
17681 .code
17682 exim -bP uucp_from_pattern
17683 .endd
17684 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17685 year in the second case. The first word after &"From&~"& is matched in the
17686 regular expression by a parenthesized subpattern. The default value for
17687 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17688 (&"ph10"& in the example above) as the message's sender. See also
17689 &%ignore_fromline_hosts%&.
17690
17691
17692 .option uucp_from_sender main string&!! &`$1`&
17693 See &%uucp_from_pattern%& above.
17694
17695
17696 .option warn_message_file main string unset
17697 .cindex "warning of delay" "customizing the message"
17698 .cindex "customizing" "warning message"
17699 This option defines a template file containing paragraphs of text to be used
17700 for constructing the warning message which is sent by Exim when a message has
17701 been on the queue for a specified amount of time, as specified by
17702 &%delay_warning%&. Details of the file's contents are given in chapter
17703 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
17704
17705
17706 .option write_rejectlog main boolean true
17707 .cindex "reject log" "disabling"
17708 If this option is set false, Exim no longer writes anything to the reject log.
17709 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
17710 .ecindex IIDconfima
17711 .ecindex IIDmaiconf
17712
17713
17714
17715
17716 . ////////////////////////////////////////////////////////////////////////////
17717 . ////////////////////////////////////////////////////////////////////////////
17718
17719 .chapter "Generic options for routers" "CHAProutergeneric"
17720 .scindex IIDgenoprou1 "options" "generic; for routers"
17721 .scindex IIDgenoprou2 "generic options" "router"
17722 This chapter describes the generic options that apply to all routers.
17723 Those that are preconditions are marked with &Dagger; in the &"use"& field.
17724
17725 For a general description of how a router operates, see sections
17726 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
17727 which the preconditions are tested. The order of expansion of the options that
17728 provide data for a transport is: &%errors_to%&, &%headers_add%&,
17729 &%headers_remove%&, &%transport%&.
17730
17731
17732
17733 .option address_data routers string&!! unset
17734 .cindex "router" "data attached to address"
17735 The string is expanded just before the router is run, that is, after all the
17736 precondition tests have succeeded. If the expansion is forced to fail, the
17737 router declines, the value of &%address_data%& remains unchanged, and the
17738 &%more%& option controls what happens next. Other expansion failures cause
17739 delivery of the address to be deferred.
17740
17741 .vindex "&$address_data$&"
17742 When the expansion succeeds, the value is retained with the address, and can be
17743 accessed using the variable &$address_data$& in the current router, subsequent
17744 routers, and the eventual transport.
17745
17746 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
17747 that runs a user's filter file, the contents of &$address_data$& are accessible
17748 in the filter. This is not normally a problem, because such data is usually
17749 either not confidential or it &"belongs"& to the current user, but if you do
17750 put confidential data into &$address_data$& you need to remember this point.
17751
17752 Even if the router declines or passes, the value of &$address_data$& remains
17753 with the address, though it can be changed by another &%address_data%& setting
17754 on a subsequent router. If a router generates child addresses, the value of
17755 &$address_data$& propagates to them. This also applies to the special kind of
17756 &"child"& that is generated by a router with the &%unseen%& option.
17757
17758 The idea of &%address_data%& is that you can use it to look up a lot of data
17759 for the address once, and then pick out parts of the data later. For example,
17760 you could use a single LDAP lookup to return a string of the form
17761 .code
17762 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
17763 .endd
17764 In the transport you could pick out the mailbox by a setting such as
17765 .code
17766 file = ${extract{mailbox}{$address_data}}
17767 .endd
17768 This makes the configuration file less messy, and also reduces the number of
17769 lookups (though Exim does cache lookups).
17770
17771 .vindex "&$sender_address_data$&"
17772 .vindex "&$address_data$&"
17773 The &%address_data%& facility is also useful as a means of passing information
17774 from one router to another, and from a router to a transport. In addition, if
17775 &$address_data$& is set by a router when verifying a recipient address from an
17776 ACL, it remains available for use in the rest of the ACL statement. After
17777 verifying a sender, the value is transferred to &$sender_address_data$&.
17778
17779
17780
17781 .option address_test routers&!? boolean true
17782 .oindex "&%-bt%&"
17783 .cindex "router" "skipping when address testing"
17784 If this option is set false, the router is skipped when routing is being tested
17785 by means of the &%-bt%& command line option. This can be a convenience when
17786 your first router sends messages to an external scanner, because it saves you
17787 having to set the &"already scanned"& indicator when testing real address
17788 routing.
17789
17790
17791
17792 .option cannot_route_message routers string&!! unset
17793 .cindex "router" "customizing &""cannot route""& message"
17794 .cindex "customizing" "&""cannot route""& message"
17795 This option specifies a text message that is used when an address cannot be
17796 routed because Exim has run out of routers. The default message is
17797 &"Unrouteable address"&. This option is useful only on routers that have
17798 &%more%& set false, or on the very last router in a configuration, because the
17799 value that is used is taken from the last router that is considered. This
17800 includes a router that is skipped because its preconditions are not met, as
17801 well as a router that declines. For example, using the default configuration,
17802 you could put:
17803 .code
17804 cannot_route_message = Remote domain not found in DNS
17805 .endd
17806 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17807 and
17808 .code
17809 cannot_route_message = Unknown local user
17810 .endd
17811 on the final router that checks for local users. If string expansion fails for
17812 this option, the default message is used. Unless the expansion failure was
17813 explicitly forced, a message about the failure is written to the main and panic
17814 logs, in addition to the normal message about the routing failure.
17815
17816
17817 .option caseful_local_part routers boolean false
17818 .cindex "case of local parts"
17819 .cindex "router" "case of local parts"
17820 By default, routers handle the local parts of addresses in a case-insensitive
17821 manner, though the actual case is preserved for transmission with the message.
17822 If you want the case of letters to be significant in a router, you must set
17823 this option true. For individual router options that contain address or local
17824 part lists (for example, &%local_parts%&), case-sensitive matching can be
17825 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
17826 more details.
17827
17828 .vindex "&$local_part$&"
17829 .vindex "&$original_local_part$&"
17830 .vindex "&$parent_local_part$&"
17831 The value of the &$local_part$& variable is forced to lower case while a
17832 router is running unless &%caseful_local_part%& is set. When a router assigns
17833 an address to a transport, the value of &$local_part$& when the transport runs
17834 is the same as it was in the router. Similarly, when a router generates child
17835 addresses by aliasing or forwarding, the values of &$original_local_part$&
17836 and &$parent_local_part$& are those that were used by the redirecting router.
17837
17838 This option applies to the processing of an address by a router. When a
17839 recipient address is being processed in an ACL, there is a separate &%control%&
17840 modifier that can be used to specify case-sensitive processing within the ACL
17841 (see section &<<SECTcontrols>>&).
17842
17843
17844
17845 .option check_local_user routers&!? boolean false
17846 .cindex "local user, checking in router"
17847 .cindex "router" "checking for local user"
17848 .cindex "&_/etc/passwd_&"
17849 .vindex "&$home$&"
17850 When this option is true, Exim checks that the local part of the recipient
17851 address (with affixes removed if relevant) is the name of an account on the
17852 local system. The check is done by calling the &[getpwnam()]& function rather
17853 than trying to read &_/etc/passwd_& directly. This means that other methods of
17854 holding password data (such as NIS) are supported. If the local part is a local
17855 user, &$home$& is set from the password data, and can be tested in other
17856 preconditions that are evaluated after this one (the order of evaluation is
17857 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17858 overridden by &%router_home_directory%&. If the local part is not a local user,
17859 the router is skipped.
17860
17861 If you want to check that the local part is either the name of a local user
17862 or matches something else, you cannot combine &%check_local_user%& with a
17863 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17864 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17865 setting to achieve this. For example:
17866 .code
17867 local_parts = passwd;$local_part : lsearch;/etc/other/users
17868 .endd
17869 Note, however, that the side effects of &%check_local_user%& (such as setting
17870 up a home directory) do not occur when a &(passwd)& lookup is used in a
17871 &%local_parts%& (or any other) precondition.
17872
17873
17874
17875 .option condition routers&!? string&!! unset
17876 .cindex "router" "customized precondition"
17877 This option specifies a general precondition test that has to succeed for the
17878 router to be called. The &%condition%& option is the last precondition to be
17879 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17880 result is a forced failure, or an empty string, or one of the strings &"0"& or
17881 &"no"& or &"false"& (checked without regard to the case of the letters), the
17882 router is skipped, and the address is offered to the next one.
17883
17884 If the result is any other value, the router is run (as this is the last
17885 precondition to be evaluated, all the other preconditions must be true).
17886
17887 This option is unusual in that multiple &%condition%& options may be present.
17888 All &%condition%& options must succeed.
17889
17890 The &%condition%& option provides a means of applying custom conditions to the
17891 running of routers. Note that in the case of a simple conditional expansion,
17892 the default expansion values are exactly what is wanted. For example:
17893 .code
17894 condition = ${if >{$message_age}{600}}
17895 .endd
17896 Because of the default behaviour of the string expansion, this is equivalent to
17897 .code
17898 condition = ${if >{$message_age}{600}{true}{}}
17899 .endd
17900
17901 A multiple condition example, which succeeds:
17902 .code
17903 condition = ${if >{$message_age}{600}}
17904 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17905 condition = foobar
17906 .endd
17907
17908 If the expansion fails (other than forced failure) delivery is deferred. Some
17909 of the other precondition options are common special cases that could in fact
17910 be specified using &%condition%&.
17911
17912 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17913 are far older, and use one set of semantics.  ACLs are newer and when
17914 they were created, the ACL &%condition%& process was given far stricter
17915 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17916 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17917 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17918 Router rules processing behavior.
17919
17920 This is best illustrated in an example:
17921 .code
17922 # If used in an ACL condition will fail with a syntax error, but
17923 # in a router condition any extra characters are treated as a string
17924
17925 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17926 true {yes} {no}}
17927
17928 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17929  {yes} {no}}
17930 .endd
17931 In each example above, the &%if%& statement actually ends after
17932 &"{google.com}}"&.  Since no true or false braces were defined, the
17933 default &%if%& behavior is to return a boolean true or a null answer
17934 (which evaluates to false). The rest of the line is then treated as a
17935 string. So the first example resulted in the boolean answer &"true"&
17936 with the string &" {yes} {no}}"& appended to it. The second example
17937 resulted in the null output (indicating false) with the string
17938 &" {yes} {no}}"& appended to it.
17939
17940 In fact you can put excess forward braces in too.  In the router
17941 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17942 mean something, like after a &"$"& or when required as part of a
17943 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17944 string characters.
17945
17946 Thus, in a Router, the above expansion strings will both always evaluate
17947 true, as the result of expansion is a non-empty string which doesn't
17948 match an explicit false value.  This can be tricky to debug.  By
17949 contrast, in an ACL either of those strings will always result in an
17950 expansion error because the result doesn't look sufficiently boolean.
17951
17952
17953 .option debug_print routers string&!! unset
17954 .cindex "testing" "variables in drivers"
17955 If this option is set and debugging is enabled (see the &%-d%& command line
17956 option) or in address-testing mode (see the &%-bt%& command line option),
17957 the string is expanded and included in the debugging output.
17958 If expansion of the string fails, the error message is written to the debugging
17959 output, and Exim carries on processing.
17960 This option is provided to help with checking out the values of variables and
17961 so on when debugging router configurations. For example, if a &%condition%&
17962 option appears not to be working, &%debug_print%& can be used to output the
17963 variables it references. The output happens after checks for &%domains%&,
17964 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17965 are tested. A newline is added to the text if it does not end with one.
17966 The variable &$router_name$& contains the name of the router.
17967
17968
17969
17970 .option disable_logging routers boolean false
17971 If this option is set true, nothing is logged for any routing errors
17972 or for any deliveries caused by this router. You should not set this option
17973 unless you really, really know what you are doing. See also the generic
17974 transport option of the same name.
17975
17976 .option dnssec_request_domains routers "domain list&!!" unset
17977 .cindex "MX record" "security"
17978 .cindex "DNSSEC" "MX lookup"
17979 .cindex "security" "MX lookup"
17980 .cindex "DNS" "DNSSEC"
17981 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17982 the dnssec request bit set.
17983 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17984
17985 .option dnssec_require_domains routers "domain list&!!" unset
17986 .cindex "MX record" "security"
17987 .cindex "DNSSEC" "MX lookup"
17988 .cindex "security" "MX lookup"
17989 .cindex "DNS" "DNSSEC"
17990 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
17991 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17992 (AD bit) set will be ignored and logged as a host-lookup failure.
17993 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17994
17995
17996 .option domains routers&!? "domain list&!!" unset
17997 .cindex "router" "restricting to specific domains"
17998 .vindex "&$domain_data$&"
17999 If this option is set, the router is skipped unless the current domain matches
18000 the list. If the match is achieved by means of a file lookup, the data that the
18001 lookup returned for the domain is placed in &$domain_data$& for use in string
18002 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18003 a list of the order in which preconditions are evaluated.
18004
18005
18006
18007 .option driver routers string unset
18008 This option must always be set. It specifies which of the available routers is
18009 to be used.
18010
18011
18012 .option dsn_lasthop routers boolean false
18013 .cindex "DSN" "success"
18014 .cindex "Delivery Status Notification" "success"
18015 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18016 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18017 instead send a success DSN as if the next hop does not support DSN.
18018 Not effective on redirect routers.
18019
18020
18021
18022 .option errors_to routers string&!! unset
18023 .cindex "envelope sender"
18024 .cindex "router" "changing address for errors"
18025 If a router successfully handles an address, it may assign the address to a
18026 transport for delivery or it may generate child addresses. In both cases, if
18027 there is a delivery problem during later processing, the resulting bounce
18028 message is sent to the address that results from expanding this string,
18029 provided that the address verifies successfully. The &%errors_to%& option is
18030 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18031
18032 The &%errors_to%& setting associated with an address can be overridden if it
18033 subsequently passes through other routers that have their own &%errors_to%&
18034 settings, or if the message is delivered by a transport with a &%return_path%&
18035 setting.
18036
18037 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18038 the expansion fails to verify, the errors address associated with the incoming
18039 address is used. At top level, this is the envelope sender. A non-forced
18040 expansion failure causes delivery to be deferred.
18041
18042 If an address for which &%errors_to%& has been set ends up being delivered over
18043 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18044 any bounces that are generated by other MTAs on the delivery route are also
18045 sent there. You can set &%errors_to%& to the empty string by either of these
18046 settings:
18047 .code
18048 errors_to =
18049 errors_to = ""
18050 .endd
18051 An expansion item that yields an empty string has the same effect. If you do
18052 this, a locally detected delivery error for addresses processed by this router
18053 no longer gives rise to a bounce message; the error is discarded. If the
18054 address is delivered to a remote host, the return path is set to &`<>`&, unless
18055 overridden by the &%return_path%& option on the transport.
18056
18057 .vindex "&$address_data$&"
18058 If for some reason you want to discard local errors, but use a non-empty
18059 MAIL command for remote delivery, you can preserve the original return
18060 path in &$address_data$& in the router, and reinstate it in the transport by
18061 setting &%return_path%&.
18062
18063 The most common use of &%errors_to%& is to direct mailing list bounces to the
18064 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18065 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18066
18067
18068
18069 .option expn routers&!? boolean true
18070 .cindex "address" "testing"
18071 .cindex "testing" "addresses"
18072 .cindex "EXPN" "router skipping"
18073 .cindex "router" "skipping for EXPN"
18074 If this option is turned off, the router is skipped when testing an address
18075 as a result of processing an SMTP EXPN command. You might, for example,
18076 want to turn it off on a router for users' &_.forward_& files, while leaving it
18077 on for the system alias file.
18078 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18079 are evaluated.
18080
18081 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18082 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18083 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18084
18085
18086
18087 .option fail_verify routers boolean false
18088 .cindex "router" "forcing verification failure"
18089 Setting this option has the effect of setting both &%fail_verify_sender%& and
18090 &%fail_verify_recipient%& to the same value.
18091
18092
18093
18094 .option fail_verify_recipient routers boolean false
18095 If this option is true and an address is accepted by this router when
18096 verifying a recipient, verification fails.
18097
18098
18099
18100 .option fail_verify_sender routers boolean false
18101 If this option is true and an address is accepted by this router when
18102 verifying a sender, verification fails.
18103
18104
18105
18106 .option fallback_hosts routers "string list" unset
18107 .cindex "router" "fallback hosts"
18108 .cindex "fallback" "hosts specified on router"
18109 String expansion is not applied to this option. The argument must be a
18110 colon-separated list of host names or IP addresses. The list separator can be
18111 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
18112 each name or address. In fact, the format of each item is exactly the same as
18113 defined for the list of hosts in a &(manualroute)& router (see section
18114 &<<SECTformatonehostitem>>&).
18115
18116 If a router queues an address for a remote transport, this host list is
18117 associated with the address, and used instead of the transport's fallback host
18118 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18119 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18120 transport for further details.
18121
18122
18123 .option group routers string&!! "see below"
18124 .cindex "gid (group id)" "local delivery"
18125 .cindex "local transports" "uid and gid"
18126 .cindex "transport" "local"
18127 .cindex "router" "setting group"
18128 When a router queues an address for a transport, and the transport does not
18129 specify a group, the group given here is used when running the delivery
18130 process.
18131 The group may be specified numerically or by name. If expansion fails, the
18132 error is logged and delivery is deferred.
18133 The default is unset, unless &%check_local_user%& is set, when the default
18134 is taken from the password information. See also &%initgroups%& and &%user%&
18135 and the discussion in chapter &<<CHAPenvironment>>&.
18136
18137
18138
18139 .option headers_add routers list&!! unset
18140 .cindex "header lines" "adding"
18141 .cindex "router" "adding header lines"
18142 This option specifies a list of text headers,
18143 newline-separated (by default, changeable in the usual way),
18144 that is associated with any addresses that are accepted by the router.
18145 Each item is separately expanded, at routing time.  However, this
18146 option has no effect when an address is just being verified. The way in which
18147 the text is used to add header lines at transport time is described in section
18148 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18149 message is in the process of being transported. This means that references to
18150 header lines in string expansions in the transport's configuration do not
18151 &"see"& the added header lines.
18152
18153 The &%headers_add%& option is expanded after &%errors_to%&, but before
18154 &%headers_remove%& and &%transport%&. If an item is empty, or if
18155 an item expansion is forced to fail, the item has no effect. Other expansion
18156 failures are treated as configuration errors.
18157
18158 Unlike most options, &%headers_add%& can be specified multiple times
18159 for a router; all listed headers are added.
18160
18161 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
18162 router that has the &%one_time%& option set.
18163
18164 .cindex "duplicate addresses"
18165 .oindex "&%unseen%&"
18166 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18167 additions are deleted when the address is passed on to subsequent routers.
18168 For a &%redirect%& router, if a generated address is the same as the incoming
18169 address, this can lead to duplicate addresses with different header
18170 modifications. Exim does not do duplicate deliveries (except, in certain
18171 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
18172 which of the duplicates is discarded, so this ambiguous situation should be
18173 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
18174
18175
18176
18177 .option headers_remove routers list&!! unset
18178 .cindex "header lines" "removing"
18179 .cindex "router" "removing header lines"
18180 This option specifies a list of text headers,
18181 colon-separated (by default, changeable in the usual way),
18182 that is associated with any addresses that are accepted by the router.
18183 Each item is separately expanded, at routing time.  However, this
18184 option has no effect when an address is just being verified. The way in which
18185 the text is used to remove header lines at transport time is described in
18186 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
18187 the message is in the process of being transported. This means that references
18188 to header lines in string expansions in the transport's configuration still
18189 &"see"& the original header lines.
18190
18191 The &%headers_remove%& option is expanded after &%errors_to%& and
18192 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
18193 the item has no effect. Other expansion failures are treated as configuration
18194 errors.
18195
18196 Unlike most options, &%headers_remove%& can be specified multiple times
18197 for a router; all listed headers are removed.
18198
18199 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
18200 router that has the &%one_time%& option set.
18201
18202 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18203 removal requests are deleted when the address is passed on to subsequent
18204 routers, and this can lead to problems with duplicates -- see the similar
18205 warning for &%headers_add%& above.
18206
18207 &*Warning 3*&: Because of the separate expansion of the list items,
18208 items that contain a list separator must have it doubled.
18209 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18210
18211
18212
18213 .option ignore_target_hosts routers "host list&!!" unset
18214 .cindex "IP address" "discarding"
18215 .cindex "router" "discarding IP addresses"
18216 Although this option is a host list, it should normally contain IP address
18217 entries rather than names. If any host that is looked up by the router has an
18218 IP address that matches an item in this list, Exim behaves as if that IP
18219 address did not exist. This option allows you to cope with rogue DNS entries
18220 like
18221 .code
18222 remote.domain.example.  A  127.0.0.1
18223 .endd
18224 by setting
18225 .code
18226 ignore_target_hosts = 127.0.0.1
18227 .endd
18228 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18229 discarded in this way, the router declines. In a conventional configuration, an
18230 attempt to mail to such a domain would normally provoke the &"unrouteable
18231 domain"& error, and an attempt to verify an address in the domain would fail.
18232 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18233 router declines if presented with one of the listed addresses.
18234
18235 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18236 means of the first or the second of the following settings, respectively:
18237 .code
18238 ignore_target_hosts = 0.0.0.0/0
18239 ignore_target_hosts = <; 0::0/0
18240 .endd
18241 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18242 in the second line matches all IPv6 addresses.
18243
18244 This option may also be useful for ignoring link-local and site-local IPv6
18245 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18246 is expanded before use as a list, it is possible to make it dependent on the
18247 domain that is being routed.
18248
18249 .vindex "&$host_address$&"
18250 During its expansion, &$host_address$& is set to the IP address that is being
18251 checked.
18252
18253 .option initgroups routers boolean false
18254 .cindex "additional groups"
18255 .cindex "groups" "additional"
18256 .cindex "local transports" "uid and gid"
18257 .cindex "transport" "local"
18258 If the router queues an address for a transport, and this option is true, and
18259 the uid supplied by the router is not overridden by the transport, the
18260 &[initgroups()]& function is called when running the transport to ensure that
18261 any additional groups associated with the uid are set up. See also &%group%&
18262 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18263
18264
18265
18266 .option local_part_prefix routers&!? "string list" unset
18267 .cindex "router" "prefix for local part"
18268 .cindex "prefix" "for local part, used in router"
18269 If this option is set, the router is skipped unless the local part starts with
18270 one of the given strings, or &%local_part_prefix_optional%& is true. See
18271 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18272 evaluated.
18273
18274 The list is scanned from left to right, and the first prefix that matches is
18275 used. A limited form of wildcard is available; if the prefix begins with an
18276 asterisk, it matches the longest possible sequence of arbitrary characters at
18277 the start of the local part. An asterisk should therefore always be followed by
18278 some character that does not occur in normal local parts.
18279 .cindex "multiple mailboxes"
18280 .cindex "mailbox" "multiple"
18281 Wildcarding can be used to set up multiple user mailboxes, as described in
18282 section &<<SECTmulbox>>&.
18283
18284 .vindex "&$local_part$&"
18285 .vindex "&$local_part_prefix$&"
18286 During the testing of the &%local_parts%& option, and while the router is
18287 running, the prefix is removed from the local part, and is available in the
18288 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18289 the router accepts the address, this remains true during subsequent delivery by
18290 a transport. In particular, the local part that is transmitted in the RCPT
18291 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18292 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18293 the relevant transport.
18294
18295 When an address is being verified, &%local_part_prefix%& affects only the
18296 behaviour of the router. If the callout feature of verification is in use, this
18297 means that the full address, including the prefix, will be used during the
18298 callout.
18299
18300 The prefix facility is commonly used to handle local parts of the form
18301 &%owner-something%&. Another common use is to support local parts of the form
18302 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18303 to tell a user their forwarding is broken &-- by placing a router like this one
18304 immediately before the router that handles &_.forward_& files:
18305 .code
18306 real_localuser:
18307   driver = accept
18308   local_part_prefix = real-
18309   check_local_user
18310   transport = local_delivery
18311 .endd
18312 For security, it would probably be a good idea to restrict the use of this
18313 router to locally-generated messages, using a condition such as this:
18314 .code
18315   condition = ${if match {$sender_host_address}\
18316                          {\N^(|127\.0\.0\.1)$\N}}
18317 .endd
18318
18319 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18320 both conditions must be met if not optional. Care must be taken if wildcards
18321 are used in both a prefix and a suffix on the same router. Different
18322 separator characters must be used to avoid ambiguity.
18323
18324
18325 .option local_part_prefix_optional routers boolean false
18326 See &%local_part_prefix%& above.
18327
18328
18329
18330 .option local_part_suffix routers&!? "string list" unset
18331 .cindex "router" "suffix for local part"
18332 .cindex "suffix for local part" "used in router"
18333 This option operates in the same way as &%local_part_prefix%&, except that the
18334 local part must end (rather than start) with the given string, the
18335 &%local_part_suffix_optional%& option determines whether the suffix is
18336 mandatory, and the wildcard * character, if present, must be the last
18337 character of the suffix. This option facility is commonly used to handle local
18338 parts of the form &%something-request%& and multiple user mailboxes of the form
18339 &%username-foo%&.
18340
18341
18342 .option local_part_suffix_optional routers boolean false
18343 See &%local_part_suffix%& above.
18344
18345
18346
18347 .option local_parts routers&!? "local part list&!!" unset
18348 .cindex "router" "restricting to specific local parts"
18349 .cindex "local part" "checking in router"
18350 The router is run only if the local part of the address matches the list.
18351 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18352 are evaluated, and
18353 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18354 string is expanded, it is possible to make it depend on the domain, for
18355 example:
18356 .code
18357 local_parts = dbm;/usr/local/specials/$domain
18358 .endd
18359 .vindex "&$local_part_data$&"
18360 If the match is achieved by a lookup, the data that the lookup returned
18361 for the local part is placed in the variable &$local_part_data$& for use in
18362 expansions of the router's private options. You might use this option, for
18363 example, if you have a large number of local virtual domains, and you want to
18364 send all postmaster mail to the same place without having to set up an alias in
18365 each virtual domain:
18366 .code
18367 postmaster:
18368   driver = redirect
18369   local_parts = postmaster
18370   data = postmaster@real.domain.example
18371 .endd
18372
18373
18374 .option log_as_local routers boolean "see below"
18375 .cindex "log" "delivery line"
18376 .cindex "delivery" "log line format"
18377 Exim has two logging styles for delivery, the idea being to make local
18378 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18379 recipient address is given just as the local part, without a domain. The use of
18380 this style is controlled by this option. It defaults to true for the &(accept)&
18381 router, and false for all the others. This option applies only when a
18382 router assigns an address to a transport. It has no effect on routers that
18383 redirect addresses.
18384
18385
18386
18387 .option more routers boolean&!! true
18388 The result of string expansion for this option must be a valid boolean value,
18389 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18390 result causes an error, and delivery is deferred. If the expansion is forced to
18391 fail, the default value for the option (true) is used. Other failures cause
18392 delivery to be deferred.
18393
18394 If this option is set false, and the router declines to handle the address, no
18395 further routers are tried, routing fails, and the address is bounced.
18396 .oindex "&%self%&"
18397 However, if the router explicitly passes an address to the following router by
18398 means of the setting
18399 .code
18400 self = pass
18401 .endd
18402 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18403 does not affect the behaviour if one of the precondition tests fails. In that
18404 case, the address is always passed to the next router.
18405
18406 Note that &%address_data%& is not considered to be a precondition. If its
18407 expansion is forced to fail, the router declines, and the value of &%more%&
18408 controls what happens next.
18409
18410
18411 .option pass_on_timeout routers boolean false
18412 .cindex "timeout" "of router"
18413 .cindex "router" "timeout"
18414 If a router times out during a host lookup, it normally causes deferral of the
18415 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18416 router, overriding &%no_more%&. This may be helpful for systems that are
18417 intermittently connected to the Internet, or those that want to pass to a smart
18418 host any messages that cannot immediately be delivered.
18419
18420 There are occasional other temporary errors that can occur while doing DNS
18421 lookups. They are treated in the same way as a timeout, and this option
18422 applies to all of them.
18423
18424
18425
18426 .option pass_router routers string unset
18427 .cindex "router" "go to after &""pass""&"
18428 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18429 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18430 routing to continue, and overriding a false setting of &%more%&. When one of
18431 these routers returns &"pass"&, the address is normally handed on to the next
18432 router in sequence. This can be changed by setting &%pass_router%& to the name
18433 of another router. However (unlike &%redirect_router%&) the named router must
18434 be below the current router, to avoid loops. Note that this option applies only
18435 to the special case of &"pass"&. It does not apply when a router returns
18436 &"decline"& because it cannot handle an address.
18437
18438
18439
18440 .option redirect_router routers string unset
18441 .cindex "router" "start at after redirection"
18442 Sometimes an administrator knows that it is pointless to reprocess addresses
18443 generated from alias or forward files with the same router again. For
18444 example, if an alias file translates real names into login ids there is no
18445 point searching the alias file a second time, especially if it is a large file.
18446
18447 The &%redirect_router%& option can be set to the name of any router instance.
18448 It causes the routing of any generated addresses to start at the named router
18449 instead of at the first router. This option has no effect if the router in
18450 which it is set does not generate new addresses.
18451
18452
18453
18454 .option require_files routers&!? "string list&!!" unset
18455 .cindex "file" "requiring for router"
18456 .cindex "router" "requiring file existence"
18457 This option provides a general mechanism for predicating the running of a
18458 router on the existence or non-existence of certain files or directories.
18459 Before running a router, as one of its precondition tests, Exim works its way
18460 through the &%require_files%& list, expanding each item separately.
18461
18462 Because the list is split before expansion, any colons in expansion items must
18463 be doubled, or the facility for using a different list separator must be used.
18464 If any expansion is forced to fail, the item is ignored. Other expansion
18465 failures cause routing of the address to be deferred.
18466
18467 If any expanded string is empty, it is ignored. Otherwise, except as described
18468 below, each string must be a fully qualified file path, optionally preceded by
18469 &"!"&. The paths are passed to the &[stat()]& function to test for the
18470 existence of the files or directories. The router is skipped if any paths not
18471 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18472
18473 .cindex "NFS"
18474 If &[stat()]& cannot determine whether a file exists or not, delivery of
18475 the message is deferred. This can happen when NFS-mounted filesystems are
18476 unavailable.
18477
18478 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18479 options, so you cannot use it to check for the existence of a file in which to
18480 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18481 full list of the order in which preconditions are evaluated.) However, as
18482 these options are all expanded, you can use the &%exists%& expansion condition
18483 to make such tests. The &%require_files%& option is intended for checking files
18484 that the router may be going to use internally, or which are needed by a
18485 transport (for example &_.procmailrc_&).
18486
18487 During delivery, the &[stat()]& function is run as root, but there is a
18488 facility for some checking of the accessibility of a file by another user.
18489 This is not a proper permissions check, but just a &"rough"& check that
18490 operates as follows:
18491
18492 If an item in a &%require_files%& list does not contain any forward slash
18493 characters, it is taken to be the user (and optional group, separated by a
18494 comma) to be checked for subsequent files in the list. If no group is specified
18495 but the user is specified symbolically, the gid associated with the uid is
18496 used. For example:
18497 .code
18498 require_files = mail:/some/file
18499 require_files = $local_part:$home/.procmailrc
18500 .endd
18501 If a user or group name in a &%require_files%& list does not exist, the
18502 &%require_files%& condition fails.
18503
18504 Exim performs the check by scanning along the components of the file path, and
18505 checking the access for the given uid and gid. It checks for &"x"& access on
18506 directories, and &"r"& access on the final file. Note that this means that file
18507 access control lists, if the operating system has them, are ignored.
18508
18509 &*Warning 1*&: When the router is being run to verify addresses for an
18510 incoming SMTP message, Exim is not running as root, but under its own uid. This
18511 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18512 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18513 user is not permitted to read one of the directories on the file's path.
18514
18515 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18516 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18517 without root access. In this case, if a check for access by a particular user
18518 is requested, Exim creates a subprocess that runs as that user, and tries the
18519 check again in that process.
18520
18521 The default action for handling an unresolved EACCES is to consider it to
18522 be caused by a configuration error, and routing is deferred because the
18523 existence or non-existence of the file cannot be determined. However, in some
18524 circumstances it may be desirable to treat this condition as if the file did
18525 not exist. If the file name (or the exclamation mark that precedes the file
18526 name for non-existence) is preceded by a plus sign, the EACCES error is treated
18527 as if the file did not exist. For example:
18528 .code
18529 require_files = +/some/file
18530 .endd
18531 If the router is not an essential part of verification (for example, it
18532 handles users' &_.forward_& files), another solution is to set the &%verify%&
18533 option false so that the router is skipped when verifying.
18534
18535
18536
18537 .option retry_use_local_part routers boolean "see below"
18538 .cindex "hints database" "retry keys"
18539 .cindex "local part" "in retry keys"
18540 When a delivery suffers a temporary routing failure, a retry record is created
18541 in Exim's hints database. For addresses whose routing depends only on the
18542 domain, the key for the retry record should not involve the local part, but for
18543 other addresses, both the domain and the local part should be included.
18544 Usually, remote routing is of the former kind, and local routing is of the
18545 latter kind.
18546
18547 This option controls whether the local part is used to form the key for retry
18548 hints for addresses that suffer temporary errors while being handled by this
18549 router. The default value is true for any router that has &%check_local_user%&
18550 set, and false otherwise. Note that this option does not apply to hints keys
18551 for transport delays; they are controlled by a generic transport option of the
18552 same name.
18553
18554 The setting of &%retry_use_local_part%& applies only to the router on which it
18555 appears. If the router generates child addresses, they are routed
18556 independently; this setting does not become attached to them.
18557
18558
18559
18560 .option router_home_directory routers string&!! unset
18561 .cindex "router" "home directory for"
18562 .cindex "home directory" "for router"
18563 .vindex "&$home$&"
18564 This option sets a home directory for use while the router is running. (Compare
18565 &%transport_home_directory%&, which sets a home directory for later
18566 transporting.) In particular, if used on a &(redirect)& router, this option
18567 sets a value for &$home$& while a filter is running. The value is expanded;
18568 forced expansion failure causes the option to be ignored &-- other failures
18569 cause the router to defer.
18570
18571 Expansion of &%router_home_directory%& happens immediately after the
18572 &%check_local_user%& test (if configured), before any further expansions take
18573 place.
18574 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18575 are evaluated.)
18576 While the router is running, &%router_home_directory%& overrides the value of
18577 &$home$& that came from &%check_local_user%&.
18578
18579 When a router accepts an address and assigns it to a local transport (including
18580 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18581 delivery), the home directory setting for the transport is taken from the first
18582 of these values that is set:
18583
18584 .ilist
18585 The &%home_directory%& option on the transport;
18586 .next
18587 The &%transport_home_directory%& option on the router;
18588 .next
18589 The password data if &%check_local_user%& is set on the router;
18590 .next
18591 The &%router_home_directory%& option on the router.
18592 .endlist
18593
18594 In other words, &%router_home_directory%& overrides the password data for the
18595 router, but not for the transport.
18596
18597
18598
18599 .option self routers string freeze
18600 .cindex "MX record" "pointing to local host"
18601 .cindex "local host" "MX pointing to"
18602 This option applies to those routers that use a recipient address to find a
18603 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18604 and &(manualroute)& routers.
18605 Certain configurations of the &(queryprogram)& router can also specify a list
18606 of remote hosts.
18607 Usually such routers are configured to send the message to a remote host via an
18608 &(smtp)& transport. The &%self%& option specifies what happens when the first
18609 host on the list turns out to be the local host.
18610 The way in which Exim checks for the local host is described in section
18611 &<<SECTreclocipadd>>&.
18612
18613 Normally this situation indicates either an error in Exim's configuration (for
18614 example, the router should be configured not to process this domain), or an
18615 error in the DNS (for example, the MX should not point to this host). For this
18616 reason, the default action is to log the incident, defer the address, and
18617 freeze the message. The following alternatives are provided for use in special
18618 cases:
18619
18620 .vlist
18621 .vitem &%defer%&
18622 Delivery of the message is tried again later, but the message is not frozen.
18623
18624 .vitem "&%reroute%&: <&'domain'&>"
18625 The domain is changed to the given domain, and the address is passed back to
18626 be reprocessed by the routers. No rewriting of headers takes place. This
18627 behaviour is essentially a redirection.
18628
18629 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18630 The domain is changed to the given domain, and the address is passed back to be
18631 reprocessed by the routers. Any headers that contain the original domain are
18632 rewritten.
18633
18634 .vitem &%pass%&
18635 .oindex "&%more%&"
18636 .vindex "&$self_hostname$&"
18637 The router passes the address to the next router, or to the router named in the
18638 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18639 subsequent routing and delivery, the variable &$self_hostname$& contains the
18640 name of the local host that the router encountered. This can be used to
18641 distinguish between different cases for hosts with multiple names. The
18642 combination
18643 .code
18644 self = pass
18645 no_more
18646 .endd
18647 ensures that only those addresses that routed to the local host are passed on.
18648 Without &%no_more%&, addresses that were declined for other reasons would also
18649 be passed to the next router.
18650
18651 .vitem &%fail%&
18652 Delivery fails and an error report is generated.
18653
18654 .vitem &%send%&
18655 .cindex "local host" "sending to"
18656 The anomaly is ignored and the address is queued for the transport. This
18657 setting should be used with extreme caution. For an &(smtp)& transport, it
18658 makes sense only in cases where the program that is listening on the SMTP port
18659 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18660 different configuration file that handles the domain in another way.
18661 .endlist
18662
18663
18664
18665 .option senders routers&!? "address list&!!" unset
18666 .cindex "router" "checking senders"
18667 If this option is set, the router is skipped unless the message's sender
18668 address matches something on the list.
18669 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18670 are evaluated.
18671
18672 There are issues concerning verification when the running of routers is
18673 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18674 setting, it sets the sender to the null string. When using the &%-bt%& option
18675 to check a configuration file, it is necessary also to use the &%-f%& option to
18676 set an appropriate sender. For incoming mail, the sender is unset when
18677 verifying the sender, but is available when verifying any recipients. If the
18678 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18679 matters.
18680
18681
18682 .option translate_ip_address routers string&!! unset
18683 .cindex "IP address" "translating"
18684 .cindex "packet radio"
18685 .cindex "router" "IP address translation"
18686 There exist some rare networking situations (for example, packet radio) where
18687 it is helpful to be able to translate IP addresses generated by normal routing
18688 mechanisms into other IP addresses, thus performing a kind of manual IP
18689 routing. This should be done only if the normal IP routing of the TCP/IP stack
18690 is inadequate or broken. Because this is an extremely uncommon requirement, the
18691 code to support this option is not included in the Exim binary unless
18692 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18693
18694 .vindex "&$host_address$&"
18695 The &%translate_ip_address%& string is expanded for every IP address generated
18696 by the router, with the generated address set in &$host_address$&. If the
18697 expansion is forced to fail, no action is taken.
18698 For any other expansion error, delivery of the message is deferred.
18699 If the result of the expansion is an IP address, that replaces the original
18700 address; otherwise the result is assumed to be a host name &-- this is looked
18701 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
18702 produce one or more replacement IP addresses. For example, to subvert all IP
18703 addresses in some specific networks, this could be added to a router:
18704 .code
18705 translate_ip_address = \
18706   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
18707     {$value}fail}}
18708 .endd
18709 The file would contain lines like
18710 .code
18711 10.2.3.128/26    some.host
18712 10.8.4.34/26     10.44.8.15
18713 .endd
18714 You should not make use of this facility unless you really understand what you
18715 are doing.
18716
18717
18718
18719 .option transport routers string&!! unset
18720 This option specifies the transport to be used when a router accepts an address
18721 and sets it up for delivery. A transport is never needed if a router is used
18722 only for verification. The value of the option is expanded at routing time,
18723 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
18724 and result must be the name of one of the configured transports. If it is not,
18725 delivery is deferred.
18726
18727 The &%transport%& option is not used by the &(redirect)& router, but it does
18728 have some private options that set up transports for pipe and file deliveries
18729 (see chapter &<<CHAPredirect>>&).
18730
18731
18732
18733 .option transport_current_directory routers string&!! unset
18734 .cindex "current directory for local transport"
18735 This option associates a current directory with any address that is routed
18736 to a local transport. This can happen either because a transport is
18737 explicitly configured for the router, or because it generates a delivery to a
18738 file or a pipe. During the delivery process (that is, at transport time), this
18739 option string is expanded and is set as the current directory, unless
18740 overridden by a setting on the transport.
18741 If the expansion fails for any reason, including forced failure, an error is
18742 logged, and delivery is deferred.
18743 See chapter &<<CHAPenvironment>>& for details of the local delivery
18744 environment.
18745
18746
18747
18748
18749 .option transport_home_directory routers string&!! "see below"
18750 .cindex "home directory" "for local transport"
18751 This option associates a home directory with any address that is routed to a
18752 local transport. This can happen either because a transport is explicitly
18753 configured for the router, or because it generates a delivery to a file or a
18754 pipe. During the delivery process (that is, at transport time), the option
18755 string is expanded and is set as the home directory, unless overridden by a
18756 setting of &%home_directory%& on the transport.
18757 If the expansion fails for any reason, including forced failure, an error is
18758 logged, and delivery is deferred.
18759
18760 If the transport does not specify a home directory, and
18761 &%transport_home_directory%& is not set for the router, the home directory for
18762 the transport is taken from the password data if &%check_local_user%& is set for
18763 the router. Otherwise it is taken from &%router_home_directory%& if that option
18764 is set; if not, no home directory is set for the transport.
18765
18766 See chapter &<<CHAPenvironment>>& for further details of the local delivery
18767 environment.
18768
18769
18770
18771
18772 .option unseen routers boolean&!! false
18773 .cindex "router" "carrying on after success"
18774 The result of string expansion for this option must be a valid boolean value,
18775 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18776 result causes an error, and delivery is deferred. If the expansion is forced to
18777 fail, the default value for the option (false) is used. Other failures cause
18778 delivery to be deferred.
18779
18780 When this option is set true, routing does not cease if the router accepts the
18781 address. Instead, a copy of the incoming address is passed to the next router,
18782 overriding a false setting of &%more%&. There is little point in setting
18783 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18784 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18785 sometimes true and sometimes false).
18786
18787 .cindex "copy of message (&%unseen%& option)"
18788 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18789 qualifier in filter files. It can be used to cause copies of messages to be
18790 delivered to some other destination, while also carrying out a normal delivery.
18791 In effect, the current address is made into a &"parent"& that has two children
18792 &-- one that is delivered as specified by this router, and a clone that goes on
18793 to be routed further. For this reason, &%unseen%& may not be combined with the
18794 &%one_time%& option in a &(redirect)& router.
18795
18796 &*Warning*&: Header lines added to the address (or specified for removal) by
18797 this router or by previous routers affect the &"unseen"& copy of the message
18798 only. The clone that continues to be processed by further routers starts with
18799 no added headers and none specified for removal. For a &%redirect%& router, if
18800 a generated address is the same as the incoming address, this can lead to
18801 duplicate addresses with different header modifications. Exim does not do
18802 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18803 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18804 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18805 &%redirect%& router may be of help.
18806
18807 Unlike the handling of header modifications, any data that was set by the
18808 &%address_data%& option in the current or previous routers &'is'& passed on to
18809 subsequent routers.
18810
18811
18812 .option user routers string&!! "see below"
18813 .cindex "uid (user id)" "local delivery"
18814 .cindex "local transports" "uid and gid"
18815 .cindex "transport" "local"
18816 .cindex "router" "user for filter processing"
18817 .cindex "filter" "user for processing"
18818 When a router queues an address for a transport, and the transport does not
18819 specify a user, the user given here is used when running the delivery process.
18820 The user may be specified numerically or by name. If expansion fails, the
18821 error is logged and delivery is deferred.
18822 This user is also used by the &(redirect)& router when running a filter file.
18823 The default is unset, except when &%check_local_user%& is set. In this case,
18824 the default is taken from the password information. If the user is specified as
18825 a name, and &%group%& is not set, the group associated with the user is used.
18826 See also &%initgroups%& and &%group%& and the discussion in chapter
18827 &<<CHAPenvironment>>&.
18828
18829
18830
18831 .option verify routers&!? boolean true
18832 Setting this option has the effect of setting &%verify_sender%& and
18833 &%verify_recipient%& to the same value.
18834
18835
18836 .option verify_only routers&!? boolean false
18837 .cindex "EXPN" "with &%verify_only%&"
18838 .oindex "&%-bv%&"
18839 .cindex "router" "used only when verifying"
18840 If this option is set, the router is used only when verifying an address,
18841 delivering in cutthrough mode or
18842 testing with the &%-bv%& option, not when actually doing a delivery, testing
18843 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18844 restricted to verifying only senders or recipients by means of
18845 &%verify_sender%& and &%verify_recipient%&.
18846
18847 &*Warning*&: When the router is being run to verify addresses for an incoming
18848 SMTP message, Exim is not running as root, but under its own uid. If the router
18849 accesses any files, you need to make sure that they are accessible to the Exim
18850 user or group.
18851
18852
18853 .option verify_recipient routers&!? boolean true
18854 If this option is false, the router is skipped when verifying recipient
18855 addresses,
18856 delivering in cutthrough mode
18857 or testing recipient verification using &%-bv%&.
18858 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18859 are evaluated.
18860 See also the &$verify_mode$& variable.
18861
18862
18863 .option verify_sender routers&!? boolean true
18864 If this option is false, the router is skipped when verifying sender addresses
18865 or testing sender verification using &%-bvs%&.
18866 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18867 are evaluated.
18868 See also the &$verify_mode$& variable.
18869 .ecindex IIDgenoprou1
18870 .ecindex IIDgenoprou2
18871
18872
18873
18874
18875
18876
18877 . ////////////////////////////////////////////////////////////////////////////
18878 . ////////////////////////////////////////////////////////////////////////////
18879
18880 .chapter "The accept router" "CHID4"
18881 .cindex "&(accept)& router"
18882 .cindex "routers" "&(accept)&"
18883 The &(accept)& router has no private options of its own. Unless it is being
18884 used purely for verification (see &%verify_only%&) a transport is required to
18885 be defined by the generic &%transport%& option. If the preconditions that are
18886 specified by generic options are met, the router accepts the address and queues
18887 it for the given transport. The most common use of this router is for setting
18888 up deliveries to local mailboxes. For example:
18889 .code
18890 localusers:
18891   driver = accept
18892   domains = mydomain.example
18893   check_local_user
18894   transport = local_delivery
18895 .endd
18896 The &%domains%& condition in this example checks the domain of the address, and
18897 &%check_local_user%& checks that the local part is the login of a local user.
18898 When both preconditions are met, the &(accept)& router runs, and queues the
18899 address for the &(local_delivery)& transport.
18900
18901
18902
18903
18904
18905
18906 . ////////////////////////////////////////////////////////////////////////////
18907 . ////////////////////////////////////////////////////////////////////////////
18908
18909 .chapter "The dnslookup router" "CHAPdnslookup"
18910 .scindex IIDdnsrou1 "&(dnslookup)& router"
18911 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18912 The &(dnslookup)& router looks up the hosts that handle mail for the
18913 recipient's domain in the DNS. A transport must always be set for this router,
18914 unless &%verify_only%& is set.
18915
18916 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18917 SRV records. If none are found, or if SRV support is not configured,
18918 MX records are looked up. If no MX records exist, address records are sought.
18919 However, &%mx_domains%& can be set to disable the direct use of address
18920 records.
18921
18922 MX records of equal priority are sorted by Exim into a random order. Exim then
18923 looks for address records for the host names obtained from MX or SRV records.
18924 When a host has more than one IP address, they are sorted into a random order,
18925 except that IPv6 addresses are sorted before IPv4 addresses. If all the
18926 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18927 generic option, the router declines.
18928
18929 Unless they have the highest priority (lowest MX value), MX records that point
18930 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18931 are discarded, together with any other MX records of equal or lower priority.
18932
18933 .cindex "MX record" "pointing to local host"
18934 .cindex "local host" "MX pointing to"
18935 .oindex "&%self%&" "in &(dnslookup)& router"
18936 If the host pointed to by the highest priority MX record, or looked up as an
18937 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18938 happens is controlled by the generic &%self%& option.
18939
18940
18941 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18942 There have been problems with DNS servers when SRV records are looked up.
18943 Some misbehaving servers return a DNS error or timeout when a non-existent
18944 SRV record is sought. Similar problems have in the past been reported for
18945 MX records. The global &%dns_again_means_nonexist%& option can help with this
18946 problem, but it is heavy-handed because it is a global option.
18947
18948 For this reason, there are two options, &%srv_fail_domains%& and
18949 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18950 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18951 an attempt to look up an SRV or MX record causes one of these results, and the
18952 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18953 such record"&. In the case of an SRV lookup, this means that the router
18954 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18955 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18956 case routing fails.
18957
18958
18959 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18960 .cindex "&(dnslookup)& router" "declines"
18961 There are a few cases where a &(dnslookup)& router will decline to accept
18962 an address; if such a router is expected to handle "all remaining non-local
18963 domains", then it is important to set &%no_more%&.
18964
18965 The router will defer rather than decline if the domain
18966 is found in the &%fail_defer_domains%& router option.
18967
18968 Reasons for a &(dnslookup)& router to decline currently include:
18969 .ilist
18970 The domain does not exist in DNS
18971 .next
18972 The domain exists but the MX record's host part is just "."; this is a common
18973 convention (borrowed from SRV) used to indicate that there is no such service
18974 for this domain and to not fall back to trying A/AAAA records.
18975 .next
18976 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18977 .next
18978 MX record points to a non-existent host.
18979 .next
18980 MX record points to an IP address and the main section option
18981 &%allow_mx_to_ip%& is not set.
18982 .next
18983 MX records exist and point to valid hosts, but all hosts resolve only to
18984 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18985 .next
18986 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18987 &%dns_check_names_pattern%& for handling one variant of this)
18988 .next
18989 &%check_secondary_mx%& is set on this router but the local host can
18990 not be found in the MX records (see below)
18991 .endlist
18992
18993
18994
18995
18996 .section "Private options for dnslookup" "SECID118"
18997 .cindex "options" "&(dnslookup)& router"
18998 The private options for the &(dnslookup)& router are as follows:
18999
19000 .option check_secondary_mx dnslookup boolean false
19001 .cindex "MX record" "checking for secondary"
19002 If this option is set, the router declines unless the local host is found in
19003 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19004 process domains for which the local host is a secondary mail exchanger
19005 differently to other domains. The way in which Exim decides whether a host is
19006 the local host is described in section &<<SECTreclocipadd>>&.
19007
19008
19009 .option check_srv dnslookup string&!! unset
19010 .cindex "SRV record" "enabling use of"
19011 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19012 addition to MX and address records. The support is disabled by default. To
19013 enable SRV support, set the &%check_srv%& option to the name of the service
19014 required. For example,
19015 .code
19016 check_srv = smtp
19017 .endd
19018 looks for SRV records that refer to the normal smtp service. The option is
19019 expanded, so the service name can vary from message to message or address
19020 to address. This might be helpful if SRV records are being used for a
19021 submission service. If the expansion is forced to fail, the &%check_srv%&
19022 option is ignored, and the router proceeds to look for MX records in the
19023 normal way.
19024
19025 When the expansion succeeds, the router searches first for SRV records for
19026 the given service (it assumes TCP protocol). A single SRV record with a
19027 host name that consists of just a single dot indicates &"no such service for
19028 this domain"&; if this is encountered, the router declines. If other kinds of
19029 SRV record are found, they are used to construct a host list for delivery
19030 according to the rules of RFC 2782. MX records are not sought in this case.
19031
19032 When no SRV records are found, MX records (and address records) are sought in
19033 the traditional way. In other words, SRV records take precedence over MX
19034 records, just as MX records take precedence over address records. Note that
19035 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19036 defined it. It is apparently believed that MX records are sufficient for email
19037 and that SRV records should not be used for this purpose. However, SRV records
19038 have an additional &"weight"& feature which some people might find useful when
19039 trying to split an SMTP load between hosts of different power.
19040
19041 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19042 when there is a DNS lookup error.
19043
19044
19045
19046
19047 .option fail_defer_domains dnslookup "domain list&!!" unset
19048 .cindex "MX record" "not found"
19049 DNS lookups for domains matching &%fail_defer_domains%&
19050 which find no matching record will cause the router to defer
19051 rather than the default behaviour of decline.
19052 This maybe be useful for queueing messages for a newly created
19053 domain while the DNS configuration is not ready.
19054 However, it will result in any message with mistyped domains
19055 also being queued.
19056
19057
19058 .option ipv4_only "string&!!" unset
19059 .cindex IPv6 disabling
19060 .cindex DNS "IPv6 disabling"
19061 The string is expanded, and if the result is anything but a forced failure,
19062 or an empty string, or one of the strings “0” or “no” or “false”
19063 (checked without regard to the case of the letters),
19064 only A records are used.
19065
19066 .option ipv4_prefer "string&!!" unset
19067 .cindex IPv4 preference
19068 .cindex DNS "IPv4 preference"
19069 The string is expanded, and if the result is anything but a forced failure,
19070 or an empty string, or one of the strings “0” or “no” or “false”
19071 (checked without regard to the case of the letters),
19072 A records are sorted before AAAA records (inverting the default).
19073
19074 .option mx_domains dnslookup "domain list&!!" unset
19075 .cindex "MX record" "required to exist"
19076 .cindex "SRV record" "required to exist"
19077 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19078 record in order to be recognized. (The name of this option could be improved.)
19079 For example, if all the mail hosts in &'fict.example'& are known to have MX
19080 records, except for those in &'discworld.fict.example'&, you could use this
19081 setting:
19082 .code
19083 mx_domains = ! *.discworld.fict.example : *.fict.example
19084 .endd
19085 This specifies that messages addressed to a domain that matches the list but
19086 has no MX record should be bounced immediately instead of being routed using
19087 the address record.
19088
19089
19090 .option mx_fail_domains dnslookup "domain list&!!" unset
19091 If the DNS lookup for MX records for one of the domains in this list causes a
19092 DNS lookup error, Exim behaves as if no MX records were found. See section
19093 &<<SECTprowitdnsloo>>& for more discussion.
19094
19095
19096
19097
19098 .option qualify_single dnslookup boolean true
19099 .cindex "DNS" "resolver options"
19100 .cindex "DNS" "qualifying single-component names"
19101 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19102 lookups. Typically, but not standardly, this causes the resolver to qualify
19103 single-component names with the default domain. For example, on a machine
19104 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
19105 &'thesaurus.ref.example'& inside the resolver. For details of what your
19106 resolver actually does, consult your man pages for &'resolver'& and
19107 &'resolv.conf'&.
19108
19109
19110
19111 .option rewrite_headers dnslookup boolean true
19112 .cindex "rewriting" "header lines"
19113 .cindex "header lines" "rewriting"
19114 If the domain name in the address that is being processed is not fully
19115 qualified, it may be expanded to its full form by a DNS lookup. For example, if
19116 an address is specified as &'dormouse@teaparty'&, the domain might be
19117 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
19118 occur as a result of setting the &%widen_domains%& option. If
19119 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
19120 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
19121 header lines of the message are rewritten with the full domain name.
19122
19123 This option should be turned off only when it is known that no message is
19124 ever going to be sent outside an environment where the abbreviation makes
19125 sense.
19126
19127 When an MX record is looked up in the DNS and matches a wildcard record, name
19128 servers normally return a record containing the name that has been looked up,
19129 making it impossible to detect whether a wildcard was present or not. However,
19130 some name servers have recently been seen to return the wildcard entry. If the
19131 name returned by a DNS lookup begins with an asterisk, it is not used for
19132 header rewriting.
19133
19134
19135 .option same_domain_copy_routing dnslookup boolean false
19136 .cindex "address" "copying routing"
19137 Addresses with the same domain are normally routed by the &(dnslookup)& router
19138 to the same list of hosts. However, this cannot be presumed, because the router
19139 options and preconditions may refer to the local part of the address. By
19140 default, therefore, Exim routes each address in a message independently. DNS
19141 servers run caches, so repeated DNS lookups are not normally expensive, and in
19142 any case, personal messages rarely have more than a few recipients.
19143
19144 If you are running mailing lists with large numbers of subscribers at the same
19145 domain, and you are using a &(dnslookup)& router which is independent of the
19146 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19147 lookups for identical domains in one message. In this case, when &(dnslookup)&
19148 routes an address to a remote transport, any other unrouted addresses in the
19149 message that have the same domain are automatically given the same routing
19150 without processing them independently,
19151 provided the following conditions are met:
19152
19153 .ilist
19154 No router that processed the address specified &%headers_add%& or
19155 &%headers_remove%&.
19156 .next
19157 The router did not change the address in any way, for example, by &"widening"&
19158 the domain.
19159 .endlist
19160
19161
19162
19163
19164 .option search_parents dnslookup boolean false
19165 .cindex "DNS" "resolver options"
19166 When this option is true, the resolver option RES_DNSRCH is set for DNS
19167 lookups. This is different from the &%qualify_single%& option in that it
19168 applies to domains containing dots. Typically, but not standardly, it causes
19169 the resolver to search for the name in the current domain and in parent
19170 domains. For example, on a machine in the &'fict.example'& domain, if looking
19171 up &'teaparty.wonderland'& failed, the resolver would try
19172 &'teaparty.wonderland.fict.example'&. For details of what your resolver
19173 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
19174
19175 Setting this option true can cause problems in domains that have a wildcard MX
19176 record, because any domain that does not have its own MX record matches the
19177 local wildcard.
19178
19179
19180
19181 .option srv_fail_domains dnslookup "domain list&!!" unset
19182 If the DNS lookup for SRV records for one of the domains in this list causes a
19183 DNS lookup error, Exim behaves as if no SRV records were found. See section
19184 &<<SECTprowitdnsloo>>& for more discussion.
19185
19186
19187
19188
19189 .option widen_domains dnslookup "string list" unset
19190 .cindex "domain" "partial; widening"
19191 If a DNS lookup fails and this option is set, each of its strings in turn is
19192 added onto the end of the domain, and the lookup is tried again. For example,
19193 if
19194 .code
19195 widen_domains = fict.example:ref.example
19196 .endd
19197 is set and a lookup of &'klingon.dictionary'& fails,
19198 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
19199 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
19200 and &%search_parents%& options can cause some widening to be undertaken inside
19201 the DNS resolver. &%widen_domains%& is not applied to sender addresses
19202 when verifying, unless &%rewrite_headers%& is false (not the default).
19203
19204
19205 .section "Effect of qualify_single and search_parents" "SECID119"
19206 When a domain from an envelope recipient is changed by the resolver as a result
19207 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
19208 corresponding address in the message's header lines unless &%rewrite_headers%&
19209 is set false. Exim then re-routes the address, using the full domain.
19210
19211 These two options affect only the DNS lookup that takes place inside the router
19212 for the domain of the address that is being routed. They do not affect lookups
19213 such as that implied by
19214 .code
19215 domains = @mx_any
19216 .endd
19217 that may happen while processing a router precondition before the router is
19218 entered. No widening ever takes place for these lookups.
19219 .ecindex IIDdnsrou1
19220 .ecindex IIDdnsrou2
19221
19222
19223
19224
19225
19226
19227
19228
19229
19230 . ////////////////////////////////////////////////////////////////////////////
19231 . ////////////////////////////////////////////////////////////////////////////
19232
19233 .chapter "The ipliteral router" "CHID5"
19234 .cindex "&(ipliteral)& router"
19235 .cindex "domain literal" "routing"
19236 .cindex "routers" "&(ipliteral)&"
19237 This router has no private options. Unless it is being used purely for
19238 verification (see &%verify_only%&) a transport is required to be defined by the
19239 generic &%transport%& option. The router accepts the address if its domain part
19240 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
19241 router handles the address
19242 .code
19243 root@[192.168.1.1]
19244 .endd
19245 by setting up delivery to the host with that IP address. IPv4 domain literals
19246 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19247 are similar, but the address is preceded by &`ipv6:`&. For example:
19248 .code
19249 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19250 .endd
19251 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19252 grounds that sooner or later somebody will try it.
19253
19254 .oindex "&%self%&" "in &(ipliteral)& router"
19255 If the IP address matches something in &%ignore_target_hosts%&, the router
19256 declines. If an IP literal turns out to refer to the local host, the generic
19257 &%self%& option determines what happens.
19258
19259 The RFCs require support for domain literals; however, their use is
19260 controversial in today's Internet. If you want to use this router, you must
19261 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19262 Exim will not recognize the domain literal syntax in addresses.
19263
19264
19265
19266 . ////////////////////////////////////////////////////////////////////////////
19267 . ////////////////////////////////////////////////////////////////////////////
19268
19269 .chapter "The iplookup router" "CHID6"
19270 .cindex "&(iplookup)& router"
19271 .cindex "routers" "&(iplookup)&"
19272 The &(iplookup)& router was written to fulfil a specific requirement in
19273 Cambridge University (which in fact no longer exists). For this reason, it is
19274 not included in the binary of Exim by default. If you want to include it, you
19275 must set
19276 .code
19277 ROUTER_IPLOOKUP=yes
19278 .endd
19279 in your &_Local/Makefile_& configuration file.
19280
19281 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19282 connection to one or more specific hosts. The host can then return the same or
19283 a different address &-- in effect rewriting the recipient address in the
19284 message's envelope. The new address is then passed on to subsequent routers. If
19285 this process fails, the address can be passed on to other routers, or delivery
19286 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19287 must not be specified for it.
19288
19289 .cindex "options" "&(iplookup)& router"
19290 .option hosts iplookup string unset
19291 This option must be supplied. Its value is a colon-separated list of host
19292 names. The hosts are looked up using &[gethostbyname()]&
19293 (or &[getipnodebyname()]& when available)
19294 and are tried in order until one responds to the query. If none respond, what
19295 happens is controlled by &%optional%&.
19296
19297
19298 .option optional iplookup boolean false
19299 If &%optional%& is true, if no response is obtained from any host, the address
19300 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19301 delivery to the address is deferred.
19302
19303
19304 .option port iplookup integer 0
19305 .cindex "port" "&(iplookup)& router"
19306 This option must be supplied. It specifies the port number for the TCP or UDP
19307 call.
19308
19309
19310 .option protocol iplookup string udp
19311 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19312 protocols is to be used.
19313
19314
19315 .option query iplookup string&!! "see below"
19316 This defines the content of the query that is sent to the remote hosts. The
19317 default value is:
19318 .code
19319 $local_part@$domain $local_part@$domain
19320 .endd
19321 The repetition serves as a way of checking that a response is to the correct
19322 query in the default case (see &%response_pattern%& below).
19323
19324
19325 .option reroute iplookup string&!! unset
19326 If this option is not set, the rerouted address is precisely the byte string
19327 returned by the remote host, up to the first white space, if any. If set, the
19328 string is expanded to form the rerouted address. It can include parts matched
19329 in the response by &%response_pattern%& by means of numeric variables such as
19330 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19331 whether or not a pattern is in use. In all cases, the rerouted address must end
19332 up in the form &'local_part@domain'&.
19333
19334
19335 .option response_pattern iplookup string unset
19336 This option can be set to a regular expression that is applied to the string
19337 returned from the remote host. If the pattern does not match the response, the
19338 router declines. If &%response_pattern%& is not set, no checking of the
19339 response is done, unless the query was defaulted, in which case there is a
19340 check that the text returned after the first white space is the original
19341 address. This checks that the answer that has been received is in response to
19342 the correct question. For example, if the response is just a new domain, the
19343 following could be used:
19344 .code
19345 response_pattern = ^([^@]+)$
19346 reroute = $local_part@$1
19347 .endd
19348
19349 .option timeout iplookup time 5s
19350 This specifies the amount of time to wait for a response from the remote
19351 machine. The same timeout is used for the &[connect()]& function for a TCP
19352 call. It does not apply to UDP.
19353
19354
19355
19356
19357 . ////////////////////////////////////////////////////////////////////////////
19358 . ////////////////////////////////////////////////////////////////////////////
19359
19360 .chapter "The manualroute router" "CHID7"
19361 .scindex IIDmanrou1 "&(manualroute)& router"
19362 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19363 .cindex "domain" "manually routing"
19364 The &(manualroute)& router is so-called because it provides a way of manually
19365 routing an address according to its domain. It is mainly used when you want to
19366 route addresses to remote hosts according to your own rules, bypassing the
19367 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19368 route to local transports, a facility that may be useful if you want to save
19369 messages for dial-in hosts in local files.
19370
19371 The &(manualroute)& router compares a list of domain patterns with the domain
19372 it is trying to route. If there is no match, the router declines. Each pattern
19373 has associated with it a list of hosts and some other optional data, which may
19374 include a transport. The combination of a pattern and its data is called a
19375 &"routing rule"&. For patterns that do not have an associated transport, the
19376 generic &%transport%& option must specify a transport, unless the router is
19377 being used purely for verification (see &%verify_only%&).
19378
19379 .vindex "&$host$&"
19380 In the case of verification, matching the domain pattern is sufficient for the
19381 router to accept the address. When actually routing an address for delivery,
19382 an address that matches a domain pattern is queued for the associated
19383 transport. If the transport is not a local one, a host list must be associated
19384 with the pattern; IP addresses are looked up for the hosts, and these are
19385 passed to the transport along with the mail address. For local transports, a
19386 host list is optional. If it is present, it is passed in &$host$& as a single
19387 text string.
19388
19389 The list of routing rules can be provided as an inline string in
19390 &%route_list%&, or the data can be obtained by looking up the domain in a file
19391 or database by setting &%route_data%&. Only one of these settings may appear in
19392 any one instance of &(manualroute)&. The format of routing rules is described
19393 below, following the list of private options.
19394
19395
19396 .section "Private options for manualroute" "SECTprioptman"
19397
19398 .cindex "options" "&(manualroute)& router"
19399 The private options for the &(manualroute)& router are as follows:
19400
19401 .option host_all_ignored manualroute string defer
19402 See &%host_find_failed%&.
19403
19404 .option host_find_failed manualroute string freeze
19405 This option controls what happens when &(manualroute)& tries to find an IP
19406 address for a host, and the host does not exist. The option can be set to one
19407 of the following values:
19408 .code
19409 decline
19410 defer
19411 fail
19412 freeze
19413 ignore
19414 pass
19415 .endd
19416 The default (&"freeze"&) assumes that this state is a serious configuration
19417 error. The difference between &"pass"& and &"decline"& is that the former
19418 forces the address to be passed to the next router (or the router defined by
19419 &%pass_router%&),
19420 .oindex "&%more%&"
19421 overriding &%no_more%&, whereas the latter passes the address to the next
19422 router only if &%more%& is true.
19423
19424 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19425 cannot be found. If all the hosts in the list are ignored, the behaviour is
19426 controlled by the &%host_all_ignored%& option. This takes the same values
19427 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19428
19429 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19430 state; if a host lookup gets a temporary error, delivery is deferred unless the
19431 generic &%pass_on_timeout%& option is set.
19432
19433
19434 .option hosts_randomize manualroute boolean false
19435 .cindex "randomized host list"
19436 .cindex "host" "list of; randomized"
19437 If this option is set, the order of the items in a host list in a routing rule
19438 is randomized each time the list is used, unless an option in the routing rule
19439 overrides (see below). Randomizing the order of a host list can be used to do
19440 crude load sharing. However, if more than one mail address is routed by the
19441 same router to the same host list, the host lists are considered to be the same
19442 (even though they may be randomized into different orders) for the purpose of
19443 deciding whether to batch the deliveries into a single SMTP transaction.
19444
19445 When &%hosts_randomize%& is true, a host list may be split
19446 into groups whose order is separately randomized. This makes it possible to
19447 set up MX-like behaviour. The boundaries between groups are indicated by an
19448 item that is just &`+`& in the host list. For example:
19449 .code
19450 route_list = * host1:host2:host3:+:host4:host5
19451 .endd
19452 The order of the first three hosts and the order of the last two hosts is
19453 randomized for each use, but the first three always end up before the last two.
19454 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19455 randomized host list is passed to an &(smtp)& transport that also has
19456 &%hosts_randomize set%&, the list is not re-randomized.
19457
19458
19459 .option route_data manualroute string&!! unset
19460 If this option is set, it must expand to yield the data part of a routing rule.
19461 Typically, the expansion string includes a lookup based on the domain. For
19462 example:
19463 .code
19464 route_data = ${lookup{$domain}dbm{/etc/routes}}
19465 .endd
19466 If the expansion is forced to fail, or the result is an empty string, the
19467 router declines. Other kinds of expansion failure cause delivery to be
19468 deferred.
19469
19470
19471 .option route_list manualroute "string list" unset
19472 This string is a list of routing rules, in the form defined below. Note that,
19473 unlike most string lists, the items are separated by semicolons. This is so
19474 that they may contain colon-separated host lists.
19475
19476
19477 .option same_domain_copy_routing manualroute boolean false
19478 .cindex "address" "copying routing"
19479 Addresses with the same domain are normally routed by the &(manualroute)&
19480 router to the same list of hosts. However, this cannot be presumed, because the
19481 router options and preconditions may refer to the local part of the address. By
19482 default, therefore, Exim routes each address in a message independently. DNS
19483 servers run caches, so repeated DNS lookups are not normally expensive, and in
19484 any case, personal messages rarely have more than a few recipients.
19485
19486 If you are running mailing lists with large numbers of subscribers at the same
19487 domain, and you are using a &(manualroute)& router which is independent of the
19488 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19489 lookups for identical domains in one message. In this case, when
19490 &(manualroute)& routes an address to a remote transport, any other unrouted
19491 addresses in the message that have the same domain are automatically given the
19492 same routing without processing them independently. However, this is only done
19493 if &%headers_add%& and &%headers_remove%& are unset.
19494
19495
19496
19497
19498 .section "Routing rules in route_list" "SECID120"
19499 The value of &%route_list%& is a string consisting of a sequence of routing
19500 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19501 entered as two semicolons. Alternatively, the list separator can be changed as
19502 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19503 Empty rules are ignored. The format of each rule is
19504 .display
19505 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19506 .endd
19507 The following example contains two rules, each with a simple domain pattern and
19508 no options:
19509 .code
19510 route_list = \
19511   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19512   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19513 .endd
19514 The three parts of a rule are separated by white space. The pattern and the
19515 list of hosts can be enclosed in quotes if necessary, and if they are, the
19516 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19517 single domain pattern, which is the only mandatory item in the rule. The
19518 pattern is in the same format as one item in a domain list (see section
19519 &<<SECTdomainlist>>&),
19520 except that it may not be the name of an interpolated file.
19521 That is, it may be wildcarded, or a regular expression, or a file or database
19522 lookup (with semicolons doubled, because of the use of semicolon as a separator
19523 in a &%route_list%&).
19524
19525 The rules in &%route_list%& are searched in order until one of the patterns
19526 matches the domain that is being routed. The list of hosts and then options are
19527 then used as described below. If there is no match, the router declines. When
19528 &%route_list%& is set, &%route_data%& must not be set.
19529
19530
19531
19532 .section "Routing rules in route_data" "SECID121"
19533 The use of &%route_list%& is convenient when there are only a small number of
19534 routing rules. For larger numbers, it is easier to use a file or database to
19535 hold the routing information, and use the &%route_data%& option instead.
19536 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19537 Most commonly, &%route_data%& is set as a string that contains an
19538 expansion lookup. For example, suppose we place two routing rules in a file
19539 like this:
19540 .code
19541 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19542 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19543 .endd
19544 This data can be accessed by setting
19545 .code
19546 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19547 .endd
19548 Failure of the lookup results in an empty string, causing the router to
19549 decline. However, you do not have to use a lookup in &%route_data%&. The only
19550 requirement is that the result of expanding the string is a list of hosts,
19551 possibly followed by options, separated by white space. The list of hosts must
19552 be enclosed in quotes if it contains white space.
19553
19554
19555
19556
19557 .section "Format of the list of hosts" "SECID122"
19558 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19559 always separately expanded before use. If the expansion fails, the router
19560 declines. The result of the expansion must be a colon-separated list of names
19561 and/or IP addresses, optionally also including ports. The format of each item
19562 in the list is described in the next section. The list separator can be changed
19563 as described in section &<<SECTlistconstruct>>&.
19564
19565 If the list of hosts was obtained from a &%route_list%& item, the following
19566 variables are set during its expansion:
19567
19568 .ilist
19569 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19570 If the domain was matched against a regular expression, the numeric variables
19571 &$1$&, &$2$&, etc. may be set. For example:
19572 .code
19573 route_list = ^domain(\d+)   host-$1.text.example
19574 .endd
19575 .next
19576 &$0$& is always set to the entire domain.
19577 .next
19578 &$1$& is also set when partial matching is done in a file lookup.
19579
19580 .next
19581 .vindex "&$value$&"
19582 If the pattern that matched the domain was a lookup item, the data that was
19583 looked up is available in the expansion variable &$value$&. For example:
19584 .code
19585 route_list = lsearch;;/some/file.routes  $value
19586 .endd
19587 .endlist
19588
19589 Note the doubling of the semicolon in the pattern that is necessary because
19590 semicolon is the default route list separator.
19591
19592
19593
19594 .section "Format of one host item" "SECTformatonehostitem"
19595 Each item in the list of hosts is either a host name or an IP address,
19596 optionally with an attached port number. When no port is given, an IP address
19597 is not enclosed in brackets. When a port is specified, it overrides the port
19598 specification on the transport. The port is separated from the name or address
19599 by a colon. This leads to some complications:
19600
19601 .ilist
19602 Because colon is the default separator for the list of hosts, either
19603 the colon that specifies a port must be doubled, or the list separator must
19604 be changed. The following two examples have the same effect:
19605 .code
19606 route_list = * "host1.tld::1225 : host2.tld::1226"
19607 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19608 .endd
19609 .next
19610 When IPv6 addresses are involved, it gets worse, because they contain
19611 colons of their own. To make this case easier, it is permitted to
19612 enclose an IP address (either v4 or v6) in square brackets if a port
19613 number follows. For example:
19614 .code
19615 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19616 .endd
19617 .endlist
19618
19619 .section "How the list of hosts is used" "SECThostshowused"
19620 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19621 the hosts is tried, in the order specified, when carrying out the SMTP
19622 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19623 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19624 transport.
19625
19626 Hosts may be listed by name or by IP address. An unadorned name in the list of
19627 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19628 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19629 records in the DNS. For example:
19630 .code
19631 route_list = *  x.y.z:p.q.r/MX:e.f.g
19632 .endd
19633 If this feature is used with a port specifier, the port must come last. For
19634 example:
19635 .code
19636 route_list = *  dom1.tld/mx::1225
19637 .endd
19638 If the &%hosts_randomize%& option is set, the order of the items in the list is
19639 randomized before any lookups are done. Exim then scans the list; for any name
19640 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19641 be an interface on the local host and the item is not the first in the list,
19642 Exim discards it and any subsequent items. If it is the first item, what
19643 happens is controlled by the
19644 .oindex "&%self%&" "in &(manualroute)& router"
19645 &%self%& option of the router.
19646
19647 A name on the list that is followed by &`/MX`& is replaced with the list of
19648 hosts obtained by looking up MX records for the name. This is always a DNS
19649 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19650 below) are not relevant here. The order of these hosts is determined by the
19651 preference values in the MX records, according to the usual rules. Because
19652 randomizing happens before the MX lookup, it does not affect the order that is
19653 defined by MX preferences.
19654
19655 If the local host is present in the sublist obtained from MX records, but is
19656 not the most preferred host in that list, it and any equally or less
19657 preferred hosts are removed before the sublist is inserted into the main list.
19658
19659 If the local host is the most preferred host in the MX list, what happens
19660 depends on where in the original list of hosts the &`/MX`& item appears. If it
19661 is not the first item (that is, there are previous hosts in the main list),
19662 Exim discards this name and any subsequent items in the main list.
19663
19664 If the MX item is first in the list of hosts, and the local host is the
19665 most preferred host, what happens is controlled by the &%self%& option of the
19666 router.
19667
19668 DNS failures when lookup up the MX records are treated in the same way as DNS
19669 failures when looking up IP addresses: &%pass_on_timeout%& and
19670 &%host_find_failed%& are used when relevant.
19671
19672 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19673 whether obtained from an MX lookup or not.
19674
19675
19676
19677 .section "How the options are used" "SECThowoptused"
19678 The options are a sequence of words, space-separated.
19679 One of the words can be the name of a transport; this overrides the
19680 &%transport%& option on the router for this particular routing rule only. The
19681 other words (if present) control randomization of the list of hosts on a
19682 per-rule basis, and how the IP addresses of the hosts are to be found when
19683 routing to a remote transport. These options are as follows:
19684
19685 .ilist
19686 &%randomize%&: randomize the order of the hosts in this list, overriding the
19687 setting of &%hosts_randomize%& for this routing rule only.
19688 .next
19689 &%no_randomize%&: do not randomize the order of the hosts in this list,
19690 overriding the setting of &%hosts_randomize%& for this routing rule only.
19691 .next
19692 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19693 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19694 also look in &_/etc/hosts_& or other sources of information.
19695 .next
19696 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
19697 no address records are found. If there is a temporary DNS error (such as a
19698 timeout), delivery is deferred.
19699 .next
19700 &%ipv4_only%&: in direct DNS lookups, look up only A records.
19701 .next
19702 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
19703 .endlist
19704
19705 For example:
19706 .code
19707 route_list = domain1  host1:host2:host3  randomize bydns;\
19708              domain2  host4:host5
19709 .endd
19710 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
19711 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
19712 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
19713 or &[gethostbyname()]&, and the result of the lookup is the result of that
19714 call.
19715
19716 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
19717 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
19718 instead of TRY_AGAIN. That is why the default action is to try a DNS
19719 lookup first. Only if that gives a definite &"no such host"& is the local
19720 function called.
19721
19722 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
19723 inadvertent constraint that a transport name as an option had to be the last
19724 option specified.
19725
19726
19727
19728 If no IP address for a host can be found, what happens is controlled by the
19729 &%host_find_failed%& option.
19730
19731 .vindex "&$host$&"
19732 When an address is routed to a local transport, IP addresses are not looked up.
19733 The host list is passed to the transport in the &$host$& variable.
19734
19735
19736
19737 .section "Manualroute examples" "SECID123"
19738 In some of the examples that follow, the presence of the &%remote_smtp%&
19739 transport, as defined in the default configuration file, is assumed:
19740
19741 .ilist
19742 .cindex "smart host" "example router"
19743 The &(manualroute)& router can be used to forward all external mail to a
19744 &'smart host'&. If you have set up, in the main part of the configuration, a
19745 named domain list that contains your local domains, for example:
19746 .code
19747 domainlist local_domains = my.domain.example
19748 .endd
19749 You can arrange for all other domains to be routed to a smart host by making
19750 your first router something like this:
19751 .code
19752 smart_route:
19753   driver = manualroute
19754   domains = !+local_domains
19755   transport = remote_smtp
19756   route_list = * smarthost.ref.example
19757 .endd
19758 This causes all non-local addresses to be sent to the single host
19759 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
19760 they are tried in order
19761 (but you can use &%hosts_randomize%& to vary the order each time).
19762 Another way of configuring the same thing is this:
19763 .code
19764 smart_route:
19765   driver = manualroute
19766   transport = remote_smtp
19767   route_list = !+local_domains  smarthost.ref.example
19768 .endd
19769 There is no difference in behaviour between these two routers as they stand.
19770 However, they behave differently if &%no_more%& is added to them. In the first
19771 example, the router is skipped if the domain does not match the &%domains%&
19772 precondition; the following router is always tried. If the router runs, it
19773 always matches the domain and so can never decline. Therefore, &%no_more%&
19774 would have no effect. In the second case, the router is never skipped; it
19775 always runs. However, if it doesn't match the domain, it declines. In this case
19776 &%no_more%& would prevent subsequent routers from running.
19777
19778 .next
19779 .cindex "mail hub example"
19780 A &'mail hub'& is a host which receives mail for a number of domains via MX
19781 records in the DNS and delivers it via its own private routing mechanism. Often
19782 the final destinations are behind a firewall, with the mail hub being the one
19783 machine that can connect to machines both inside and outside the firewall. The
19784 &(manualroute)& router is usually used on a mail hub to route incoming messages
19785 to the correct hosts. For a small number of domains, the routing can be inline,
19786 using the &%route_list%& option, but for a larger number a file or database
19787 lookup is easier to manage.
19788
19789 If the domain names are in fact the names of the machines to which the mail is
19790 to be sent by the mail hub, the configuration can be quite simple. For
19791 example:
19792 .code
19793 hub_route:
19794   driver = manualroute
19795   transport = remote_smtp
19796   route_list = *.rhodes.tvs.example  $domain
19797 .endd
19798 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
19799 whose names are the same as the mail domains. A similar approach can be taken
19800 if the host name can be obtained from the domain name by a string manipulation
19801 that the expansion facilities can handle. Otherwise, a lookup based on the
19802 domain can be used to find the host:
19803 .code
19804 through_firewall:
19805   driver = manualroute
19806   transport = remote_smtp
19807   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19808 .endd
19809 The result of the lookup must be the name or IP address of the host (or
19810 hosts) to which the address is to be routed. If the lookup fails, the route
19811 data is empty, causing the router to decline. The address then passes to the
19812 next router.
19813
19814 .next
19815 .cindex "batched SMTP output example"
19816 .cindex "SMTP" "batched outgoing; example"
19817 You can use &(manualroute)& to deliver messages to pipes or files in batched
19818 SMTP format for onward transportation by some other means. This is one way of
19819 storing mail for a dial-up host when it is not connected. The route list entry
19820 can be as simple as a single domain name in a configuration like this:
19821 .code
19822 save_in_file:
19823   driver = manualroute
19824   transport = batchsmtp_appendfile
19825   route_list = saved.domain.example
19826 .endd
19827 though often a pattern is used to pick up more than one domain. If there are
19828 several domains or groups of domains with different transport requirements,
19829 different transports can be listed in the routing information:
19830 .code
19831 save_in_file:
19832   driver = manualroute
19833   route_list = \
19834     *.saved.domain1.example  $domain  batch_appendfile; \
19835     *.saved.domain2.example  \
19836       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
19837       batch_pipe
19838 .endd
19839 .vindex "&$domain$&"
19840 .vindex "&$host$&"
19841 The first of these just passes the domain in the &$host$& variable, which
19842 doesn't achieve much (since it is also in &$domain$&), but the second does a
19843 file lookup to find a value to pass, causing the router to decline to handle
19844 the address if the lookup fails.
19845
19846 .next
19847 .cindex "UUCP" "example of router for"
19848 Routing mail directly to UUCP software is a specific case of the use of
19849 &(manualroute)& in a gateway to another mail environment. This is an example of
19850 one way it can be done:
19851 .code
19852 # Transport
19853 uucp:
19854   driver = pipe
19855   user = nobody
19856   command = /usr/local/bin/uux -r - \
19857     ${substr_-5:$host}!rmail ${local_part}
19858   return_fail_output = true
19859
19860 # Router
19861 uucphost:
19862   transport = uucp
19863   driver = manualroute
19864   route_data = \
19865     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19866 .endd
19867 The file &_/usr/local/exim/uucphosts_& contains entries like
19868 .code
19869 darksite.ethereal.example:           darksite.UUCP
19870 .endd
19871 It can be set up more simply without adding and removing &".UUCP"& but this way
19872 makes clear the distinction between the domain name
19873 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19874 .endlist
19875 .ecindex IIDmanrou1
19876 .ecindex IIDmanrou2
19877
19878
19879
19880
19881
19882
19883
19884
19885 . ////////////////////////////////////////////////////////////////////////////
19886 . ////////////////////////////////////////////////////////////////////////////
19887
19888 .chapter "The queryprogram router" "CHAPdriverlast"
19889 .scindex IIDquerou1 "&(queryprogram)& router"
19890 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19891 .cindex "routing" "by external program"
19892 The &(queryprogram)& router routes an address by running an external command
19893 and acting on its output. This is an expensive way to route, and is intended
19894 mainly for use in lightly-loaded systems, or for performing experiments.
19895 However, if it is possible to use the precondition options (&%domains%&,
19896 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19897 be used in special cases, even on a busy host. There are the following private
19898 options:
19899 .cindex "options" "&(queryprogram)& router"
19900
19901 .option command queryprogram string&!! unset
19902 This option must be set. It specifies the command that is to be run. The
19903 command is split up into a command name and arguments, and then each is
19904 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19905 &<<CHAPpipetransport>>&).
19906
19907
19908 .option command_group queryprogram string unset
19909 .cindex "gid (group id)" "in &(queryprogram)& router"
19910 This option specifies a gid to be set when running the command while routing an
19911 address for deliver. It must be set if &%command_user%& specifies a numerical
19912 uid. If it begins with a digit, it is interpreted as the numerical value of the
19913 gid. Otherwise it is looked up using &[getgrnam()]&.
19914
19915
19916 .option command_user queryprogram string unset
19917 .cindex "uid (user id)" "for &(queryprogram)&"
19918 This option must be set. It specifies the uid which is set when running the
19919 command while routing an address for delivery. If the value begins with a digit,
19920 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19921 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19922 not set, a value for the gid also.
19923
19924 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19925 root, which it does during a normal delivery in a conventional configuration.
19926 However, when an address is being verified during message reception, Exim is
19927 usually running as the Exim user, not as root. If the &(queryprogram)& router
19928 is called from a non-root process, Exim cannot change uid or gid before running
19929 the command. In this circumstance the command runs under the current uid and
19930 gid.
19931
19932
19933 .option current_directory queryprogram string /
19934 This option specifies an absolute path which is made the current directory
19935 before running the command.
19936
19937
19938 .option timeout queryprogram time 1h
19939 If the command does not complete within the timeout period, its process group
19940 is killed and the message is frozen. A value of zero time specifies no
19941 timeout.
19942
19943
19944 The standard output of the command is connected to a pipe, which is read when
19945 the command terminates. It should consist of a single line of output,
19946 containing up to five fields, separated by white space. The maximum length of
19947 the line is 1023 characters. Longer lines are silently truncated. The first
19948 field is one of the following words (case-insensitive):
19949
19950 .ilist
19951 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19952 below).
19953 .next
19954 &'Decline'&: the router declines; pass the address to the next router, unless
19955 &%no_more%& is set.
19956 .next
19957 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19958 subsequent text on the line is an error message. If the router is run as part
19959 of address verification during an incoming SMTP message, the message is
19960 included in the SMTP response.
19961 .next
19962 &'Defer'&: routing could not be completed at this time; try again later. Any
19963 subsequent text on the line is an error message which is logged. It is not
19964 included in any SMTP response.
19965 .next
19966 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19967 .next
19968 &'Pass'&: pass the address to the next router (or the router specified by
19969 &%pass_router%&), overriding &%no_more%&.
19970 .next
19971 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19972 new addresses, which are routed independently, starting with the first router,
19973 or the router specified by &%redirect_router%&, if set.
19974 .endlist
19975
19976 When the first word is &'accept'&, the remainder of the line consists of a
19977 number of keyed data values, as follows (split into two lines here, to fit on
19978 the page):
19979 .code
19980 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19981 LOOKUP=byname|bydns DATA=<text>
19982 .endd
19983 The data items can be given in any order, and all are optional. If no transport
19984 is included, the transport specified by the generic &%transport%& option is
19985 used. The list of hosts and the lookup type are needed only if the transport is
19986 an &(smtp)& transport that does not itself supply a list of hosts.
19987
19988 The format of the list of hosts is the same as for the &(manualroute)& router.
19989 As well as host names and IP addresses with optional port numbers, as described
19990 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19991 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19992 (see section &<<SECThostshowused>>&).
19993
19994 If the lookup type is not specified, Exim behaves as follows when trying to
19995 find an IP address for each host: First, a DNS lookup is done. If this yields
19996 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19997 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19998 result of the lookup is the result of that call.
19999
20000 .vindex "&$address_data$&"
20001 If the DATA field is set, its value is placed in the &$address_data$&
20002 variable. For example, this return line
20003 .code
20004 accept hosts=x1.y.example:x2.y.example data="rule1"
20005 .endd
20006 routes the address to the default transport, passing a list of two hosts. When
20007 the transport runs, the string &"rule1"& is in &$address_data$&.
20008 .ecindex IIDquerou1
20009 .ecindex IIDquerou2
20010
20011
20012
20013
20014 . ////////////////////////////////////////////////////////////////////////////
20015 . ////////////////////////////////////////////////////////////////////////////
20016
20017 .chapter "The redirect router" "CHAPredirect"
20018 .scindex IIDredrou1 "&(redirect)& router"
20019 .scindex IIDredrou2 "routers" "&(redirect)&"
20020 .cindex "alias file" "in a &(redirect)& router"
20021 .cindex "address redirection" "&(redirect)& router"
20022 The &(redirect)& router handles several kinds of address redirection. Its most
20023 common uses are for resolving local part aliases from a central alias file
20024 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20025 files, but it has many other potential uses. The incoming address can be
20026 redirected in several different ways:
20027
20028 .ilist
20029 It can be replaced by one or more new addresses which are themselves routed
20030 independently.
20031 .next
20032 It can be routed to be delivered to a given file or directory.
20033 .next
20034 It can be routed to be delivered to a specified pipe command.
20035 .next
20036 It can cause an automatic reply to be generated.
20037 .next
20038 It can be forced to fail, optionally with a custom error message.
20039 .next
20040 It can be temporarily deferred, optionally with a custom message.
20041 .next
20042 It can be discarded.
20043 .endlist
20044
20045 The generic &%transport%& option must not be set for &(redirect)& routers.
20046 However, there are some private options which define transports for delivery to
20047 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20048 &%pipe_transport%& and &%reply_transport%& descriptions below.
20049
20050 If success DSNs have been requested
20051 .cindex "DSN" "success"
20052 .cindex "Delivery Status Notification" "success"
20053 redirection triggers one and the DSN options are not passed any further.
20054
20055
20056
20057 .section "Redirection data" "SECID124"
20058 The router operates by interpreting a text string which it obtains either by
20059 expanding the contents of the &%data%& option, or by reading the entire
20060 contents of a file whose name is given in the &%file%& option. These two
20061 options are mutually exclusive. The first is commonly used for handling system
20062 aliases, in a configuration like this:
20063 .code
20064 system_aliases:
20065   driver = redirect
20066   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20067 .endd
20068 If the lookup fails, the expanded string in this example is empty. When the
20069 expansion of &%data%& results in an empty string, the router declines. A forced
20070 expansion failure also causes the router to decline; other expansion failures
20071 cause delivery to be deferred.
20072
20073 A configuration using &%file%& is commonly used for handling users'
20074 &_.forward_& files, like this:
20075 .code
20076 userforward:
20077   driver = redirect
20078   check_local_user
20079   file = $home/.forward
20080   no_verify
20081 .endd
20082 If the file does not exist, or causes no action to be taken (for example, it is
20083 empty or consists only of comments), the router declines. &*Warning*&: This
20084 is not the case when the file contains syntactically valid items that happen to
20085 yield empty addresses, for example, items containing only RFC 2822 address
20086 comments.
20087
20088
20089
20090 .section "Forward files and address verification" "SECID125"
20091 .cindex "address redirection" "while verifying"
20092 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
20093 &_.forward_& files, as in the example above. There are two reasons for this:
20094
20095 .ilist
20096 When Exim is receiving an incoming SMTP message from a remote host, it is
20097 running under the Exim uid, not as root. Exim is unable to change uid to read
20098 the file as the user, and it may not be able to read it as the Exim user. So in
20099 practice the router may not be able to operate.
20100 .next
20101 However, even when the router can operate, the existence of a &_.forward_& file
20102 is unimportant when verifying an address. What should be checked is whether the
20103 local part is a valid user name or not. Cutting out the redirection processing
20104 saves some resources.
20105 .endlist
20106
20107
20108
20109
20110
20111
20112 .section "Interpreting redirection data" "SECID126"
20113 .cindex "Sieve filter" "specifying in redirection data"
20114 .cindex "filter" "specifying in redirection data"
20115 The contents of the data string, whether obtained from &%data%& or &%file%&,
20116 can be interpreted in two different ways:
20117
20118 .ilist
20119 If the &%allow_filter%& option is set true, and the data begins with the text
20120 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
20121 &'filtering'& instructions in the form of an Exim or Sieve filter file,
20122 respectively. Details of the syntax and semantics of filter files are described
20123 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
20124 document is intended for use by end users.
20125 .next
20126 Otherwise, the data must be a comma-separated list of redirection items, as
20127 described in the next section.
20128 .endlist
20129
20130 When a message is redirected to a file (a &"mail folder"&), the file name given
20131 in a non-filter redirection list must always be an absolute path. A filter may
20132 generate a relative path &-- how this is handled depends on the transport's
20133 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
20134 for the &(appendfile)& transport.
20135
20136
20137
20138 .section "Items in a non-filter redirection list" "SECTitenonfilred"
20139 .cindex "address redirection" "non-filter list items"
20140 When the redirection data is not an Exim or Sieve filter, for example, if it
20141 comes from a conventional alias or forward file, it consists of a list of
20142 addresses, file names, pipe commands, or certain special items (see section
20143 &<<SECTspecitredli>>& below). The special items can be individually enabled or
20144 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
20145 depending on their default values. The items in the list are separated by
20146 commas or newlines.
20147 If a comma is required in an item, the entire item must be enclosed in double
20148 quotes.
20149
20150 Lines starting with a # character are comments, and are ignored, and # may
20151 also appear following a comma, in which case everything between the # and the
20152 next newline character is ignored.
20153
20154 If an item is entirely enclosed in double quotes, these are removed. Otherwise
20155 double quotes are retained because some forms of mail address require their use
20156 (but never to enclose the entire address). In the following description,
20157 &"item"& refers to what remains after any surrounding double quotes have been
20158 removed.
20159
20160 .vindex "&$local_part$&"
20161 &*Warning*&: If you use an Exim expansion to construct a redirection address,
20162 and the expansion contains a reference to &$local_part$&, you should make use
20163 of the &%quote_local_part%& expansion operator, in case the local part contains
20164 special characters. For example, to redirect all mail for the domain
20165 &'obsolete.example'&, retaining the existing local part, you could use this
20166 setting:
20167 .code
20168 data = ${quote_local_part:$local_part}@newdomain.example
20169 .endd
20170
20171
20172 .section "Redirecting to a local mailbox" "SECTredlocmai"
20173 .cindex "routing" "loops in"
20174 .cindex "loop" "while routing, avoidance of"
20175 .cindex "address redirection" "to local mailbox"
20176 A redirection item may safely be the same as the address currently under
20177 consideration. This does not cause a routing loop, because a router is
20178 automatically skipped if any ancestor of the address that is being processed
20179 is the same as the current address and was processed by the current router.
20180 Such an address is therefore passed to the following routers, so it is handled
20181 as if there were no redirection. When making this loop-avoidance test, the
20182 complete local part, including any prefix or suffix, is used.
20183
20184 .cindex "address redirection" "local part without domain"
20185 Specifying the same local part without a domain is a common usage in personal
20186 filter files when the user wants to have messages delivered to the local
20187 mailbox and also forwarded elsewhere. For example, the user whose login is
20188 &'cleo'& might have a &_.forward_& file containing this:
20189 .code
20190 cleo, cleopatra@egypt.example
20191 .endd
20192 .cindex "backslash in alias file"
20193 .cindex "alias file" "backslash in"
20194 For compatibility with other MTAs, such unqualified local parts may be
20195 preceded by &"\"&, but this is not a requirement for loop prevention. However,
20196 it does make a difference if more than one domain is being handled
20197 synonymously.
20198
20199 If an item begins with &"\"& and the rest of the item parses as a valid RFC
20200 2822 address that does not include a domain, the item is qualified using the
20201 domain of the incoming address. In the absence of a leading &"\"&, unqualified
20202 addresses are qualified using the value in &%qualify_recipient%&, but you can
20203 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
20204
20205 Care must be taken if there are alias names for local users.
20206 Consider an MTA handling a single local domain where the system alias file
20207 contains:
20208 .code
20209 Sam.Reman: spqr
20210 .endd
20211 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
20212 messages in the local mailbox, and also forward copies elsewhere. He creates
20213 this forward file:
20214 .code
20215 Sam.Reman, spqr@reme.elsewhere.example
20216 .endd
20217 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
20218 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
20219 second time round, because it has previously routed it,
20220 and the following routers presumably cannot handle the alias. The forward file
20221 should really contain
20222 .code
20223 spqr, spqr@reme.elsewhere.example
20224 .endd
20225 but because this is such a common error, the &%check_ancestor%& option (see
20226 below) exists to provide a way to get round it. This is normally set on a
20227 &(redirect)& router that is handling users' &_.forward_& files.
20228
20229
20230
20231 .section "Special items in redirection lists" "SECTspecitredli"
20232 In addition to addresses, the following types of item may appear in redirection
20233 lists (that is, in non-filter redirection data):
20234
20235 .ilist
20236 .cindex "pipe" "in redirection list"
20237 .cindex "address redirection" "to pipe"
20238 An item is treated as a pipe command if it begins with &"|"& and does not parse
20239 as a valid RFC 2822 address that includes a domain. A transport for running the
20240 command must be specified by the &%pipe_transport%& option.
20241 Normally, either the router or the transport specifies a user and a group under
20242 which to run the delivery. The default is to use the Exim user and group.
20243
20244 Single or double quotes can be used for enclosing the individual arguments of
20245 the pipe command; no interpretation of escapes is done for single quotes. If
20246 the command contains a comma character, it is necessary to put the whole item
20247 in double quotes, for example:
20248 .code
20249 "|/some/command ready,steady,go"
20250 .endd
20251 since items in redirection lists are terminated by commas. Do not, however,
20252 quote just the command. An item such as
20253 .code
20254 |"/some/command ready,steady,go"
20255 .endd
20256 is interpreted as a pipe with a rather strange command name, and no arguments.
20257
20258 Note that the above example assumes that the text comes from a lookup source
20259 of some sort, so that the quotes are part of the data.  If composing a
20260 redirect router with a &%data%& option directly specifying this command, the
20261 quotes will be used by the configuration parser to define the extent of one
20262 string, but will not be passed down into the redirect router itself.  There
20263 are two main approaches to get around this: escape quotes to be part of the
20264 data itself, or avoid using this mechanism and instead create a custom
20265 transport with the &%command%& option set and reference that transport from
20266 an &%accept%& router.
20267
20268 .next
20269 .cindex "file" "in redirection list"
20270 .cindex "address redirection" "to file"
20271 An item is interpreted as a path name if it begins with &"/"& and does not
20272 parse as a valid RFC 2822 address that includes a domain. For example,
20273 .code
20274 /home/world/minbari
20275 .endd
20276 is treated as a file name, but
20277 .code
20278 /s=molari/o=babylon/@x400gate.way
20279 .endd
20280 is treated as an address. For a file name, a transport must be specified using
20281 the &%file_transport%& option. However, if the generated path name ends with a
20282 forward slash character, it is interpreted as a directory name rather than a
20283 file name, and &%directory_transport%& is used instead.
20284
20285 Normally, either the router or the transport specifies a user and a group under
20286 which to run the delivery. The default is to use the Exim user and group.
20287
20288 .cindex "&_/dev/null_&"
20289 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20290 bypassed at a high level, and the log entry shows &"**bypassed**"&
20291 instead of a transport name. In this case the user and group are not used.
20292
20293 .next
20294 .cindex "included address list"
20295 .cindex "address redirection" "included external list"
20296 If an item is of the form
20297 .code
20298 :include:<path name>
20299 .endd
20300 a list of further items is taken from the given file and included at that
20301 point. &*Note*&: Such a file can not be a filter file; it is just an
20302 out-of-line addition to the list. The items in the included list are separated
20303 by commas or newlines and are not subject to expansion. If this is the first
20304 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20305 the alias name. This example is incorrect:
20306 .code
20307 list1    :include:/opt/lists/list1
20308 .endd
20309 It must be given as
20310 .code
20311 list1:   :include:/opt/lists/list1
20312 .endd
20313 .next
20314 .cindex "address redirection" "to black hole"
20315 .cindex "delivery" "discard"
20316 .cindex "delivery" "blackhole"
20317 .cindex "black hole"
20318 .cindex "abandoning mail"
20319 Sometimes you want to throw away mail to a particular local part.  Making the
20320 &%data%& option expand to an empty string does not work, because that causes
20321 the router to decline. Instead, the alias item
20322 .code
20323 :blackhole:
20324 .endd
20325 can be used. It does what its name implies. No delivery is
20326 done, and no error message is generated. This has the same effect as specifying
20327 &_/dev/null_& as a destination, but it can be independently disabled.
20328
20329 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20330 delivery is done for the original local part, even if other redirection items
20331 are present. If you are generating a multi-item list (for example, by reading a
20332 database) and need the ability to provide a no-op item, you must use
20333 &_/dev/null_&.
20334
20335 .next
20336 .cindex "delivery" "forcing failure"
20337 .cindex "delivery" "forcing deferral"
20338 .cindex "failing delivery" "forcing"
20339 .cindex "deferred delivery, forcing"
20340 .cindex "customizing" "failure message"
20341 An attempt to deliver a particular address can be deferred or forced to fail by
20342 redirection items of the form
20343 .code
20344 :defer:
20345 :fail:
20346 .endd
20347 respectively. When a redirection list contains such an item, it applies
20348 to the entire redirection; any other items in the list are ignored. Any
20349 text following &':fail:'& or &':defer:'& is placed in the error text
20350 associated with the failure. For example, an alias file might contain:
20351 .code
20352 X.Employee:  :fail: Gone away, no forwarding address
20353 .endd
20354 In the case of an address that is being verified from an ACL or as the subject
20355 of a
20356 .cindex "VRFY" "error text, display of"
20357 VRFY command, the text is included in the SMTP error response by
20358 default.
20359 .cindex "EXPN" "error text, display of"
20360 The text is not included in the response to an EXPN command. In non-SMTP cases
20361 the text is included in the error message that Exim generates.
20362
20363 .cindex "SMTP" "error codes"
20364 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20365 &':fail:'&. However, if the message starts with three digits followed by a
20366 space, optionally followed by an extended code of the form &'n.n.n'&, also
20367 followed by a space, and the very first digit is the same as the default error
20368 code, the code from the message is used instead. If the very first digit is
20369 incorrect, a panic error is logged, and the default code is used. You can
20370 suppress the use of the supplied code in a redirect router by setting the
20371 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20372 ignored.
20373
20374 .vindex "&$acl_verify_message$&"
20375 In an ACL, an explicitly provided message overrides the default, but the
20376 default message is available in the variable &$acl_verify_message$& and can
20377 therefore be included in a custom message if this is desired.
20378
20379 Normally the error text is the rest of the redirection list &-- a comma does
20380 not terminate it &-- but a newline does act as a terminator. Newlines are not
20381 normally present in alias expansions. In &(lsearch)& lookups they are removed
20382 as part of the continuation process, but they may exist in other kinds of
20383 lookup and in &':include:'& files.
20384
20385 During routing for message delivery (as opposed to verification), a redirection
20386 containing &':fail:'& causes an immediate failure of the incoming address,
20387 whereas &':defer:'& causes the message to remain on the queue so that a
20388 subsequent delivery attempt can happen at a later time. If an address is
20389 deferred for too long, it will ultimately fail, because the normal retry
20390 rules still apply.
20391
20392 .next
20393 .cindex "alias file" "exception to default"
20394 Sometimes it is useful to use a single-key search type with a default (see
20395 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20396 for exceptions to the default. These can be handled by aliasing them to
20397 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20398 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20399 results in an empty redirection list has the same effect.
20400 .endlist
20401
20402
20403 .section "Duplicate addresses" "SECTdupaddr"
20404 .cindex "duplicate addresses"
20405 .cindex "address duplicate, discarding"
20406 .cindex "pipe" "duplicated"
20407 Exim removes duplicate addresses from the list to which it is delivering, so as
20408 to deliver just one copy to each address. This does not apply to deliveries
20409 routed to pipes by different immediate parent addresses, but an indirect
20410 aliasing scheme of the type
20411 .code
20412 pipe:       |/some/command $local_part
20413 localpart1: pipe
20414 localpart2: pipe
20415 .endd
20416 does not work with a message that is addressed to both local parts, because
20417 when the second is aliased to the intermediate local part &"pipe"& it gets
20418 discarded as being the same as a previously handled address. However, a scheme
20419 such as
20420 .code
20421 localpart1: |/some/command $local_part
20422 localpart2: |/some/command $local_part
20423 .endd
20424 does result in two different pipe deliveries, because the immediate parents of
20425 the pipes are distinct.
20426
20427
20428
20429 .section "Repeated redirection expansion" "SECID128"
20430 .cindex "repeated redirection expansion"
20431 .cindex "address redirection" "repeated for each delivery attempt"
20432 When a message cannot be delivered to all of its recipients immediately,
20433 leading to two or more delivery attempts, redirection expansion is carried out
20434 afresh each time for those addresses whose children were not all previously
20435 delivered. If redirection is being used as a mailing list, this can lead to new
20436 members of the list receiving copies of old messages. The &%one_time%& option
20437 can be used to avoid this.
20438
20439
20440 .section "Errors in redirection lists" "SECID129"
20441 .cindex "address redirection" "errors"
20442 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20443 error is skipped, and an entry is written to the main log. This may be useful
20444 for mailing lists that are automatically managed. Otherwise, if an error is
20445 detected while generating the list of new addresses, the original address is
20446 deferred. See also &%syntax_errors_to%&.
20447
20448
20449
20450 .section "Private options for the redirect router" "SECID130"
20451
20452 .cindex "options" "&(redirect)& router"
20453 The private options for the &(redirect)& router are as follows:
20454
20455
20456 .option allow_defer redirect boolean false
20457 Setting this option allows the use of &':defer:'& in non-filter redirection
20458 data, or the &%defer%& command in an Exim filter file.
20459
20460
20461 .option allow_fail redirect boolean false
20462 .cindex "failing delivery" "from filter"
20463 If this option is true, the &':fail:'& item can be used in a redirection list,
20464 and the &%fail%& command may be used in an Exim filter file.
20465
20466
20467 .option allow_filter redirect boolean false
20468 .cindex "filter" "enabling use of"
20469 .cindex "Sieve filter" "enabling use of"
20470 Setting this option allows Exim to interpret redirection data that starts with
20471 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20472 are some features of Exim filter files that some administrators may wish to
20473 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20474
20475 It is also possible to lock out Exim filters or Sieve filters while allowing
20476 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20477
20478
20479 The filter is run using the uid and gid set by the generic &%user%& and
20480 &%group%& options. These take their defaults from the password data if
20481 &%check_local_user%& is set, so in the normal case of users' personal filter
20482 files, the filter is run as the relevant user. When &%allow_filter%& is set
20483 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20484
20485
20486
20487 .option allow_freeze redirect boolean false
20488 .cindex "freezing messages" "allowing in filter"
20489 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20490 This command is more normally encountered in system filters, and is disabled by
20491 default for redirection filters because it isn't something you usually want to
20492 let ordinary users do.
20493
20494
20495
20496 .option check_ancestor redirect boolean false
20497 This option is concerned with handling generated addresses that are the same
20498 as some address in the list of redirection ancestors of the current address.
20499 Although it is turned off by default in the code, it is set in the default
20500 configuration file for handling users' &_.forward_& files. It is recommended
20501 for this use of the &(redirect)& router.
20502
20503 When &%check_ancestor%& is set, if a generated address (including the domain)
20504 is the same as any ancestor of the current address, it is replaced by a copy of
20505 the current address. This helps in the case where local part A is aliased to B,
20506 and B has a &_.forward_& file pointing back to A. For example, within a single
20507 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20508 &_&~jb/.forward_& contains:
20509 .code
20510 \Joe.Bloggs, <other item(s)>
20511 .endd
20512 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20513 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20514 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20515 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20516 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20517 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20518 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20519 original address. See also the &%repeat_use%& option below.
20520
20521
20522 .option check_group redirect boolean "see below"
20523 When the &%file%& option is used, the group owner of the file is checked only
20524 when this option is set. The permitted groups are those listed in the
20525 &%owngroups%& option, together with the user's default group if
20526 &%check_local_user%& is set. If the file has the wrong group, routing is
20527 deferred. The default setting for this option is true if &%check_local_user%&
20528 is set and the &%modemask%& option permits the group write bit, or if the
20529 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20530
20531
20532
20533 .option check_owner redirect boolean "see below"
20534 When the &%file%& option is used, the owner of the file is checked only when
20535 this option is set. If &%check_local_user%& is set, the local user is
20536 permitted; otherwise the owner must be one of those listed in the &%owners%&
20537 option. The default value for this option is true if &%check_local_user%& or
20538 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20539
20540
20541 .option data redirect string&!! unset
20542 This option is mutually exclusive with &%file%&. One or other of them must be
20543 set, but not both. The contents of &%data%& are expanded, and then used as the
20544 list of forwarding items, or as a set of filtering instructions. If the
20545 expansion is forced to fail, or the result is an empty string or a string that
20546 has no effect (consists entirely of comments), the router declines.
20547
20548 When filtering instructions are used, the string must begin with &"#Exim
20549 filter"&, and all comments in the string, including this initial one, must be
20550 terminated with newline characters. For example:
20551 .code
20552 data = #Exim filter\n\
20553        if $h_to: contains Exim then save $home/mail/exim endif
20554 .endd
20555 If you are reading the data from a database where newlines cannot be included,
20556 you can use the &${sg}$& expansion item to turn the escape string of your
20557 choice into a newline.
20558
20559
20560 .option directory_transport redirect string&!! unset
20561 A &(redirect)& router sets up a direct delivery to a directory when a path name
20562 ending with a slash is specified as a new &"address"&. The transport used is
20563 specified by this option, which, after expansion, must be the name of a
20564 configured transport. This should normally be an &(appendfile)& transport.
20565
20566
20567 .option file redirect string&!! unset
20568 This option specifies the name of a file that contains the redirection data. It
20569 is mutually exclusive with the &%data%& option. The string is expanded before
20570 use; if the expansion is forced to fail, the router declines. Other expansion
20571 failures cause delivery to be deferred. The result of a successful expansion
20572 must be an absolute path. The entire file is read and used as the redirection
20573 data. If the data is an empty string or a string that has no effect (consists
20574 entirely of comments), the router declines.
20575
20576 .cindex "NFS" "checking for file existence"
20577 If the attempt to open the file fails with a &"does not exist"& error, Exim
20578 runs a check on the containing directory,
20579 unless &%ignore_enotdir%& is true (see below).
20580 If the directory does not appear to exist, delivery is deferred. This can
20581 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20582 is a mount problem. If the containing directory does exist, but the file does
20583 not, the router declines.
20584
20585
20586 .option file_transport redirect string&!! unset
20587 .vindex "&$address_file$&"
20588 A &(redirect)& router sets up a direct delivery to a file when a path name not
20589 ending in a slash is specified as a new &"address"&. The transport used is
20590 specified by this option, which, after expansion, must be the name of a
20591 configured transport. This should normally be an &(appendfile)& transport. When
20592 it is running, the file name is in &$address_file$&.
20593
20594
20595 .option filter_prepend_home redirect boolean true
20596 When this option is true, if a &(save)& command in an Exim filter specifies a
20597 relative path, and &$home$& is defined, it is automatically prepended to the
20598 relative path. If this option is set false, this action does not happen. The
20599 relative path is then passed to the transport unmodified.
20600
20601
20602 .option forbid_blackhole redirect boolean false
20603 .cindex "restricting access to features"
20604 .cindex "filter" "locking out certain features"
20605 If this option is true, the &':blackhole:'& item may not appear in a
20606 redirection list.
20607
20608
20609 .option forbid_exim_filter redirect boolean false
20610 .cindex "restricting access to features"
20611 .cindex "filter" "locking out certain features"
20612 If this option is set true, only Sieve filters are permitted when
20613 &%allow_filter%& is true.
20614
20615
20616
20617
20618 .option forbid_file redirect boolean false
20619 .cindex "restricting access to features"
20620 .cindex "delivery" "to file; forbidding"
20621 .cindex "filter" "locking out certain features"
20622 .cindex "Sieve filter" "forbidding delivery to a file"
20623 .cindex "Sieve filter" "&""keep""& facility; disabling"
20624 If this option is true, this router may not generate a new address that
20625 specifies delivery to a local file or directory, either from a filter or from a
20626 conventional forward file. This option is forced to be true if &%one_time%& is
20627 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20628 locks out the Sieve's &"keep"& facility.
20629
20630
20631 .option forbid_filter_dlfunc redirect boolean false
20632 .cindex "restricting access to features"
20633 .cindex "filter" "locking out certain features"
20634 If this option is true, string expansions in Exim filters are not allowed to
20635 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20636 functions.
20637
20638 .option forbid_filter_existstest redirect boolean false
20639 .cindex "restricting access to features"
20640 .cindex "filter" "locking out certain features"
20641 .cindex "expansion" "statting a file"
20642 If this option is true, string expansions in Exim filters are not allowed to
20643 make use of the &%exists%& condition or the &%stat%& expansion item.
20644
20645 .option forbid_filter_logwrite redirect boolean false
20646 .cindex "restricting access to features"
20647 .cindex "filter" "locking out certain features"
20648 If this option is true, use of the logging facility in Exim filters is not
20649 permitted. Logging is in any case available only if the filter is being run
20650 under some unprivileged uid (which is normally the case for ordinary users'
20651 &_.forward_& files).
20652
20653
20654 .option forbid_filter_lookup redirect boolean false
20655 .cindex "restricting access to features"
20656 .cindex "filter" "locking out certain features"
20657 If this option is true, string expansions in Exim filter files are not allowed
20658 to make use of &%lookup%& items.
20659
20660
20661 .option forbid_filter_perl redirect boolean false
20662 .cindex "restricting access to features"
20663 .cindex "filter" "locking out certain features"
20664 This option has an effect only if Exim is built with embedded Perl support. If
20665 it is true, string expansions in Exim filter files are not allowed to make use
20666 of the embedded Perl support.
20667
20668
20669 .option forbid_filter_readfile redirect boolean false
20670 .cindex "restricting access to features"
20671 .cindex "filter" "locking out certain features"
20672 If this option is true, string expansions in Exim filter files are not allowed
20673 to make use of &%readfile%& items.
20674
20675
20676 .option forbid_filter_readsocket redirect boolean false
20677 .cindex "restricting access to features"
20678 .cindex "filter" "locking out certain features"
20679 If this option is true, string expansions in Exim filter files are not allowed
20680 to make use of &%readsocket%& items.
20681
20682
20683 .option forbid_filter_reply redirect boolean false
20684 .cindex "restricting access to features"
20685 .cindex "filter" "locking out certain features"
20686 If this option is true, this router may not generate an automatic reply
20687 message. Automatic replies can be generated only from Exim or Sieve filter
20688 files, not from traditional forward files. This option is forced to be true if
20689 &%one_time%& is set.
20690
20691
20692 .option forbid_filter_run redirect boolean false
20693 .cindex "restricting access to features"
20694 .cindex "filter" "locking out certain features"
20695 If this option is true, string expansions in Exim filter files are not allowed
20696 to make use of &%run%& items.
20697
20698
20699 .option forbid_include redirect boolean false
20700 .cindex "restricting access to features"
20701 .cindex "filter" "locking out certain features"
20702 If this option is true, items of the form
20703 .code
20704 :include:<path name>
20705 .endd
20706 are not permitted in non-filter redirection lists.
20707
20708
20709 .option forbid_pipe redirect boolean false
20710 .cindex "restricting access to features"
20711 .cindex "filter" "locking out certain features"
20712 .cindex "delivery" "to pipe; forbidding"
20713 If this option is true, this router may not generate a new address which
20714 specifies delivery to a pipe, either from an Exim filter or from a conventional
20715 forward file. This option is forced to be true if &%one_time%& is set.
20716
20717
20718 .option forbid_sieve_filter redirect boolean false
20719 .cindex "restricting access to features"
20720 .cindex "filter" "locking out certain features"
20721 If this option is set true, only Exim filters are permitted when
20722 &%allow_filter%& is true.
20723
20724
20725 .cindex "SMTP" "error codes"
20726 .option forbid_smtp_code redirect boolean false
20727 If this option is set true, any SMTP error codes that are present at the start
20728 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
20729 the default codes (451 and 550, respectively) are always used.
20730
20731
20732
20733
20734 .option hide_child_in_errmsg redirect boolean false
20735 .cindex "bounce message" "redirection details; suppressing"
20736 If this option is true, it prevents Exim from quoting a child address if it
20737 generates a bounce or delay message for it. Instead it says &"an address
20738 generated from <&'the top level address'&>"&. Of course, this applies only to
20739 bounces generated locally. If a message is forwarded to another host, &'its'&
20740 bounce may well quote the generated address.
20741
20742
20743 .option ignore_eacces redirect boolean false
20744 .cindex "EACCES"
20745 If this option is set and an attempt to open a redirection file yields the
20746 EACCES error (permission denied), the &(redirect)& router behaves as if the
20747 file did not exist.
20748
20749
20750 .option ignore_enotdir redirect boolean false
20751 .cindex "ENOTDIR"
20752 If this option is set and an attempt to open a redirection file yields the
20753 ENOTDIR error (something on the path is not a directory), the &(redirect)&
20754 router behaves as if the file did not exist.
20755
20756 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
20757 router that has the &%file%& option set discovers that the file does not exist
20758 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
20759 against unmounted NFS directories. If the parent can not be statted, delivery
20760 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
20761 is set, because that option tells Exim to ignore &"something on the path is not
20762 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
20763 that some operating systems give ENOENT where others give ENOTDIR.
20764
20765
20766
20767 .option include_directory redirect string unset
20768 If this option is set, the path names of any &':include:'& items in a
20769 redirection list must start with this directory.
20770
20771
20772 .option modemask redirect "octal integer" 022
20773 This specifies mode bits which must not be set for a file specified by the
20774 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
20775
20776
20777 .option one_time redirect boolean false
20778 .cindex "one-time aliasing/forwarding expansion"
20779 .cindex "alias file" "one-time expansion"
20780 .cindex "forward file" "one-time expansion"
20781 .cindex "mailing lists" "one-time expansion"
20782 .cindex "address redirection" "one-time expansion"
20783 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
20784 files each time it tries to deliver a message causes a problem when one or more
20785 of the generated addresses fails be delivered at the first attempt. The problem
20786 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
20787 but of what happens when the redirection list changes during the time that the
20788 message is on Exim's queue. This is particularly true in the case of mailing
20789 lists, where new subscribers might receive copies of messages that were posted
20790 before they subscribed.
20791
20792 If &%one_time%& is set and any addresses generated by the router fail to
20793 deliver at the first attempt, the failing addresses are added to the message as
20794 &"top level"& addresses, and the parent address that generated them is marked
20795 &"delivered"&. Thus, redirection does not happen again at the next delivery
20796 attempt.
20797
20798 &*Warning 1*&: Any header line addition or removal that is specified by this
20799 router would be lost if delivery did not succeed at the first attempt. For this
20800 reason, the &%headers_add%& and &%headers_remove%& generic options are not
20801 permitted when &%one_time%& is set.
20802
20803 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
20804 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
20805 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
20806
20807 &*Warning 3*&: The &%unseen%& generic router option may not be set with
20808 &%one_time%&.
20809
20810 The original top-level address is remembered with each of the generated
20811 addresses, and is output in any log messages. However, any intermediate parent
20812 addresses are not recorded. This makes a difference to the log only if
20813 &%all_parents%& log selector is set. It is expected that &%one_time%& will
20814 typically be used for mailing lists, where there is normally just one level of
20815 expansion.
20816
20817
20818 .option owners redirect "string list" unset
20819 .cindex "ownership" "alias file"
20820 .cindex "ownership" "forward file"
20821 .cindex "alias file" "ownership"
20822 .cindex "forward file" "ownership"
20823 This specifies a list of permitted owners for the file specified by &%file%&.
20824 This list is in addition to the local user when &%check_local_user%& is set.
20825 See &%check_owner%& above.
20826
20827
20828 .option owngroups redirect "string list" unset
20829 This specifies a list of permitted groups for the file specified by &%file%&.
20830 The list is in addition to the local user's primary group when
20831 &%check_local_user%& is set. See &%check_group%& above.
20832
20833
20834 .option pipe_transport redirect string&!! unset
20835 .vindex "&$address_pipe$&"
20836 A &(redirect)& router sets up a direct delivery to a pipe when a string
20837 starting with a vertical bar character is specified as a new &"address"&. The
20838 transport used is specified by this option, which, after expansion, must be the
20839 name of a configured transport. This should normally be a &(pipe)& transport.
20840 When the transport is run, the pipe command is in &$address_pipe$&.
20841
20842
20843 .option qualify_domain redirect string&!! unset
20844 .vindex "&$qualify_recipient$&"
20845 If this option is set, and an unqualified address (one without a domain) is
20846 generated, and that address would normally be qualified by the global setting
20847 in &%qualify_recipient%&, it is instead qualified with the domain specified by
20848 expanding this string. If the expansion fails, the router declines. If you want
20849 to revert to the default, you can have the expansion generate
20850 &$qualify_recipient$&.
20851
20852 This option applies to all unqualified addresses generated by Exim filters,
20853 but for traditional &_.forward_& files, it applies only to addresses that are
20854 not preceded by a backslash. Sieve filters cannot generate unqualified
20855 addresses.
20856
20857 .option qualify_preserve_domain redirect boolean false
20858 .cindex "domain" "in redirection; preserving"
20859 .cindex "preserving domain in redirection"
20860 .cindex "address redirection" "domain; preserving"
20861 If this option is set, the router's local &%qualify_domain%& option must not be
20862 set (a configuration error occurs if it is). If an unqualified address (one
20863 without a domain) is generated, it is qualified with the domain of the parent
20864 address (the immediately preceding ancestor) instead of the global
20865 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
20866 this applies whether or not the address is preceded by a backslash.
20867
20868
20869 .option repeat_use redirect boolean true
20870 If this option is set false, the router is skipped for a child address that has
20871 any ancestor that was routed by this router. This test happens before any of
20872 the other preconditions are tested. Exim's default anti-looping rules skip
20873 only when the ancestor is the same as the current address. See also
20874 &%check_ancestor%& above and the generic &%redirect_router%& option.
20875
20876
20877 .option reply_transport redirect string&!! unset
20878 A &(redirect)& router sets up an automatic reply when a &%mail%& or
20879 &%vacation%& command is used in a filter file. The transport used is specified
20880 by this option, which, after expansion, must be the name of a configured
20881 transport. This should normally be an &(autoreply)& transport. Other transports
20882 are unlikely to do anything sensible or useful.
20883
20884
20885 .option rewrite redirect boolean true
20886 .cindex "address redirection" "disabling rewriting"
20887 If this option is set false, addresses generated by the router are not
20888 subject to address rewriting. Otherwise, they are treated like new addresses
20889 and are rewritten according to the global rewriting rules.
20890
20891
20892 .option sieve_subaddress redirect string&!! unset
20893 The value of this option is passed to a Sieve filter to specify the
20894 :subaddress part of an address.
20895
20896 .option sieve_useraddress redirect string&!! unset
20897 The value of this option is passed to a Sieve filter to specify the :user part
20898 of an address. However, if it is unset, the entire original local part
20899 (including any prefix or suffix) is used for :user.
20900
20901
20902 .option sieve_vacation_directory redirect string&!! unset
20903 .cindex "Sieve filter" "vacation directory"
20904 To enable the &"vacation"& extension for Sieve filters, you must set
20905 &%sieve_vacation_directory%& to the directory where vacation databases are held
20906 (do not put anything else in that directory), and ensure that the
20907 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20908 needs their own directory; Exim will create it if necessary.
20909
20910
20911
20912 .option skip_syntax_errors redirect boolean false
20913 .cindex "forward file" "broken"
20914 .cindex "address redirection" "broken files"
20915 .cindex "alias file" "broken"
20916 .cindex "broken alias or forward files"
20917 .cindex "ignoring faulty addresses"
20918 .cindex "skipping faulty addresses"
20919 .cindex "error" "skipping bad syntax"
20920 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20921 non-filter redirection data are skipped, and each failing address is logged. If
20922 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20923 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20924 are expanded and placed at the head of the error message generated by
20925 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20926 be the same address as the generic &%errors_to%& option. The
20927 &%skip_syntax_errors%& option is often used when handling mailing lists.
20928
20929 If all the addresses in a redirection list are skipped because of syntax
20930 errors, the router declines to handle the original address, and it is passed to
20931 the following routers.
20932
20933 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20934 error in the filter causes filtering to be abandoned without any action being
20935 taken. The incident is logged, and the router declines to handle the address,
20936 so it is passed to the following routers.
20937
20938 .cindex "Sieve filter" "syntax errors in"
20939 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20940 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20941 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20942
20943 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20944 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20945 option, used with an address that does not get redirected, can be used to
20946 notify users of these errors, by means of a router like this:
20947 .code
20948 userforward:
20949   driver = redirect
20950   allow_filter
20951   check_local_user
20952   file = $home/.forward
20953   file_transport = address_file
20954   pipe_transport = address_pipe
20955   reply_transport = address_reply
20956   no_verify
20957   skip_syntax_errors
20958   syntax_errors_to = real-$local_part@$domain
20959   syntax_errors_text = \
20960    This is an automatically generated message. An error has\n\
20961    been found in your .forward file. Details of the error are\n\
20962    reported below. While this error persists, you will receive\n\
20963    a copy of this message for every message that is addressed\n\
20964    to you. If your .forward file is a filter file, or if it is\n\
20965    a non-filter file containing no valid forwarding addresses,\n\
20966    a copy of each incoming message will be put in your normal\n\
20967    mailbox. If a non-filter file contains at least one valid\n\
20968    forwarding address, forwarding to the valid addresses will\n\
20969    happen, and those will be the only deliveries that occur.
20970 .endd
20971 You also need a router to ensure that local addresses that are prefixed by
20972 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20973 put this immediately before the &(userforward)& router:
20974 .code
20975 real_localuser:
20976   driver = accept
20977   check_local_user
20978   local_part_prefix = real-
20979   transport = local_delivery
20980 .endd
20981 For security, it would probably be a good idea to restrict the use of this
20982 router to locally-generated messages, using a condition such as this:
20983 .code
20984   condition = ${if match {$sender_host_address}\
20985                          {\N^(|127\.0\.0\.1)$\N}}
20986 .endd
20987
20988
20989 .option syntax_errors_text redirect string&!! unset
20990 See &%skip_syntax_errors%& above.
20991
20992
20993 .option syntax_errors_to redirect string unset
20994 See &%skip_syntax_errors%& above.
20995 .ecindex IIDredrou1
20996 .ecindex IIDredrou2
20997
20998
20999
21000
21001
21002
21003 . ////////////////////////////////////////////////////////////////////////////
21004 . ////////////////////////////////////////////////////////////////////////////
21005
21006 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21007          "Environment for local transports"
21008 .scindex IIDenvlotra1 "local transports" "environment for"
21009 .scindex IIDenvlotra2 "environment" "local transports"
21010 .scindex IIDenvlotra3 "transport" "local; environment for"
21011 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21012 transport can be thought of as similar to a pipe.) Exim always runs transports
21013 in subprocesses, under specified uids and gids. Typical deliveries to local
21014 mailboxes run under the uid and gid of the local user.
21015
21016 Exim also sets a specific current directory while running the transport; for
21017 some transports a home directory setting is also relevant. The &(pipe)&
21018 transport is the only one that sets up environment variables; see section
21019 &<<SECTpipeenv>>& for details.
21020
21021 The values used for the uid, gid, and the directories may come from several
21022 different places. In many cases, the router that handles the address associates
21023 settings with that address as a result of its &%check_local_user%&, &%group%&,
21024 or &%user%& options. However, values may also be given in the transport's own
21025 configuration, and these override anything that comes from the router.
21026
21027
21028
21029 .section "Concurrent deliveries" "SECID131"
21030 .cindex "concurrent deliveries"
21031 .cindex "simultaneous deliveries"
21032 If two different messages for the same local recipient arrive more or less
21033 simultaneously, the two delivery processes are likely to run concurrently. When
21034 the &(appendfile)& transport is used to write to a file, Exim applies locking
21035 rules to stop concurrent processes from writing to the same file at the same
21036 time.
21037
21038 However, when you use a &(pipe)& transport, it is up to you to arrange any
21039 locking that is needed. Here is a silly example:
21040 .code
21041 my_transport:
21042   driver = pipe
21043   command = /bin/sh -c 'cat >>/some/file'
21044 .endd
21045 This is supposed to write the message at the end of the file. However, if two
21046 messages arrive at the same time, the file will be scrambled. You can use the
21047 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21048 file using the same algorithm that Exim itself uses.
21049
21050
21051
21052
21053 .section "Uids and gids" "SECTenvuidgid"
21054 .cindex "local transports" "uid and gid"
21055 .cindex "transport" "local; uid and gid"
21056 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21057 overrides any group that the router set in the address, even if &%user%& is not
21058 set for the transport. This makes it possible, for example, to run local mail
21059 delivery under the uid of the recipient (set by the router), but in a special
21060 group (set by the transport). For example:
21061 .code
21062 # Routers ...
21063 # User/group are set by check_local_user in this router
21064 local_users:
21065   driver = accept
21066   check_local_user
21067   transport = group_delivery
21068
21069 # Transports ...
21070 # This transport overrides the group
21071 group_delivery:
21072   driver = appendfile
21073   file = /var/spool/mail/$local_part
21074   group = mail
21075 .endd
21076 If &%user%& is set for a transport, its value overrides what is set in the
21077 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21078 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21079 set.
21080
21081 .oindex "&%initgroups%&"
21082 When the uid is taken from the transport's configuration, the &[initgroups()]&
21083 function is called for the groups associated with that uid if the
21084 &%initgroups%& option is set for the transport. When the uid is not specified
21085 by the transport, but is associated with the address by a router, the option
21086 for calling &[initgroups()]& is taken from the router configuration.
21087
21088 .cindex "&(pipe)& transport" "uid for"
21089 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
21090 is set and &%user%& is not set, the uid of the process that called Exim to
21091 receive the message is used, and if &%group%& is not set, the corresponding
21092 original gid is also used.
21093
21094 This is the detailed preference order for obtaining a gid; the first of the
21095 following that is set is used:
21096
21097 .ilist
21098 A &%group%& setting of the transport;
21099 .next
21100 A &%group%& setting of the router;
21101 .next
21102 A gid associated with a user setting of the router, either as a result of
21103 &%check_local_user%& or an explicit non-numeric &%user%& setting;
21104 .next
21105 The group associated with a non-numeric &%user%& setting of the transport;
21106 .next
21107 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
21108 the uid is the creator's uid;
21109 .next
21110 The Exim gid if the Exim uid is being used as a default.
21111 .endlist
21112
21113 If, for example, the user is specified numerically on the router and there are
21114 no group settings, no gid is available. In this situation, an error occurs.
21115 This is different for the uid, for which there always is an ultimate default.
21116 The first of the following that is set is used:
21117
21118 .ilist
21119 A &%user%& setting of the transport;
21120 .next
21121 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
21122 .next
21123 A &%user%& setting of the router;
21124 .next
21125 A &%check_local_user%& setting of the router;
21126 .next
21127 The Exim uid.
21128 .endlist
21129
21130 Of course, an error will still occur if the uid that is chosen is on the
21131 &%never_users%& list.
21132
21133
21134
21135
21136
21137 .section "Current and home directories" "SECID132"
21138 .cindex "current directory for local transport"
21139 .cindex "home directory" "for local transport"
21140 .cindex "transport" "local; home directory for"
21141 .cindex "transport" "local; current directory for"
21142 Routers may set current and home directories for local transports by means of
21143 the &%transport_current_directory%& and &%transport_home_directory%& options.
21144 However, if the transport's &%current_directory%& or &%home_directory%& options
21145 are set, they override the router's values. In detail, the home directory
21146 for a local transport is taken from the first of these values that is set:
21147
21148 .ilist
21149 The &%home_directory%& option on the transport;
21150 .next
21151 The &%transport_home_directory%& option on the router;
21152 .next
21153 The password data if &%check_local_user%& is set on the router;
21154 .next
21155 The &%router_home_directory%& option on the router.
21156 .endlist
21157
21158 The current directory is taken from the first of these values that is set:
21159
21160 .ilist
21161 The &%current_directory%& option on the transport;
21162 .next
21163 The &%transport_current_directory%& option on the router.
21164 .endlist
21165
21166
21167 If neither the router nor the transport sets a current directory, Exim uses the
21168 value of the home directory, if it is set. Otherwise it sets the current
21169 directory to &_/_& before running a local transport.
21170
21171
21172
21173 .section "Expansion variables derived from the address" "SECID133"
21174 .vindex "&$domain$&"
21175 .vindex "&$local_part$&"
21176 .vindex "&$original_domain$&"
21177 Normally a local delivery is handling a single address, and in that case the
21178 variables such as &$domain$& and &$local_part$& are set during local
21179 deliveries. However, in some circumstances more than one address may be handled
21180 at once (for example, while writing batch SMTP for onward transmission by some
21181 other means). In this case, the variables associated with the local part are
21182 never set, &$domain$& is set only if all the addresses have the same domain,
21183 and &$original_domain$& is never set.
21184 .ecindex IIDenvlotra1
21185 .ecindex IIDenvlotra2
21186 .ecindex IIDenvlotra3
21187
21188
21189
21190
21191
21192
21193
21194 . ////////////////////////////////////////////////////////////////////////////
21195 . ////////////////////////////////////////////////////////////////////////////
21196
21197 .chapter "Generic options for transports" "CHAPtransportgeneric"
21198 .scindex IIDgenoptra1 "generic options" "transport"
21199 .scindex IIDgenoptra2 "options" "generic; for transports"
21200 .scindex IIDgenoptra3 "transport" "generic options for"
21201 The following generic options apply to all transports:
21202
21203
21204 .option body_only transports boolean false
21205 .cindex "transport" "body only"
21206 .cindex "message" "transporting body only"
21207 .cindex "body of message" "transporting"
21208 If this option is set, the message's headers are not transported. It is
21209 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
21210 or &(pipe)& transports, the settings of &%message_prefix%& and
21211 &%message_suffix%& should be checked, because this option does not
21212 automatically suppress them.
21213
21214
21215 .option current_directory transports string&!! unset
21216 .cindex "transport" "current directory for"
21217 This specifies the current directory that is to be set while running the
21218 transport, overriding any value that may have been set by the router.
21219 If the expansion fails for any reason, including forced failure, an error is
21220 logged, and delivery is deferred.
21221
21222
21223 .option disable_logging transports boolean false
21224 If this option is set true, nothing is logged for any
21225 deliveries by the transport or for any
21226 transport errors. You should not set this option unless you really, really know
21227 what you are doing.
21228
21229
21230 .option debug_print transports string&!! unset
21231 .cindex "testing" "variables in drivers"
21232 If this option is set and debugging is enabled (see the &%-d%& command line
21233 option), the string is expanded and included in the debugging output when the
21234 transport is run.
21235 If expansion of the string fails, the error message is written to the debugging
21236 output, and Exim carries on processing.
21237 This facility is provided to help with checking out the values of variables and
21238 so on when debugging driver configurations. For example, if a &%headers_add%&
21239 option is not working properly, &%debug_print%& could be used to output the
21240 variables it references. A newline is added to the text if it does not end with
21241 one.
21242 The variables &$transport_name$& and &$router_name$& contain the name of the
21243 transport and the router that called it.
21244
21245 .option delivery_date_add transports boolean false
21246 .cindex "&'Delivery-date:'& header line"
21247 If this option is true, a &'Delivery-date:'& header is added to the message.
21248 This gives the actual time the delivery was made. As this is not a standard
21249 header, Exim has a configuration option (&%delivery_date_remove%&) which
21250 requests its removal from incoming messages, so that delivered messages can
21251 safely be resent to other recipients.
21252
21253
21254 .option driver transports string unset
21255 This specifies which of the available transport drivers is to be used.
21256 There is no default, and this option must be set for every transport.
21257
21258
21259 .option envelope_to_add transports boolean false
21260 .cindex "&'Envelope-to:'& header line"
21261 If this option is true, an &'Envelope-to:'& header is added to the message.
21262 This gives the original address(es) in the incoming envelope that caused this
21263 delivery to happen. More than one address may be present if the transport is
21264 configured to handle several addresses at once, or if more than one original
21265 address was redirected to the same final address. As this is not a standard
21266 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21267 its removal from incoming messages, so that delivered messages can safely be
21268 resent to other recipients.
21269
21270
21271 .option event_action transports string&!! unset
21272 .cindex events
21273 This option declares a string to be expanded for Exim's events mechanism.
21274 For details see chapter &<<CHAPevents>>&.
21275
21276
21277 .option group transports string&!! "Exim group"
21278 .cindex "transport" "group; specifying"
21279 This option specifies a gid for running the transport process, overriding any
21280 value that the router supplies, and also overriding any value associated with
21281 &%user%& (see below).
21282
21283
21284 .option headers_add transports list&!! unset
21285 .cindex "header lines" "adding in transport"
21286 .cindex "transport" "header lines; adding"
21287 This option specifies a list of text headers,
21288 newline-separated (by default, changeable in the usual way),
21289 which are (separately) expanded and added to the header
21290 portion of a message as it is transported, as described in section
21291 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
21292 routers. If the result of the expansion is an empty string, or if the expansion
21293 is forced to fail, no action is taken. Other expansion failures are treated as
21294 errors and cause the delivery to be deferred.
21295
21296 Unlike most options, &%headers_add%& can be specified multiple times
21297 for a transport; all listed headers are added.
21298
21299
21300 .option headers_only transports boolean false
21301 .cindex "transport" "header lines only"
21302 .cindex "message" "transporting headers only"
21303 .cindex "header lines" "transporting"
21304 If this option is set, the message's body is not transported. It is mutually
21305 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
21306 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
21307 checked, since this option does not automatically suppress them.
21308
21309
21310 .option headers_remove transports list&!! unset
21311 .cindex "header lines" "removing"
21312 .cindex "transport" "header lines; removing"
21313 This option specifies a list of header names,
21314 colon-separated (by default, changeable in the usual way);
21315 these headers are omitted from the message as it is transported, as described
21316 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21317 routers.
21318 Each list item is separately expanded.
21319 If the result of the expansion is an empty string, or if the expansion
21320 is forced to fail, no action is taken. Other expansion failures are treated as
21321 errors and cause the delivery to be deferred.
21322
21323 Unlike most options, &%headers_remove%& can be specified multiple times
21324 for a transport; all listed headers are removed.
21325
21326 &*Warning*&: Because of the separate expansion of the list items,
21327 items that contain a list separator must have it doubled.
21328 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21329
21330
21331
21332 .option headers_rewrite transports string unset
21333 .cindex "transport" "header lines; rewriting"
21334 .cindex "rewriting" "at transport time"
21335 This option allows addresses in header lines to be rewritten at transport time,
21336 that is, as the message is being copied to its destination. The contents of the
21337 option are a colon-separated list of rewriting rules. Each rule is in exactly
21338 the same form as one of the general rewriting rules that are applied when a
21339 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21340 example,
21341 .code
21342 headers_rewrite = a@b c@d f : \
21343                   x@y w@z
21344 .endd
21345 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21346 &'w@z'& in all address-bearing header lines. The rules are applied to the
21347 header lines just before they are written out at transport time, so they affect
21348 only those copies of the message that pass through the transport. However, only
21349 the message's original header lines, and any that were added by a system
21350 filter, are rewritten. If a router or transport adds header lines, they are not
21351 affected by this option. These rewriting rules are &'not'& applied to the
21352 envelope. You can change the return path using &%return_path%&, but you cannot
21353 change envelope recipients at this time.
21354
21355
21356 .option home_directory transports string&!! unset
21357 .cindex "transport" "home directory for"
21358 .vindex "&$home$&"
21359 This option specifies a home directory setting for a local transport,
21360 overriding any value that may be set by the router. The home directory is
21361 placed in &$home$& while expanding the transport's private options. It is also
21362 used as the current directory if no current directory is set by the
21363 &%current_directory%& option on the transport or the
21364 &%transport_current_directory%& option on the router. If the expansion fails
21365 for any reason, including forced failure, an error is logged, and delivery is
21366 deferred.
21367
21368
21369 .option initgroups transports boolean false
21370 .cindex "additional groups"
21371 .cindex "groups" "additional"
21372 .cindex "transport" "group; additional"
21373 If this option is true and the uid for the delivery process is provided by the
21374 transport, the &[initgroups()]& function is called when running the transport
21375 to ensure that any additional groups associated with the uid are set up.
21376
21377
21378 .option max_parallel transports integer&!! unset
21379 .cindex limit "transport parallelism"
21380 .cindex transport "parallel processes"
21381 .cindex transport "concurrency limit"
21382 .cindex "delivery" "parallelism for transport"
21383 If this option is set and expands to an integer greater than zero
21384 it limits the number of concurrent runs of the transport.
21385 The control does not apply to shadow transports.
21386
21387 .cindex "hints database" "transport concurrency control"
21388 Exim implements this control by means of a hints database in which a record is
21389 incremented whenever a transport process is being created. The record
21390 is decremented and possibly removed when the process terminates.
21391 Obviously there is scope for
21392 records to get left lying around if there is a system or program crash. To
21393 guard against this, Exim ignores any records that are more than six hours old.
21394
21395 If you use this option, you should also arrange to delete the
21396 relevant hints database whenever your system reboots. The names of the files
21397 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21398 may be one or two files, depending on the type of DBM in use. The same files
21399 are used for ETRN and smtp transport serialization.
21400
21401
21402 .option message_size_limit transports string&!! 0
21403 .cindex "limit" "message size per transport"
21404 .cindex "size" "of message, limit"
21405 .cindex "transport" "message size; limiting"
21406 This option controls the size of messages passed through the transport. It is
21407 expanded before use; the result of the expansion must be a sequence of decimal
21408 digits, optionally followed by K or M. If the expansion fails for any reason,
21409 including forced failure, or if the result is not of the required form,
21410 delivery is deferred. If the value is greater than zero and the size of a
21411 message exceeds this limit, the address is failed. If there is any chance that
21412 the resulting bounce message could be routed to the same transport, you should
21413 ensure that &%return_size_limit%& is less than the transport's
21414 &%message_size_limit%&, as otherwise the bounce message will fail to get
21415 delivered.
21416
21417
21418
21419 .option rcpt_include_affixes transports boolean false
21420 .cindex "prefix" "for local part, including in envelope"
21421 .cindex "suffix for local part" "including in envelope"
21422 .cindex "local part" "prefix"
21423 .cindex "local part" "suffix"
21424 When this option is false (the default), and an address that has had any
21425 affixes (prefixes or suffixes) removed from the local part is delivered by any
21426 form of SMTP or LMTP, the affixes are not included. For example, if a router
21427 that contains
21428 .code
21429 local_part_prefix = *-
21430 .endd
21431 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21432 is delivered with
21433 .code
21434 RCPT TO:<xyz@some.domain>
21435 .endd
21436 This is also the case when an ACL-time callout is being used to verify a
21437 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21438 whole local part is included in the RCPT command. This option applies to BSMTP
21439 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21440 &(lmtp)& and &(smtp)& transports.
21441
21442
21443 .option retry_use_local_part transports boolean "see below"
21444 .cindex "hints database" "retry keys"
21445 When a delivery suffers a temporary failure, a retry record is created
21446 in Exim's hints database. For remote deliveries, the key for the retry record
21447 is based on the name and/or IP address of the failing remote host. For local
21448 deliveries, the key is normally the entire address, including both the local
21449 part and the domain. This is suitable for most common cases of local delivery
21450 temporary failure &-- for example, exceeding a mailbox quota should delay only
21451 deliveries to that mailbox, not to the whole domain.
21452
21453 However, in some special cases you may want to treat a temporary local delivery
21454 as a failure associated with the domain, and not with a particular local part.
21455 (For example, if you are storing all mail for some domain in files.) You can do
21456 this by setting &%retry_use_local_part%& false.
21457
21458 For all the local transports, its default value is true. For remote transports,
21459 the default value is false for tidiness, but changing the value has no effect
21460 on a remote transport in the current implementation.
21461
21462
21463 .option return_path transports string&!! unset
21464 .cindex "envelope sender"
21465 .cindex "transport" "return path; changing"
21466 .cindex "return path" "changing in transport"
21467 If this option is set, the string is expanded at transport time and replaces
21468 the existing return path (envelope sender) value in the copy of the message
21469 that is being delivered. An empty return path is permitted. This feature is
21470 designed for remote deliveries, where the value of this option is used in the
21471 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21472 only effect is to change the address that is placed in the &'Return-path:'&
21473 header line, if one is added to the message (see the next option).
21474
21475 &*Note:*& A changed return path is not logged unless you add
21476 &%return_path_on_delivery%& to the log selector.
21477
21478 .vindex "&$return_path$&"
21479 The expansion can refer to the existing value via &$return_path$&. This is
21480 either the message's envelope sender, or an address set by the
21481 &%errors_to%& option on a router. If the expansion is forced to fail, no
21482 replacement occurs; if it fails for another reason, delivery is deferred. This
21483 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21484 section &<<SECTverp>>&.
21485
21486 &*Note*&: If a delivery error is detected locally, including the case when a
21487 remote server rejects a message at SMTP time, the bounce message is not sent to
21488 the value of this option. It is sent to the previously set errors address.
21489 This defaults to the incoming sender address, but can be changed by setting
21490 &%errors_to%& in a router.
21491
21492
21493
21494 .option return_path_add transports boolean false
21495 .cindex "&'Return-path:'& header line"
21496 If this option is true, a &'Return-path:'& header is added to the message.
21497 Although the return path is normally available in the prefix line of BSD
21498 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21499 have easy access to it.
21500
21501 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21502 the delivery SMTP server makes the final delivery"&. This implies that this
21503 header should not be present in incoming messages. Exim has a configuration
21504 option, &%return_path_remove%&, which requests removal of this header from
21505 incoming messages, so that delivered messages can safely be resent to other
21506 recipients.
21507
21508
21509 .option shadow_condition transports string&!! unset
21510 See &%shadow_transport%& below.
21511
21512
21513 .option shadow_transport transports string unset
21514 .cindex "shadow transport"
21515 .cindex "transport" "shadow"
21516 A local transport may set the &%shadow_transport%& option to the name of
21517 another local transport. Shadow remote transports are not supported.
21518
21519 Whenever a delivery to the main transport succeeds, and either
21520 &%shadow_condition%& is unset, or its expansion does not result in the empty
21521 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21522 passed to the shadow transport, with the same delivery address or addresses. If
21523 expansion fails, no action is taken except that non-forced expansion failures
21524 cause a log line to be written.
21525
21526 The result of the shadow transport is discarded and does not affect the
21527 subsequent processing of the message. Only a single level of shadowing is
21528 provided; the &%shadow_transport%& option is ignored on any transport when it
21529 is running as a shadow. Options concerned with output from pipes are also
21530 ignored. The log line for the successful delivery has an item added on the end,
21531 of the form
21532 .code
21533 ST=<shadow transport name>
21534 .endd
21535 If the shadow transport did not succeed, the error message is put in
21536 parentheses afterwards. Shadow transports can be used for a number of different
21537 purposes, including keeping more detailed log information than Exim normally
21538 provides, and implementing automatic acknowledgment policies based on message
21539 headers that some sites insist on.
21540
21541
21542 .option transport_filter transports string&!! unset
21543 .cindex "transport" "filter"
21544 .cindex "filter" "transport filter"
21545 This option sets up a filtering (in the Unix shell sense) process for messages
21546 at transport time. It should not be confused with mail filtering as set up by
21547 individual users or via a system filter.
21548 If unset, or expanding to an empty string, no filtering is done.
21549
21550 When the message is about to be written out, the command specified by
21551 &%transport_filter%& is started up in a separate, parallel process, and
21552 the entire message, including the header lines, is passed to it on its standard
21553 input (this in fact is done from a third process, to avoid deadlock). The
21554 command must be specified as an absolute path.
21555
21556 The lines of the message that are written to the transport filter are
21557 terminated by newline (&"\n"&). The message is passed to the filter before any
21558 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21559 lines beginning with a dot, and also before any processing implied by the
21560 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21561 &(pipe)& transports.
21562
21563 The standard error for the filter process is set to the same destination as its
21564 standard output; this is read and written to the message's ultimate
21565 destination. The process that writes the message to the filter, the
21566 filter itself, and the original process that reads the result and delivers it
21567 are all run in parallel, like a shell pipeline.
21568
21569 The filter can perform any transformations it likes, but of course should take
21570 care not to break RFC 2822 syntax. Exim does not check the result, except to
21571 test for a final newline when SMTP is in use. All messages transmitted over
21572 SMTP must end with a newline, so Exim supplies one if it is missing.
21573
21574 .cindex "content scanning" "per user"
21575 A transport filter can be used to provide content-scanning on a per-user basis
21576 at delivery time if the only required effect of the scan is to modify the
21577 message. For example, a content scan could insert a new header line containing
21578 a spam score. This could be interpreted by a filter in the user's MUA. It is
21579 not possible to discard a message at this stage.
21580
21581 .cindex "SMTP" "SIZE"
21582 A problem might arise if the filter increases the size of a message that is
21583 being sent down an SMTP connection. If the receiving SMTP server has indicated
21584 support for the SIZE parameter, Exim will have sent the size of the message
21585 at the start of the SMTP session. If what is actually sent is substantially
21586 more, the server might reject the message. This can be worked round by setting
21587 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21588 additions to the message, or to disable the use of SIZE altogether.
21589
21590 .vindex "&$pipe_addresses$&"
21591 The value of the &%transport_filter%& option is the command string for starting
21592 the filter, which is run directly from Exim, not under a shell. The string is
21593 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21594 Exim breaks it up into arguments and then expands each argument separately (see
21595 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21596 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
21597 of arguments, one for each address that applies to this delivery. (This isn't
21598 an ideal name for this feature here, but as it was already implemented for the
21599 &(pipe)& transport, it seemed sensible not to change it.)
21600
21601 .vindex "&$host$&"
21602 .vindex "&$host_address$&"
21603 The expansion variables &$host$& and &$host_address$& are available when the
21604 transport is a remote one. They contain the name and IP address of the host to
21605 which the message is being sent. For example:
21606 .code
21607 transport_filter = /some/directory/transport-filter.pl \
21608   $host $host_address $sender_address $pipe_addresses
21609 .endd
21610
21611 Two problems arise if you want to use more complicated expansion items to
21612 generate transport filter commands, both of which due to the fact that the
21613 command is split up &'before'& expansion.
21614 .ilist
21615 If an expansion item contains white space, you must quote it, so that it is all
21616 part of the same command item. If the entire option setting is one such
21617 expansion item, you have to take care what kind of quoting you use. For
21618 example:
21619 .code
21620 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21621 .endd
21622 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21623 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21624 stripped by Exim when it read the option's value. When the value is used, if
21625 the single quotes were missing, the line would be split into two items,
21626 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21627 Exim tried to expand the first one.
21628 .next
21629 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21630 expansion cannot generate multiple arguments, or a command name followed by
21631 arguments. Consider this example:
21632 .code
21633 transport_filter = ${lookup{$host}lsearch{/a/file}\
21634                     {$value}{/bin/cat}}
21635 .endd
21636 The result of the lookup is interpreted as the name of the command, even
21637 if it contains white space. The simplest way round this is to use a shell:
21638 .code
21639 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21640                                {$value}{/bin/cat}}
21641 .endd
21642 .endlist
21643
21644 The filter process is run under the same uid and gid as the normal delivery.
21645 For remote deliveries this is the Exim uid/gid by default. The command should
21646 normally yield a zero return code. Transport filters are not supposed to fail.
21647 A non-zero code is taken to mean that the transport filter encountered some
21648 serious problem. Delivery of the message is deferred; the message remains on
21649 the queue and is tried again later. It is not possible to cause a message to be
21650 bounced from a transport filter.
21651
21652 If a transport filter is set on an autoreply transport, the original message is
21653 passed through the filter as it is being copied into the newly generated
21654 message, which happens if the &%return_message%& option is set.
21655
21656
21657 .option transport_filter_timeout transports time 5m
21658 .cindex "transport" "filter, timeout"
21659 When Exim is reading the output of a transport filter, it applies a timeout
21660 that can be set by this option. Exceeding the timeout is normally treated as a
21661 temporary delivery failure. However, if a transport filter is used with a
21662 &(pipe)& transport, a timeout in the transport filter is treated in the same
21663 way as a timeout in the pipe command itself. By default, a timeout is a hard
21664 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21665 becomes a temporary error.
21666
21667
21668 .option user transports string&!! "Exim user"
21669 .cindex "uid (user id)" "local delivery"
21670 .cindex "transport" "user, specifying"
21671 This option specifies the user under whose uid the delivery process is to be
21672 run, overriding any uid that may have been set by the router. If the user is
21673 given as a name, the uid is looked up from the password data, and the
21674 associated group is taken as the value of the gid to be used if the &%group%&
21675 option is not set.
21676
21677 For deliveries that use local transports, a user and group are normally
21678 specified explicitly or implicitly (for example, as a result of
21679 &%check_local_user%&) by the router or transport.
21680
21681 .cindex "hints database" "access by remote transport"
21682 For remote transports, you should leave this option unset unless you really are
21683 sure you know what you are doing. When a remote transport is running, it needs
21684 to be able to access Exim's hints databases, because each host may have its own
21685 retry data.
21686 .ecindex IIDgenoptra1
21687 .ecindex IIDgenoptra2
21688 .ecindex IIDgenoptra3
21689
21690
21691
21692
21693
21694
21695 . ////////////////////////////////////////////////////////////////////////////
21696 . ////////////////////////////////////////////////////////////////////////////
21697
21698 .chapter "Address batching in local transports" "CHAPbatching" &&&
21699          "Address batching"
21700 .cindex "transport" "local; address batching in"
21701 The only remote transport (&(smtp)&) is normally configured to handle more than
21702 one address at a time, so that when several addresses are routed to the same
21703 remote host, just one copy of the message is sent. Local transports, however,
21704 normally handle one address at a time. That is, a separate instance of the
21705 transport is run for each address that is routed to the transport. A separate
21706 copy of the message is delivered each time.
21707
21708 .cindex "batched local delivery"
21709 .oindex "&%batch_max%&"
21710 .oindex "&%batch_id%&"
21711 In special cases, it may be desirable to handle several addresses at once in a
21712 local transport, for example:
21713
21714 .ilist
21715 In an &(appendfile)& transport, when storing messages in files for later
21716 delivery by some other means, a single copy of the message with multiple
21717 recipients saves space.
21718 .next
21719 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
21720 a single copy saves time, and is the normal way LMTP is expected to work.
21721 .next
21722 In a &(pipe)& transport, when passing the message
21723 to a scanner program or
21724 to some other delivery mechanism such as UUCP, multiple recipients may be
21725 acceptable.
21726 .endlist
21727
21728 These three local transports all have the same options for controlling multiple
21729 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
21730 repeating the information for each transport, these options are described here.
21731
21732 The &%batch_max%& option specifies the maximum number of addresses that can be
21733 delivered together in a single run of the transport. Its default value is one
21734 (no batching). When more than one address is routed to a transport that has a
21735 &%batch_max%& value greater than one, the addresses are delivered in a batch
21736 (that is, in a single run of the transport with multiple recipients), subject
21737 to certain conditions:
21738
21739 .ilist
21740 .vindex "&$local_part$&"
21741 If any of the transport's options contain a reference to &$local_part$&, no
21742 batching is possible.
21743 .next
21744 .vindex "&$domain$&"
21745 If any of the transport's options contain a reference to &$domain$&, only
21746 addresses with the same domain are batched.
21747 .next
21748 .cindex "customizing" "batching condition"
21749 If &%batch_id%& is set, it is expanded for each address, and only those
21750 addresses with the same expanded value are batched. This allows you to specify
21751 customized batching conditions. Failure of the expansion for any reason,
21752 including forced failure, disables batching, but it does not stop the delivery
21753 from taking place.
21754 .next
21755 Batched addresses must also have the same errors address (where to send
21756 delivery errors), the same header additions and removals, the same user and
21757 group for the transport, and if a host list is present, the first host must
21758 be the same.
21759 .endlist
21760
21761 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
21762 both when the file or pipe command is specified in the transport, and when it
21763 is specified by a &(redirect)& router, but all the batched addresses must of
21764 course be routed to the same file or pipe command. These two transports have an
21765 option called &%use_bsmtp%&, which causes them to deliver the message in
21766 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
21767 &%check_string%& and &%escape_string%& options are forced to the values
21768 .code
21769 check_string = "."
21770 escape_string = ".."
21771 .endd
21772 when batched SMTP is in use. A full description of the batch SMTP mechanism is
21773 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
21774 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
21775
21776 .cindex "&'Envelope-to:'& header line"
21777 If the generic &%envelope_to_add%& option is set for a batching transport, the
21778 &'Envelope-to:'& header that is added to the message contains all the addresses
21779 that are being processed together. If you are using a batching &(appendfile)&
21780 transport without &%use_bsmtp%&, the only way to preserve the recipient
21781 addresses is to set the &%envelope_to_add%& option.
21782
21783 .cindex "&(pipe)& transport" "with multiple addresses"
21784 .vindex "&$pipe_addresses$&"
21785 If you are using a &(pipe)& transport without BSMTP, and setting the
21786 transport's &%command%& option, you can include &$pipe_addresses$& as part of
21787 the command. This is not a true variable; it is a bit of magic that causes each
21788 of the recipient addresses to be inserted into the command as a separate
21789 argument. This provides a way of accessing all the addresses that are being
21790 delivered in the batch. &*Note:*& This is not possible for pipe commands that
21791 are specified by a &(redirect)& router.
21792
21793
21794
21795
21796 . ////////////////////////////////////////////////////////////////////////////
21797 . ////////////////////////////////////////////////////////////////////////////
21798
21799 .chapter "The appendfile transport" "CHAPappendfile"
21800 .scindex IIDapptra1 "&(appendfile)& transport"
21801 .scindex IIDapptra2 "transports" "&(appendfile)&"
21802 .cindex "directory creation"
21803 .cindex "creating directories"
21804 The &(appendfile)& transport delivers a message by appending it to an existing
21805 file, or by creating an entirely new file in a specified directory. Single
21806 files to which messages are appended can be in the traditional Unix mailbox
21807 format, or optionally in the MBX format supported by the Pine MUA and
21808 University of Washington IMAP daemon, &'inter alia'&. When each message is
21809 being delivered as a separate file, &"maildir"& format can optionally be used
21810 to give added protection against failures that happen part-way through the
21811 delivery. A third form of separate-file delivery known as &"mailstore"& is also
21812 supported. For all file formats, Exim attempts to create as many levels of
21813 directory as necessary, provided that &%create_directory%& is set.
21814
21815 The code for the optional formats is not included in the Exim binary by
21816 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
21817 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
21818 included.
21819
21820 .cindex "quota" "system"
21821 Exim recognizes system quota errors, and generates an appropriate message. Exim
21822 also supports its own quota control within the transport, for use when the
21823 system facility is unavailable or cannot be used for some reason.
21824
21825 If there is an error while appending to a file (for example, quota exceeded or
21826 partition filled), Exim attempts to reset the file's length and last
21827 modification time back to what they were before. If there is an error while
21828 creating an entirely new file, the new file is removed.
21829
21830 Before appending to a file, a number of security checks are made, and the
21831 file is locked. A detailed description is given below, after the list of
21832 private options.
21833
21834 The &(appendfile)& transport is most commonly used for local deliveries to
21835 users' mailboxes. However, it can also be used as a pseudo-remote transport for
21836 putting messages into files for remote delivery by some means other than Exim.
21837 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
21838 option).
21839
21840
21841
21842 .section "The file and directory options" "SECTfildiropt"
21843 The &%file%& option specifies a single file, to which the message is appended;
21844 the &%directory%& option specifies a directory, in which a new file containing
21845 the message is created. Only one of these two options can be set, and for
21846 normal deliveries to mailboxes, one of them &'must'& be set.
21847
21848 .vindex "&$address_file$&"
21849 .vindex "&$local_part$&"
21850 However, &(appendfile)& is also used for delivering messages to files or
21851 directories whose names (or parts of names) are obtained from alias,
21852 forwarding, or filtering operations (for example, a &%save%& command in a
21853 user's Exim filter). When such a transport is running, &$local_part$& contains
21854 the local part that was aliased or forwarded, and &$address_file$& contains the
21855 name (or partial name) of the file or directory generated by the redirection
21856 operation. There are two cases:
21857
21858 .ilist
21859 If neither &%file%& nor &%directory%& is set, the redirection operation
21860 must specify an absolute path (one that begins with &`/`&). This is the most
21861 common case when users with local accounts use filtering to sort mail into
21862 different folders. See for example, the &(address_file)& transport in the
21863 default configuration. If the path ends with a slash, it is assumed to be the
21864 name of a directory. A delivery to a directory can also be forced by setting
21865 &%maildir_format%& or &%mailstore_format%&.
21866 .next
21867 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
21868 used to determine the file or directory name for the delivery. Normally, the
21869 contents of &$address_file$& are used in some way in the string expansion.
21870 .endlist
21871
21872
21873 .cindex "Sieve filter" "configuring &(appendfile)&"
21874 .cindex "Sieve filter" "relative mailbox path handling"
21875 As an example of the second case, consider an environment where users do not
21876 have home directories. They may be permitted to use Exim filter commands of the
21877 form:
21878 .code
21879 save folder23
21880 .endd
21881 or Sieve filter commands of the form:
21882 .code
21883 require "fileinto";
21884 fileinto "folder23";
21885 .endd
21886 In this situation, the expansion of &%file%& or &%directory%& in the transport
21887 must transform the relative path into an appropriate absolute file name. In the
21888 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
21889 is used as a result of a &"keep"& action in the filter. This example shows one
21890 way of handling this requirement:
21891 .code
21892 file = ${if eq{$address_file}{inbox} \
21893             {/var/mail/$local_part} \
21894             {${if eq{${substr_0_1:$address_file}}{/} \
21895                   {$address_file} \
21896                   {$home/mail/$address_file} \
21897             }} \
21898        }
21899 .endd
21900 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
21901 location, absolute paths are used without change, and other folders are in the
21902 &_mail_& directory within the home directory.
21903
21904 &*Note 1*&: While processing an Exim filter, a relative path such as
21905 &_folder23_& is turned into an absolute path if a home directory is known to
21906 the router. In particular, this is the case if &%check_local_user%& is set. If
21907 you want to prevent this happening at routing time, you can set
21908 &%router_home_directory%& empty. This forces the router to pass the relative
21909 path to the transport.
21910
21911 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
21912 the &%file%& or &%directory%& option is still used if it is set.
21913
21914
21915
21916
21917 .section "Private options for appendfile" "SECID134"
21918 .cindex "options" "&(appendfile)& transport"
21919
21920
21921
21922 .option allow_fifo appendfile boolean false
21923 .cindex "fifo (named pipe)"
21924 .cindex "named pipe (fifo)"
21925 .cindex "pipe" "named (fifo)"
21926 Setting this option permits delivery to named pipes (FIFOs) as well as to
21927 regular files. If no process is reading the named pipe at delivery time, the
21928 delivery is deferred.
21929
21930
21931 .option allow_symlink appendfile boolean false
21932 .cindex "symbolic link" "to mailbox"
21933 .cindex "mailbox" "symbolic link"
21934 By default, &(appendfile)& will not deliver if the path name for the file is
21935 that of a symbolic link. Setting this option relaxes that constraint, but there
21936 are security issues involved in the use of symbolic links. Be sure you know
21937 what you are doing if you set this. Details of exactly what this option affects
21938 are included in the discussion which follows this list of options.
21939
21940
21941 .option batch_id appendfile string&!! unset
21942 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21943 However, batching is automatically disabled for &(appendfile)& deliveries that
21944 happen as a result of forwarding or aliasing or other redirection directly to a
21945 file.
21946
21947
21948 .option batch_max appendfile integer 1
21949 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21950
21951
21952 .option check_group appendfile boolean false
21953 When this option is set, the group owner of the file defined by the &%file%&
21954 option is checked to see that it is the same as the group under which the
21955 delivery process is running. The default setting is false because the default
21956 file mode is 0600, which means that the group is irrelevant.
21957
21958
21959 .option check_owner appendfile boolean true
21960 When this option is set, the owner of the file defined by the &%file%& option
21961 is checked to ensure that it is the same as the user under which the delivery
21962 process is running.
21963
21964
21965 .option check_string appendfile string "see below"
21966 .cindex "&""From""& line"
21967 As &(appendfile)& writes the message, the start of each line is tested for
21968 matching &%check_string%&, and if it does, the initial matching characters are
21969 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21970 a literal string, not a regular expression, and the case of any letters it
21971 contains is significant.
21972
21973 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21974 are forced to &"."& and &".."& respectively, and any settings in the
21975 configuration are ignored. Otherwise, they default to &"From&~"& and
21976 &">From&~"& when the &%file%& option is set, and unset when any of the
21977 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21978
21979 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21980 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21981 &"From&~"& indicates the start of a new message. All four options need changing
21982 if another format is used. For example, to deliver to mailboxes in MMDF format:
21983 .cindex "MMDF format mailbox"
21984 .cindex "mailbox" "MMDF format"
21985 .code
21986 check_string = "\1\1\1\1\n"
21987 escape_string = "\1\1\1\1 \n"
21988 message_prefix = "\1\1\1\1\n"
21989 message_suffix = "\1\1\1\1\n"
21990 .endd
21991 .option create_directory appendfile boolean true
21992 .cindex "directory creation"
21993 When this option is true, Exim attempts to create any missing superior
21994 directories for the file that it is about to write. A created directory's mode
21995 is given by the &%directory_mode%& option.
21996
21997 The group ownership of a newly created directory is highly dependent on the
21998 operating system (and possibly the file system) that is being used. For
21999 example, in Solaris, if the parent directory has the setgid bit set, its group
22000 is propagated to the child; if not, the currently set group is used. However,
22001 in FreeBSD, the parent's group is always used.
22002
22003
22004
22005 .option create_file appendfile string anywhere
22006 This option constrains the location of files and directories that are created
22007 by this transport. It applies to files defined by the &%file%& option and
22008 directories defined by the &%directory%& option. In the case of maildir
22009 delivery, it applies to the top level directory, not the maildir directories
22010 beneath.
22011
22012 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22013 &"belowhome"&. In the second and third cases, a home directory must have been
22014 set for the transport. This option is not useful when an explicit file name is
22015 given for normal mailbox deliveries. It is intended for the case when file
22016 names are generated from users' &_.forward_& files. These are usually handled
22017 by an &(appendfile)& transport called &%address_file%&. See also
22018 &%file_must_exist%&.
22019
22020
22021 .option directory appendfile string&!! unset
22022 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22023 or &%directory%& must be set, unless the delivery is the direct result of a
22024 redirection (see section &<<SECTfildiropt>>&).
22025
22026 When &%directory%& is set, the string is expanded, and the message is delivered
22027 into a new file or files in or below the given directory, instead of being
22028 appended to a single mailbox file. A number of different formats are provided
22029 (see &%maildir_format%& and &%mailstore_format%&), and see section
22030 &<<SECTopdir>>& for further details of this form of delivery.
22031
22032
22033 .option directory_file appendfile string&!! "see below"
22034 .cindex "base62"
22035 .vindex "&$inode$&"
22036 When &%directory%& is set, but neither &%maildir_format%& nor
22037 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22038 whose name is obtained by expanding this string. The default value is:
22039 .code
22040 q${base62:$tod_epoch}-$inode
22041 .endd
22042 This generates a unique name from the current time, in base 62 form, and the
22043 inode of the file. The variable &$inode$& is available only when expanding this
22044 option.
22045
22046
22047 .option directory_mode appendfile "octal integer" 0700
22048 If &(appendfile)& creates any directories as a result of the
22049 &%create_directory%& option, their mode is specified by this option.
22050
22051
22052 .option escape_string appendfile string "see description"
22053 See &%check_string%& above.
22054
22055
22056 .option file appendfile string&!! unset
22057 This option is mutually exclusive with the &%directory%& option, but one of
22058 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22059 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22060 specifies a single file, to which the message is appended. One or more of
22061 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22062 &%file%&.
22063
22064 .cindex "NFS" "lock file"
22065 .cindex "locking files"
22066 .cindex "lock files"
22067 If you are using more than one host to deliver over NFS into the same
22068 mailboxes, you should always use lock files.
22069
22070 The string value is expanded for each delivery, and must yield an absolute
22071 path. The most common settings of this option are variations on one of these
22072 examples:
22073 .code
22074 file = /var/spool/mail/$local_part
22075 file = /home/$local_part/inbox
22076 file = $home/inbox
22077 .endd
22078 .cindex "&""sticky""& bit"
22079 In the first example, all deliveries are done into the same directory. If Exim
22080 is configured to use lock files (see &%use_lockfile%& below) it must be able to
22081 create a file in the directory, so the &"sticky"& bit must be turned on for
22082 deliveries to be possible, or alternatively the &%group%& option can be used to
22083 run the delivery under a group id which has write access to the directory.
22084
22085
22086
22087 .option file_format appendfile string unset
22088 .cindex "file" "mailbox; checking existing format"
22089 This option requests the transport to check the format of an existing file
22090 before adding to it. The check consists of matching a specific string at the
22091 start of the file. The value of the option consists of an even number of
22092 colon-separated strings. The first of each pair is the test string, and the
22093 second is the name of a transport. If the transport associated with a matched
22094 string is not the current transport, control is passed over to the other
22095 transport. For example, suppose the standard &(local_delivery)& transport has
22096 this added to it:
22097 .code
22098 file_format = "From       : local_delivery :\
22099                \1\1\1\1\n : local_mmdf_delivery"
22100 .endd
22101 Mailboxes that begin with &"From"& are still handled by this transport, but if
22102 a mailbox begins with four binary ones followed by a newline, control is passed
22103 to a transport called &%local_mmdf_delivery%&, which presumably is configured
22104 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
22105 is assumed to match the current transport. If the start of a mailbox doesn't
22106 match any string, or if the transport named for a given string is not defined,
22107 delivery is deferred.
22108
22109
22110 .option file_must_exist appendfile boolean false
22111 If this option is true, the file specified by the &%file%& option must exist.
22112 A temporary error occurs if it does not, causing delivery to be deferred.
22113 If this option is false, the file is created if it does not exist.
22114
22115
22116 .option lock_fcntl_timeout appendfile time 0s
22117 .cindex "timeout" "mailbox locking"
22118 .cindex "mailbox" "locking, blocking and non-blocking"
22119 .cindex "locking files"
22120 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
22121 when locking an open mailbox file. If the call fails, the delivery process
22122 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
22123 Non-blocking calls are used so that the file is not kept open during the wait
22124 for the lock; the reason for this is to make it as safe as possible for
22125 deliveries over NFS in the case when processes might be accessing an NFS
22126 mailbox without using a lock file. This should not be done, but
22127 misunderstandings and hence misconfigurations are not unknown.
22128
22129 On a busy system, however, the performance of a non-blocking lock approach is
22130 not as good as using a blocking lock with a timeout. In this case, the waiting
22131 is done inside the system call, and Exim's delivery process acquires the lock
22132 and can proceed as soon as the previous lock holder releases it.
22133
22134 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
22135 timeout, are used. There may still be some retrying: the maximum number of
22136 retries is
22137 .code
22138 (lock_retries * lock_interval) / lock_fcntl_timeout
22139 .endd
22140 rounded up to the next whole number. In other words, the total time during
22141 which &(appendfile)& is trying to get a lock is roughly the same, unless
22142 &%lock_fcntl_timeout%& is set very large.
22143
22144 You should consider setting this option if you are getting a lot of delayed
22145 local deliveries because of errors of the form
22146 .code
22147 failed to lock mailbox /some/file (fcntl)
22148 .endd
22149
22150 .option lock_flock_timeout appendfile time 0s
22151 This timeout applies to file locking when using &[flock()]& (see
22152 &%use_flock%&); the timeout operates in a similar manner to
22153 &%lock_fcntl_timeout%&.
22154
22155
22156 .option lock_interval appendfile time 3s
22157 This specifies the time to wait between attempts to lock the file. See below
22158 for details of locking.
22159
22160
22161 .option lock_retries appendfile integer 10
22162 This specifies the maximum number of attempts to lock the file. A value of zero
22163 is treated as 1. See below for details of locking.
22164
22165
22166 .option lockfile_mode appendfile "octal integer" 0600
22167 This specifies the mode of the created lock file, when a lock file is being
22168 used (see &%use_lockfile%& and &%use_mbx_lock%&).
22169
22170
22171 .option lockfile_timeout appendfile time 30m
22172 .cindex "timeout" "mailbox locking"
22173 When a lock file is being used (see &%use_lockfile%&), if a lock file already
22174 exists and is older than this value, it is assumed to have been left behind by
22175 accident, and Exim attempts to remove it.
22176
22177
22178 .option mailbox_filecount appendfile string&!! unset
22179 .cindex "mailbox" "specifying size of"
22180 .cindex "size" "of mailbox"
22181 If this option is set, it is expanded, and the result is taken as the current
22182 number of files in the mailbox. It must be a decimal number, optionally
22183 followed by K or M. This provides a way of obtaining this information from an
22184 external source that maintains the data.
22185
22186
22187 .option mailbox_size appendfile string&!! unset
22188 .cindex "mailbox" "specifying size of"
22189 .cindex "size" "of mailbox"
22190 If this option is set, it is expanded, and the result is taken as the current
22191 size the mailbox. It must be a decimal number, optionally followed by K or M.
22192 This provides a way of obtaining this information from an external source that
22193 maintains the data. This is likely to be helpful for maildir deliveries where
22194 it is computationally expensive to compute the size of a mailbox.
22195
22196
22197
22198 .option maildir_format appendfile boolean false
22199 .cindex "maildir format" "specifying"
22200 If this option is set with the &%directory%& option, the delivery is into a new
22201 file, in the &"maildir"& format that is used by other mail software. When the
22202 transport is activated directly from a &(redirect)& router (for example, the
22203 &(address_file)& transport in the default configuration), setting
22204 &%maildir_format%& causes the path received from the router to be treated as a
22205 directory, whether or not it ends with &`/`&. This option is available only if
22206 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
22207 &<<SECTmaildirdelivery>>& below for further details.
22208
22209
22210 .option maildir_quota_directory_regex appendfile string "See below"
22211 .cindex "maildir format" "quota; directories included in"
22212 .cindex "quota" "maildir; directories included in"
22213 This option is relevant only when &%maildir_use_size_file%& is set. It defines
22214 a regular expression for specifying directories, relative to the quota
22215 directory (see &%quota_directory%&), that should be included in the quota
22216 calculation. The default value is:
22217 .code
22218 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
22219 .endd
22220 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
22221 (directories whose names begin with a dot). If you want to exclude the
22222 &_Trash_&
22223 folder from the count (as some sites do), you need to change this setting to
22224 .code
22225 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
22226 .endd
22227 This uses a negative lookahead in the regular expression to exclude the
22228 directory whose name is &_.Trash_&. When a directory is excluded from quota
22229 calculations, quota processing is bypassed for any messages that are delivered
22230 directly into that directory.
22231
22232
22233 .option maildir_retries appendfile integer 10
22234 This option specifies the number of times to retry when writing a file in
22235 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
22236
22237
22238 .option maildir_tag appendfile string&!! unset
22239 This option applies only to deliveries in maildir format, and is described in
22240 section &<<SECTmaildirdelivery>>& below.
22241
22242
22243 .option maildir_use_size_file appendfile&!! boolean false
22244 .cindex "maildir format" "&_maildirsize_& file"
22245 The result of string expansion for this option must be a valid boolean value.
22246 If it is true, it enables support for &_maildirsize_& files. Exim
22247 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
22248 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
22249 value is zero. See &%maildir_quota_directory_regex%& above and section
22250 &<<SECTmaildirdelivery>>& below for further details.
22251
22252 .option maildirfolder_create_regex appendfile string unset
22253 .cindex "maildir format" "&_maildirfolder_& file"
22254 .cindex "&_maildirfolder_&, creating"
22255 The value of this option is a regular expression. If it is unset, it has no
22256 effect. Otherwise, before a maildir delivery takes place, the pattern is
22257 matched against the name of the maildir directory, that is, the directory
22258 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22259 delivery. If there is a match, Exim checks for the existence of a file called
22260 &_maildirfolder_& in the directory, and creates it if it does not exist.
22261 See section &<<SECTmaildirdelivery>>& for more details.
22262
22263
22264 .option mailstore_format appendfile boolean false
22265 .cindex "mailstore format" "specifying"
22266 If this option is set with the &%directory%& option, the delivery is into two
22267 new files in  &"mailstore"& format. The option is available only if
22268 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
22269 below for further details.
22270
22271
22272 .option mailstore_prefix appendfile string&!! unset
22273 This option applies only to deliveries in mailstore format, and is described in
22274 section &<<SECTopdir>>& below.
22275
22276
22277 .option mailstore_suffix appendfile string&!! unset
22278 This option applies only to deliveries in mailstore format, and is described in
22279 section &<<SECTopdir>>& below.
22280
22281
22282 .option mbx_format appendfile boolean false
22283 .cindex "locking files"
22284 .cindex "file" "locking"
22285 .cindex "file" "MBX format"
22286 .cindex "MBX format, specifying"
22287 This option is available only if Exim has been compiled with SUPPORT_MBX
22288 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
22289 the message is appended to the mailbox file in MBX format instead of
22290 traditional Unix format. This format is supported by Pine4 and its associated
22291 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
22292
22293 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
22294 automatically changed by the use of &%mbx_format%&. They should normally be set
22295 empty when using MBX format, so this option almost always appears in this
22296 combination:
22297 .code
22298 mbx_format = true
22299 message_prefix =
22300 message_suffix =
22301 .endd
22302 If none of the locking options are mentioned in the configuration,
22303 &%use_mbx_lock%& is assumed and the other locking options default to false. It
22304 is possible to specify the other kinds of locking with &%mbx_format%&, but
22305 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
22306 interworks with &'c-client'&, providing for shared access to the mailbox. It
22307 should not be used if any program that does not use this form of locking is
22308 going to access the mailbox, nor should it be used if the mailbox file is NFS
22309 mounted, because it works only when the mailbox is accessed from a single host.
22310
22311 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22312 the standard version of &'c-client'&, because as long as it has a mailbox open
22313 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22314 append messages to it.
22315
22316
22317 .option message_prefix appendfile string&!! "see below"
22318 .cindex "&""From""& line"
22319 The string specified here is expanded and output at the start of every message.
22320 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22321 in which case it is:
22322 .code
22323 message_prefix = "From ${if def:return_path{$return_path}\
22324   {MAILER-DAEMON}} $tod_bsdinbox\n"
22325 .endd
22326 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22327 &`\n`& to &`\r\n`& in &%message_prefix%&.
22328
22329 .option message_suffix appendfile string&!! "see below"
22330 The string specified here is expanded and output at the end of every message.
22331 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22332 in which case it is a single newline character. The suffix can be suppressed by
22333 setting
22334 .code
22335 message_suffix =
22336 .endd
22337 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22338 &`\n`& to &`\r\n`& in &%message_suffix%&.
22339
22340 .option mode appendfile "octal integer" 0600
22341 If the output file is created, it is given this mode. If it already exists and
22342 has wider permissions, they are reduced to this mode. If it has narrower
22343 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22344 if the delivery is the result of a &%save%& command in a filter file specifying
22345 a particular mode, the mode of the output file is always forced to take that
22346 value, and this option is ignored.
22347
22348
22349 .option mode_fail_narrower appendfile boolean true
22350 This option applies in the case when an existing mailbox file has a narrower
22351 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22352 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22353 continues with the delivery attempt, using the existing mode of the file.
22354
22355
22356 .option notify_comsat appendfile boolean false
22357 If this option is true, the &'comsat'& daemon is notified after every
22358 successful delivery to a user mailbox. This is the daemon that notifies logged
22359 on users about incoming mail.
22360
22361
22362 .option quota appendfile string&!! unset
22363 .cindex "quota" "imposed by Exim"
22364 This option imposes a limit on the size of the file to which Exim is appending,
22365 or to the total space used in the directory tree when the &%directory%& option
22366 is set. In the latter case, computation of the space used is expensive, because
22367 all the files in the directory (and any sub-directories) have to be
22368 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22369 &%maildir_use_size_file%& for ways to avoid this in environments where users
22370 have no shell access to their mailboxes).
22371
22372 As there is no interlock against two simultaneous deliveries into a
22373 multi-file mailbox, it is possible for the quota to be overrun in this case.
22374 For single-file mailboxes, of course, an interlock is a necessity.
22375
22376 A file's size is taken as its &'used'& value. Because of blocking effects, this
22377 may be a lot less than the actual amount of disk space allocated to the file.
22378 If the sizes of a number of files are being added up, the rounding effect can
22379 become quite noticeable, especially on systems that have large block sizes.
22380 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22381 the obvious value which users understand most easily.
22382
22383 The value of the option is expanded, and must then be a numerical value
22384 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22385 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
22386 and further option modifiers. If Exim is running on a system with
22387 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22388 be handled.
22389
22390 The option modifier &%no_check%& can be used to force delivery even if the over
22391 quota condition is met. The quota gets updated as usual.
22392
22393 &*Note*&: A value of zero is interpreted as &"no quota"&.
22394
22395 The expansion happens while Exim is running as root, before it changes uid for
22396 the delivery. This means that files that are inaccessible to the end user can
22397 be used to hold quota values that are looked up in the expansion. When delivery
22398 fails because this quota is exceeded, the handling of the error is as for
22399 system quota failures.
22400
22401 By default, Exim's quota checking mimics system quotas, and restricts the
22402 mailbox to the specified maximum size, though the value is not accurate to the
22403 last byte, owing to separator lines and additional headers that may get added
22404 during message delivery. When a mailbox is nearly full, large messages may get
22405 refused even though small ones are accepted, because the size of the current
22406 message is added to the quota when the check is made. This behaviour can be
22407 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22408 for exceeding the quota does not include the current message. Thus, deliveries
22409 continue until the quota has been exceeded; thereafter, no further messages are
22410 delivered. See also &%quota_warn_threshold%&.
22411
22412
22413 .option quota_directory appendfile string&!! unset
22414 This option defines the directory to check for quota purposes when delivering
22415 into individual files. The default is the delivery directory, or, if a file
22416 called &_maildirfolder_& exists in a maildir directory, the parent of the
22417 delivery directory.
22418
22419
22420 .option quota_filecount appendfile string&!! 0
22421 This option applies when the &%directory%& option is set. It limits the total
22422 number of files in the directory (compare the inode limit in system quotas). It
22423 can only be used if &%quota%& is also set. The value is expanded; an expansion
22424 failure causes delivery to be deferred. A value of zero is interpreted as
22425 &"no quota"&.
22426
22427 The option modifier &%no_check%& can be used to force delivery even if the over
22428 quota condition is met. The quota gets updated as usual.
22429
22430 .option quota_is_inclusive appendfile boolean true
22431 See &%quota%& above.
22432
22433
22434 .option quota_size_regex appendfile string unset
22435 This option applies when one of the delivery modes that writes a separate file
22436 for each message is being used. When Exim wants to find the size of one of
22437 these files in order to test the quota, it first checks &%quota_size_regex%&.
22438 If this is set to a regular expression that matches the file name, and it
22439 captures one string, that string is interpreted as a representation of the
22440 file's size. The value of &%quota_size_regex%& is not expanded.
22441
22442 This feature is useful only when users have no shell access to their mailboxes
22443 &-- otherwise they could defeat the quota simply by renaming the files. This
22444 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22445 the file length to the file name. For example:
22446 .code
22447 maildir_tag = ,S=$message_size
22448 quota_size_regex = ,S=(\d+)
22449 .endd
22450 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22451 number of lines in the message.
22452
22453 The regular expression should not assume that the length is at the end of the
22454 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
22455 sometimes add other information onto the ends of message file names.
22456
22457 Section &<<SECID136>>& contains further information.
22458
22459
22460 .option quota_warn_message appendfile string&!! "see below"
22461 See below for the use of this option. If it is not set when
22462 &%quota_warn_threshold%& is set, it defaults to
22463 .code
22464 quota_warn_message = "\
22465   To: $local_part@$domain\n\
22466   Subject: Your mailbox\n\n\
22467   This message is automatically created \
22468   by mail delivery software.\n\n\
22469   The size of your mailbox has exceeded \
22470   a warning threshold that is\n\
22471   set by the system administrator.\n"
22472 .endd
22473
22474
22475 .option quota_warn_threshold appendfile string&!! 0
22476 .cindex "quota" "warning threshold"
22477 .cindex "mailbox" "size warning"
22478 .cindex "size" "of mailbox"
22479 This option is expanded in the same way as &%quota%& (see above). If the
22480 resulting value is greater than zero, and delivery of the message causes the
22481 size of the file or total space in the directory tree to cross the given
22482 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22483 may be specified as a percentage of it by following the value with a percent
22484 sign. For example:
22485 .code
22486 quota = 10M
22487 quota_warn_threshold = 75%
22488 .endd
22489 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22490 percent sign is ignored.
22491
22492 The warning message itself is specified by the &%quota_warn_message%& option,
22493 and it must start with a &'To:'& header line containing the recipient(s) of the
22494 warning message. These do not necessarily have to include the recipient(s) of
22495 the original message. A &'Subject:'& line should also normally be supplied. You
22496 can include any other header lines that you want. If you do not include a
22497 &'From:'& line, the default is:
22498 .code
22499 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22500 .endd
22501 .oindex &%errors_reply_to%&
22502 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22503 option.
22504
22505 The &%quota%& option does not have to be set in order to use this option; they
22506 are independent of one another except when the threshold is specified as a
22507 percentage.
22508
22509
22510 .option use_bsmtp appendfile boolean false
22511 .cindex "envelope sender"
22512 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22513 format, with the envelope sender and recipient(s) included as SMTP commands. If
22514 you want to include a leading HELO command with such messages, you can do
22515 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22516 for details of batch SMTP.
22517
22518
22519 .option use_crlf appendfile boolean false
22520 .cindex "carriage return"
22521 .cindex "linefeed"
22522 This option causes lines to be terminated with the two-character CRLF sequence
22523 (carriage return, linefeed) instead of just a linefeed character. In the case
22524 of batched SMTP, the byte sequence written to the file is then an exact image
22525 of what would be sent down a real SMTP connection.
22526
22527 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22528 (which are used to supply the traditional &"From&~"& and blank line separators
22529 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22530 carriage return characters if these are needed. In cases where these options
22531 have non-empty defaults, the values end with a single linefeed, so they must be
22532 changed to end with &`\r\n`& if &%use_crlf%& is set.
22533
22534
22535 .option use_fcntl_lock appendfile boolean "see below"
22536 This option controls the use of the &[fcntl()]& function to lock a file for
22537 exclusive use when a message is being appended. It is set by default unless
22538 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22539 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22540 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
22541
22542
22543 .option use_flock_lock appendfile boolean false
22544 This option is provided to support the use of &[flock()]& for file locking, for
22545 the few situations where it is needed. Most modern operating systems support
22546 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
22547 each other. Exim uses &[fcntl()]& locking by default.
22548
22549 This option is required only if you are using an operating system where
22550 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
22551 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
22552 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
22553
22554 .cindex "Solaris" "&[flock()]& support"
22555 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
22556 have it (and some, I think, provide a not quite right version built on top of
22557 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
22558 the ability to use it, and any attempt to do so will cause a configuration
22559 error.
22560
22561 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
22562 is just being mapped onto &[fcntl()]& by the OS).
22563
22564
22565 .option use_lockfile appendfile boolean "see below"
22566 If this option is turned off, Exim does not attempt to create a lock file when
22567 appending to a mailbox file. In this situation, the only locking is by
22568 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22569 sure that every MUA that is ever going to look at your users' mailboxes uses
22570 &[fcntl()]& rather than a lock file, and even then only when you are not
22571 delivering over NFS from more than one host.
22572
22573 .cindex "NFS" "lock file"
22574 In order to append to an NFS file safely from more than one host, it is
22575 necessary to take out a lock &'before'& opening the file, and the lock file
22576 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22577 file corruption.
22578
22579 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22580 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22581 except when &%mbx_format%& is set.
22582
22583
22584 .option use_mbx_lock appendfile boolean "see below"
22585 This option is available only if Exim has been compiled with SUPPORT_MBX
22586 set in &_Local/Makefile_&. Setting the option specifies that special MBX
22587 locking rules be used. It is set by default if &%mbx_format%& is set and none
22588 of the locking options are mentioned in the configuration. The locking rules
22589 are the same as are used by the &'c-client'& library that underlies Pine and
22590 the IMAP4 and POP daemons that come with it (see the discussion below). The
22591 rules allow for shared access to the mailbox. However, this kind of locking
22592 does not work when the mailbox is NFS mounted.
22593
22594 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
22595 &%use_flock_lock%& to control what kind of locking is used in implementing the
22596 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
22597 without &%use_fcntl_lock%& or &%use_flock_lock%&.
22598
22599
22600
22601
22602 .section "Operational details for appending" "SECTopappend"
22603 .cindex "appending to a file"
22604 .cindex "file" "appending"
22605 Before appending to a file, the following preparations are made:
22606
22607 .ilist
22608 If the name of the file is &_/dev/null_&, no action is taken, and a success
22609 return is given.
22610
22611 .next
22612 .cindex "directory creation"
22613 If any directories on the file's path are missing, Exim creates them if the
22614 &%create_directory%& option is set. A created directory's mode is given by the
22615 &%directory_mode%& option.
22616
22617 .next
22618 If &%file_format%& is set, the format of an existing file is checked. If this
22619 indicates that a different transport should be used, control is passed to that
22620 transport.
22621
22622 .next
22623 .cindex "file" "locking"
22624 .cindex "locking files"
22625 .cindex "NFS" "lock file"
22626 If &%use_lockfile%& is set, a lock file is built in a way that will work
22627 reliably over NFS, as follows:
22628
22629 .olist
22630 Create a &"hitching post"& file whose name is that of the lock file with the
22631 current time, primary host name, and process id added, by opening for writing
22632 as a new file. If this fails with an access error, delivery is deferred.
22633 .next
22634 Close the hitching post file, and hard link it to the lock file name.
22635 .next
22636 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22637 Unlink the hitching post name.
22638 .next
22639 Otherwise, use &[stat()]& to get information about the hitching post file, and
22640 then unlink hitching post name. If the number of links is exactly two, creation
22641 of the lock file succeeded but something (for example, an NFS server crash and
22642 restart) caused this fact not to be communicated to the &[link()]& call.
22643 .next
22644 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22645 up to &%lock_retries%& times. However, since any program that writes to a
22646 mailbox should complete its task very quickly, it is reasonable to time out old
22647 lock files that are normally the result of user agent and system crashes. If an
22648 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22649 it before trying again.
22650 .endlist olist
22651
22652 .next
22653 A call is made to &[lstat()]& to discover whether the main file exists, and if
22654 so, what its characteristics are. If &[lstat()]& fails for any reason other
22655 than non-existence, delivery is deferred.
22656
22657 .next
22658 .cindex "symbolic link" "to mailbox"
22659 .cindex "mailbox" "symbolic link"
22660 If the file does exist and is a symbolic link, delivery is deferred, unless the
22661 &%allow_symlink%& option is set, in which case the ownership of the link is
22662 checked, and then &[stat()]& is called to find out about the real file, which
22663 is then subjected to the checks below. The check on the top-level link
22664 ownership prevents one user creating a link for another's mailbox in a sticky
22665 directory, though allowing symbolic links in this case is definitely not a good
22666 idea. If there is a chain of symbolic links, the intermediate ones are not
22667 checked.
22668
22669 .next
22670 If the file already exists but is not a regular file, or if the file's owner
22671 and group (if the group is being checked &-- see &%check_group%& above) are
22672 different from the user and group under which the delivery is running,
22673 delivery is deferred.
22674
22675 .next
22676 If the file's permissions are more generous than specified, they are reduced.
22677 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22678 is set false, in which case the delivery is tried using the existing
22679 permissions.
22680
22681 .next
22682 The file's inode number is saved, and the file is then opened for appending.
22683 If this fails because the file has vanished, &(appendfile)& behaves as if it
22684 hadn't existed (see below). For any other failures, delivery is deferred.
22685
22686 .next
22687 If the file is opened successfully, check that the inode number hasn't
22688 changed, that it is still a regular file, and that the owner and permissions
22689 have not changed. If anything is wrong, defer delivery and freeze the message.
22690
22691 .next
22692 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22693 option is set. Otherwise, check that the file is being created in a permitted
22694 directory if the &%create_file%& option is set (deferring on failure), and then
22695 open for writing as a new file, with the O_EXCL and O_CREAT options,
22696 except when dealing with a symbolic link (the &%allow_symlink%& option must be
22697 set). In this case, which can happen if the link points to a non-existent file,
22698 the file is opened for writing using O_CREAT but not O_EXCL, because
22699 that prevents link following.
22700
22701 .next
22702 .cindex "loop" "while file testing"
22703 If opening fails because the file exists, obey the tests given above for
22704 existing files. However, to avoid looping in a situation where the file is
22705 being continuously created and destroyed, the exists/not-exists loop is broken
22706 after 10 repetitions, and the message is then frozen.
22707
22708 .next
22709 If opening fails with any other error, defer delivery.
22710
22711 .next
22712 .cindex "file" "locking"
22713 .cindex "locking files"
22714 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
22715 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
22716 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
22717 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
22718 file, and an exclusive lock on the file whose name is
22719 .code
22720 /tmp/.<device-number>.<inode-number>
22721 .endd
22722 using the device and inode numbers of the open mailbox file, in accordance with
22723 the MBX locking rules. This file is created with a mode that is specified by
22724 the &%lockfile_mode%& option.
22725
22726 If Exim fails to lock the file, there are two possible courses of action,
22727 depending on the value of the locking timeout. This is obtained from
22728 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
22729
22730 If the timeout value is zero, the file is closed, Exim waits for
22731 &%lock_interval%&, and then goes back and re-opens the file as above and tries
22732 to lock it again. This happens up to &%lock_retries%& times, after which the
22733 delivery is deferred.
22734
22735 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
22736 &[flock()]& are used (with the given timeout), so there has already been some
22737 waiting involved by the time locking fails. Nevertheless, Exim does not give up
22738 immediately. It retries up to
22739 .code
22740 (lock_retries * lock_interval) / <timeout>
22741 .endd
22742 times (rounded up).
22743 .endlist
22744
22745 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
22746 and/or &[flock()]& locks) and then deletes the lock file if one was created.
22747
22748
22749 .section "Operational details for delivery to a new file" "SECTopdir"
22750 .cindex "delivery" "to single file"
22751 .cindex "&""From""& line"
22752 When the &%directory%& option is set instead of &%file%&, each message is
22753 delivered into a newly-created file or set of files. When &(appendfile)& is
22754 activated directly from a &(redirect)& router, neither &%file%& nor
22755 &%directory%& is normally set, because the path for delivery is supplied by the
22756 router. (See for example, the &(address_file)& transport in the default
22757 configuration.) In this case, delivery is to a new file if either the path name
22758 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
22759
22760 No locking is required while writing the message to a new file, so the various
22761 locking options of the transport are ignored. The &"From"& line that by default
22762 separates messages in a single file is not normally needed, nor is the escaping
22763 of message lines that start with &"From"&, and there is no need to ensure a
22764 newline at the end of each message. Consequently, the default values for
22765 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
22766 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
22767
22768 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
22769 the files in the delivery directory by default. However, you can specify a
22770 different directory by setting &%quota_directory%&. Also, for maildir
22771 deliveries (see below) the &_maildirfolder_& convention is honoured.
22772
22773
22774 .cindex "maildir format"
22775 .cindex "mailstore format"
22776 There are three different ways in which delivery to individual files can be
22777 done, controlled by the settings of the &%maildir_format%& and
22778 &%mailstore_format%& options. Note that code to support maildir or mailstore
22779 formats is not included in the binary unless SUPPORT_MAILDIR or
22780 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
22781
22782 .cindex "directory creation"
22783 In all three cases an attempt is made to create the directory and any necessary
22784 sub-directories if they do not exist, provided that the &%create_directory%&
22785 option is set (the default). The location of a created directory can be
22786 constrained by setting &%create_file%&. A created directory's mode is given by
22787 the &%directory_mode%& option. If creation fails, or if the
22788 &%create_directory%& option is not set when creation is required, delivery is
22789 deferred.
22790
22791
22792
22793 .section "Maildir delivery" "SECTmaildirdelivery"
22794 .cindex "maildir format" "description of"
22795 If the &%maildir_format%& option is true, Exim delivers each message by writing
22796 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
22797 directory that is defined by the &%directory%& option (the &"delivery
22798 directory"&). If the delivery is successful, the file is renamed into the
22799 &_new_& subdirectory.
22800
22801 In the file name, <&'stime'&> is the current time of day in seconds, and
22802 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
22803 Exim checks that the time-of-day clock has moved on by at least one microsecond
22804 before terminating the delivery process. This guarantees uniqueness for the
22805 file name. However, as a precaution, Exim calls &[stat()]& for the file before
22806 opening it. If any response other than ENOENT (does not exist) is given,
22807 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
22808
22809 Before Exim carries out a maildir delivery, it ensures that subdirectories
22810 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
22811 do not exist, Exim tries to create them and any superior directories in their
22812 path, subject to the &%create_directory%& and &%create_file%& options. If the
22813 &%maildirfolder_create_regex%& option is set, and the regular expression it
22814 contains matches the delivery directory, Exim also ensures that a file called
22815 &_maildirfolder_& exists in the delivery directory. If a missing directory or
22816 &_maildirfolder_& file cannot be created, delivery is deferred.
22817
22818 These features make it possible to use Exim to create all the necessary files
22819 and directories in a maildir mailbox, including subdirectories for maildir++
22820 folders. Consider this example:
22821 .code
22822 maildir_format = true
22823 directory = /var/mail/$local_part\
22824            ${if eq{$local_part_suffix}{}{}\
22825            {/.${substr_1:$local_part_suffix}}}
22826 maildirfolder_create_regex = /\.[^/]+$
22827 .endd
22828 If &$local_part_suffix$& is empty (there was no suffix for the local part),
22829 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
22830 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
22831 not match this name, so Exim will not look for or create the file
22832 &_/var/mail/pimbo/maildirfolder_&, though it will create
22833 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
22834
22835 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
22836 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
22837 does match &%maildirfolder_create_regex%&. In this case, Exim will create
22838 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
22839 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
22840
22841 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
22842 not inadvertently match the toplevel maildir directory, because a
22843 &_maildirfolder_& file at top level would completely break quota calculations.
22844
22845 .cindex "quota" "in maildir delivery"
22846 .cindex "maildir++"
22847 If Exim is required to check a &%quota%& setting before a maildir delivery, and
22848 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
22849 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
22850 Exim assumes the directory is a maildir++ folder directory, which is one level
22851 down from the user's top level mailbox directory. This causes it to start at
22852 the parent directory instead of the current directory when calculating the
22853 amount of space used.
22854
22855 One problem with delivering into a multi-file mailbox is that it is
22856 computationally expensive to compute the size of the mailbox for quota
22857 checking. Various approaches have been taken to reduce the amount of work
22858 needed. The next two sections describe two of them. A third alternative is to
22859 use some external process for maintaining the size data, and use the expansion
22860 of the &%mailbox_size%& option as a way of importing it into Exim.
22861
22862
22863
22864
22865 .section "Using tags to record message sizes" "SECID135"
22866 If &%maildir_tag%& is set, the string is expanded for each delivery.
22867 When the maildir file is renamed into the &_new_& sub-directory, the
22868 tag is added to its name. However, if adding the tag takes the length of the
22869 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
22870 the tag is dropped and the maildir file is created with no tag.
22871
22872
22873 .vindex "&$message_size$&"
22874 Tags can be used to encode the size of files in their names; see
22875 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
22876 happens after the message has been written. The value of the &$message_size$&
22877 variable is set to the number of bytes actually written. If the expansion is
22878 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
22879 be deferred. The expanded tag may contain any printing characters except &"/"&.
22880 Non-printing characters in the string are ignored; if the resulting string is
22881 empty, it is ignored. If it starts with an alphanumeric character, a leading
22882 colon is inserted; this default has not proven to be the path that popular
22883 maildir implementations have chosen (but changing it in Exim would break
22884 backwards compatibility).
22885
22886 For one common implementation, you might set:
22887 .code
22888 maildir_tag = ,S=${message_size}
22889 .endd
22890 but you should check the documentation of the other software to be sure.
22891
22892 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
22893 as this allows Exim to extract the size from your tag, instead of having to
22894 &[stat()]& each message file.
22895
22896
22897 .section "Using a maildirsize file" "SECID136"
22898 .cindex "quota" "in maildir delivery"
22899 .cindex "maildir format" "&_maildirsize_& file"
22900 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
22901 storing quota and message size information in a file called &_maildirsize_&
22902 within the toplevel maildir directory. If this file does not exist, Exim
22903 creates it, setting the quota from the &%quota%& option of the transport. If
22904 the maildir directory itself does not exist, it is created before any attempt
22905 to write a &_maildirsize_& file.
22906
22907 The &_maildirsize_& file is used to hold information about the sizes of
22908 messages in the maildir, thus speeding up quota calculations. The quota value
22909 in the file is just a cache; if the quota is changed in the transport, the new
22910 value overrides the cached value when the next message is delivered. The cache
22911 is maintained for the benefit of other programs that access the maildir and
22912 need to know the quota.
22913
22914 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
22915 file is maintained (with a zero quota setting), but no quota is imposed.
22916
22917 A regular expression is available for controlling which directories in the
22918 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
22919 See the description of the &%maildir_quota_directory_regex%& option above for
22920 details.
22921
22922
22923 .section "Mailstore delivery" "SECID137"
22924 .cindex "mailstore format" "description of"
22925 If the &%mailstore_format%& option is true, each message is written as two
22926 files in the given directory. A unique base name is constructed from the
22927 message id and the current delivery process, and the files that are written use
22928 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22929 contains the message's envelope, and the &_.msg_& file contains the message
22930 itself. The base name is placed in the variable &$mailstore_basename$&.
22931
22932 During delivery, the envelope is first written to a file with the suffix
22933 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22934 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22935 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22936 file before accessing either of them. An alternative approach is to wait for
22937 the absence of a &_.tmp_& file.
22938
22939 The envelope file starts with any text defined by the &%mailstore_prefix%&
22940 option, expanded and terminated by a newline if there isn't one. Then follows
22941 the sender address on one line, then all the recipient addresses, one per line.
22942 There can be more than one recipient only if the &%batch_max%& option is set
22943 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22944 appended to the file, followed by a newline if it does not end with one.
22945
22946 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22947 failure, it is ignored. Other expansion errors are treated as serious
22948 configuration errors, and delivery is deferred. The variable
22949 &$mailstore_basename$& is available for use during these expansions.
22950
22951
22952 .section "Non-special new file delivery" "SECID138"
22953 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
22954 file is created directly in the named directory. For example, when delivering
22955 messages into files in batched SMTP format for later delivery to some host (see
22956 section &<<SECTbatchSMTP>>&), a setting such as
22957 .code
22958 directory = /var/bsmtp/$host
22959 .endd
22960 might be used. A message is written to a file with a temporary name, which is
22961 then renamed when the delivery is complete. The final name is obtained by
22962 expanding the contents of the &%directory_file%& option.
22963 .ecindex IIDapptra1
22964 .ecindex IIDapptra2
22965
22966
22967
22968
22969
22970
22971 . ////////////////////////////////////////////////////////////////////////////
22972 . ////////////////////////////////////////////////////////////////////////////
22973
22974 .chapter "The autoreply transport" "CHID8"
22975 .scindex IIDauttra1 "transports" "&(autoreply)&"
22976 .scindex IIDauttra2 "&(autoreply)& transport"
22977 The &(autoreply)& transport is not a true transport in that it does not cause
22978 the message to be transmitted. Instead, it generates a new mail message as an
22979 automatic reply to the incoming message. &'References:'& and
22980 &'Auto-Submitted:'& header lines are included. These are constructed according
22981 to the rules in RFCs 2822 and 3834, respectively.
22982
22983 If the router that passes the message to this transport does not have the
22984 &%unseen%& option set, the original message (for the current recipient) is not
22985 delivered anywhere. However, when the &%unseen%& option is set on the router
22986 that passes the message to this transport, routing of the address continues, so
22987 another router can set up a normal message delivery.
22988
22989
22990 The &(autoreply)& transport is usually run as the result of mail filtering, a
22991 &"vacation"& message being the standard example. However, it can also be run
22992 directly from a router like any other transport. To reduce the possibility of
22993 message cascades, messages created by the &(autoreply)& transport always have
22994 empty envelope sender addresses, like bounce messages.
22995
22996 The parameters of the message to be sent can be specified in the configuration
22997 by options described below. However, these are used only when the address
22998 passed to the transport does not contain its own reply information. When the
22999 transport is run as a consequence of a
23000 &%mail%&
23001 or &%vacation%& command in a filter file, the parameters of the message are
23002 supplied by the filter, and passed with the address. The transport's options
23003 that define the message are then ignored (so they are not usually set in this
23004 case). The message is specified entirely by the filter or by the transport; it
23005 is never built from a mixture of options. However, the &%file_optional%&,
23006 &%mode%&, and &%return_message%& options apply in all cases.
23007
23008 &(Autoreply)& is implemented as a local transport. When used as a result of a
23009 command in a user's filter file, &(autoreply)& normally runs under the uid and
23010 gid of the user, and with appropriate current and home directories (see chapter
23011 &<<CHAPenvironment>>&).
23012
23013 There is a subtle difference between routing a message to a &(pipe)& transport
23014 that generates some text to be returned to the sender, and routing it to an
23015 &(autoreply)& transport. This difference is noticeable only if more than one
23016 address from the same message is so handled. In the case of a pipe, the
23017 separate outputs from the different addresses are gathered up and returned to
23018 the sender in a single message, whereas if &(autoreply)& is used, a separate
23019 message is generated for each address that is passed to it.
23020
23021 Non-printing characters are not permitted in the header lines generated for the
23022 message that &(autoreply)& creates, with the exception of newlines that are
23023 immediately followed by white space. If any non-printing characters are found,
23024 the transport defers.
23025 Whether characters with the top bit set count as printing characters or not is
23026 controlled by the &%print_topbitchars%& global option.
23027
23028 If any of the generic options for manipulating headers (for example,
23029 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23030 of the original message that is included in the generated message when
23031 &%return_message%& is set. They do not apply to the generated message itself.
23032
23033 .vindex "&$sender_address$&"
23034 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23035 the message, indicating that there were no recipients, it does not treat this
23036 as an error. This means that autoreplies sent to &$sender_address$& when this
23037 is empty (because the incoming message is a bounce message) do not cause
23038 problems. They are just discarded.
23039
23040
23041
23042 .section "Private options for autoreply" "SECID139"
23043 .cindex "options" "&(autoreply)& transport"
23044
23045 .option bcc autoreply string&!! unset
23046 This specifies the addresses that are to receive &"blind carbon copies"& of the
23047 message when the message is specified by the transport.
23048
23049
23050 .option cc autoreply string&!! unset
23051 This specifies recipients of the message and the contents of the &'Cc:'& header
23052 when the message is specified by the transport.
23053
23054
23055 .option file autoreply string&!! unset
23056 The contents of the file are sent as the body of the message when the message
23057 is specified by the transport. If both &%file%& and &%text%& are set, the text
23058 string comes first.
23059
23060
23061 .option file_expand autoreply boolean false
23062 If this is set, the contents of the file named by the &%file%& option are
23063 subjected to string expansion as they are added to the message.
23064
23065
23066 .option file_optional autoreply boolean false
23067 If this option is true, no error is generated if the file named by the &%file%&
23068 option or passed with the address does not exist or cannot be read.
23069
23070
23071 .option from autoreply string&!! unset
23072 This specifies the contents of the &'From:'& header when the message is
23073 specified by the transport.
23074
23075
23076 .option headers autoreply string&!! unset
23077 This specifies additional RFC 2822 headers that are to be added to the message
23078 when the message is specified by the transport. Several can be given by using
23079 &"\n"& to separate them. There is no check on the format.
23080
23081
23082 .option log autoreply string&!! unset
23083 This option names a file in which a record of every message sent is logged when
23084 the message is specified by the transport.
23085
23086
23087 .option mode autoreply "octal integer" 0600
23088 If either the log file or the &"once"& file has to be created, this mode is
23089 used.
23090
23091
23092 .option never_mail autoreply "address list&!!" unset
23093 If any run of the transport creates a message with a recipient that matches any
23094 item in the list, that recipient is quietly discarded. If all recipients are
23095 discarded, no message is created. This applies both when the recipients are
23096 generated by a filter and when they are specified in the transport.
23097
23098
23099
23100 .option once autoreply string&!! unset
23101 This option names a file or DBM database in which a record of each &'To:'&
23102 recipient is kept when the message is specified by the transport. &*Note*&:
23103 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
23104
23105 If &%once%& is unset, or is set to an empty string, the message is always sent.
23106 By default, if &%once%& is set to a non-empty file name, the message
23107 is not sent if a potential recipient is already listed in the database.
23108 However, if the &%once_repeat%& option specifies a time greater than zero, the
23109 message is sent if that much time has elapsed since a message was last sent to
23110 this recipient. A setting of zero time for &%once_repeat%& (the default)
23111 prevents a message from being sent a second time &-- in this case, zero means
23112 infinity.
23113
23114 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
23115 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
23116 greater than zero, it changes the way Exim implements the &%once%& option.
23117 Instead of using a DBM file to record every recipient it sends to, it uses a
23118 regular file, whose size will never get larger than the given value.
23119
23120 In the file, Exim keeps a linear list of recipient addresses and the times at
23121 which they were sent messages. If the file is full when a new address needs to
23122 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
23123 means that a given recipient may receive multiple messages, but at
23124 unpredictable intervals that depend on the rate of turnover of addresses in the
23125 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
23126
23127
23128 .option once_file_size autoreply integer 0
23129 See &%once%& above.
23130
23131
23132 .option once_repeat autoreply time&!! 0s
23133 See &%once%& above.
23134 After expansion, the value of this option must be a valid time value.
23135
23136
23137 .option reply_to autoreply string&!! unset
23138 This specifies the contents of the &'Reply-To:'& header when the message is
23139 specified by the transport.
23140
23141
23142 .option return_message autoreply boolean false
23143 If this is set, a copy of the original message is returned with the new
23144 message, subject to the maximum size set in the &%return_size_limit%& global
23145 configuration option.
23146
23147
23148 .option subject autoreply string&!! unset
23149 This specifies the contents of the &'Subject:'& header when the message is
23150 specified by the transport. It is tempting to quote the original subject in
23151 automatic responses. For example:
23152 .code
23153 subject = Re: $h_subject:
23154 .endd
23155 There is a danger in doing this, however. It may allow a third party to
23156 subscribe your users to an opt-in mailing list, provided that the list accepts
23157 bounce messages as subscription confirmations. Well-managed lists require a
23158 non-bounce message to confirm a subscription, so the danger is relatively
23159 small.
23160
23161
23162
23163 .option text autoreply string&!! unset
23164 This specifies a single string to be used as the body of the message when the
23165 message is specified by the transport. If both &%text%& and &%file%& are set,
23166 the text comes first.
23167
23168
23169 .option to autoreply string&!! unset
23170 This specifies recipients of the message and the contents of the &'To:'& header
23171 when the message is specified by the transport.
23172 .ecindex IIDauttra1
23173 .ecindex IIDauttra2
23174
23175
23176
23177
23178 . ////////////////////////////////////////////////////////////////////////////
23179 . ////////////////////////////////////////////////////////////////////////////
23180
23181 .chapter "The lmtp transport" "CHAPLMTP"
23182 .cindex "transports" "&(lmtp)&"
23183 .cindex "&(lmtp)& transport"
23184 .cindex "LMTP" "over a pipe"
23185 .cindex "LMTP" "over a socket"
23186 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
23187 specified command
23188 or by interacting with a Unix domain socket.
23189 This transport is something of a cross between the &(pipe)& and &(smtp)&
23190 transports. Exim also has support for using LMTP over TCP/IP; this is
23191 implemented as an option for the &(smtp)& transport. Because LMTP is expected
23192 to be of minority interest, the default build-time configure in &_src/EDITME_&
23193 has it commented out. You need to ensure that
23194 .code
23195 TRANSPORT_LMTP=yes
23196 .endd
23197 .cindex "options" "&(lmtp)& transport"
23198 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
23199 included in the Exim binary. The private options of the &(lmtp)& transport are
23200 as follows:
23201
23202 .option batch_id lmtp string&!! unset
23203 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23204
23205
23206 .option batch_max lmtp integer 1
23207 This limits the number of addresses that can be handled in a single delivery.
23208 Most LMTP servers can handle several addresses at once, so it is normally a
23209 good idea to increase this value. See the description of local delivery
23210 batching in chapter &<<CHAPbatching>>&.
23211
23212
23213 .option command lmtp string&!! unset
23214 This option must be set if &%socket%& is not set. The string is a command which
23215 is run in a separate process. It is split up into a command name and list of
23216 arguments, each of which is separately expanded (so expansion cannot change the
23217 number of arguments). The command is run directly, not via a shell. The message
23218 is passed to the new process using the standard input and output to operate the
23219 LMTP protocol.
23220
23221 .option ignore_quota lmtp boolean false
23222 .cindex "LMTP" "ignoring quota errors"
23223 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
23224 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
23225 in its response to the LHLO command.
23226
23227 .option socket lmtp string&!! unset
23228 This option must be set if &%command%& is not set. The result of expansion must
23229 be the name of a Unix domain socket. The transport connects to the socket and
23230 delivers the message to it using the LMTP protocol.
23231
23232
23233 .option timeout lmtp time 5m
23234 The transport is aborted if the created process or Unix domain socket does not
23235 respond to LMTP commands or message input within this timeout. Delivery
23236 is deferred, and will be tried again later. Here is an example of a typical
23237 LMTP transport:
23238 .code
23239 lmtp:
23240   driver = lmtp
23241   command = /some/local/lmtp/delivery/program
23242   batch_max = 20
23243   user = exim
23244 .endd
23245 This delivers up to 20 addresses at a time, in a mixture of domains if
23246 necessary, running as the user &'exim'&.
23247
23248
23249
23250 . ////////////////////////////////////////////////////////////////////////////
23251 . ////////////////////////////////////////////////////////////////////////////
23252
23253 .chapter "The pipe transport" "CHAPpipetransport"
23254 .scindex IIDpiptra1 "transports" "&(pipe)&"
23255 .scindex IIDpiptra2 "&(pipe)& transport"
23256 The &(pipe)& transport is used to deliver messages via a pipe to a command
23257 running in another process. One example is the use of &(pipe)& as a
23258 pseudo-remote transport for passing messages to some other delivery mechanism
23259 (such as UUCP). Another is the use by individual users to automatically process
23260 their incoming messages. The &(pipe)& transport can be used in one of the
23261 following ways:
23262
23263 .ilist
23264 .vindex "&$local_part$&"
23265 A router routes one address to a transport in the normal way, and the
23266 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
23267 contains the local part of the address (as usual), and the command that is run
23268 is specified by the &%command%& option on the transport.
23269 .next
23270 .vindex "&$pipe_addresses$&"
23271 If the &%batch_max%& option is set greater than 1 (the default is 1), the
23272 transport can handle more than one address in a single run. In this case, when
23273 more than one address is routed to the transport, &$local_part$& is not set
23274 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
23275 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
23276 that are routed to the transport.
23277 .next
23278 .vindex "&$address_pipe$&"
23279 A router redirects an address directly to a pipe command (for example, from an
23280 alias or forward file). In this case, &$address_pipe$& contains the text of the
23281 pipe command, and the &%command%& option on the transport is ignored unless
23282 &%force_command%& is set. If only one address is being transported
23283 (&%batch_max%& is not greater than one, or only one address was redirected to
23284 this pipe command), &$local_part$& contains the local part that was redirected.
23285 .endlist
23286
23287
23288 The &(pipe)& transport is a non-interactive delivery method. Exim can also
23289 deliver messages over pipes using the LMTP interactive protocol. This is
23290 implemented by the &(lmtp)& transport.
23291
23292 In the case when &(pipe)& is run as a consequence of an entry in a local user's
23293 &_.forward_& file, the command runs under the uid and gid of that user. In
23294 other cases, the uid and gid have to be specified explicitly, either on the
23295 transport or on the router that handles the address. Current and &"home"&
23296 directories are also controllable. See chapter &<<CHAPenvironment>>& for
23297 details of the local delivery environment and chapter &<<CHAPbatching>>&
23298 for a discussion of local delivery batching.
23299
23300
23301 .section "Concurrent delivery" "SECID140"
23302 If two messages arrive at almost the same time, and both are routed to a pipe
23303 delivery, the two pipe transports may be run concurrently. You must ensure that
23304 any pipe commands you set up are robust against this happening. If the commands
23305 write to a file, the &%exim_lock%& utility might be of use.
23306 Alternatively the &%max_parallel%& option could be used with a value
23307 of "1" to enforce serialization.
23308
23309
23310
23311
23312 .section "Returned status and data" "SECID141"
23313 .cindex "&(pipe)& transport" "returned data"
23314 If the command exits with a non-zero return code, the delivery is deemed to
23315 have failed, unless either the &%ignore_status%& option is set (in which case
23316 the return code is treated as zero), or the return code is one of those listed
23317 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23318 later"&. In this case, delivery is deferred. Details of a permanent failure are
23319 logged, but are not included in the bounce message, which merely contains
23320 &"local delivery failed"&.
23321
23322 If the command exits on a signal and the &%freeze_signal%& option is set then
23323 the message will be frozen in the queue. If that option is not set, a bounce
23324 will be sent as normal.
23325
23326 If the return code is greater than 128 and the command being run is a shell
23327 script, it normally means that the script was terminated by a signal whose
23328 value is the return code minus 128. The &%freeze_signal%& option does not
23329 apply in this case.
23330
23331 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23332 return code is set to 127. This is the value that a shell returns if it is
23333 asked to run a non-existent command. The wording for the log line suggests that
23334 a non-existent command may be the problem.
23335
23336 The &%return_output%& option can affect the result of a pipe delivery. If it is
23337 set and the command produces any output on its standard output or standard
23338 error streams, the command is considered to have failed, even if it gave a zero
23339 return code or if &%ignore_status%& is set. The output from the command is
23340 included as part of the bounce message. The &%return_fail_output%& option is
23341 similar, except that output is returned only when the command exits with a
23342 failure return code, that is, a value other than zero or a code that matches
23343 &%temp_errors%&.
23344
23345
23346
23347 .section "How the command is run" "SECThowcommandrun"
23348 .cindex "&(pipe)& transport" "path for command"
23349 The command line is (by default) broken down into a command name and arguments
23350 by the &(pipe)& transport itself. The &%allow_commands%& and
23351 &%restrict_to_path%& options can be used to restrict the commands that may be
23352 run.
23353
23354 .cindex "quoting" "in pipe command"
23355 Unquoted arguments are delimited by white space. If an argument appears in
23356 double quotes, backslash is interpreted as an escape character in the usual
23357 way. If an argument appears in single quotes, no escaping is done.
23358
23359 String expansion is applied to the command line except when it comes from a
23360 traditional &_.forward_& file (commands from a filter file are expanded). The
23361 expansion is applied to each argument in turn rather than to the whole line.
23362 For this reason, any string expansion item that contains white space must be
23363 quoted so as to be contained within a single argument. A setting such as
23364 .code
23365 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23366 .endd
23367 will not work, because the expansion item gets split between several
23368 arguments. You have to write
23369 .code
23370 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23371 .endd
23372 to ensure that it is all in one argument. The expansion is done in this way,
23373 argument by argument, so that the number of arguments cannot be changed as a
23374 result of expansion, and quotes or backslashes in inserted variables do not
23375 interact with external quoting. However, this leads to problems if you want to
23376 generate multiple arguments (or the command name plus arguments) from a single
23377 expansion. In this situation, the simplest solution is to use a shell. For
23378 example:
23379 .code
23380 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23381 .endd
23382
23383 .cindex "transport" "filter"
23384 .cindex "filter" "transport filter"
23385 .vindex "&$pipe_addresses$&"
23386 Special handling takes place when an argument consists of precisely the text
23387 &`$pipe_addresses`&. This is not a general expansion variable; the only
23388 place this string is recognized is when it appears as an argument for a pipe or
23389 transport filter command. It causes each address that is being handled to be
23390 inserted in the argument list at that point &'as a separate argument'&. This
23391 avoids any problems with spaces or shell metacharacters, and is of use when a
23392 &(pipe)& transport is handling groups of addresses in a batch.
23393
23394 If &%force_command%& is enabled on the transport, Special handling takes place
23395 for an argument that consists of precisely the text &`$address_pipe`&.  It
23396 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23397 argument is inserted in the argument list at that point
23398 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23399 the only item in the argument; in fact, if it were then &%force_command%&
23400 should behave as a no-op.  Rather, it should be used to adjust the command
23401 run while preserving the argument vector separation.
23402
23403 After splitting up into arguments and expansion, the resulting command is run
23404 in a subprocess directly from the transport, &'not'& under a shell. The
23405 message that is being delivered is supplied on the standard input, and the
23406 standard output and standard error are both connected to a single pipe that is
23407 read by Exim. The &%max_output%& option controls how much output the command
23408 may produce, and the &%return_output%& and &%return_fail_output%& options
23409 control what is done with it.
23410
23411 Not running the command under a shell (by default) lessens the security risks
23412 in cases when a command from a user's filter file is built out of data that was
23413 taken from an incoming message. If a shell is required, it can of course be
23414 explicitly specified as the command to be run. However, there are circumstances
23415 where existing commands (for example, in &_.forward_& files) expect to be run
23416 under a shell and cannot easily be modified. To allow for these cases, there is
23417 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23418 works. Instead of breaking up the command line as just described, it expands it
23419 as a single string and passes the result to &_/bin/sh_&. The
23420 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23421 with &%use_shell%&, and the whole mechanism is inherently less secure.
23422
23423
23424
23425 .section "Environment variables" "SECTpipeenv"
23426 .cindex "&(pipe)& transport" "environment for command"
23427 .cindex "environment" "&(pipe)& transport"
23428 The environment variables listed below are set up when the command is invoked.
23429 This list is a compromise for maximum compatibility with other MTAs. Note that
23430 the &%environment%& option can be used to add additional variables to this
23431 environment. The environment for the &(pipe)& transport is not subject
23432 to the &%add_environment%& and &%keep_environment%& main config options.
23433 .display
23434 &`DOMAIN            `&   the domain of the address
23435 &`HOME              `&   the home directory, if set
23436 &`HOST              `&   the host name when called from a router (see below)
23437 &`LOCAL_PART        `&   see below
23438 &`LOCAL_PART_PREFIX `&   see below
23439 &`LOCAL_PART_SUFFIX `&   see below
23440 &`LOGNAME           `&   see below
23441 &`MESSAGE_ID        `&   Exim's local ID for the message
23442 &`PATH              `&   as specified by the &%path%& option below
23443 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23444 &`RECIPIENT         `&   the complete recipient address
23445 &`SENDER            `&   the sender of the message (empty if a bounce)
23446 &`SHELL             `&   &`/bin/sh`&
23447 &`TZ                `&   the value of the &%timezone%& option, if set
23448 &`USER              `&   see below
23449 .endd
23450 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23451 router, LOCAL_PART is set to the local part of the address. When it is
23452 called as a result of a forward or alias expansion, LOCAL_PART is set to
23453 the local part of the address that was expanded. In both cases, any affixes are
23454 removed from the local part, and made available in LOCAL_PART_PREFIX and
23455 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23456 same value as LOCAL_PART for compatibility with other MTAs.
23457
23458 .cindex "HOST"
23459 HOST is set only when a &(pipe)& transport is called from a router that
23460 associates hosts with an address, typically when using &(pipe)& as a
23461 pseudo-remote transport. HOST is set to the first host name specified by
23462 the router.
23463
23464 .cindex "HOME"
23465 If the transport's generic &%home_directory%& option is set, its value is used
23466 for the HOME environment variable. Otherwise, a home directory may be set
23467 by the router's &%transport_home_directory%& option, which defaults to the
23468 user's home directory if &%check_local_user%& is set.
23469
23470
23471 .section "Private options for pipe" "SECID142"
23472 .cindex "options" "&(pipe)& transport"
23473
23474
23475
23476 .option allow_commands pipe "string list&!!" unset
23477 .cindex "&(pipe)& transport" "permitted commands"
23478 The string is expanded, and is then interpreted as a colon-separated list of
23479 permitted commands. If &%restrict_to_path%& is not set, the only commands
23480 permitted are those in the &%allow_commands%& list. They need not be absolute
23481 paths; the &%path%& option is still used for relative paths. If
23482 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23483 in the &%allow_commands%& list, or a name without any slashes that is found on
23484 the path. In other words, if neither &%allow_commands%& nor
23485 &%restrict_to_path%& is set, there is no restriction on the command, but
23486 otherwise only commands that are permitted by one or the other are allowed. For
23487 example, if
23488 .code
23489 allow_commands = /usr/bin/vacation
23490 .endd
23491 and &%restrict_to_path%& is not set, the only permitted command is
23492 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23493 &%use_shell%& is set.
23494
23495
23496 .option batch_id pipe string&!! unset
23497 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23498
23499
23500 .option batch_max pipe integer 1
23501 This limits the number of addresses that can be handled in a single delivery.
23502 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23503
23504
23505 .option check_string pipe string unset
23506 As &(pipe)& writes the message, the start of each line is tested for matching
23507 &%check_string%&, and if it does, the initial matching characters are replaced
23508 by the contents of &%escape_string%&, provided both are set. The value of
23509 &%check_string%& is a literal string, not a regular expression, and the case of
23510 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23511 of &%check_string%& and &%escape_string%& are forced to values that implement
23512 the SMTP escaping protocol. Any settings made in the configuration file are
23513 ignored.
23514
23515
23516 .option command pipe string&!! unset
23517 This option need not be set when &(pipe)& is being used to deliver to pipes
23518 obtained directly from address redirections. In other cases, the option must be
23519 set, to provide a command to be run. It need not yield an absolute path (see
23520 the &%path%& option below). The command is split up into separate arguments by
23521 Exim, and each argument is separately expanded, as described in section
23522 &<<SECThowcommandrun>>& above.
23523
23524
23525 .option environment pipe string&!! unset
23526 .cindex "&(pipe)& transport" "environment for command"
23527 .cindex "environment" "&(pipe)& transport"
23528 This option is used to add additional variables to the environment in which the
23529 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23530 a string which is expanded, and then interpreted as a colon-separated list of
23531 environment settings of the form <&'name'&>=<&'value'&>.
23532
23533
23534 .option escape_string pipe string unset
23535 See &%check_string%& above.
23536
23537
23538 .option freeze_exec_fail pipe boolean false
23539 .cindex "exec failure"
23540 .cindex "failure of exec"
23541 .cindex "&(pipe)& transport" "failure of exec"
23542 Failure to exec the command in a pipe transport is by default treated like
23543 any other failure while running the command. However, if &%freeze_exec_fail%&
23544 is set, failure to exec is treated specially, and causes the message to be
23545 frozen, whatever the setting of &%ignore_status%&.
23546
23547
23548 .option freeze_signal pipe boolean false
23549 .cindex "signal exit"
23550 .cindex "&(pipe)& transport", "signal exit"
23551 Normally if the process run by a command in a pipe transport exits on a signal,
23552 a bounce message is sent. If &%freeze_signal%& is set, the message will be
23553 frozen in Exim's queue instead.
23554
23555
23556 .option force_command pipe boolean false
23557 .cindex "force command"
23558 .cindex "&(pipe)& transport", "force command"
23559 Normally when a router redirects an address directly to a pipe command
23560 the &%command%& option on the transport is ignored.  If &%force_command%&
23561 is set, the &%command%& option will used. This is especially
23562 useful for forcing a wrapper or additional argument to be added to the
23563 command. For example:
23564 .code
23565 command = /usr/bin/remote_exec myhost -- $address_pipe
23566 force_command
23567 .endd
23568
23569 Note that &$address_pipe$& is handled specially in &%command%& when
23570 &%force_command%& is set, expanding out to the original argument vector as
23571 separate items, similarly to a Unix shell &`"$@"`& construct.
23572
23573
23574 .option ignore_status pipe boolean false
23575 If this option is true, the status returned by the subprocess that is set up to
23576 run the command is ignored, and Exim behaves as if zero had been returned.
23577 Otherwise, a non-zero status or termination by signal causes an error return
23578 from the transport unless the status value is one of those listed in
23579 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23580
23581 &*Note*&: This option does not apply to timeouts, which do not return a status.
23582 See the &%timeout_defer%& option for how timeouts are handled.
23583
23584
23585 .option log_defer_output pipe boolean false
23586 .cindex "&(pipe)& transport" "logging output"
23587 If this option is set, and the status returned by the command is
23588 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
23589 and any output was produced on stdout or stderr, the first line of it is
23590 written to the main log.
23591
23592
23593 .option log_fail_output pipe boolean false
23594 If this option is set, and the command returns any output on stdout or
23595 stderr, and also ends with a return code that is neither zero nor one of
23596 the return codes listed in &%temp_errors%& (that is, the delivery
23597 failed), the first line of output is written to the main log. This
23598 option and &%log_output%& are mutually exclusive.  Only one of them may
23599 be set.
23600
23601
23602 .option log_output pipe boolean false
23603 If this option is set and the command returns any output on stdout or
23604 stderr, the first line of output is written to the main log, whatever
23605 the return code. This option and &%log_fail_output%& are mutually
23606 exclusive. Only one of them may be set.
23607
23608
23609 .option max_output pipe integer 20K
23610 This specifies the maximum amount of output that the command may produce on its
23611 standard output and standard error file combined. If the limit is exceeded, the
23612 process running the command is killed. This is intended as a safety measure to
23613 catch runaway processes. The limit is applied independently of the settings of
23614 the options that control what is done with such output (for example,
23615 &%return_output%&). Because of buffering effects, the amount of output may
23616 exceed the limit by a small amount before Exim notices.
23617
23618
23619 .option message_prefix pipe string&!! "see below"
23620 The string specified here is expanded and output at the start of every message.
23621 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23622 .code
23623 message_prefix = \
23624   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23625   ${tod_bsdinbox}\n
23626 .endd
23627 .cindex "Cyrus"
23628 .cindex "&%tmail%&"
23629 .cindex "&""From""& line"
23630 This is required by the commonly used &_/usr/bin/vacation_& program.
23631 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23632 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23633 setting
23634 .code
23635 message_prefix =
23636 .endd
23637 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23638 &`\n`& to &`\r\n`& in &%message_prefix%&.
23639
23640
23641 .option message_suffix pipe string&!! "see below"
23642 The string specified here is expanded and output at the end of every message.
23643 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23644 The suffix can be suppressed by setting
23645 .code
23646 message_suffix =
23647 .endd
23648 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23649 &`\n`& to &`\r\n`& in &%message_suffix%&.
23650
23651
23652 .option path pipe string&!! "/bin:/usr/bin"
23653 This option is expanded and
23654 specifies the string that is set up in the PATH environment
23655 variable of the subprocess.
23656 If the &%command%& option does not yield an absolute path name, the command is
23657 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23658 apply to a command specified as a transport filter.
23659
23660
23661 .option permit_coredump pipe boolean false
23662 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23663 a core-dump of a pipe command, enable this command.  This enables core-dumps
23664 during delivery and affects both the Exim binary and the pipe command run.
23665 It is recommended that this option remain off unless and until you have a need
23666 for it and that this only be enabled when needed, as the risk of excessive
23667 resource consumption can be quite high.  Note also that Exim is typically
23668 installed as a setuid binary and most operating systems will inhibit coredumps
23669 of these by default, so further OS-specific action may be required.
23670
23671
23672 .option pipe_as_creator pipe boolean false
23673 .cindex "uid (user id)" "local delivery"
23674 If the generic &%user%& option is not set and this option is true, the delivery
23675 process is run under the uid that was in force when Exim was originally called
23676 to accept the message. If the group id is not otherwise set (via the generic
23677 &%group%& option), the gid that was in force when Exim was originally called to
23678 accept the message is used.
23679
23680
23681 .option restrict_to_path pipe boolean false
23682 When this option is set, any command name not listed in &%allow_commands%& must
23683 contain no slashes. The command is searched for only in the directories listed
23684 in the &%path%& option. This option is intended for use in the case when a pipe
23685 command has been generated from a user's &_.forward_& file. This is usually
23686 handled by a &(pipe)& transport called &%address_pipe%&.
23687
23688
23689 .option return_fail_output pipe boolean false
23690 If this option is true, and the command produced any output and ended with a
23691 return code other than zero or one of the codes listed in &%temp_errors%& (that
23692 is, the delivery failed), the output is returned in the bounce message.
23693 However, if the message has a null sender (that is, it is itself a bounce
23694 message), output from the command is discarded. This option and
23695 &%return_output%& are mutually exclusive. Only one of them may be set.
23696
23697
23698
23699 .option return_output pipe boolean false
23700 If this option is true, and the command produced any output, the delivery is
23701 deemed to have failed whatever the return code from the command, and the output
23702 is returned in the bounce message. Otherwise, the output is just discarded.
23703 However, if the message has a null sender (that is, it is a bounce message),
23704 output from the command is always discarded, whatever the setting of this
23705 option. This option and &%return_fail_output%& are mutually exclusive. Only one
23706 of them may be set.
23707
23708
23709
23710 .option temp_errors pipe "string list" "see below"
23711 .cindex "&(pipe)& transport" "temporary failure"
23712 This option contains either a colon-separated list of numbers, or a single
23713 asterisk. If &%ignore_status%& is false
23714 and &%return_output%& is not set,
23715 and the command exits with a non-zero return code, the failure is treated as
23716 temporary and the delivery is deferred if the return code matches one of the
23717 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
23718 codes are treated as permanent errors. The default setting contains the codes
23719 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
23720 compiled on a system that does not define these macros, it assumes values of 75
23721 and 73, respectively.
23722
23723
23724 .option timeout pipe time 1h
23725 If the command fails to complete within this time, it is killed. This normally
23726 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
23727 specifies no timeout. In order to ensure that any subprocesses created by the
23728 command are also killed, Exim makes the initial process a process group leader,
23729 and kills the whole process group on a timeout. However, this can be defeated
23730 if one of the processes starts a new process group.
23731
23732 .option timeout_defer pipe boolean false
23733 A timeout in a &(pipe)& transport, either in the command that the transport
23734 runs, or in a transport filter that is associated with it, is by default
23735 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
23736 is set true, both kinds of timeout become temporary errors, causing the
23737 delivery to be deferred.
23738
23739 .option umask pipe "octal integer" 022
23740 This specifies the umask setting for the subprocess that runs the command.
23741
23742
23743 .option use_bsmtp pipe boolean false
23744 .cindex "envelope sender"
23745 If this option is set true, the &(pipe)& transport writes messages in &"batch
23746 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
23747 commands. If you want to include a leading HELO command with such messages,
23748 you can do so by setting the &%message_prefix%& option. See section
23749 &<<SECTbatchSMTP>>& for details of batch SMTP.
23750
23751 .option use_classresources pipe boolean false
23752 .cindex "class resources (BSD)"
23753 This option is available only when Exim is running on FreeBSD, NetBSD, or
23754 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
23755 resource limits when a &(pipe)& transport is run to perform a delivery. The
23756 limits for the uid under which the pipe is to run are obtained from the login
23757 class database.
23758
23759
23760 .option use_crlf pipe boolean false
23761 .cindex "carriage return"
23762 .cindex "linefeed"
23763 This option causes lines to be terminated with the two-character CRLF sequence
23764 (carriage return, linefeed) instead of just a linefeed character. In the case
23765 of batched SMTP, the byte sequence written to the pipe is then an exact image
23766 of what would be sent down a real SMTP connection.
23767
23768 The contents of the &%message_prefix%& and &%message_suffix%& options are
23769 written verbatim, so must contain their own carriage return characters if these
23770 are needed. When &%use_bsmtp%& is not set, the default values for both
23771 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
23772 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
23773
23774
23775 .option use_shell pipe boolean false
23776 .vindex "&$pipe_addresses$&"
23777 If this option is set, it causes the command to be passed to &_/bin/sh_&
23778 instead of being run directly from the transport, as described in section
23779 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
23780 where the command is expected to be run under a shell and cannot easily be
23781 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
23782 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
23783 command is expanded as a single string, and handed to &_/bin/sh_& as data for
23784 its &%-c%& option.
23785
23786
23787
23788 .section "Using an external local delivery agent" "SECID143"
23789 .cindex "local delivery" "using an external agent"
23790 .cindex "&'procmail'&"
23791 .cindex "external local delivery"
23792 .cindex "delivery" "&'procmail'&"
23793 .cindex "delivery" "by external agent"
23794 The &(pipe)& transport can be used to pass all messages that require local
23795 delivery to a separate local delivery agent such as &%procmail%&. When doing
23796 this, care must be taken to ensure that the pipe is run under an appropriate
23797 uid and gid. In some configurations one wants this to be a uid that is trusted
23798 by the delivery agent to supply the correct sender of the message. It may be
23799 necessary to recompile or reconfigure the delivery agent so that it trusts an
23800 appropriate user. The following is an example transport and router
23801 configuration for &%procmail%&:
23802 .code
23803 # transport
23804 procmail_pipe:
23805   driver = pipe
23806   command = /usr/local/bin/procmail -d $local_part
23807   return_path_add
23808   delivery_date_add
23809   envelope_to_add
23810   check_string = "From "
23811   escape_string = ">From "
23812   umask = 077
23813   user = $local_part
23814   group = mail
23815
23816 # router
23817 procmail:
23818   driver = accept
23819   check_local_user
23820   transport = procmail_pipe
23821 .endd
23822 In this example, the pipe is run as the local user, but with the group set to
23823 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
23824 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
23825 user to supply a correct sender address. If you do not specify either a
23826 &%group%& or a &%user%& option, the pipe command is run as the local user. The
23827 home directory is the user's home directory by default.
23828
23829 &*Note*&: The command that the pipe transport runs does &'not'& begin with
23830 .code
23831 IFS=" "
23832 .endd
23833 as shown in some &%procmail%& documentation, because Exim does not by default
23834 use a shell to run pipe commands.
23835
23836 .cindex "Cyrus"
23837 The next example shows a transport and a router for a system where local
23838 deliveries are handled by the Cyrus IMAP server.
23839 .code
23840 # transport
23841 local_delivery_cyrus:
23842   driver = pipe
23843   command = /usr/cyrus/bin/deliver \
23844             -m ${substr_1:$local_part_suffix} -- $local_part
23845   user = cyrus
23846   group = mail
23847   return_output
23848   log_output
23849   message_prefix =
23850   message_suffix =
23851
23852 # router
23853 local_user_cyrus:
23854   driver = accept
23855   check_local_user
23856   local_part_suffix = .*
23857   transport = local_delivery_cyrus
23858 .endd
23859 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
23860 &%return_output%& to cause any text written by Cyrus to be returned to the
23861 sender.
23862 .ecindex IIDpiptra1
23863 .ecindex IIDpiptra2
23864
23865
23866 . ////////////////////////////////////////////////////////////////////////////
23867 . ////////////////////////////////////////////////////////////////////////////
23868
23869 .chapter "The smtp transport" "CHAPsmtptrans"
23870 .scindex IIDsmttra1 "transports" "&(smtp)&"
23871 .scindex IIDsmttra2 "&(smtp)& transport"
23872 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
23873 or LMTP protocol. The list of hosts to try can either be taken from the address
23874 that is being processed (having been set up by the router), or specified
23875 explicitly for the transport. Timeout and retry processing (see chapter
23876 &<<CHAPretry>>&) is applied to each IP address independently.
23877
23878
23879 .section "Multiple messages on a single connection" "SECID144"
23880 The sending of multiple messages over a single TCP/IP connection can arise in
23881 two ways:
23882
23883 .ilist
23884 If a message contains more than &%max_rcpt%& (see below) addresses that are
23885 routed to the same host, more than one copy of the message has to be sent to
23886 that host. In this situation, multiple copies may be sent in a single run of
23887 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
23888 does when it has too many addresses to send in one message also depends on the
23889 value of the global &%remote_max_parallel%& option. Details are given in
23890 section &<<SECToutSMTPTCP>>&.)
23891 .next
23892 .cindex "hints database" "remembering routing"
23893 When a message has been successfully delivered over a TCP/IP connection, Exim
23894 looks in its hints database to see if there are any other messages awaiting a
23895 connection to the same host. If there are, a new delivery process is started
23896 for one of them, and the current TCP/IP connection is passed on to it. The new
23897 process may in turn send multiple copies and possibly create yet another
23898 process.
23899 .endlist
23900
23901
23902 For each copy sent over the same TCP/IP connection, a sequence counter is
23903 incremented, and if it ever gets to the value of &%connection_max_messages%&,
23904 no further messages are sent over that connection.
23905
23906
23907
23908 .section "Use of the $host and $host_address variables" "SECID145"
23909 .vindex "&$host$&"
23910 .vindex "&$host_address$&"
23911 At the start of a run of the &(smtp)& transport, the values of &$host$& and
23912 &$host_address$& are the name and IP address of the first host on the host list
23913 passed by the router. However, when the transport is about to connect to a
23914 specific host, and while it is connected to that host, &$host$& and
23915 &$host_address$& are set to the values for that host. These are the values
23916 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
23917 &%serialize_hosts%&, and the various TLS options are expanded.
23918
23919
23920 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
23921 .vindex &$tls_bits$&
23922 .vindex &$tls_cipher$&
23923 .vindex &$tls_peerdn$&
23924 .vindex &$tls_sni$&
23925 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
23926 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
23927 are the values that were set when the message was received.
23928 These are the values that are used for options that are expanded before any
23929 SMTP connections are made. Just before each connection is made, these four
23930 variables are emptied. If TLS is subsequently started, they are set to the
23931 appropriate values for the outgoing connection, and these are the values that
23932 are in force when any authenticators are run and when the
23933 &%authenticated_sender%& option is expanded.
23934
23935 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23936 and will be removed in a future release.
23937
23938
23939 .section "Private options for smtp" "SECID146"
23940 .cindex "options" "&(smtp)& transport"
23941 The private options of the &(smtp)& transport are as follows:
23942
23943
23944 .option address_retry_include_sender smtp boolean true
23945 .cindex "4&'xx'& responses" "retrying after"
23946 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23947 is the combination of sender and recipient that is delayed in subsequent queue
23948 runs until the retry time is reached. You can delay the recipient without
23949 reference to the sender (which is what earlier versions of Exim did), by
23950 setting &%address_retry_include_sender%& false. However, this can lead to
23951 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
23952
23953 .option allow_localhost smtp boolean false
23954 .cindex "local host" "sending to"
23955 .cindex "fallback" "hosts specified on transport"
23956 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
23957 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
23958 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
23959 the delivery anyway. This should be used only in special cases when the
23960 configuration ensures that no looping will result (for example, a differently
23961 configured Exim is listening on the port to which the message is sent).
23962
23963
23964 .option authenticated_sender smtp string&!! unset
23965 .cindex "Cyrus"
23966 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
23967 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
23968 overriding any existing authenticated sender value. If the string expansion is
23969 forced to fail, the option is ignored. Other expansion failures cause delivery
23970 to be deferred. If the result of expansion is an empty string, that is also
23971 ignored.
23972
23973 The expansion happens after the outgoing connection has been made and TLS
23974 started, if required. This means that the &$host$&, &$host_address$&,
23975 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23976 particular connection.
23977
23978 If the SMTP session is not authenticated, the expansion of
23979 &%authenticated_sender%& still happens (and can cause the delivery to be
23980 deferred if it fails), but no AUTH= item is added to MAIL commands
23981 unless &%authenticated_sender_force%& is true.
23982
23983 This option allows you to use the &(smtp)& transport in LMTP mode to
23984 deliver mail to Cyrus IMAP and provide the proper local part as the
23985 &"authenticated sender"&, via a setting such as:
23986 .code
23987 authenticated_sender = $local_part
23988 .endd
23989 This removes the need for IMAP subfolders to be assigned special ACLs to
23990 allow direct delivery to those subfolders.
23991
23992 Because of expected uses such as that just described for Cyrus (when no
23993 domain is involved), there is no checking on the syntax of the provided
23994 value.
23995
23996
23997 .option authenticated_sender_force smtp boolean false
23998 If this option is set true, the &%authenticated_sender%& option's value
23999 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24000 authenticated as a client.
24001
24002
24003 .option command_timeout smtp time 5m
24004 This sets a timeout for receiving a response to an SMTP command that has been
24005 sent out. It is also used when waiting for the initial banner line from the
24006 remote host. Its value must not be zero.
24007
24008
24009 .option connect_timeout smtp time 5m
24010 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24011 to a remote host. A setting of zero allows the system timeout (typically
24012 several minutes) to act. To have any effect, the value of this option must be
24013 less than the system timeout. However, it has been observed that on some
24014 systems there is no system timeout, which is why the default value for this
24015 option is 5 minutes, a value recommended by RFC 1123.
24016
24017
24018 .option connection_max_messages smtp integer 500
24019 .cindex "SMTP" "passed connection"
24020 .cindex "SMTP" "multiple deliveries"
24021 .cindex "multiple SMTP deliveries"
24022 This controls the maximum number of separate message deliveries that are sent
24023 over a single TCP/IP connection. If the value is zero, there is no limit.
24024 For testing purposes, this value can be overridden by the &%-oB%& command line
24025 option.
24026
24027
24028 .option dane_require_tls_ciphers smtp string&!! unset
24029 .cindex "TLS" "requiring specific ciphers for DANE"
24030 .cindex "cipher" "requiring specific"
24031 .cindex DANE "TLS ciphers"
24032 This option may be used to override &%tls_require_ciphers%& for connections
24033 where DANE has been determined to be in effect.
24034 If not set, then &%tls_require_ciphers%& will be used.
24035 Normal SMTP delivery is not able to make strong demands of TLS cipher
24036 configuration, because delivery will fall back to plaintext.  Once DANE has
24037 been determined to be in effect, there is no plaintext fallback and making the
24038 TLS cipherlist configuration stronger will increase security, rather than
24039 counter-intuitively decreasing it.
24040 If the option expands to be empty or is forced to fail, then it will
24041 be treated as unset and &%tls_require_ciphers%& will be used instead.
24042
24043
24044 .option data_timeout smtp time 5m
24045 This sets a timeout for the transmission of each block in the data portion of
24046 the message. As a result, the overall timeout for a message depends on the size
24047 of the message. Its value must not be zero. See also &%final_timeout%&.
24048
24049
24050 .option dkim_canon smtp string&!! unset
24051 .option dkim_domain smtp string list&!! unset
24052 .option dkim_hash smtp string&!! sha256
24053 .option dkim_identity smtp string&!! unset
24054 .option dkim_private_key smtp string&!! unset
24055 .option dkim_selector smtp string&!! unset
24056 .option dkim_strict smtp string&!! unset
24057 .option dkim_sign_headers smtp string&!! "per RFC"
24058 .option dkim_timestamps smtp string&!! unset
24059 DKIM signing options.  For details see section &<<SECDKIMSIGN>>&.
24060
24061
24062 .option delay_after_cutoff smtp boolean true
24063 This option controls what happens when all remote IP addresses for a given
24064 domain have been inaccessible for so long that they have passed their retry
24065 cutoff times.
24066
24067 In the default state, if the next retry time has not been reached for any of
24068 them, the address is bounced without trying any deliveries. In other words,
24069 Exim delays retrying an IP address after the final cutoff time until a new
24070 retry time is reached, and can therefore bounce an address without ever trying
24071 a delivery, when machines have been down for a long time. Some people are
24072 unhappy at this prospect, so...
24073
24074 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24075 addresses are past their final cutoff time, Exim tries to deliver to those
24076 IP addresses that have not been tried since the message arrived. If there are
24077 none, of if they all fail, the address is bounced. In other words, it does not
24078 delay when a new message arrives, but immediately tries those expired IP
24079 addresses that haven't been tried since the message arrived. If there is a
24080 continuous stream of messages for the dead hosts, unsetting
24081 &%delay_after_cutoff%& means that there will be many more attempts to deliver
24082 to them.
24083
24084
24085 .option dns_qualify_single smtp boolean true
24086 If the &%hosts%& or &%fallback_hosts%& option is being used,
24087 and the &%gethostbyname%& option is false,
24088 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
24089 in chapter &<<CHAPdnslookup>>& for more details.
24090
24091
24092 .option dns_search_parents smtp boolean false
24093 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
24094 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
24095 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
24096 details.
24097
24098
24099 .option dnssec_request_domains smtp "domain list&!!" unset
24100 .cindex "MX record" "security"
24101 .cindex "DNSSEC" "MX lookup"
24102 .cindex "security" "MX lookup"
24103 .cindex "DNS" "DNSSEC"
24104 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
24105 the dnssec request bit set.
24106 This applies to all of the SRV, MX, AAAA, A lookup sequence.
24107
24108
24109
24110 .option dnssec_require_domains smtp "domain list&!!" unset
24111 .cindex "MX record" "security"
24112 .cindex "DNSSEC" "MX lookup"
24113 .cindex "security" "MX lookup"
24114 .cindex "DNS" "DNSSEC"
24115 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
24116 the dnssec request bit set.  Any returns not having the Authenticated Data bit
24117 (AD bit) set will be ignored and logged as a host-lookup failure.
24118 This applies to all of the SRV, MX, AAAA, A lookup sequence.
24119
24120
24121
24122 .option dscp smtp string&!! unset
24123 .cindex "DCSP" "outbound"
24124 This option causes the DSCP value associated with a socket to be set to one
24125 of a number of fixed strings or to numeric value.
24126 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
24127 Common values include &`throughput`&, &`mincost`&, and on newer systems
24128 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
24129
24130 The outbound packets from Exim will be marked with this value in the header
24131 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
24132 that these values will have any effect, not be stripped by networking
24133 equipment, or do much of anything without cooperation with your Network
24134 Engineer and those of all network operators between the source and destination.
24135
24136
24137 .option fallback_hosts smtp "string list" unset
24138 .cindex "fallback" "hosts specified on transport"
24139 String expansion is not applied to this option. The argument must be a
24140 colon-separated list of host names or IP addresses, optionally also including
24141 port numbers, though the separator can be changed, as described in section
24142 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24143 item in a &%route_list%& setting for the &(manualroute)& router, as described
24144 in section &<<SECTformatonehostitem>>&.
24145
24146 Fallback hosts can also be specified on routers, which associate them with the
24147 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
24148 &%fallback_hosts%& specified on the transport is used only if the address does
24149 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
24150 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
24151 However, &%hosts_randomize%& does apply to fallback host lists.
24152
24153 If Exim is unable to deliver to any of the hosts for a particular address, and
24154 the errors are not permanent rejections, the address is put on a separate
24155 transport queue with its host list replaced by the fallback hosts, unless the
24156 address was routed via MX records and the current host was in the original MX
24157 list. In that situation, the fallback host list is not used.
24158
24159 Once normal deliveries are complete, the fallback queue is delivered by
24160 re-running the same transports with the new host lists. If several failing
24161 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
24162 copy of the message is sent.
24163
24164 The resolution of the host names on the fallback list is controlled by the
24165 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
24166 both to cases when the host list comes with the address and when it is taken
24167 from &%hosts%&. This option provides a &"use a smart host only if delivery
24168 fails"& facility.
24169
24170
24171 .option final_timeout smtp time 10m
24172 This is the timeout that applies while waiting for the response to the final
24173 line containing just &"."& that terminates a message. Its value must not be
24174 zero.
24175
24176 .option gethostbyname smtp boolean false
24177 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
24178 being used, names are looked up using &[gethostbyname()]&
24179 (or &[getipnodebyname()]& when available)
24180 instead of using the DNS. Of course, that function may in fact use the DNS, but
24181 it may also consult other sources of information such as &_/etc/hosts_&.
24182
24183 .option gnutls_compat_mode smtp boolean unset
24184 This option controls whether GnuTLS is used in compatibility mode in an Exim
24185 server. This reduces security slightly, but improves interworking with older
24186 implementations of TLS.
24187
24188 .option helo_data smtp string&!! "see below"
24189 .cindex "HELO" "argument, setting"
24190 .cindex "EHLO" "argument, setting"
24191 .cindex "LHLO argument setting"
24192 The value of this option is expanded after a connection to a another host has
24193 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
24194 command that starts the outgoing SMTP or LMTP session. The default value of the
24195 option is:
24196 .code
24197 $primary_hostname
24198 .endd
24199 During the expansion, the variables &$host$& and &$host_address$& are set to
24200 the identity of the remote host, and the variables &$sending_ip_address$& and
24201 &$sending_port$& are set to the local IP address and port number that are being
24202 used. These variables can be used to generate different values for different
24203 servers or different local IP addresses. For example, if you want the string
24204 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
24205 interface address, you could use this:
24206 .code
24207 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
24208   {$primary_hostname}}
24209 .endd
24210 The use of &%helo_data%& applies both to sending messages and when doing
24211 callouts.
24212
24213 .option hosts smtp "string list&!!" unset
24214 Hosts are associated with an address by a router such as &(dnslookup)&, which
24215 finds the hosts by looking up the address domain in the DNS, or by
24216 &(manualroute)&, which has lists of hosts in its configuration. However,
24217 email addresses can be passed to the &(smtp)& transport by any router, and not
24218 all of them can provide an associated list of hosts.
24219
24220 The &%hosts%& option specifies a list of hosts to be used if the address being
24221 processed does not have any hosts associated with it. The hosts specified by
24222 &%hosts%& are also used, whether or not the address has its own hosts, if
24223 &%hosts_override%& is set.
24224
24225 The string is first expanded, before being interpreted as a colon-separated
24226 list of host names or IP addresses, possibly including port numbers. The
24227 separator may be changed to something other than colon, as described in section
24228 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24229 item in a &%route_list%& setting for the &(manualroute)& router, as described
24230 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
24231 of the &(manualroute)& router is not available here.
24232
24233 If the expansion fails, delivery is deferred. Unless the failure was caused by
24234 the inability to complete a lookup, the error is logged to the panic log as
24235 well as the main log. Host names are looked up either by searching directly for
24236 address records in the DNS or by calling &[gethostbyname()]& (or
24237 &[getipnodebyname()]& when available), depending on the setting of the
24238 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
24239 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
24240 address are used.
24241
24242 During delivery, the hosts are tried in order, subject to their retry status,
24243 unless &%hosts_randomize%& is set.
24244
24245
24246 .option hosts_avoid_esmtp smtp "host list&!!" unset
24247 .cindex "ESMTP, avoiding use of"
24248 .cindex "HELO" "forcing use of"
24249 .cindex "EHLO" "avoiding use of"
24250 .cindex "PIPELINING" "avoiding the use of"
24251 This option is for use with broken hosts that announce ESMTP facilities (for
24252 example, PIPELINING) and then fail to implement them properly. When a host
24253 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
24254 start of the SMTP session. This means that it cannot use any of the ESMTP
24255 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
24256
24257
24258 .option hosts_avoid_pipelining smtp "host list&!!" unset
24259 .cindex "PIPELINING" "avoiding the use of"
24260 Exim will not use the SMTP PIPELINING extension when delivering to any host
24261 that matches this list, even if the server host advertises PIPELINING support.
24262
24263
24264 .option hosts_avoid_tls smtp "host list&!!" unset
24265 .cindex "TLS" "avoiding for certain hosts"
24266 Exim will not try to start a TLS session when delivering to any host that
24267 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24268
24269 .option hosts_verify_avoid_tls smtp "host list&!!" unset
24270 .cindex "TLS" "avoiding for certain hosts"
24271 Exim will not try to start a TLS session for a verify callout,
24272 or when delivering in cutthrough mode,
24273 to any host that matches this list.
24274
24275
24276 .option hosts_max_try smtp integer 5
24277 .cindex "host" "maximum number to try"
24278 .cindex "limit" "number of hosts tried"
24279 .cindex "limit" "number of MX tried"
24280 .cindex "MX record" "maximum tried"
24281 This option limits the number of IP addresses that are tried for any one
24282 delivery in cases where there are temporary delivery errors. Section
24283 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
24284
24285
24286 .option hosts_max_try_hardlimit smtp integer 50
24287 This is an additional check on the maximum number of IP addresses that Exim
24288 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
24289 why it exists.
24290
24291
24292
24293 .option hosts_nopass_tls smtp "host list&!!" unset
24294 .cindex "TLS" "passing connection"
24295 .cindex "multiple SMTP deliveries"
24296 .cindex "TLS" "multiple message deliveries"
24297 For any host that matches this list, a connection on which a TLS session has
24298 been started will not be passed to a new delivery process for sending another
24299 message on the same connection. See section &<<SECTmulmessam>>& for an
24300 explanation of when this might be needed.
24301
24302 .option hosts_noproxy_tls smtp "host list&!!" *
24303 .cindex "TLS" "passing connection"
24304 .cindex "multiple SMTP deliveries"
24305 .cindex "TLS" "multiple message deliveries"
24306 For any host that matches this list, a TLS session which has
24307 been started will not be passed to a new delivery process for sending another
24308 message on the same session.
24309
24310 The traditional implementation closes down TLS and re-starts it in the new
24311 process, on the same open TCP connection, for each successive message
24312 sent.  If permitted by this option a pipe to to the new process is set up
24313 instead, and the original process maintains the TLS connection and proxies
24314 the SMTP connection from and to the new process and any subsequents.
24315 The new process has no access to TLS information, so cannot include it in
24316 logging.
24317
24318
24319
24320 .option hosts_override smtp boolean false
24321 If this option is set and the &%hosts%& option is also set, any hosts that are
24322 attached to the address are ignored, and instead the hosts specified by the
24323 &%hosts%& option are always used. This option does not apply to
24324 &%fallback_hosts%&.
24325
24326
24327 .option hosts_randomize smtp boolean false
24328 .cindex "randomized host list"
24329 .cindex "host" "list of; randomized"
24330 .cindex "fallback" "randomized hosts"
24331 If this option is set, and either the list of hosts is taken from the
24332 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
24333 were not obtained from MX records (this includes fallback hosts from the
24334 router), and were not randomized by the router, the order of trying the hosts
24335 is randomized each time the transport runs. Randomizing the order of a host
24336 list can be used to do crude load sharing.
24337
24338 When &%hosts_randomize%& is true, a host list may be split into groups whose
24339 order is separately randomized. This makes it possible to set up MX-like
24340 behaviour. The boundaries between groups are indicated by an item that is just
24341 &`+`& in the host list. For example:
24342 .code
24343 hosts = host1:host2:host3:+:host4:host5
24344 .endd
24345 The order of the first three hosts and the order of the last two hosts is
24346 randomized for each use, but the first three always end up before the last two.
24347 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24348
24349 .option hosts_require_auth smtp "host list&!!" unset
24350 .cindex "authentication" "required by client"
24351 This option provides a list of servers for which authentication must succeed
24352 before Exim will try to transfer a message. If authentication fails for
24353 servers which are not in this list, Exim tries to send unauthenticated. If
24354 authentication fails for one of these servers, delivery is deferred. This
24355 temporary error is detectable in the retry rules, so it can be turned into a
24356 hard failure if required. See also &%hosts_try_auth%&, and chapter
24357 &<<CHAPSMTPAUTH>>& for details of authentication.
24358
24359
24360 .option hosts_request_ocsp smtp "host list&!!" *
24361 .cindex "TLS" "requiring for certain servers"
24362 Exim will request a Certificate Status on a
24363 TLS session for any host that matches this list.
24364 &%tls_verify_certificates%& should also be set for the transport.
24365
24366 .option hosts_require_dane smtp "host list&!!" unset
24367 .cindex DANE "transport options"
24368 .cindex DANE "requiring for certain servers"
24369 If built with DANE support, Exim  will require that a DNSSEC-validated
24370 TLSA record is present for any host matching the list,
24371 and that a DANE-verified TLS connection is made.
24372 There will be no fallback to in-clear communication.
24373 See section &<<SECDANE>>&.
24374
24375 .option hosts_require_ocsp smtp "host list&!!" unset
24376 .cindex "TLS" "requiring for certain servers"
24377 Exim will request, and check for a valid Certificate Status being given, on a
24378 TLS session for any host that matches this list.
24379 &%tls_verify_certificates%& should also be set for the transport.
24380
24381 .option hosts_require_tls smtp "host list&!!" unset
24382 .cindex "TLS" "requiring for certain servers"
24383 Exim will insist on using a TLS session when delivering to any host that
24384 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24385 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24386 incoming messages, use an appropriate ACL.
24387
24388 .option hosts_try_auth smtp "host list&!!" unset
24389 .cindex "authentication" "optional in client"
24390 This option provides a list of servers to which, provided they announce
24391 authentication support, Exim will attempt to authenticate as a client when it
24392 connects. If authentication fails, Exim will try to transfer the message
24393 unauthenticated. See also &%hosts_require_auth%&, and chapter
24394 &<<CHAPSMTPAUTH>>& for details of authentication.
24395
24396 .option hosts_try_chunking smtp "host list&!!" *
24397 .cindex CHUNKING "enabling, in client"
24398 .cindex BDAT "SMTP command"
24399 .cindex "RFC 3030" "CHUNKING"
24400 This option provides a list of servers to which, provided they announce
24401 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24402 BDAT will not be used in conjunction with a transport filter.
24403
24404 .option hosts_try_dane smtp "host list&!!" unset
24405 .cindex DANE "transport options"
24406 .cindex DANE "attempting for certain servers"
24407 If built with DANE support, Exim  will lookup a
24408 TLSA record for any host matching the list.
24409 If found and verified by DNSSEC,
24410 a DANE-verified TLS connection is made to that host;
24411 there will be no fallback to in-clear communication.
24412 See section &<<SECDANE>>&.
24413
24414 .option hosts_try_fastopen smtp "host list&!!" unset
24415 .cindex "fast open, TCP" "enabling, in client"
24416 .cindex "TCP Fast Open" "enabling, in client"
24417 .cindex "RFC 7413" "TCP Fast Open"
24418 This option provides a list of servers to which, provided
24419 the facility is supported by this system, Exim will attempt to
24420 perform a TCP Fast Open.
24421 No data is sent on the SYN segment but, if the remote server also
24422 supports the facility, it can send its SMTP banner immediately after
24423 the SYN,ACK segment.  This can save up to one round-trip time.
24424
24425 The facility is only active for previously-contacted servers,
24426 as the initiator must present a cookie in the SYN segment.
24427
24428 On (at least some) current Linux distributions the facility must be enabled
24429 in the kernel by the sysadmin before the support is usable.
24430 There is no option for control of the server side; if the system supports
24431 it it is always enabled.  Note that lengthy operations in the connect ACL,
24432 such as DNSBL lookups, will still delay the emission of the SMTP banner.
24433
24434 .option hosts_try_prdr smtp "host list&!!" *
24435 .cindex "PRDR" "enabling, optional in client"
24436 This option provides a list of servers to which, provided they announce
24437 PRDR support, Exim will attempt to negotiate PRDR
24438 for multi-recipient messages.
24439 The option can usually be left as default.
24440
24441 .option interface smtp "string list&!!" unset
24442 .cindex "bind IP address"
24443 .cindex "IP address" "binding"
24444 .vindex "&$host$&"
24445 .vindex "&$host_address$&"
24446 This option specifies which interface to bind to when making an outgoing SMTP
24447 call. The value is an IP address, not an interface name such as
24448 &`eth0`&. Do not confuse this with the interface address that was used when a
24449 message was received, which is in &$received_ip_address$&, formerly known as
24450 &$interface_address$&. The name was changed to minimize confusion with the
24451 outgoing interface address. There is no variable that contains an outgoing
24452 interface address because, unless it is set by this option, its value is
24453 unknown.
24454
24455 During the expansion of the &%interface%& option the variables &$host$& and
24456 &$host_address$& refer to the host to which a connection is about to be made
24457 during the expansion of the string. Forced expansion failure, or an empty
24458 string result causes the option to be ignored. Otherwise, after expansion, the
24459 string must be a list of IP addresses, colon-separated by default, but the
24460 separator can be changed in the usual way. For example:
24461 .code
24462 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
24463 .endd
24464 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
24465 connection. If none of them are the correct type, the option is ignored. If
24466 &%interface%& is not set, or is ignored, the system's IP functions choose which
24467 interface to use if the host has more than one.
24468
24469
24470 .option keepalive smtp boolean true
24471 .cindex "keepalive" "on outgoing connection"
24472 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
24473 connections. When set, it causes the kernel to probe idle connections
24474 periodically, by sending packets with &"old"& sequence numbers. The other end
24475 of the connection should send a acknowledgment if the connection is still okay
24476 or a reset if the connection has been aborted. The reason for doing this is
24477 that it has the beneficial effect of freeing up certain types of connection
24478 that can get stuck when the remote host is disconnected without tidying up the
24479 TCP/IP call properly. The keepalive mechanism takes several hours to detect
24480 unreachable hosts.
24481
24482
24483 .option lmtp_ignore_quota smtp boolean false
24484 .cindex "LMTP" "ignoring quota errors"
24485 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
24486 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
24487 has advertised support for IGNOREQUOTA in its response to the LHLO command.
24488
24489 .option max_rcpt smtp integer 100
24490 .cindex "RCPT" "maximum number of outgoing"
24491 This option limits the number of RCPT commands that are sent in a single
24492 SMTP message transaction. Each set of addresses is treated independently, and
24493 so can cause parallel connections to the same host if &%remote_max_parallel%&
24494 permits this.
24495
24496
24497 .option multi_domain smtp boolean&!! true
24498 .vindex "&$domain$&"
24499 When this option is set, the &(smtp)& transport can handle a number of
24500 addresses containing a mixture of different domains provided they all resolve
24501 to the same list of hosts. Turning the option off restricts the transport to
24502 handling only one domain at a time. This is useful if you want to use
24503 &$domain$& in an expansion for the transport, because it is set only when there
24504 is a single domain involved in a remote delivery.
24505
24506 It is expanded per-address and can depend on any of
24507 &$address_data$&, &$domain_data$&, &$local_part_data$&,
24508 &$host$&, &$host_address$& and &$host_port$&.
24509
24510 .option port smtp string&!! "see below"
24511 .cindex "port" "sending TCP/IP"
24512 .cindex "TCP/IP" "setting outgoing port"
24513 This option specifies the TCP/IP port on the server to which Exim connects.
24514 &*Note:*& Do not confuse this with the port that was used when a message was
24515 received, which is in &$received_port$&, formerly known as &$interface_port$&.
24516 The name was changed to minimize confusion with the outgoing port. There is no
24517 variable that contains an outgoing port.
24518
24519 If the value of this option begins with a digit it is taken as a port number;
24520 otherwise it is looked up using &[getservbyname()]&. The default value is
24521 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
24522 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
24523 is deferred.
24524
24525
24526
24527 .option protocol smtp string smtp
24528 .cindex "LMTP" "over TCP/IP"
24529 .cindex "ssmtp protocol" "outbound"
24530 .cindex "TLS" "SSL-on-connect outbound"
24531 .vindex "&$port$&"
24532 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
24533 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
24534 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
24535 deliveries into closed message stores. Exim also has support for running LMTP
24536 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
24537
24538 If this option is set to &"smtps"&, the default value for the &%port%& option
24539 changes to &"smtps"&, and the transport initiates TLS immediately after
24540 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
24541 The Internet standards bodies strongly discourage use of this mode.
24542
24543
24544 .option retry_include_ip_address smtp boolean&!! true
24545 Exim normally includes both the host name and the IP address in the key it
24546 constructs for indexing retry data after a temporary delivery failure. This
24547 means that when one of several IP addresses for a host is failing, it gets
24548 tried periodically (controlled by the retry rules), but use of the other IP
24549 addresses is not affected.
24550
24551 However, in some dialup environments hosts are assigned a different IP address
24552 each time they connect. In this situation the use of the IP address as part of
24553 the retry key leads to undesirable behaviour. Setting this option false causes
24554 Exim to use only the host name.
24555 Since it is expanded it can be made to depend on the host or domain.
24556
24557
24558 .option serialize_hosts smtp "host list&!!" unset
24559 .cindex "serializing connections"
24560 .cindex "host" "serializing connections"
24561 Because Exim operates in a distributed manner, if several messages for the same
24562 host arrive at around the same time, more than one simultaneous connection to
24563 the remote host can occur. This is not usually a problem except when there is a
24564 slow link between the hosts. In that situation it may be helpful to restrict
24565 Exim to one connection at a time. This can be done by setting
24566 &%serialize_hosts%& to match the relevant hosts.
24567
24568 .cindex "hints database" "serializing deliveries to a host"
24569 Exim implements serialization by means of a hints database in which a record is
24570 written whenever a process connects to one of the restricted hosts. The record
24571 is deleted when the connection is completed. Obviously there is scope for
24572 records to get left lying around if there is a system or program crash. To
24573 guard against this, Exim ignores any records that are more than six hours old.
24574
24575 If you set up this kind of serialization, you should also arrange to delete the
24576 relevant hints database whenever your system reboots. The names of the files
24577 start with &_misc_& and they are kept in the &_spool/db_& directory. There
24578 may be one or two files, depending on the type of DBM in use. The same files
24579 are used for ETRN serialization.
24580
24581 See also the &%max_parallel%& generic transport option.
24582
24583
24584 .option size_addition smtp integer 1024
24585 .cindex "SMTP" "SIZE"
24586 .cindex "message" "size issue for transport filter"
24587 .cindex "size" "of message"
24588 .cindex "transport" "filter"
24589 .cindex "filter" "transport filter"
24590 If a remote SMTP server indicates that it supports the SIZE option of the
24591 MAIL command, Exim uses this to pass over the message size at the start of
24592 an SMTP transaction. It adds the value of &%size_addition%& to the value it
24593 sends, to allow for headers and other text that may be added during delivery by
24594 configuration options or in a transport filter. It may be necessary to increase
24595 this if a lot of text is added to messages.
24596
24597 Alternatively, if the value of &%size_addition%& is set negative, it disables
24598 the use of the SIZE option altogether.
24599
24600
24601 .option socks_proxy smtp string&!! unset
24602 .cindex proxy SOCKS
24603 This option enables use of SOCKS proxies for connections made by the
24604 transport.  For details see section &<<SECTproxySOCKS>>&.
24605
24606
24607 .option tls_certificate smtp string&!! unset
24608 .cindex "TLS" "client certificate, location of"
24609 .cindex "certificate" "client, location of"
24610 .vindex "&$host$&"
24611 .vindex "&$host_address$&"
24612 The value of this option must be the absolute path to a file which contains the
24613 client's certificate, for possible use when sending a message over an encrypted
24614 connection. The values of &$host$& and &$host_address$& are set to the name and
24615 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
24616 details of TLS.
24617
24618 &*Note*&: This option must be set if you want Exim to be able to use a TLS
24619 certificate when sending messages as a client. The global option of the same
24620 name specifies the certificate for Exim as a server; it is not automatically
24621 assumed that the same certificate should be used when Exim is operating as a
24622 client.
24623
24624
24625 .option tls_crl smtp string&!! unset
24626 .cindex "TLS" "client certificate revocation list"
24627 .cindex "certificate" "revocation list for client"
24628 This option specifies a certificate revocation list. The expanded value must
24629 be the name of a file that contains a CRL in PEM format.
24630
24631
24632 .option tls_dh_min_bits smtp integer 1024
24633 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
24634 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
24635 key agreement is negotiated, the server will provide a large prime number
24636 for use.  This option establishes the minimum acceptable size of that number.
24637 If the parameter offered by the server is too small, then the TLS handshake
24638 will fail.
24639
24640 Only supported when using GnuTLS.
24641
24642
24643 .option tls_privatekey smtp string&!! unset
24644 .cindex "TLS" "client private key, location of"
24645 .vindex "&$host$&"
24646 .vindex "&$host_address$&"
24647 The value of this option must be the absolute path to a file which contains the
24648 client's private key. This is used when sending a message over an encrypted
24649 connection using a client certificate. The values of &$host$& and
24650 &$host_address$& are set to the name and address of the server during the
24651 expansion. If this option is unset, or the expansion is forced to fail, or the
24652 result is an empty string, the private key is assumed to be in the same file as
24653 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
24654
24655
24656 .option tls_require_ciphers smtp string&!! unset
24657 .cindex "TLS" "requiring specific ciphers"
24658 .cindex "cipher" "requiring specific"
24659 .vindex "&$host$&"
24660 .vindex "&$host_address$&"
24661 The value of this option must be a list of permitted cipher suites, for use
24662 when setting up an outgoing encrypted connection. (There is a global option of
24663 the same name for controlling incoming connections.) The values of &$host$& and
24664 &$host_address$& are set to the name and address of the server during the
24665 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
24666 is used in different ways by OpenSSL and GnuTLS (see sections
24667 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
24668 ciphers is a preference order.
24669
24670
24671
24672 .option tls_sni smtp string&!! unset
24673 .cindex "TLS" "Server Name Indication"
24674 .vindex "&$tls_sni$&"
24675 If this option is set then it sets the $tls_out_sni variable and causes any
24676 TLS session to pass this value as the Server Name Indication extension to
24677 the remote side, which can be used by the remote side to select an appropriate
24678 certificate and private key for the session.
24679
24680 See &<<SECTtlssni>>& for more information.
24681
24682 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
24683 TLS extensions.
24684
24685
24686
24687
24688 .option tls_tempfail_tryclear smtp boolean true
24689 .cindex "4&'xx'& responses" "to STARTTLS"
24690 When the server host is not in &%hosts_require_tls%&, and there is a problem in
24691 setting up a TLS session, this option determines whether or not Exim should try
24692 to deliver the message unencrypted. If it is set false, delivery to the
24693 current host is deferred; if there are other hosts, they are tried. If this
24694 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
24695 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
24696 TLS negotiation fails, Exim closes the current connection (because it is in an
24697 unknown state), opens a new one to the same host, and then tries the delivery
24698 in clear.
24699
24700
24701 .option tls_try_verify_hosts smtp "host list&!!" *
24702 .cindex "TLS" "server certificate verification"
24703 .cindex "certificate" "verification of server"
24704 This option gives a list of hosts for which, on encrypted connections,
24705 certificate verification will be tried but need not succeed.
24706 The &%tls_verify_certificates%& option must also be set.
24707 Note that unless the host is in this list
24708 TLS connections will be denied to hosts using self-signed certificates
24709 when &%tls_verify_certificates%& is matched.
24710 The &$tls_out_certificate_verified$& variable is set when
24711 certificate verification succeeds.
24712
24713
24714 .option tls_verify_cert_hostnames smtp "host list&!!" *
24715 .cindex "TLS" "server certificate hostname verification"
24716 .cindex "certificate" "verification of server"
24717 This option give a list of hosts for which,
24718 while verifying the server certificate,
24719 checks will be included on the host name
24720 (note that this will generally be the result of a DNS MX lookup)
24721 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
24722 limited to being the initial component of a 3-or-more component FQDN.
24723
24724 There is no equivalent checking on client certificates.
24725
24726
24727 .option tls_verify_certificates smtp string&!! system
24728 .cindex "TLS" "server certificate verification"
24729 .cindex "certificate" "verification of server"
24730 .vindex "&$host$&"
24731 .vindex "&$host_address$&"
24732 The value of this option must be either the
24733 word "system"
24734 or the absolute path to
24735 a file or directory containing permitted certificates for servers,
24736 for use when setting up an encrypted connection.
24737
24738 The "system" value for the option will use a location compiled into the SSL library.
24739 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
24740 is taken as empty and an explicit location
24741 must be specified.
24742
24743 The use of a directory for the option value is not available for GnuTLS versions
24744 preceding 3.3.6 and a single file must be used.
24745
24746 With OpenSSL the certificates specified
24747 explicitly
24748 either by file or directory
24749 are added to those given by the system default location.
24750
24751 The values of &$host$& and
24752 &$host_address$& are set to the name and address of the server during the
24753 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
24754
24755 For back-compatibility,
24756 if neither tls_verify_hosts nor tls_try_verify_hosts are set
24757 (a single-colon empty list counts as being set)
24758 and certificate verification fails the TLS connection is closed.
24759
24760
24761 .option tls_verify_hosts smtp "host list&!!" unset
24762 .cindex "TLS" "server certificate verification"
24763 .cindex "certificate" "verification of server"
24764 This option gives a list of hosts for which, on encrypted connections,
24765 certificate verification must succeed.
24766 The &%tls_verify_certificates%& option must also be set.
24767 If both this option and &%tls_try_verify_hosts%& are unset
24768 operation is as if this option selected all hosts.
24769
24770 .new
24771 .option utf8_downconvert smtp integer!! unset
24772 .cindex utf8 "address downconversion"
24773 .cindex i18n "utf8 address downconversion"
24774 If built with internationalization support,
24775 this option controls conversion of UTF-8 in message addresses
24776 to a-label form.
24777 For details see section &<<SECTi18nMTA>>&.
24778 .wen
24779
24780
24781
24782
24783 .section "How the limits for the number of hosts to try are used" &&&
24784          "SECTvalhosmax"
24785 .cindex "host" "maximum number to try"
24786 .cindex "limit" "hosts; maximum number tried"
24787 There are two options that are concerned with the number of hosts that are
24788 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
24789 &%hosts_max_try_hardlimit%&.
24790
24791
24792 The &%hosts_max_try%& option limits the number of hosts that are tried
24793 for a single delivery. However, despite the term &"host"& in its name, the
24794 option actually applies to each IP address independently. In other words, a
24795 multihomed host is treated as several independent hosts, just as it is for
24796 retrying.
24797
24798 Many of the larger ISPs have multiple MX records which often point to
24799 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
24800 created as a result of routing one of these domains.
24801
24802 Trying every single IP address on such a long list does not seem sensible; if
24803 several at the top of the list fail, it is reasonable to assume there is some
24804 problem that is likely to affect all of them. Roughly speaking, the value of
24805 &%hosts_max_try%& is the maximum number that are tried before deferring the
24806 delivery. However, the logic cannot be quite that simple.
24807
24808 Firstly, IP addresses that are skipped because their retry times have not
24809 arrived do not count, and in addition, addresses that are past their retry
24810 limits are also not counted, even when they are tried. This means that when
24811 some IP addresses are past their retry limits, more than the value of
24812 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
24813 that all IP addresses are considered before timing out an email address (but
24814 see below for an exception).
24815
24816 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
24817 list to see if there is a subsequent host with a different (higher valued) MX.
24818 If there is, that host is considered next, and the current IP address is used
24819 but not counted. This behaviour helps in the case of a domain with a retry rule
24820 that hardly ever delays any hosts, as is now explained:
24821
24822 Consider the case of a long list of hosts with one MX value, and a few with a
24823 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
24824 hosts at the top of the list are tried at first. With the default retry rule,
24825 which specifies increasing retry times, the higher MX hosts are eventually
24826 tried when those at the top of the list are skipped because they have not
24827 reached their retry times.
24828
24829 However, it is common practice to put a fixed short retry time on domains for
24830 large ISPs, on the grounds that their servers are rarely down for very long.
24831 Unfortunately, these are exactly the domains that tend to resolve to long lists
24832 of hosts. The short retry time means that the lowest MX hosts are tried every
24833 time. The attempts may be in a different order because of random sorting, but
24834 without the special MX check, the higher MX hosts would never be tried until
24835 all the lower MX hosts had timed out (which might be several days), because
24836 there are always some lower MX hosts that have reached their retry times. With
24837 the special check, Exim considers at least one IP address from each MX value at
24838 every delivery attempt, even if the &%hosts_max_try%& limit has already been
24839 reached.
24840
24841 The above logic means that &%hosts_max_try%& is not a hard limit, and in
24842 particular, Exim normally eventually tries all the IP addresses before timing
24843 out an email address. When &%hosts_max_try%& was implemented, this seemed a
24844 reasonable thing to do. Recently, however, some lunatic DNS configurations have
24845 been set up with hundreds of IP addresses for some domains. It can
24846 take a very long time indeed for an address to time out in these cases.
24847
24848 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
24849 Exim never tries more than this number of IP addresses; if it hits this limit
24850 and they are all timed out, the email address is bounced, even though not all
24851 possible IP addresses have been tried.
24852 .ecindex IIDsmttra1
24853 .ecindex IIDsmttra2
24854
24855
24856
24857
24858
24859 . ////////////////////////////////////////////////////////////////////////////
24860 . ////////////////////////////////////////////////////////////////////////////
24861
24862 .chapter "Address rewriting" "CHAPrewrite"
24863 .scindex IIDaddrew "rewriting" "addresses"
24864 There are some circumstances in which Exim automatically rewrites domains in
24865 addresses. The two most common are when an address is given without a domain
24866 (referred to as an &"unqualified address"&) or when an address contains an
24867 abbreviated domain that is expanded by DNS lookup.
24868
24869 Unqualified envelope addresses are accepted only for locally submitted
24870 messages, or for messages that are received from hosts matching
24871 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
24872 appropriate. Unqualified addresses in header lines are qualified if they are in
24873 locally submitted messages, or messages from hosts that are permitted to send
24874 unqualified envelope addresses. Otherwise, unqualified addresses in header
24875 lines are neither qualified nor rewritten.
24876
24877 One situation in which Exim does &'not'& automatically rewrite a domain is
24878 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
24879 such a domain should be rewritten using the &"canonical"& name, and some MTAs
24880 do this. The new RFCs do not contain this suggestion.
24881
24882
24883 .section "Explicitly configured address rewriting" "SECID147"
24884 This chapter describes the rewriting rules that can be used in the
24885 main rewrite section of the configuration file, and also in the generic
24886 &%headers_rewrite%& option that can be set on any transport.
24887
24888 Some people believe that configured address rewriting is a Mortal Sin.
24889 Others believe that life is not possible without it. Exim provides the
24890 facility; you do not have to use it.
24891
24892 The main rewriting rules that appear in the &"rewrite"& section of the
24893 configuration file are applied to addresses in incoming messages, both envelope
24894 addresses and addresses in header lines. Each rule specifies the types of
24895 address to which it applies.
24896
24897 Whether or not addresses in header lines are rewritten depends on the origin of
24898 the headers and the type of rewriting. Global rewriting, that is, rewriting
24899 rules from the rewrite section of the configuration file, is applied only to
24900 those headers that were received with the message. Header lines that are added
24901 by ACLs or by a system filter or by individual routers or transports (which
24902 are specific to individual recipient addresses) are not rewritten by the global
24903 rules.
24904
24905 Rewriting at transport time, by means of the &%headers_rewrite%& option,
24906 applies all headers except those added by routers and transports. That is, as
24907 well as the headers that were received with the message, it also applies to
24908 headers that were added by an ACL or a system filter.
24909
24910
24911 In general, rewriting addresses from your own system or domain has some
24912 legitimacy. Rewriting other addresses should be done only with great care and
24913 in special circumstances. The author of Exim believes that rewriting should be
24914 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
24915 Although it can sometimes be used as a routing tool, this is very strongly
24916 discouraged.
24917
24918 There are two commonly encountered circumstances where rewriting is used, as
24919 illustrated by these examples:
24920
24921 .ilist
24922 The company whose domain is &'hitch.fict.example'& has a number of hosts that
24923 exchange mail with each other behind a firewall, but there is only a single
24924 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
24925 &'hitch.fict.example'& when sending mail off-site.
24926 .next
24927 A host rewrites the local parts of its own users so that, for example,
24928 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
24929 .endlist
24930
24931
24932
24933 .section "When does rewriting happen?" "SECID148"
24934 .cindex "rewriting" "timing of"
24935 .cindex "&ACL;" "rewriting addresses in"
24936 Configured address rewriting can take place at several different stages of a
24937 message's processing.
24938
24939 .vindex "&$sender_address$&"
24940 At the start of an ACL for MAIL, the sender address may have been rewritten
24941 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
24942 ordinary rewrite rules have yet been applied. If, however, the sender address
24943 is verified in the ACL, it is rewritten before verification, and remains
24944 rewritten thereafter. The subsequent value of &$sender_address$& is the
24945 rewritten address. This also applies if sender verification happens in a
24946 RCPT ACL. Otherwise, when the sender address is not verified, it is
24947 rewritten as soon as a message's header lines have been received.
24948
24949 .vindex "&$domain$&"
24950 .vindex "&$local_part$&"
24951 Similarly, at the start of an ACL for RCPT, the current recipient's address
24952 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
24953 rewrite rules have yet been applied to it. However, the behaviour is different
24954 from the sender address when a recipient is verified. The address is rewritten
24955 for the verification, but the rewriting is not remembered at this stage. The
24956 value of &$local_part$& and &$domain$& after verification are always the same
24957 as they were before (that is, they contain the unrewritten &-- except for
24958 SMTP-time rewriting &-- address).
24959
24960 As soon as a message's header lines have been received, all the envelope
24961 recipient addresses are permanently rewritten, and rewriting is also applied to
24962 the addresses in the header lines (if configured). This happens before adding
24963 any header lines that were specified in MAIL or RCPT ACLs, and
24964 .cindex "&[local_scan()]& function" "address rewriting; timing of"
24965 before the DATA ACL and &[local_scan()]& functions are run.
24966
24967 When an address is being routed, either for delivery or for verification,
24968 rewriting is applied immediately to child addresses that are generated by
24969 redirection, unless &%no_rewrite%& is set on the router.
24970
24971 .cindex "envelope sender" "rewriting at transport time"
24972 .cindex "rewriting" "at transport time"
24973 .cindex "header lines" "rewriting at transport time"
24974 At transport time, additional rewriting of addresses in header lines can be
24975 specified by setting the generic &%headers_rewrite%& option on a transport.
24976 This option contains rules that are identical in form to those in the rewrite
24977 section of the configuration file. They are applied to the original message
24978 header lines and any that were added by ACLs or a system filter. They are not
24979 applied to header lines that are added by routers or the transport.
24980
24981 The outgoing envelope sender can be rewritten by means of the &%return_path%&
24982 transport option. However, it is not possible to rewrite envelope recipients at
24983 transport time.
24984
24985
24986
24987
24988 .section "Testing the rewriting rules that apply on input" "SECID149"
24989 .cindex "rewriting" "testing"
24990 .cindex "testing" "rewriting"
24991 Exim's input rewriting configuration appears in a part of the run time
24992 configuration file headed by &"begin rewrite"&. It can be tested by the
24993 &%-brw%& command line option. This takes an address (which can be a full RFC
24994 2822 address) as its argument. The output is a list of how the address would be
24995 transformed by the rewriting rules for each of the different places it might
24996 appear in an incoming message, that is, for each different header and for the
24997 envelope sender and recipient fields. For example,
24998 .code
24999 exim -brw ph10@exim.workshop.example
25000 .endd
25001 might produce the output
25002 .code
25003 sender: Philip.Hazel@exim.workshop.example
25004 from: Philip.Hazel@exim.workshop.example
25005 to: ph10@exim.workshop.example
25006 cc: ph10@exim.workshop.example
25007 bcc: ph10@exim.workshop.example
25008 reply-to: Philip.Hazel@exim.workshop.example
25009 env-from: Philip.Hazel@exim.workshop.example
25010 env-to: ph10@exim.workshop.example
25011 .endd
25012 which shows that rewriting has been set up for that address when used in any of
25013 the source fields, but not when it appears as a recipient address. At the
25014 present time, there is no equivalent way of testing rewriting rules that are
25015 set for a particular transport.
25016
25017
25018 .section "Rewriting rules" "SECID150"
25019 .cindex "rewriting" "rules"
25020 The rewrite section of the configuration file consists of lines of rewriting
25021 rules in the form
25022 .display
25023 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
25024 .endd
25025 Rewriting rules that are specified for the &%headers_rewrite%& generic
25026 transport option are given as a colon-separated list. Each item in the list
25027 takes the same form as a line in the main rewriting configuration (except that
25028 any colons must be doubled, of course).
25029
25030 The formats of source patterns and replacement strings are described below.
25031 Each is terminated by white space, unless enclosed in double quotes, in which
25032 case normal quoting conventions apply inside the quotes. The flags are single
25033 characters which may appear in any order. Spaces and tabs between them are
25034 ignored.
25035
25036 For each address that could potentially be rewritten, the rules are scanned in
25037 order, and replacements for the address from earlier rules can themselves be
25038 replaced by later rules (but see the &"q"& and &"R"& flags).
25039
25040 The order in which addresses are rewritten is undefined, may change between
25041 releases, and must not be relied on, with one exception: when a message is
25042 received, the envelope sender is always rewritten first, before any header
25043 lines are rewritten. For example, the replacement string for a rewrite of an
25044 address in &'To:'& must not assume that the message's address in &'From:'& has
25045 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
25046 that the envelope sender has already been rewritten.
25047
25048 .vindex "&$domain$&"
25049 .vindex "&$local_part$&"
25050 The variables &$local_part$& and &$domain$& can be used in the replacement
25051 string to refer to the address that is being rewritten. Note that lookup-driven
25052 rewriting can be done by a rule of the form
25053 .code
25054 *@*   ${lookup ...
25055 .endd
25056 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
25057 refer to the address that is being rewritten.
25058
25059
25060 .section "Rewriting patterns" "SECID151"
25061 .cindex "rewriting" "patterns"
25062 .cindex "address list" "in a rewriting pattern"
25063 The source pattern in a rewriting rule is any item which may appear in an
25064 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
25065 single-item address list, which means that it is expanded before being tested
25066 against the address. As always, if you use a regular expression as a pattern,
25067 you must take care to escape dollar and backslash characters, or use the &`\N`&
25068 facility to suppress string expansion within the regular expression.
25069
25070 Domains in patterns should be given in lower case. Local parts in patterns are
25071 case-sensitive. If you want to do case-insensitive matching of local parts, you
25072 can use a regular expression that starts with &`^(?i)`&.
25073
25074 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
25075 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
25076 depending on the type of match which occurred. These can be used in the
25077 replacement string to insert portions of the incoming address. &$0$& always
25078 refers to the complete incoming address. When a regular expression is used, the
25079 numerical variables are set from its capturing subexpressions. For other types
25080 of pattern they are set as follows:
25081
25082 .ilist
25083 If a local part or domain starts with an asterisk, the numerical variables
25084 refer to the character strings matched by asterisks, with &$1$& associated with
25085 the first asterisk, and &$2$& with the second, if present. For example, if the
25086 pattern
25087 .code
25088 *queen@*.fict.example
25089 .endd
25090 is matched against the address &'hearts-queen@wonderland.fict.example'& then
25091 .code
25092 $0 = hearts-queen@wonderland.fict.example
25093 $1 = hearts-
25094 $2 = wonderland
25095 .endd
25096 Note that if the local part does not start with an asterisk, but the domain
25097 does, it is &$1$& that contains the wild part of the domain.
25098
25099 .next
25100 If the domain part of the pattern is a partial lookup, the wild and fixed parts
25101 of the domain are placed in the next available numerical variables. Suppose,
25102 for example, that the address &'foo@bar.baz.example'& is processed by a
25103 rewriting rule of the form
25104 .display
25105 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
25106 .endd
25107 and the key in the file that matches the domain is &`*.baz.example`&. Then
25108 .code
25109 $1 = foo
25110 $2 = bar
25111 $3 = baz.example
25112 .endd
25113 If the address &'foo@baz.example'& is looked up, this matches the same
25114 wildcard file entry, and in this case &$2$& is set to the empty string, but
25115 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
25116 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
25117 whole domain. For non-partial domain lookups, no numerical variables are set.
25118 .endlist
25119
25120
25121 .section "Rewriting replacements" "SECID152"
25122 .cindex "rewriting" "replacements"
25123 If the replacement string for a rule is a single asterisk, addresses that
25124 match the pattern and the flags are &'not'& rewritten, and no subsequent
25125 rewriting rules are scanned. For example,
25126 .code
25127 hatta@lookingglass.fict.example  *  f
25128 .endd
25129 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
25130 &'From:'& headers.
25131
25132 .vindex "&$domain$&"
25133 .vindex "&$local_part$&"
25134 If the replacement string is not a single asterisk, it is expanded, and must
25135 yield a fully qualified address. Within the expansion, the variables
25136 &$local_part$& and &$domain$& refer to the address that is being rewritten.
25137 Any letters they contain retain their original case &-- they are not lower
25138 cased. The numerical variables are set up according to the type of pattern that
25139 matched the address, as described above. If the expansion is forced to fail by
25140 the presence of &"fail"& in a conditional or lookup item, rewriting by the
25141 current rule is abandoned, but subsequent rules may take effect. Any other
25142 expansion failure causes the entire rewriting operation to be abandoned, and an
25143 entry written to the panic log.
25144
25145
25146
25147 .section "Rewriting flags" "SECID153"
25148 There are three different kinds of flag that may appear on rewriting rules:
25149
25150 .ilist
25151 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
25152 c, f, h, r, s, t.
25153 .next
25154 A flag that specifies rewriting at SMTP time: S.
25155 .next
25156 Flags that control the rewriting process: Q, q, R, w.
25157 .endlist
25158
25159 For rules that are part of the &%headers_rewrite%& generic transport option,
25160 E, F, T, and S are not permitted.
25161
25162
25163
25164 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
25165          "SECID154"
25166 .cindex "rewriting" "flags"
25167 If none of the following flag letters, nor the &"S"& flag (see section
25168 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
25169 and to both the sender and recipient fields of the envelope, whereas a
25170 transport-time rewriting rule just applies to all headers. Otherwise, the
25171 rewriting rule is skipped unless the relevant addresses are being processed.
25172 .display
25173 &`E`&       rewrite all envelope fields
25174 &`F`&       rewrite the envelope From field
25175 &`T`&       rewrite the envelope To field
25176 &`b`&       rewrite the &'Bcc:'& header
25177 &`c`&       rewrite the &'Cc:'& header
25178 &`f`&       rewrite the &'From:'& header
25179 &`h`&       rewrite all headers
25180 &`r`&       rewrite the &'Reply-To:'& header
25181 &`s`&       rewrite the &'Sender:'& header
25182 &`t`&       rewrite the &'To:'& header
25183 .endd
25184 "All headers" means all of the headers listed above that can be selected
25185 individually, plus their &'Resent-'& versions. It does not include
25186 other headers such as &'Subject:'& etc.
25187
25188 You should be particularly careful about rewriting &'Sender:'& headers, and
25189 restrict this to special known cases in your own domains.
25190
25191
25192 .section "The SMTP-time rewriting flag" "SECTrewriteS"
25193 .cindex "SMTP" "rewriting malformed addresses"
25194 .cindex "RCPT" "rewriting argument of"
25195 .cindex "MAIL" "rewriting argument of"
25196 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
25197 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
25198 before any other processing; even before syntax checking. The pattern is
25199 required to be a regular expression, and it is matched against the whole of the
25200 data for the command, including any surrounding angle brackets.
25201
25202 .vindex "&$domain$&"
25203 .vindex "&$local_part$&"
25204 This form of rewrite rule allows for the handling of addresses that are not
25205 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
25206 input). Because the input is not required to be a syntactically valid address,
25207 the variables &$local_part$& and &$domain$& are not available during the
25208 expansion of the replacement string. The result of rewriting replaces the
25209 original address in the MAIL or RCPT command.
25210
25211
25212 .section "Flags controlling the rewriting process" "SECID155"
25213 There are four flags which control the way the rewriting process works. These
25214 take effect only when a rule is invoked, that is, when the address is of the
25215 correct type (matches the flags) and matches the pattern:
25216
25217 .ilist
25218 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
25219 unqualified local part. It is qualified with &%qualify_recipient%&. In the
25220 absence of &"Q"& the rewritten address must always include a domain.
25221 .next
25222 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
25223 even if no rewriting actually takes place because of a &"fail"& in the
25224 expansion. The &"q"& flag is not effective if the address is of the wrong type
25225 (does not match the flags) or does not match the pattern.
25226 .next
25227 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
25228 address, up to ten times. It can be combined with the &"q"& flag, to stop
25229 rewriting once it fails to match (after at least one successful rewrite).
25230 .next
25231 .cindex "rewriting" "whole addresses"
25232 When an address in a header is rewritten, the rewriting normally applies only
25233 to the working part of the address, with any comments and RFC 2822 &"phrase"&
25234 left unchanged. For example, rewriting might change
25235 .code
25236 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
25237 .endd
25238 into
25239 .code
25240 From: Ford Prefect <prefectf@hitch.fict.example>
25241 .endd
25242 .cindex "RFC 2047"
25243 Sometimes there is a need to replace the whole address item, and this can be
25244 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
25245 causes an address in a header line to be rewritten, the entire address is
25246 replaced, not just the working part. The replacement must be a complete RFC
25247 2822 address, including the angle brackets if necessary. If text outside angle
25248 brackets contains a character whose value is greater than 126 or less than 32
25249 (except for tab), the text is encoded according to RFC 2047. The character set
25250 is taken from &%headers_charset%&, which gets its default at build time.
25251
25252 When the &"w"& flag is set on a rule that causes an envelope address to be
25253 rewritten, all but the working part of the replacement address is discarded.
25254 .endlist
25255
25256
25257 .section "Rewriting examples" "SECID156"
25258 Here is an example of the two common rewriting paradigms:
25259 .code
25260 *@*.hitch.fict.example  $1@hitch.fict.example
25261 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
25262                      {$value}fail}@hitch.fict.example bctfrF
25263 .endd
25264 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
25265 the string expansion to fail if the lookup does not succeed. In this context it
25266 has the effect of leaving the original address unchanged, but Exim goes on to
25267 consider subsequent rewriting rules, if any, because the &"q"& flag is not
25268 present in that rule. An alternative to &"fail"& would be to supply &$1$&
25269 explicitly, which would cause the rewritten address to be the same as before,
25270 at the cost of a small bit of processing. Not supplying either of these is an
25271 error, since the rewritten address would then contain no local part.
25272
25273 The first example above replaces the domain with a superior, more general
25274 domain. This may not be desirable for certain local parts. If the rule
25275 .code
25276 root@*.hitch.fict.example  *
25277 .endd
25278 were inserted before the first rule, rewriting would be suppressed for the
25279 local part &'root'& at any domain ending in &'hitch.fict.example'&.
25280
25281 Rewriting can be made conditional on a number of tests, by making use of
25282 &${if$& in the expansion item. For example, to apply a rewriting rule only to
25283 messages that originate outside the local host:
25284 .code
25285 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
25286                          {$1@hitch.fict.example}fail}"
25287 .endd
25288 The replacement string is quoted in this example because it contains white
25289 space.
25290
25291 .cindex "rewriting" "bang paths"
25292 .cindex "bang paths" "rewriting"
25293 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
25294 an address it treats it as an unqualified local part which it qualifies with
25295 the local qualification domain (if the source of the message is local or if the
25296 remote host is permitted to send unqualified addresses). Rewriting can
25297 sometimes be used to handle simple bang paths with a fixed number of
25298 components. For example, the rule
25299 .code
25300 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
25301 .endd
25302 rewrites a two-component bang path &'host.name!user'& as the domain address
25303 &'user@host.name'&. However, there is a security implication in using this as
25304 a global rewriting rule for envelope addresses. It can provide a backdoor
25305 method for using your system as a relay, because the incoming addresses appear
25306 to be local. If the bang path addresses are received via SMTP, it is safer to
25307 use the &"S"& flag to rewrite them as they are received, so that relay checking
25308 can be done on the rewritten addresses.
25309 .ecindex IIDaddrew
25310
25311
25312
25313
25314
25315 . ////////////////////////////////////////////////////////////////////////////
25316 . ////////////////////////////////////////////////////////////////////////////
25317
25318 .chapter "Retry configuration" "CHAPretry"
25319 .scindex IIDretconf1 "retry" "configuration, description of"
25320 .scindex IIDregconf2 "configuration file" "retry section"
25321 The &"retry"& section of the runtime configuration file contains a list of
25322 retry rules that control how often Exim tries to deliver messages that cannot
25323 be delivered at the first attempt. If there are no retry rules (the section is
25324 empty or not present), there are no retries. In this situation, temporary
25325 errors are treated as permanent. The default configuration contains a single,
25326 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
25327 line option can be used to test which retry rule will be used for a given
25328 address, domain and error.
25329
25330 The most common cause of retries is temporary failure to deliver to a remote
25331 host because the host is down, or inaccessible because of a network problem.
25332 Exim's retry processing in this case is applied on a per-host (strictly, per IP
25333 address) basis, not on a per-message basis. Thus, if one message has recently
25334 been delayed, delivery of a new message to the same host is not immediately
25335 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
25336 log selector is set, the message
25337 .cindex "retry" "time not reached"
25338 &"retry time not reached"& is written to the main log whenever a delivery is
25339 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
25340 the handling of errors during remote deliveries.
25341
25342 Retry processing applies to routing as well as to delivering, except as covered
25343 in the next paragraph. The retry rules do not distinguish between these
25344 actions. It is not possible, for example, to specify different behaviour for
25345 failures to route the domain &'snark.fict.example'& and failures to deliver to
25346 the host &'snark.fict.example'&. I didn't think anyone would ever need this
25347 added complication, so did not implement it. However, although they share the
25348 same retry rule, the actual retry times for routing and transporting a given
25349 domain are maintained independently.
25350
25351 When a delivery is not part of a queue run (typically an immediate delivery on
25352 receipt of a message), the routers are always run, and local deliveries are
25353 always attempted, even if retry times are set for them. This makes for better
25354 behaviour if one particular message is causing problems (for example, causing
25355 quota overflow, or provoking an error in a filter file). If such a delivery
25356 suffers a temporary failure, the retry data is updated as normal, and
25357 subsequent delivery attempts from queue runs occur only when the retry time for
25358 the local address is reached.
25359
25360 .section "Changing retry rules" "SECID157"
25361 If you change the retry rules in your configuration, you should consider
25362 whether or not to delete the retry data that is stored in Exim's spool area in
25363 files with names like &_db/retry_&. Deleting any of Exim's hints files is
25364 always safe; that is why they are called &"hints"&.
25365
25366 The hints retry data contains suggested retry times based on the previous
25367 rules. In the case of a long-running problem with a remote host, it might
25368 record the fact that the host has timed out. If your new rules increase the
25369 timeout time for such a host, you should definitely remove the old retry data
25370 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
25371 messages that it should now be retaining.
25372
25373
25374
25375 .section "Format of retry rules" "SECID158"
25376 .cindex "retry" "rules"
25377 Each retry rule occupies one line and consists of three or four parts,
25378 separated by white space: a pattern, an error name, an optional list of sender
25379 addresses, and a list of retry parameters. The pattern and sender lists must be
25380 enclosed in double quotes if they contain white space. The rules are searched
25381 in order until one is found where the pattern, error name, and sender list (if
25382 present) match the failing host or address, the error that occurred, and the
25383 message's sender, respectively.
25384
25385
25386 The pattern is any single item that may appear in an address list (see section
25387 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
25388 which means that it is expanded before being tested against the address that
25389 has been delayed. A negated address list item is permitted. Address
25390 list processing treats a plain domain name as if it were preceded by &"*@"&,
25391 which makes it possible for many retry rules to start with just a domain. For
25392 example,
25393 .code
25394 lookingglass.fict.example        *  F,24h,30m;
25395 .endd
25396 provides a rule for any address in the &'lookingglass.fict.example'& domain,
25397 whereas
25398 .code
25399 alice@lookingglass.fict.example  *  F,24h,30m;
25400 .endd
25401 applies only to temporary failures involving the local part &%alice%&.
25402 In practice, almost all rules start with a domain name pattern without a local
25403 part.
25404
25405 .cindex "regular expressions" "in retry rules"
25406 &*Warning*&: If you use a regular expression in a retry rule pattern, it
25407 must match a complete address, not just a domain, because that is how regular
25408 expressions work in address lists.
25409 .display
25410 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
25411 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
25412 .endd
25413
25414
25415 .section "Choosing which retry rule to use for address errors" "SECID159"
25416 When Exim is looking for a retry rule after a routing attempt has failed (for
25417 example, after a DNS timeout), each line in the retry configuration is tested
25418 against the complete address only if &%retry_use_local_part%& is set for the
25419 router. Otherwise, only the domain is used, except when matching against a
25420 regular expression, when the local part of the address is replaced with &"*"&.
25421 A domain on its own can match a domain pattern, or a pattern that starts with
25422 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
25423 &%check_local_user%& is true, and false for other routers.
25424
25425 Similarly, when Exim is looking for a retry rule after a local delivery has
25426 failed (for example, after a mailbox full error), each line in the retry
25427 configuration is tested against the complete address only if
25428 &%retry_use_local_part%& is set for the transport (it defaults true for all
25429 local transports).
25430
25431 .cindex "4&'xx'& responses" "retry rules for"
25432 However, when Exim is looking for a retry rule after a remote delivery attempt
25433 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
25434 whole address is always used as the key when searching the retry rules. The
25435 rule that is found is used to create a retry time for the combination of the
25436 failing address and the message's sender. It is the combination of sender and
25437 recipient that is delayed in subsequent queue runs until its retry time is
25438 reached. You can delay the recipient without regard to the sender by setting
25439 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
25440 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
25441 commands.
25442
25443
25444
25445 .section "Choosing which retry rule to use for host and message errors" &&&
25446          "SECID160"
25447 For a temporary error that is not related to an individual address (for
25448 example, a connection timeout), each line in the retry configuration is checked
25449 twice. First, the name of the remote host is used as a domain name (preceded by
25450 &"*@"& when matching a regular expression). If this does not match the line,
25451 the domain from the email address is tried in a similar fashion. For example,
25452 suppose the MX records for &'a.b.c.example'& are
25453 .code
25454 a.b.c.example  MX  5  x.y.z.example
25455                MX  6  p.q.r.example
25456                MX  7  m.n.o.example
25457 .endd
25458 and the retry rules are
25459 .code
25460 p.q.r.example    *      F,24h,30m;
25461 a.b.c.example    *      F,4d,45m;
25462 .endd
25463 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
25464 first rule matches neither the host nor the domain, so Exim looks at the second
25465 rule. This does not match the host, but it does match the domain, so it is used
25466 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
25467 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
25468 first retry rule is used, because it matches the host.
25469
25470 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
25471 first rule to determine retry times, but for all the other hosts for the domain
25472 &'a.b.c.example'&, the second rule is used. The second rule is also used if
25473 routing to &'a.b.c.example'& suffers a temporary failure.
25474
25475 &*Note*&: The host name is used when matching the patterns, not its IP address.
25476 However, if a message is routed directly to an IP address without the use of a
25477 host name, for example, if a &(manualroute)& router contains a setting such as:
25478 .code
25479 route_list = *.a.example  192.168.34.23
25480 .endd
25481 then the &"host name"& that is used when searching for a retry rule is the
25482 textual form of the IP address.
25483
25484 .section "Retry rules for specific errors" "SECID161"
25485 .cindex "retry" "specific errors; specifying"
25486 The second field in a retry rule is the name of a particular error, or an
25487 asterisk, which matches any error. The errors that can be tested for are:
25488
25489 .vlist
25490 .vitem &%auth_failed%&
25491 Authentication failed when trying to send to a host in the
25492 &%hosts_require_auth%& list in an &(smtp)& transport.
25493
25494 .vitem &%data_4xx%&
25495 A 4&'xx'& error was received for an outgoing DATA command, either immediately
25496 after the command, or after sending the message's data.
25497
25498 .vitem &%mail_4xx%&
25499 A 4&'xx'& error was received for an outgoing MAIL command.
25500
25501 .vitem &%rcpt_4xx%&
25502 A 4&'xx'& error was received for an outgoing RCPT command.
25503 .endlist
25504
25505 For the three 4&'xx'& errors, either the first or both of the x's can be given
25506 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
25507 recognize 452 errors given to RCPT commands for addresses in a certain domain,
25508 and have retries every ten minutes with a one-hour timeout, you could set up a
25509 retry rule of this form:
25510 .code
25511 the.domain.name  rcpt_452   F,1h,10m
25512 .endd
25513 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
25514 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
25515
25516 .vlist
25517 .vitem &%lost_connection%&
25518 A server unexpectedly closed the SMTP connection. There may, of course,
25519 legitimate reasons for this (host died, network died), but if it repeats a lot
25520 for the same host, it indicates something odd.
25521
25522 .vitem &%lookup%&
25523 A DNS lookup for a host failed.
25524 Note that a &%dnslookup%& router will need to have matched
25525 its &%fail_defer_domains%& option for this retry type to be usable.
25526 Also note that a &%manualroute%& router will probably need
25527 its &%host_find_failed%& option set to &%defer%&.
25528
25529 .vitem &%refused_MX%&
25530 A connection to a host obtained from an MX record was refused.
25531
25532 .vitem &%refused_A%&
25533 A connection to a host not obtained from an MX record was refused.
25534
25535 .vitem &%refused%&
25536 A connection was refused.
25537
25538 .vitem &%timeout_connect_MX%&
25539 A connection attempt to a host obtained from an MX record timed out.
25540
25541 .vitem &%timeout_connect_A%&
25542 A connection attempt to a host not obtained from an MX record timed out.
25543
25544 .vitem &%timeout_connect%&
25545 A connection attempt timed out.
25546
25547 .vitem &%timeout_MX%&
25548 There was a timeout while connecting or during an SMTP session with a host
25549 obtained from an MX record.
25550
25551 .vitem &%timeout_A%&
25552 There was a timeout while connecting or during an SMTP session with a host not
25553 obtained from an MX record.
25554
25555 .vitem &%timeout%&
25556 There was a timeout while connecting or during an SMTP session.
25557
25558 .vitem &%tls_required%&
25559 The server was required to use TLS (it matched &%hosts_require_tls%& in the
25560 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
25561 to STARTTLS, or there was a problem setting up the TLS connection.
25562
25563 .vitem &%quota%&
25564 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25565 transport.
25566
25567 .vitem &%quota_%&<&'time'&>
25568 .cindex "quota" "error testing in retry rule"
25569 .cindex "retry" "quota error testing"
25570 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25571 transport, and the mailbox has not been accessed for <&'time'&>. For example,
25572 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
25573 for four days.
25574 .endlist
25575
25576 .cindex "mailbox" "time of last read"
25577 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
25578 timeouts when the mailbox is full and is not being read by its owner. Ideally,
25579 it should be based on the last time that the user accessed the mailbox.
25580 However, it is not always possible to determine this. Exim uses the following
25581 heuristic rules:
25582
25583 .ilist
25584 If the mailbox is a single file, the time of last access (the &"atime"&) is
25585 used. As no new messages are being delivered (because the mailbox is over
25586 quota), Exim does not access the file, so this is the time of last user access.
25587 .next
25588 .cindex "maildir format" "time of last read"
25589 For a maildir delivery, the time of last modification of the &_new_&
25590 subdirectory is used. As the mailbox is over quota, no new files are created in
25591 the &_new_& subdirectory, because no new messages are being delivered. Any
25592 change to the &_new_& subdirectory is therefore assumed to be the result of an
25593 MUA moving a new message to the &_cur_& directory when it is first read. The
25594 time that is used is therefore the last time that the user read a new message.
25595 .next
25596 For other kinds of multi-file mailbox, the time of last access cannot be
25597 obtained, so a retry rule that uses this type of error field is never matched.
25598 .endlist
25599
25600 The quota errors apply both to system-enforced quotas and to Exim's own quota
25601 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
25602 when a local delivery is deferred because a partition is full (the ENOSPC
25603 error).
25604
25605
25606
25607 .section "Retry rules for specified senders" "SECID162"
25608 .cindex "retry" "rules; sender-specific"
25609 You can specify retry rules that apply only when the failing message has a
25610 specific sender. In particular, this can be used to define retry rules that
25611 apply only to bounce messages. The third item in a retry rule can be of this
25612 form:
25613 .display
25614 &`senders=`&<&'address list'&>
25615 .endd
25616 The retry timings themselves are then the fourth item. For example:
25617 .code
25618 *   rcpt_4xx   senders=:   F,1h,30m
25619 .endd
25620 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
25621 host. If the address list contains white space, it must be enclosed in quotes.
25622 For example:
25623 .code
25624 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
25625 .endd
25626 &*Warning*&: This facility can be unhelpful if it is used for host errors
25627 (which do not depend on the recipient). The reason is that the sender is used
25628 only to match the retry rule. Once the rule has been found for a host error,
25629 its contents are used to set a retry time for the host, and this will apply to
25630 all messages, not just those with specific senders.
25631
25632 When testing retry rules using &%-brt%&, you can supply a sender using the
25633 &%-f%& command line option, like this:
25634 .code
25635 exim -f "" -brt user@dom.ain
25636 .endd
25637 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
25638 list is never matched.
25639
25640
25641
25642
25643
25644 .section "Retry parameters" "SECID163"
25645 .cindex "retry" "parameters in rules"
25646 The third (or fourth, if a senders list is present) field in a retry rule is a
25647 sequence of retry parameter sets, separated by semicolons. Each set consists of
25648 .display
25649 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
25650 .endd
25651 The letter identifies the algorithm for computing a new retry time; the cutoff
25652 time is the time beyond which this algorithm no longer applies, and the
25653 arguments vary the algorithm's action. The cutoff time is measured from the
25654 time that the first failure for the domain (combined with the local part if
25655 relevant) was detected, not from the time the message was received.
25656
25657 .cindex "retry" "algorithms"
25658 .cindex "retry" "fixed intervals"
25659 .cindex "retry" "increasing intervals"
25660 .cindex "retry" "random intervals"
25661 The available algorithms are:
25662
25663 .ilist
25664 &'F'&: retry at fixed intervals. There is a single time parameter specifying
25665 the interval.
25666 .next
25667 &'G'&: retry at geometrically increasing intervals. The first argument
25668 specifies a starting value for the interval, and the second a multiplier, which
25669 is used to increase the size of the interval at each retry.
25670 .next
25671 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
25672 retry, the previous interval is multiplied by the factor in order to get a
25673 maximum for the next interval. The minimum interval is the first argument of
25674 the parameter, and an actual interval is chosen randomly between them. Such a
25675 rule has been found to be helpful in cluster configurations when all the
25676 members of the cluster restart at once, and may therefore synchronize their
25677 queue processing times.
25678 .endlist
25679
25680 When computing the next retry time, the algorithm definitions are scanned in
25681 order until one whose cutoff time has not yet passed is reached. This is then
25682 used to compute a new retry time that is later than the current time. In the
25683 case of fixed interval retries, this simply means adding the interval to the
25684 current time. For geometrically increasing intervals, retry intervals are
25685 computed from the rule's parameters until one that is greater than the previous
25686 interval is found. The main configuration variable
25687 .cindex "limit" "retry interval"
25688 .cindex "retry" "interval, maximum"
25689 .oindex "&%retry_interval_max%&"
25690 &%retry_interval_max%& limits the maximum interval between retries. It
25691 cannot be set greater than &`24h`&, which is its default value.
25692
25693 A single remote domain may have a number of hosts associated with it, and each
25694 host may have more than one IP address. Retry algorithms are selected on the
25695 basis of the domain name, but are applied to each IP address independently. If,
25696 for example, a host has two IP addresses and one is unusable, Exim will
25697 generate retry times for it and will not try to use it until its next retry
25698 time comes. Thus the good IP address is likely to be tried first most of the
25699 time.
25700
25701 .cindex "hints database" "use for retrying"
25702 Retry times are hints rather than promises. Exim does not make any attempt to
25703 run deliveries exactly at the computed times. Instead, a queue runner process
25704 starts delivery processes for delayed messages periodically, and these attempt
25705 new deliveries only for those addresses that have passed their next retry time.
25706 If a new message arrives for a deferred address, an immediate delivery attempt
25707 occurs only if the address has passed its retry time. In the absence of new
25708 messages, the minimum time between retries is the interval between queue runner
25709 processes. There is not much point in setting retry times of five minutes if
25710 your queue runners happen only once an hour, unless there are a significant
25711 number of incoming messages (which might be the case on a system that is
25712 sending everything to a smart host, for example).
25713
25714 The data in the retry hints database can be inspected by using the
25715 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
25716 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
25717 &'exinext'& utility script can be used to find out what the next retry times
25718 are for the hosts associated with a particular mail domain, and also for local
25719 deliveries that have been deferred.
25720
25721
25722 .section "Retry rule examples" "SECID164"
25723 Here are some example retry rules:
25724 .code
25725 alice@wonderland.fict.example quota_5d  F,7d,3h
25726 wonderland.fict.example       quota_5d
25727 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
25728 lookingglass.fict.example     *         F,24h,30m;
25729 *                 refused_A   F,2h,20m;
25730 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
25731 .endd
25732 The first rule sets up special handling for mail to
25733 &'alice@wonderland.fict.example'& when there is an over-quota error and the
25734 mailbox has not been read for at least 5 days. Retries continue every three
25735 hours for 7 days. The second rule handles over-quota errors for all other local
25736 parts at &'wonderland.fict.example'&; the absence of a local part has the same
25737 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
25738 fail are bounced immediately if the mailbox has not been read for at least 5
25739 days.
25740
25741 The third rule handles all other errors at &'wonderland.fict.example'&; retries
25742 happen every 15 minutes for an hour, then with geometrically increasing
25743 intervals until two days have passed since a delivery first failed. After the
25744 first hour there is a delay of one hour, then two hours, then four hours, and
25745 so on (this is a rather extreme example).
25746
25747 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
25748 They happen every 30 minutes for 24 hours only. The remaining two rules handle
25749 all other domains, with special action for connection refusal from hosts that
25750 were not obtained from an MX record.
25751
25752 The final rule in a retry configuration should always have asterisks in the
25753 first two fields so as to provide a general catch-all for any addresses that do
25754 not have their own special handling. This example tries every 15 minutes for 2
25755 hours, then with intervals starting at one hour and increasing by a factor of
25756 1.5 up to 16 hours, then every 8 hours up to 5 days.
25757
25758
25759
25760 .section "Timeout of retry data" "SECID165"
25761 .cindex "timeout" "of retry data"
25762 .oindex "&%retry_data_expire%&"
25763 .cindex "hints database" "data expiry"
25764 .cindex "retry" "timeout of data"
25765 Exim timestamps the data that it writes to its retry hints database. When it
25766 consults the data during a delivery it ignores any that is older than the value
25767 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
25768 been tried for 7 days, Exim will try to deliver to it immediately a message
25769 arrives, and if that fails, it will calculate a retry time as if it were
25770 failing for the first time.
25771
25772 This improves the behaviour for messages routed to rarely-used hosts such as MX
25773 backups. If such a host was down at one time, and happens to be down again when
25774 Exim tries a month later, using the old retry data would imply that it had been
25775 down all the time, which is not a justified assumption.
25776
25777 If a host really is permanently dead, this behaviour causes a burst of retries
25778 every now and again, but only if messages routed to it are rare. If there is a
25779 message at least once every 7 days the retry data never expires.
25780
25781
25782
25783
25784 .section "Long-term failures" "SECID166"
25785 .cindex "delivery failure, long-term"
25786 .cindex "retry" "after long-term failure"
25787 Special processing happens when an email address has been failing for so long
25788 that the cutoff time for the last algorithm is reached. For example, using the
25789 default retry rule:
25790 .code
25791 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
25792 .endd
25793 the cutoff time is four days. Reaching the retry cutoff is independent of how
25794 long any specific message has been failing; it is the length of continuous
25795 failure for the recipient address that counts.
25796
25797 When the cutoff time is reached for a local delivery, or for all the IP
25798 addresses associated with a remote delivery, a subsequent delivery failure
25799 causes Exim to give up on the address, and a bounce message is generated.
25800 In order to cater for new messages that use the failing address, a next retry
25801 time is still computed from the final algorithm, and is used as follows:
25802
25803 For local deliveries, one delivery attempt is always made for any subsequent
25804 messages. If this delivery fails, the address fails immediately. The
25805 post-cutoff retry time is not used.
25806
25807 If the delivery is remote, there are two possibilities, controlled by the
25808 .oindex "&%delay_after_cutoff%&"
25809 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
25810 default. Until the post-cutoff retry time for one of the IP addresses is
25811 reached, the failing email address is bounced immediately, without a delivery
25812 attempt taking place. After that time, one new delivery attempt is made to
25813 those IP addresses that are past their retry times, and if that still fails,
25814 the address is bounced and new retry times are computed.
25815
25816 In other words, when all the hosts for a given email address have been failing
25817 for a long time, Exim bounces rather then defers until one of the hosts' retry
25818 times is reached. Then it tries once, and bounces if that attempt fails. This
25819 behaviour ensures that few resources are wasted in repeatedly trying to deliver
25820 to a broken destination, but if the host does recover, Exim will eventually
25821 notice.
25822
25823 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25824 addresses are past their final cutoff time, Exim tries to deliver to those IP
25825 addresses that have not been tried since the message arrived. If there are
25826 no suitable IP addresses, or if they all fail, the address is bounced. In other
25827 words, it does not delay when a new message arrives, but tries the expired
25828 addresses immediately, unless they have been tried since the message arrived.
25829 If there is a continuous stream of messages for the failing domains, setting
25830 &%delay_after_cutoff%& false means that there will be many more attempts to
25831 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
25832 true.
25833
25834 .section "Deliveries that work intermittently" "SECID167"
25835 .cindex "retry" "intermittently working deliveries"
25836 Some additional logic is needed to cope with cases where a host is
25837 intermittently available, or when a message has some attribute that prevents
25838 its delivery when others to the same address get through. In this situation,
25839 because some messages are successfully delivered, the &"retry clock"& for the
25840 host or address keeps getting reset by the successful deliveries, and so
25841 failing messages remain on the queue for ever because the cutoff time is never
25842 reached.
25843
25844 Two exceptional actions are applied to prevent this happening. The first
25845 applies to errors that are related to a message rather than a remote host.
25846 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
25847 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
25848 commands, and quota failures. For this type of error, if a message's arrival
25849 time is earlier than the &"first failed"& time for the error, the earlier time
25850 is used when scanning the retry rules to decide when to try next and when to
25851 time out the address.
25852
25853 The exceptional second action applies in all cases. If a message has been on
25854 the queue for longer than the cutoff time of any applicable retry rule for a
25855 given address, a delivery is attempted for that address, even if it is not yet
25856 time, and if this delivery fails, the address is timed out. A new retry time is
25857 not computed in this case, so that other messages for the same address are
25858 considered immediately.
25859 .ecindex IIDretconf1
25860 .ecindex IIDregconf2
25861
25862
25863
25864
25865
25866
25867 . ////////////////////////////////////////////////////////////////////////////
25868 . ////////////////////////////////////////////////////////////////////////////
25869
25870 .chapter "SMTP authentication" "CHAPSMTPAUTH"
25871 .scindex IIDauthconf1 "SMTP" "authentication configuration"
25872 .scindex IIDauthconf2 "authentication"
25873 The &"authenticators"& section of Exim's run time configuration is concerned
25874 with SMTP authentication. This facility is an extension to the SMTP protocol,
25875 described in RFC 2554, which allows a client SMTP host to authenticate itself
25876 to a server. This is a common way for a server to recognize clients that are
25877 permitted to use it as a relay. SMTP authentication is not of relevance to the
25878 transfer of mail between servers that have no managerial connection with each
25879 other.
25880
25881 .cindex "AUTH" "description of"
25882 Very briefly, the way SMTP authentication works is as follows:
25883
25884 .ilist
25885 The server advertises a number of authentication &'mechanisms'& in response to
25886 the client's EHLO command.
25887 .next
25888 The client issues an AUTH command, naming a specific mechanism. The command
25889 may, optionally, contain some authentication data.
25890 .next
25891 The server may issue one or more &'challenges'&, to which the client must send
25892 appropriate responses. In simple authentication mechanisms, the challenges are
25893 just prompts for user names and passwords. The server does not have to issue
25894 any challenges &-- in some mechanisms the relevant data may all be transmitted
25895 with the AUTH command.
25896 .next
25897 The server either accepts or denies authentication.
25898 .next
25899 If authentication succeeds, the client may optionally make use of the AUTH
25900 option on the MAIL command to pass an authenticated sender in subsequent
25901 mail transactions. Authentication lasts for the remainder of the SMTP
25902 connection.
25903 .next
25904 If authentication fails, the client may give up, or it may try a different
25905 authentication mechanism, or it may try transferring mail over the
25906 unauthenticated connection.
25907 .endlist
25908
25909 If you are setting up a client, and want to know which authentication
25910 mechanisms the server supports, you can use Telnet to connect to port 25 (the
25911 SMTP port) on the server, and issue an EHLO command. The response to this
25912 includes the list of supported mechanisms. For example:
25913 .display
25914 &`$ `&&*&`telnet server.example 25`&*&
25915 &`Trying 192.168.34.25...`&
25916 &`Connected to server.example.`&
25917 &`Escape character is &#x0027;^]&#x0027;.`&
25918 &`220 server.example ESMTP Exim 4.20 ...`&
25919 &*&`ehlo client.example`&*&
25920 &`250-server.example Hello client.example [10.8.4.5]`&
25921 &`250-SIZE 52428800`&
25922 &`250-PIPELINING`&
25923 &`250-AUTH PLAIN`&
25924 &`250 HELP`&
25925 .endd
25926 The second-last line of this example output shows that the server supports
25927 authentication using the PLAIN mechanism. In Exim, the different authentication
25928 mechanisms are configured by specifying &'authenticator'& drivers. Like the
25929 routers and transports, which authenticators are included in the binary is
25930 controlled by build-time definitions. The following are currently available,
25931 included by setting
25932 .code
25933 AUTH_CRAM_MD5=yes
25934 AUTH_CYRUS_SASL=yes
25935 AUTH_DOVECOT=yes
25936 AUTH_GSASL=yes
25937 AUTH_HEIMDAL_GSSAPI=yes
25938 AUTH_PLAINTEXT=yes
25939 AUTH_SPA=yes
25940 AUTH_TLS=yes
25941 .endd
25942 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
25943 authentication mechanism (RFC 2195), and the second provides an interface to
25944 the Cyrus SASL authentication library.
25945 The third is an interface to Dovecot's authentication system, delegating the
25946 work via a socket interface.
25947 The fourth provides an interface to the GNU SASL authentication library, which
25948 provides mechanisms but typically not data sources.
25949 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
25950 supporting setting a server keytab.
25951 The sixth can be configured to support
25952 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
25953 not formally documented, but used by several MUAs. The seventh authenticator
25954 supports Microsoft's &'Secure Password Authentication'& mechanism.
25955 The eighth is an Exim authenticator but not an SMTP one;
25956 instead it can use information from a TLS negotiation.
25957
25958 The authenticators are configured using the same syntax as other drivers (see
25959 section &<<SECTfordricon>>&). If no authenticators are required, no
25960 authentication section need be present in the configuration file. Each
25961 authenticator can in principle have both server and client functions. When Exim
25962 is receiving SMTP mail, it is acting as a server; when it is sending out
25963 messages over SMTP, it is acting as a client. Authenticator configuration
25964 options are provided for use in both these circumstances.
25965
25966 To make it clear which options apply to which situation, the prefixes
25967 &%server_%& and &%client_%& are used on option names that are specific to
25968 either the server or the client function, respectively. Server and client
25969 functions are disabled if none of their options are set. If an authenticator is
25970 to be used for both server and client functions, a single definition, using
25971 both sets of options, is required. For example:
25972 .code
25973 cram:
25974   driver = cram_md5
25975   public_name = CRAM-MD5
25976   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
25977   client_name = ph10
25978   client_secret = secret2
25979 .endd
25980 The &%server_%& option is used when Exim is acting as a server, and the
25981 &%client_%& options when it is acting as a client.
25982
25983 Descriptions of the individual authenticators are given in subsequent chapters.
25984 The remainder of this chapter covers the generic options for the
25985 authenticators, followed by general discussion of the way authentication works
25986 in Exim.
25987
25988 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
25989 per-mechanism basis.  Please read carefully to determine which variables hold
25990 account labels such as usercodes and which hold passwords or other
25991 authenticating data.
25992
25993 Note that some mechanisms support two different identifiers for accounts: the
25994 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
25995 and &'authz'& are commonly encountered.  The American spelling is standard here.
25996 Conceptually, authentication data such as passwords are tied to the identifier
25997 used to authenticate; servers may have rules to permit one user to act as a
25998 second user, so that after login the session is treated as though that second
25999 user had logged in.  That second user is the &'authorization id'&.  A robust
26000 configuration might confirm that the &'authz'& field is empty or matches the
26001 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
26002 as verified data, the &'authz'& as an unverified request which the server might
26003 choose to honour.
26004
26005 A &'realm'& is a text string, typically a domain name, presented by a server
26006 to a client to help it select an account and credentials to use.  In some
26007 mechanisms, the client and server provably agree on the realm, but clients
26008 typically can not treat the realm as secure data to be blindly trusted.
26009
26010
26011
26012 .section "Generic options for authenticators" "SECID168"
26013 .cindex "authentication" "generic options"
26014 .cindex "options" "generic; for authenticators"
26015
26016 .option client_condition authenticators string&!! unset
26017 When Exim is authenticating as a client, it skips any authenticator whose
26018 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
26019 used, for example, to skip plain text authenticators when the connection is not
26020 encrypted by a setting such as:
26021 .code
26022 client_condition = ${if !eq{$tls_out_cipher}{}}
26023 .endd
26024
26025
26026 .option client_set_id authenticators string&!! unset
26027 When client authentication succeeds, this condition is expanded; the
26028 result is used in the log lines for outbound messages.
26029 Typically it will be the user name used for authentication.
26030
26031
26032 .option driver authenticators string unset
26033 This option must always be set. It specifies which of the available
26034 authenticators is to be used.
26035
26036
26037 .option public_name authenticators string unset
26038 This option specifies the name of the authentication mechanism that the driver
26039 implements, and by which it is known to the outside world. These names should
26040 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
26041 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
26042 defaults to the driver's instance name.
26043
26044
26045 .option server_advertise_condition authenticators string&!! unset
26046 When a server is about to advertise an authentication mechanism, the condition
26047 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
26048 mechanism is not advertised.
26049 If the expansion fails, the mechanism is not advertised. If the failure was not
26050 forced, and was not caused by a lookup defer, the incident is logged.
26051 See section &<<SECTauthexiser>>& below for further discussion.
26052
26053
26054 .option server_condition authenticators string&!! unset
26055 This option must be set for a &%plaintext%& server authenticator, where it
26056 is used directly to control authentication. See section &<<SECTplainserver>>&
26057 for details.
26058
26059 For the &(gsasl)& authenticator, this option is required for various
26060 mechanisms; see chapter &<<CHAPgsasl>>& for details.
26061
26062 For the other authenticators, &%server_condition%& can be used as an additional
26063 authentication or authorization mechanism that is applied after the other
26064 authenticator conditions succeed. If it is set, it is expanded when the
26065 authenticator would otherwise return a success code. If the expansion is forced
26066 to fail, authentication fails. Any other expansion failure causes a temporary
26067 error code to be returned. If the result of a successful expansion is an empty
26068 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26069 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
26070 other result, a temporary error code is returned, with the expanded string as
26071 the error text.
26072
26073
26074 .option server_debug_print authenticators string&!! unset
26075 If this option is set and authentication debugging is enabled (see the &%-d%&
26076 command line option), the string is expanded and included in the debugging
26077 output when the authenticator is run as a server. This can help with checking
26078 out the values of variables.
26079 If expansion of the string fails, the error message is written to the debugging
26080 output, and Exim carries on processing.
26081
26082
26083 .option server_set_id authenticators string&!! unset
26084 .vindex "&$authenticated_id$&"
26085 When an Exim server successfully authenticates a client, this string is
26086 expanded using data from the authentication, and preserved for any incoming
26087 messages in the variable &$authenticated_id$&. It is also included in the log
26088 lines for incoming messages. For example, a user/password authenticator
26089 configuration might preserve the user name that was used to authenticate, and
26090 refer to it subsequently during delivery of the message.
26091 If expansion fails, the option is ignored.
26092
26093
26094 .option server_mail_auth_condition authenticators string&!! unset
26095 This option allows a server to discard authenticated sender addresses supplied
26096 as part of MAIL commands in SMTP connections that are authenticated by the
26097 driver on which &%server_mail_auth_condition%& is set. The option is not used
26098 as part of the authentication process; instead its (unexpanded) value is
26099 remembered for later use.
26100 How it is used is described in the following section.
26101
26102
26103
26104
26105
26106 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
26107 .cindex "authentication" "sender; authenticated"
26108 .cindex "AUTH" "on MAIL command"
26109 When a client supplied an AUTH= item on a MAIL command, Exim applies
26110 the following checks before accepting it as the authenticated sender of the
26111 message:
26112
26113 .ilist
26114 If the connection is not using extended SMTP (that is, HELO was used rather
26115 than EHLO), the use of AUTH= is a syntax error.
26116 .next
26117 If the value of the AUTH= parameter is &"<>"&, it is ignored.
26118 .next
26119 .vindex "&$authenticated_sender$&"
26120 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
26121 running, the value of &$authenticated_sender$& is set to the value obtained
26122 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
26123 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
26124 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
26125 given for the MAIL command.
26126 .next
26127 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
26128 is accepted and placed in &$authenticated_sender$& only if the client has
26129 authenticated.
26130 .next
26131 If the AUTH= value was accepted by either of the two previous rules, and
26132 the client has authenticated, and the authenticator has a setting for the
26133 &%server_mail_auth_condition%&, the condition is checked at this point. The
26134 valued that was saved from the authenticator is expanded. If the expansion
26135 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
26136 &$authenticated_sender$& is deleted. If the expansion yields any other value,
26137 the value of &$authenticated_sender$& is retained and passed on with the
26138 message.
26139 .endlist
26140
26141
26142 When &$authenticated_sender$& is set for a message, it is passed on to other
26143 hosts to which Exim authenticates as a client. Do not confuse this value with
26144 &$authenticated_id$&, which is a string obtained from the authentication
26145 process, and which is not usually a complete email address.
26146
26147 .vindex "&$sender_address$&"
26148 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
26149 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
26150 therefore make use of &$authenticated_sender$&. The converse is not true: the
26151 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
26152 ACL is run.
26153
26154
26155
26156 .section "Authentication on an Exim server" "SECTauthexiser"
26157 .cindex "authentication" "on an Exim server"
26158 When Exim receives an EHLO command, it advertises the public names of those
26159 authenticators that are configured as servers, subject to the following
26160 conditions:
26161
26162 .ilist
26163 The client host must match &%auth_advertise_hosts%& (default *).
26164 .next
26165 It the &%server_advertise_condition%& option is set, its expansion must not
26166 yield the empty string, &"0"&, &"no"&, or &"false"&.
26167 .endlist
26168
26169 The order in which the authenticators are defined controls the order in which
26170 the mechanisms are advertised.
26171
26172 Some mail clients (for example, some versions of Netscape) require the user to
26173 provide a name and password for authentication whenever AUTH is advertised,
26174 even though authentication may not in fact be needed (for example, Exim may be
26175 set up to allow unconditional relaying from the client by an IP address check).
26176 You can make such clients more friendly by not advertising AUTH to them.
26177 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
26178 that runs for RCPT) to relay without authentication, you should set
26179 .code
26180 auth_advertise_hosts = ! 10.9.8.0/24
26181 .endd
26182 so that no authentication mechanisms are advertised to them.
26183
26184 The &%server_advertise_condition%& controls the advertisement of individual
26185 authentication mechanisms. For example, it can be used to restrict the
26186 advertisement of a particular mechanism to encrypted connections, by a setting
26187 such as:
26188 .code
26189 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
26190 .endd
26191 .vindex "&$tls_in_cipher$&"
26192 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
26193 yields &"yes"&, which allows the advertisement to happen.
26194
26195 When an Exim server receives an AUTH command from a client, it rejects it
26196 immediately if AUTH was not advertised in response to an earlier EHLO
26197 command. This is the case if
26198
26199 .ilist
26200 The client host does not match &%auth_advertise_hosts%&; or
26201 .next
26202 No authenticators are configured with server options; or
26203 .next
26204 Expansion of &%server_advertise_condition%& blocked the advertising of all the
26205 server authenticators.
26206 .endlist
26207
26208
26209 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
26210 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
26211 AUTH is accepted from any client host.
26212
26213 If AUTH is not rejected by the ACL, Exim searches its configuration for a
26214 server authentication mechanism that was advertised in response to EHLO and
26215 that matches the one named in the AUTH command. If it finds one, it runs
26216 the appropriate authentication protocol, and authentication either succeeds or
26217 fails. If there is no matching advertised mechanism, the AUTH command is
26218 rejected with a 504 error.
26219
26220 .vindex "&$received_protocol$&"
26221 .vindex "&$sender_host_authenticated$&"
26222 When a message is received from an authenticated host, the value of
26223 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
26224 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
26225 public name) of the authenticator driver that successfully authenticated the
26226 client from which the message was received. This variable is empty if there was
26227 no successful authentication.
26228
26229 .cindex authentication "expansion item"
26230 Successful authentication sets up information used by the
26231 &$authresults$& expansion item.
26232
26233
26234
26235
26236 .section "Testing server authentication" "SECID169"
26237 .cindex "authentication" "testing a server"
26238 .cindex "AUTH" "testing a server"
26239 .cindex "base64 encoding" "creating authentication test data"
26240 Exim's &%-bh%& option can be useful for testing server authentication
26241 configurations. The data for the AUTH command has to be sent using base64
26242 encoding. A quick way to produce such data for testing is the following Perl
26243 script:
26244 .code
26245 use MIME::Base64;
26246 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
26247 .endd
26248 .cindex "binary zero" "in authentication data"
26249 This interprets its argument as a Perl string, and then encodes it. The
26250 interpretation as a Perl string allows binary zeros, which are required for
26251 some kinds of authentication, to be included in the data. For example, a
26252 command line to run this script on such data might be
26253 .code
26254 encode '\0user\0password'
26255 .endd
26256 Note the use of single quotes to prevent the shell interpreting the
26257 backslashes, so that they can be interpreted by Perl to specify characters
26258 whose code value is zero.
26259
26260 &*Warning 1*&: If either of the user or password strings starts with an octal
26261 digit, you must use three zeros instead of one after the leading backslash. If
26262 you do not, the octal digit that starts your string will be incorrectly
26263 interpreted as part of the code for the first character.
26264
26265 &*Warning 2*&: If there are characters in the strings that Perl interprets
26266 specially, you must use a Perl escape to prevent them being misinterpreted. For
26267 example, a command such as
26268 .code
26269 encode '\0user@domain.com\0pas$$word'
26270 .endd
26271 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
26272
26273 If you have the &%mimencode%& command installed, another way to do produce
26274 base64-encoded strings is to run the command
26275 .code
26276 echo -e -n `\0user\0password' | mimencode
26277 .endd
26278 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
26279 in the argument, and the &%-n%& option specifies no newline at the end of its
26280 output. However, not all versions of &%echo%& recognize these options, so you
26281 should check your version before relying on this suggestion.
26282
26283
26284
26285 .section "Authentication by an Exim client" "SECID170"
26286 .cindex "authentication" "on an Exim client"
26287 The &(smtp)& transport has two options called &%hosts_require_auth%& and
26288 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
26289 announces support for authentication, and the host matches an entry in either
26290 of these options, Exim (as a client) tries to authenticate as follows:
26291
26292 .ilist
26293 For each authenticator that is configured as a client, in the order in which
26294 they are defined in the configuration, it searches the authentication
26295 mechanisms announced by the server for one whose name matches the public name
26296 of the authenticator.
26297 .next
26298 .vindex "&$host$&"
26299 .vindex "&$host_address$&"
26300 When it finds one that matches, it runs the authenticator's client code. The
26301 variables &$host$& and &$host_address$& are available for any string expansions
26302 that the client might do. They are set to the server's name and IP address. If
26303 any expansion is forced to fail, the authentication attempt is abandoned, and
26304 Exim moves on to the next authenticator. Otherwise an expansion failure causes
26305 delivery to be deferred.
26306 .next
26307 If the result of the authentication attempt is a temporary error or a timeout,
26308 Exim abandons trying to send the message to the host for the moment. It will
26309 try again later. If there are any backup hosts available, they are tried in the
26310 usual way.
26311 .next
26312 If the response to authentication is a permanent error (5&'xx'& code), Exim
26313 carries on searching the list of authenticators and tries another one if
26314 possible. If all authentication attempts give permanent errors, or if there are
26315 no attempts because no mechanisms match (or option expansions force failure),
26316 what happens depends on whether the host matches &%hosts_require_auth%& or
26317 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
26318 delivery is deferred. The error can be detected in the retry rules, and thereby
26319 turned into a permanent error if you wish. In the second case, Exim tries to
26320 deliver the message unauthenticated.
26321 .endlist
26322
26323 Note that the hostlist test for whether to do authentication can be
26324 confused if name-IP lookups change between the time the peer is decided
26325 upon and the time that the transport runs.  For example, with a manualroute
26326 router given a host name, and with DNS "round-robin" used by that name: if
26327 the local resolver cache times out between the router and the transport
26328 running, the transport may get an IP for the name for its authentication
26329 check which does not match the connection peer IP.
26330 No authentication will then be done, despite the names being identical.
26331
26332 For such cases use a separate transport which always authenticates.
26333
26334 .cindex "AUTH" "on MAIL command"
26335 When Exim has authenticated itself to a remote server, it adds the AUTH
26336 parameter to the MAIL commands it sends, if it has an authenticated sender for
26337 the message. If the message came from a remote host, the authenticated sender
26338 is the one that was receiving on an incoming MAIL command, provided that the
26339 incoming connection was authenticated and the &%server_mail_auth%& condition
26340 allowed the authenticated sender to be retained. If a local process calls Exim
26341 to send a message, the sender address that is built from the login name and
26342 &%qualify_domain%& is treated as authenticated. However, if the
26343 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
26344 the authenticated sender that was received with the message.
26345 .ecindex IIDauthconf1
26346 .ecindex IIDauthconf2
26347
26348
26349
26350
26351
26352
26353 . ////////////////////////////////////////////////////////////////////////////
26354 . ////////////////////////////////////////////////////////////////////////////
26355
26356 .chapter "The plaintext authenticator" "CHAPplaintext"
26357 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
26358 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
26359 The &(plaintext)& authenticator can be configured to support the PLAIN and
26360 LOGIN authentication mechanisms, both of which transfer authentication data as
26361 plain (unencrypted) text (though base64 encoded). The use of plain text is a
26362 security risk; you are strongly advised to insist on the use of SMTP encryption
26363 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
26364 use unencrypted plain text, you should not use the same passwords for SMTP
26365 connections as you do for login accounts.
26366
26367 .section "Plaintext options" "SECID171"
26368 .cindex "options" "&(plaintext)& authenticator (server)"
26369 When configured as a server, &(plaintext)& uses the following options:
26370
26371 .option server_condition authenticators string&!! unset
26372 This is actually a global authentication option, but it must be set in order to
26373 configure the &(plaintext)& driver as a server. Its use is described below.
26374
26375 .option server_prompts plaintext string&!! unset
26376 The contents of this option, after expansion, must be a colon-separated list of
26377 prompt strings. If expansion fails, a temporary authentication rejection is
26378 given.
26379
26380 .section "Using plaintext in a server" "SECTplainserver"
26381 .cindex "AUTH" "in &(plaintext)& authenticator"
26382 .cindex "binary zero" "in &(plaintext)& authenticator"
26383 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
26384         "in &(plaintext)& authenticator"
26385 .vindex "&$auth1$&, &$auth2$&, etc"
26386 .cindex "base64 encoding" "in &(plaintext)& authenticator"
26387
26388 When running as a server, &(plaintext)& performs the authentication test by
26389 expanding a string. The data sent by the client with the AUTH command, or in
26390 response to subsequent prompts, is base64 encoded, and so may contain any byte
26391 values when decoded. If any data is supplied with the command, it is treated as
26392 a list of strings, separated by NULs (binary zeros), the first three of which
26393 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
26394 (neither LOGIN nor PLAIN uses more than three strings).
26395
26396 For compatibility with previous releases of Exim, the values are also placed in
26397 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
26398 variables for this purpose is now deprecated, as it can lead to confusion in
26399 string expansions that also use them for other things.
26400
26401 If there are more strings in &%server_prompts%& than the number of strings
26402 supplied with the AUTH command, the remaining prompts are used to obtain more
26403 data. Each response from the client may be a list of NUL-separated strings.
26404
26405 .vindex "&$authenticated_id$&"
26406 Once a sufficient number of data strings have been received,
26407 &%server_condition%& is expanded. If the expansion is forced to fail,
26408 authentication fails. Any other expansion failure causes a temporary error code
26409 to be returned. If the result of a successful expansion is an empty string,
26410 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26411 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
26412 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
26413 For any other result, a temporary error code is returned, with the expanded
26414 string as the error text
26415
26416 &*Warning*&: If you use a lookup in the expansion to find the user's
26417 password, be sure to make the authentication fail if the user is unknown.
26418 There are good and bad examples at the end of the next section.
26419
26420
26421
26422 .section "The PLAIN authentication mechanism" "SECID172"
26423 .cindex "PLAIN authentication mechanism"
26424 .cindex "authentication" "PLAIN mechanism"
26425 .cindex "binary zero" "in &(plaintext)& authenticator"
26426 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
26427 sent as one item of data (that is, one combined string containing two NUL
26428 separators). The data is sent either as part of the AUTH command, or
26429 subsequently in response to an empty prompt from the server.
26430
26431 The second and third strings are a user name and a corresponding password.
26432 Using a single fixed user name and password as an example, this could be
26433 configured as follows:
26434 .code
26435 fixed_plain:
26436   driver = plaintext
26437   public_name = PLAIN
26438   server_prompts = :
26439   server_condition = \
26440     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
26441   server_set_id = $auth2
26442 .endd
26443 Note that the default result strings from &%if%& (&"true"& or an empty string)
26444 are exactly what we want here, so they need not be specified. Obviously, if the
26445 password contains expansion-significant characters such as dollar, backslash,
26446 or closing brace, they have to be escaped.
26447
26448 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
26449 the end of a string list are ignored). If all the data comes as part of the
26450 AUTH command, as is commonly the case, the prompt is not used. This
26451 authenticator is advertised in the response to EHLO as
26452 .code
26453 250-AUTH PLAIN
26454 .endd
26455 and a client host can authenticate itself by sending the command
26456 .code
26457 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
26458 .endd
26459 As this contains three strings (more than the number of prompts), no further
26460 data is required from the client. Alternatively, the client may just send
26461 .code
26462 AUTH PLAIN
26463 .endd
26464 to initiate authentication, in which case the server replies with an empty
26465 prompt. The client must respond with the combined data string.
26466
26467 The data string is base64 encoded, as required by the RFC. This example,
26468 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
26469 represents a zero byte. This is split up into three strings, the first of which
26470 is empty. The &%server_condition%& option in the authenticator checks that the
26471 second two are &`username`& and &`mysecret`& respectively.
26472
26473 Having just one fixed user name and password, as in this example, is not very
26474 realistic, though for a small organization with only a handful of
26475 authenticating clients it could make sense.
26476
26477 A more sophisticated instance of this authenticator could use the user name in
26478 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
26479 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
26480 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
26481 This is an incorrect example:
26482 .code
26483 server_condition = \
26484   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
26485 .endd
26486 The expansion uses the user name (&$auth2$&) as the key to look up a password,
26487 which it then compares to the supplied password (&$auth3$&). Why is this example
26488 incorrect? It works fine for existing users, but consider what happens if a
26489 non-existent user name is given. The lookup fails, but as no success/failure
26490 strings are given for the lookup, it yields an empty string. Thus, to defeat
26491 the authentication, all a client has to do is to supply a non-existent user
26492 name and an empty password. The correct way of writing this test is:
26493 .code
26494 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
26495   {${if eq{$value}{$auth3}}} {false}}
26496 .endd
26497 In this case, if the lookup succeeds, the result is checked; if the lookup
26498 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
26499 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
26500 always fails if its second argument is empty. However, the second way of
26501 writing the test makes the logic clearer.
26502
26503
26504 .section "The LOGIN authentication mechanism" "SECID173"
26505 .cindex "LOGIN authentication mechanism"
26506 .cindex "authentication" "LOGIN mechanism"
26507 The LOGIN authentication mechanism is not documented in any RFC, but is in use
26508 in a number of programs. No data is sent with the AUTH command. Instead, a
26509 user name and password are supplied separately, in response to prompts. The
26510 plaintext authenticator can be configured to support this as in this example:
26511 .code
26512 fixed_login:
26513   driver = plaintext
26514   public_name = LOGIN
26515   server_prompts = User Name : Password
26516   server_condition = \
26517     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
26518   server_set_id = $auth1
26519 .endd
26520 Because of the way plaintext operates, this authenticator accepts data supplied
26521 with the AUTH command (in contravention of the specification of LOGIN), but
26522 if the client does not supply it (as is the case for LOGIN clients), the prompt
26523 strings are used to obtain two data items.
26524
26525 Some clients are very particular about the precise text of the prompts. For
26526 example, Outlook Express is reported to recognize only &"Username:"& and
26527 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
26528 strings. It uses the &%ldapauth%& expansion condition to check the user
26529 name and password by binding to an LDAP server:
26530 .code
26531 login:
26532   driver = plaintext
26533   public_name = LOGIN
26534   server_prompts = Username:: : Password::
26535   server_condition = ${if and{{ \
26536     !eq{}{$auth1} }{ \
26537     ldapauth{\
26538       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
26539       pass=${quote:$auth2} \
26540       ldap://ldap.example.org/} }} }
26541   server_set_id = uid=$auth1,ou=people,o=example.org
26542 .endd
26543 We have to check that the username is not empty before using it, because LDAP
26544 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
26545 operator to correctly quote the DN for authentication. However, the basic
26546 &%quote%& operator, rather than any of the LDAP quoting operators, is the
26547 correct one to use for the password, because quoting is needed only to make
26548 the password conform to the Exim syntax. At the LDAP level, the password is an
26549 uninterpreted string.
26550
26551
26552 .section "Support for different kinds of authentication" "SECID174"
26553 A number of string expansion features are provided for the purpose of
26554 interfacing to different ways of user authentication. These include checking
26555 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
26556 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
26557 &<<SECTexpcond>>&.
26558
26559
26560
26561
26562 .section "Using plaintext in a client" "SECID175"
26563 .cindex "options" "&(plaintext)& authenticator (client)"
26564 The &(plaintext)& authenticator has two client options:
26565
26566 .option client_ignore_invalid_base64 plaintext boolean false
26567 If the client receives a server prompt that is not a valid base64 string,
26568 authentication is abandoned by default. However, if this option is set true,
26569 the error in the challenge is ignored and the client sends the response as
26570 usual.
26571
26572 .option client_send plaintext string&!! unset
26573 The string is a colon-separated list of authentication data strings. Each
26574 string is independently expanded before being sent to the server. The first
26575 string is sent with the AUTH command; any more strings are sent in response
26576 to prompts from the server. Before each string is expanded, the value of the
26577 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
26578 with &$auth1$& for the first prompt. Up to three prompts are stored in this
26579 way. Thus, the prompt that is received in response to sending the first string
26580 (with the AUTH command) can be used in the expansion of the second string, and
26581 so on. If an invalid base64 string is received when
26582 &%client_ignore_invalid_base64%& is set, an empty string is put in the
26583 &$auth$&<&'n'&> variable.
26584
26585 &*Note*&: You cannot use expansion to create multiple strings, because
26586 splitting takes priority and happens first.
26587
26588 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
26589 the data, further processing is applied to each string before it is sent. If
26590 there are any single circumflex characters in the string, they are converted to
26591 NULs. Should an actual circumflex be required as data, it must be doubled in
26592 the string.
26593
26594 This is an example of a client configuration that implements the PLAIN
26595 authentication mechanism with a fixed user name and password:
26596 .code
26597 fixed_plain:
26598   driver = plaintext
26599   public_name = PLAIN
26600   client_send = ^username^mysecret
26601 .endd
26602 The lack of colons means that the entire text is sent with the AUTH
26603 command, with the circumflex characters converted to NULs. A similar example
26604 that uses the LOGIN mechanism is:
26605 .code
26606 fixed_login:
26607   driver = plaintext
26608   public_name = LOGIN
26609   client_send = : username : mysecret
26610 .endd
26611 The initial colon means that the first string is empty, so no data is sent with
26612 the AUTH command itself. The remaining strings are sent in response to
26613 prompts.
26614 .ecindex IIDplaiauth1
26615 .ecindex IIDplaiauth2
26616
26617
26618
26619
26620 . ////////////////////////////////////////////////////////////////////////////
26621 . ////////////////////////////////////////////////////////////////////////////
26622
26623 .chapter "The cram_md5 authenticator" "CHID9"
26624 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
26625 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
26626 .cindex "CRAM-MD5 authentication mechanism"
26627 .cindex "authentication" "CRAM-MD5 mechanism"
26628 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
26629 sends a challenge string to the client, and the response consists of a user
26630 name and the CRAM-MD5 digest of the challenge string combined with a secret
26631 string (password) which is known to both server and client. Thus, the secret
26632 is not sent over the network as plain text, which makes this authenticator more
26633 secure than &(plaintext)&. However, the downside is that the secret has to be
26634 available in plain text at either end.
26635
26636
26637 .section "Using cram_md5 as a server" "SECID176"
26638 .cindex "options" "&(cram_md5)& authenticator (server)"
26639 This authenticator has one server option, which must be set to configure the
26640 authenticator as a server:
26641
26642 .option server_secret cram_md5 string&!! unset
26643 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
26644 When the server receives the client's response, the user name is placed in
26645 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
26646 obtain the password for that user. The server then computes the CRAM-MD5 digest
26647 that the client should have sent, and checks that it received the correct
26648 string. If the expansion of &%server_secret%& is forced to fail, authentication
26649 fails. If the expansion fails for some other reason, a temporary error code is
26650 returned to the client.
26651
26652 For compatibility with previous releases of Exim, the user name is also placed
26653 in &$1$&. However, the use of this variables for this purpose is now
26654 deprecated, as it can lead to confusion in string expansions that also use
26655 numeric variables for other things.
26656
26657 For example, the following authenticator checks that the user name given by the
26658 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
26659 user name, authentication fails.
26660 .code
26661 fixed_cram:
26662   driver = cram_md5
26663   public_name = CRAM-MD5
26664   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
26665   server_set_id = $auth1
26666 .endd
26667 .vindex "&$authenticated_id$&"
26668 If authentication succeeds, the setting of &%server_set_id%& preserves the user
26669 name in &$authenticated_id$&. A more typical configuration might look up the
26670 secret string in a file, using the user name as the key. For example:
26671 .code
26672 lookup_cram:
26673   driver = cram_md5
26674   public_name = CRAM-MD5
26675   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
26676                   {$value}fail}
26677   server_set_id = $auth1
26678 .endd
26679 Note that this expansion explicitly forces failure if the lookup fails
26680 because &$auth1$& contains an unknown user name.
26681
26682 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
26683 using the relevant libraries, you need to know the realm to specify in the
26684 lookup and then ask for the &"userPassword"& attribute for that user in that
26685 realm, with:
26686 .code
26687 cyrusless_crammd5:
26688   driver = cram_md5
26689   public_name = CRAM-MD5
26690   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
26691                   dbmjz{/etc/sasldb2}{$value}fail}
26692   server_set_id = $auth1
26693 .endd
26694
26695 .section "Using cram_md5 as a client" "SECID177"
26696 .cindex "options" "&(cram_md5)& authenticator (client)"
26697 When used as a client, the &(cram_md5)& authenticator has two options:
26698
26699
26700
26701 .option client_name cram_md5 string&!! "the primary host name"
26702 This string is expanded, and the result used as the user name data when
26703 computing the response to the server's challenge.
26704
26705
26706 .option client_secret cram_md5 string&!! unset
26707 This option must be set for the authenticator to work as a client. Its value is
26708 expanded and the result used as the secret string when computing the response.
26709
26710
26711 .vindex "&$host$&"
26712 .vindex "&$host_address$&"
26713 Different user names and secrets can be used for different servers by referring
26714 to &$host$& or &$host_address$& in the options. Forced failure of either
26715 expansion string is treated as an indication that this authenticator is not
26716 prepared to handle this case. Exim moves on to the next configured client
26717 authenticator. Any other expansion failure causes Exim to give up trying to
26718 send the message to the current server.
26719
26720 A simple example configuration of a &(cram_md5)& authenticator, using fixed
26721 strings, is:
26722 .code
26723 fixed_cram:
26724   driver = cram_md5
26725   public_name = CRAM-MD5
26726   client_name = ph10
26727   client_secret = secret
26728 .endd
26729 .ecindex IIDcramauth1
26730 .ecindex IIDcramauth2
26731
26732
26733
26734 . ////////////////////////////////////////////////////////////////////////////
26735 . ////////////////////////////////////////////////////////////////////////////
26736
26737 .chapter "The cyrus_sasl authenticator" "CHID10"
26738 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
26739 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
26740 .cindex "Cyrus" "SASL library"
26741 .cindex "Kerberos"
26742 The code for this authenticator was provided by Matthew Byng-Maddick while
26743 at A L Digital Ltd.
26744
26745 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
26746 library implementation of the RFC 2222 (&"Simple Authentication and Security
26747 Layer"&). This library supports a number of authentication mechanisms,
26748 including PLAIN and LOGIN, but also several others that Exim does not support
26749 directly. In particular, there is support for Kerberos authentication.
26750
26751 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
26752 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
26753 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
26754 name of the driver to determine which mechanism to support.
26755
26756 Where access to some kind of secret file is required, for example in GSSAPI
26757 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
26758 user, and that the Cyrus SASL library has no way of escalating privileges
26759 by default. You may also find you need to set environment variables,
26760 depending on the driver you are using.
26761
26762 The application name provided by Exim is &"exim"&, so various SASL options may
26763 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
26764 Kerberos, note that because of limitations in the GSSAPI interface,
26765 changing the server keytab might need to be communicated down to the Kerberos
26766 layer independently. The mechanism for doing so is dependent upon the Kerberos
26767 implementation.
26768
26769 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
26770 may be set to point to an alternative keytab file. Exim will pass this
26771 variable through from its own inherited environment when started as root or the
26772 Exim user. The keytab file needs to be readable by the Exim user.
26773 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
26774 environment variable.  In practice, for those releases, the Cyrus authenticator
26775 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
26776 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
26777
26778
26779 .section "Using cyrus_sasl as a server" "SECID178"
26780 The &(cyrus_sasl)& authenticator has four private options. It puts the username
26781 (on a successful authentication) into &$auth1$&. For compatibility with
26782 previous releases of Exim, the username is also placed in &$1$&. However, the
26783 use of this variable for this purpose is now deprecated, as it can lead to
26784 confusion in string expansions that also use numeric variables for other
26785 things.
26786
26787
26788 .option server_hostname cyrus_sasl string&!! "see below"
26789 This option selects the hostname that is used when communicating with the
26790 library. The default value is &`$primary_hostname`&. It is up to the underlying
26791 SASL plug-in what it does with this data.
26792
26793
26794 .option server_mech cyrus_sasl string "see below"
26795 This option selects the authentication mechanism this driver should use. The
26796 default is the value of the generic &%public_name%& option. This option allows
26797 you to use a different underlying mechanism from the advertised name. For
26798 example:
26799 .code
26800 sasl:
26801   driver = cyrus_sasl
26802   public_name = X-ANYTHING
26803   server_mech = CRAM-MD5
26804   server_set_id = $auth1
26805 .endd
26806
26807 .option server_realm cyrus_sasl string&!! unset
26808 This specifies the SASL realm that the server claims to be in.
26809
26810
26811 .option server_service cyrus_sasl string &`smtp`&
26812 This is the SASL service that the server claims to implement.
26813
26814
26815 For straightforward cases, you do not need to set any of the authenticator's
26816 private options. All you need to do is to specify an appropriate mechanism as
26817 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
26818 PLAIN, you could have two authenticators as follows:
26819 .code
26820 sasl_cram_md5:
26821   driver = cyrus_sasl
26822   public_name = CRAM-MD5
26823   server_set_id = $auth1
26824
26825 sasl_plain:
26826   driver = cyrus_sasl
26827   public_name = PLAIN
26828   server_set_id = $auth2
26829 .endd
26830 Cyrus SASL does implement the LOGIN authentication method, even though it is
26831 not a standard method. It is disabled by default in the source distribution,
26832 but it is present in many binary distributions.
26833 .ecindex IIDcyrauth1
26834 .ecindex IIDcyrauth2
26835
26836
26837
26838
26839 . ////////////////////////////////////////////////////////////////////////////
26840 . ////////////////////////////////////////////////////////////////////////////
26841 .chapter "The dovecot authenticator" "CHAPdovecot"
26842 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
26843 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
26844 This authenticator is an interface to the authentication facility of the
26845 Dovecot POP/IMAP server, which can support a number of authentication methods.
26846 Note that Dovecot must be configured to use auth-client not auth-userdb.
26847 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
26848 to use the same mechanisms for SMTP authentication. This is a server
26849 authenticator only. There is only one option:
26850
26851 .option server_socket dovecot string unset
26852
26853 This option must specify the UNIX socket that is the interface to Dovecot
26854 authentication. The &%public_name%& option must specify an authentication
26855 mechanism that Dovecot is configured to support. You can have several
26856 authenticators for different mechanisms. For example:
26857 .code
26858 dovecot_plain:
26859   driver = dovecot
26860   public_name = PLAIN
26861   server_socket = /var/run/dovecot/auth-client
26862   server_set_id = $auth1
26863
26864 dovecot_ntlm:
26865   driver = dovecot
26866   public_name = NTLM
26867   server_socket = /var/run/dovecot/auth-client
26868   server_set_id = $auth1
26869 .endd
26870 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
26871 &$received_ip_address$& (that is, the connection is local), the &"secured"&
26872 option is passed in the Dovecot authentication command. If, for a TLS
26873 connection, a client certificate has been verified, the &"valid-client-cert"&
26874 option is passed. When authentication succeeds, the identity of the user
26875 who authenticated is placed in &$auth1$&.
26876 .ecindex IIDdcotauth1
26877 .ecindex IIDdcotauth2
26878
26879
26880 . ////////////////////////////////////////////////////////////////////////////
26881 . ////////////////////////////////////////////////////////////////////////////
26882 .chapter "The gsasl authenticator" "CHAPgsasl"
26883 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
26884 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
26885 .cindex "authentication" "GNU SASL"
26886 .cindex "authentication" "SASL"
26887 .cindex "authentication" "EXTERNAL"
26888 .cindex "authentication" "ANONYMOUS"
26889 .cindex "authentication" "PLAIN"
26890 .cindex "authentication" "LOGIN"
26891 .cindex "authentication" "DIGEST-MD5"
26892 .cindex "authentication" "CRAM-MD5"
26893 .cindex "authentication" "SCRAM-SHA-1"
26894 The &(gsasl)& authenticator provides server integration for the GNU SASL
26895 library and the mechanisms it provides.  This is new as of the 4.80 release
26896 and there are a few areas where the library does not let Exim smoothly
26897 scale to handle future authentication mechanisms, so no guarantee can be
26898 made that any particular new authentication mechanism will be supported
26899 without code changes in Exim.
26900
26901
26902 .option server_channelbinding gsasl boolean false
26903 Do not set this true without consulting a cryptographic engineer.
26904
26905 Some authentication mechanisms are able to use external context at both ends
26906 of the session to bind the authentication to that context, and fail the
26907 authentication process if that context differs.  Specifically, some TLS
26908 ciphersuites can provide identifying information about the cryptographic
26909 context.
26910
26911 This should have meant that certificate identity and verification becomes a
26912 non-issue, as a man-in-the-middle attack will cause the correct client and
26913 server to see different identifiers and authentication will fail.
26914
26915 This is currently only supported when using the GnuTLS library.  This is
26916 only usable by mechanisms which support "channel binding"; at time of
26917 writing, that's the SCRAM family.
26918
26919 This defaults off to ensure smooth upgrade across Exim releases, in case
26920 this option causes some clients to start failing.  Some future release
26921 of Exim might have switched the default to be true.
26922
26923 However, Channel Binding in TLS has proven to be broken in current versions.
26924 Do not plan to rely upon this feature for security, ever, without consulting
26925 with a subject matter expert (a cryptographic engineer).
26926
26927
26928 .option server_hostname gsasl string&!! "see below"
26929 This option selects the hostname that is used when communicating with the
26930 library. The default value is &`$primary_hostname`&.
26931 Some mechanisms will use this data.
26932
26933
26934 .option server_mech gsasl string "see below"
26935 This option selects the authentication mechanism this driver should use. The
26936 default is the value of the generic &%public_name%& option. This option allows
26937 you to use a different underlying mechanism from the advertised name. For
26938 example:
26939 .code
26940 sasl:
26941   driver = gsasl
26942   public_name = X-ANYTHING
26943   server_mech = CRAM-MD5
26944   server_set_id = $auth1
26945 .endd
26946
26947
26948 .option server_password gsasl string&!! unset
26949 Various mechanisms need access to the cleartext password on the server, so
26950 that proof-of-possession can be demonstrated on the wire, without sending
26951 the password itself.
26952
26953 The data available for lookup varies per mechanism.
26954 In all cases, &$auth1$& is set to the &'authentication id'&.
26955 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
26956 if available, else the empty string.
26957 The &$auth3$& variable will always be the &'realm'& if available,
26958 else the empty string.
26959
26960 A forced failure will cause authentication to defer.
26961
26962 If using this option, it may make sense to set the &%server_condition%&
26963 option to be simply "true".
26964
26965
26966 .option server_realm gsasl string&!! unset
26967 This specifies the SASL realm that the server claims to be in.
26968 Some mechanisms will use this data.
26969
26970
26971 .option server_scram_iter gsasl string&!! unset
26972 This option provides data for the SCRAM family of mechanisms.
26973 &$auth1$& is not available at evaluation time.
26974 (This may change, as we receive feedback on use)
26975
26976
26977 .option server_scram_salt gsasl string&!! unset
26978 This option provides data for the SCRAM family of mechanisms.
26979 &$auth1$& is not available at evaluation time.
26980 (This may change, as we receive feedback on use)
26981
26982
26983 .option server_service gsasl string &`smtp`&
26984 This is the SASL service that the server claims to implement.
26985 Some mechanisms will use this data.
26986
26987
26988 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
26989 .vindex "&$auth1$&, &$auth2$&, etc"
26990 These may be set when evaluating specific options, as detailed above.
26991 They will also be set when evaluating &%server_condition%&.
26992
26993 Unless otherwise stated below, the &(gsasl)& integration will use the following
26994 meanings for these variables:
26995
26996 .ilist
26997 .vindex "&$auth1$&"
26998 &$auth1$&: the &'authentication id'&
26999 .next
27000 .vindex "&$auth2$&"
27001 &$auth2$&: the &'authorization id'&
27002 .next
27003 .vindex "&$auth3$&"
27004 &$auth3$&: the &'realm'&
27005 .endlist
27006
27007 On a per-mechanism basis:
27008
27009 .ilist
27010 .cindex "authentication" "EXTERNAL"
27011 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
27012 the &%server_condition%& option must be present.
27013 .next
27014 .cindex "authentication" "ANONYMOUS"
27015 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
27016 the &%server_condition%& option must be present.
27017 .next
27018 .cindex "authentication" "GSSAPI"
27019 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
27020 &$auth2$& will be set to the &'authorization id'&,
27021 the &%server_condition%& option must be present.
27022 .endlist
27023
27024 An &'anonymous token'& is something passed along as an unauthenticated
27025 identifier; this is analogous to FTP anonymous authentication passing an
27026 email address, or software-identifier@, as the "password".
27027
27028
27029 An example showing the password having the realm specified in the callback
27030 and demonstrating a Cyrus SASL to GSASL migration approach is:
27031 .code
27032 gsasl_cyrusless_crammd5:
27033   driver = gsasl
27034   public_name = CRAM-MD5
27035   server_realm = imap.example.org
27036   server_password = ${lookup{$auth1:$auth3:userPassword}\
27037                     dbmjz{/etc/sasldb2}{$value}fail}
27038   server_set_id = ${quote:$auth1}
27039   server_condition = yes
27040 .endd
27041
27042
27043 . ////////////////////////////////////////////////////////////////////////////
27044 . ////////////////////////////////////////////////////////////////////////////
27045
27046 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
27047 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
27048 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
27049 .cindex "authentication" "GSSAPI"
27050 .cindex "authentication" "Kerberos"
27051 The &(heimdal_gssapi)& authenticator provides server integration for the
27052 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
27053 reliably.
27054
27055 .option server_hostname heimdal_gssapi string&!! "see below"
27056 This option selects the hostname that is used, with &%server_service%&,
27057 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
27058 identifier.  The default value is &`$primary_hostname`&.
27059
27060 .option server_keytab heimdal_gssapi string&!! unset
27061 If set, then Heimdal will not use the system default keytab (typically
27062 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
27063 The value should be a pathname, with no &"file:"& prefix.
27064
27065 .option server_service heimdal_gssapi string&!! "smtp"
27066 This option specifies the service identifier used, in conjunction with
27067 &%server_hostname%&, for building the identifier for finding credentials
27068 from the keytab.
27069
27070
27071 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
27072 Beware that these variables will typically include a realm, thus will appear
27073 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
27074 not verified, so a malicious client can set it to anything.
27075
27076 The &$auth1$& field should be safely trustable as a value from the Key
27077 Distribution Center.  Note that these are not quite email addresses.
27078 Each identifier is for a role, and so the left-hand-side may include a
27079 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
27080
27081 .vindex "&$auth1$&, &$auth2$&, etc"
27082 .ilist
27083 .vindex "&$auth1$&"
27084 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
27085 .next
27086 .vindex "&$auth2$&"
27087 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
27088 authentication.  If that was empty, this will also be set to the
27089 GSS Display Name.
27090 .endlist
27091
27092
27093 . ////////////////////////////////////////////////////////////////////////////
27094 . ////////////////////////////////////////////////////////////////////////////
27095
27096 .chapter "The spa authenticator" "CHAPspa"
27097 .scindex IIDspaauth1 "&(spa)& authenticator"
27098 .scindex IIDspaauth2 "authenticators" "&(spa)&"
27099 .cindex "authentication" "Microsoft Secure Password"
27100 .cindex "authentication" "NTLM"
27101 .cindex "Microsoft Secure Password Authentication"
27102 .cindex "NTLM authentication"
27103 The &(spa)& authenticator provides client support for Microsoft's &'Secure
27104 Password Authentication'& mechanism,
27105 which is also sometimes known as NTLM (NT LanMan). The code for client side of
27106 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
27107 taken from the Samba project (&url(https://www.samba.org/)). The code for the
27108 server side was subsequently contributed by Tom Kistner. The mechanism works as
27109 follows:
27110
27111 .ilist
27112 After the AUTH command has been accepted, the client sends an SPA
27113 authentication request based on the user name and optional domain.
27114 .next
27115 The server sends back a challenge.
27116 .next
27117 The client builds a challenge response which makes use of the user's password
27118 and sends it to the server, which then accepts or rejects it.
27119 .endlist
27120
27121 Encryption is used to protect the password in transit.
27122
27123
27124
27125 .section "Using spa as a server" "SECID179"
27126 .cindex "options" "&(spa)& authenticator (server)"
27127 The &(spa)& authenticator has just one server option:
27128
27129 .option server_password spa string&!! unset
27130 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
27131 This option is expanded, and the result must be the cleartext password for the
27132 authenticating user, whose name is at this point in &$auth1$&. For
27133 compatibility with previous releases of Exim, the user name is also placed in
27134 &$1$&. However, the use of this variable for this purpose is now deprecated, as
27135 it can lead to confusion in string expansions that also use numeric variables
27136 for other things. For example:
27137 .code
27138 spa:
27139   driver = spa
27140   public_name = NTLM
27141   server_password = \
27142     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
27143 .endd
27144 If the expansion is forced to fail, authentication fails. Any other expansion
27145 failure causes a temporary error code to be returned.
27146
27147
27148
27149
27150
27151 .section "Using spa as a client" "SECID180"
27152 .cindex "options" "&(spa)& authenticator (client)"
27153 The &(spa)& authenticator has the following client options:
27154
27155
27156
27157 .option client_domain spa string&!! unset
27158 This option specifies an optional domain for the authentication.
27159
27160
27161 .option client_password spa string&!! unset
27162 This option specifies the user's password, and must be set.
27163
27164
27165 .option client_username spa string&!! unset
27166 This option specifies the user name, and must be set. Here is an example of a
27167 configuration of this authenticator for use with the mail servers at
27168 &'msn.com'&:
27169 .code
27170 msn:
27171   driver = spa
27172   public_name = MSN
27173   client_username = msn/msn_username
27174   client_password = msn_plaintext_password
27175   client_domain = DOMAIN_OR_UNSET
27176 .endd
27177 .ecindex IIDspaauth1
27178 .ecindex IIDspaauth2
27179
27180
27181
27182
27183
27184 . ////////////////////////////////////////////////////////////////////////////
27185 . ////////////////////////////////////////////////////////////////////////////
27186
27187 .chapter "The tls authenticator" "CHAPtlsauth"
27188 .scindex IIDtlsauth1 "&(tls)& authenticator"
27189 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
27190 .cindex "authentication" "Client Certificate"
27191 .cindex "authentication" "X509"
27192 .cindex "Certificate-based authentication"
27193 The &(tls)& authenticator provides server support for
27194 authentication based on client certificates.
27195
27196 It is not an SMTP authentication mechanism and is not
27197 advertised by the server as part of the SMTP EHLO response.
27198 It is an Exim authenticator in the sense that it affects
27199 the protocol element of the log line, can be tested for
27200 by the &%authenticated%& ACL condition, and can set
27201 the &$authenticated_id$& variable.
27202
27203 The client must present a verifiable certificate,
27204 for which it must have been requested via the
27205 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27206 (see &<<CHAPTLS>>&).
27207
27208 If an authenticator of this type is configured it is
27209 run before any SMTP-level communication is done,
27210 and can authenticate the connection.
27211 If it does, SMTP authentication is not offered.
27212
27213 A maximum of one authenticator of this type may be present.
27214
27215
27216 .cindex "options" "&(tls)& authenticator (server)"
27217 The &(tls)& authenticator has three server options:
27218
27219 .option server_param1 tls string&!! unset
27220 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
27221 This option is expanded after the TLS negotiation and
27222 the result is placed in &$auth1$&.
27223 If the expansion is forced to fail, authentication fails. Any other expansion
27224 failure causes a temporary error code to be returned.
27225
27226 .option server_param2 tls string&!! unset
27227 .option server_param3 tls string&!! unset
27228 As above, for &$auth2$& and &$auth3$&.
27229
27230 &%server_param1%& may also be spelled &%server_param%&.
27231
27232
27233 Example:
27234 .code
27235 tls:
27236   driver = tls
27237   server_param1 =     ${certextract {subj_altname,mail,>:} \
27238                                     {$tls_in_peercert}}
27239   server_condition =  ${if forany {$auth1} \
27240                             {!= {0} \
27241                                 {${lookup ldap{ldap:///\
27242                          mailname=${quote_ldap_dn:${lc:$item}},\
27243                          ou=users,LDAP_DC?mailid} {$value}{0} \
27244                        }    }   } }
27245   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
27246 .endd
27247 This accepts a client certificate that is verifiable against any
27248 of your configured trust-anchors
27249 (which usually means the full set of public CAs)
27250 and which has a SAN with a good account name.
27251 Note that the client cert is on the wire in-clear, including the SAN,
27252 whereas a plaintext SMTP AUTH done inside TLS is not.
27253
27254 . An alternative might use
27255 . .code
27256 .   server_param1 = ${sha256:$tls_in_peercert}
27257 . .endd
27258 . to require one of a set of specific certs that define a given account
27259 . (the verification is still required, but mostly irrelevant).
27260 . This would help for per-device use.
27261 .
27262 . However, for the future we really need support for checking a
27263 . user cert in LDAP - which probably wants a base-64 DER.
27264
27265 .ecindex IIDtlsauth1
27266 .ecindex IIDtlsauth2
27267
27268
27269 Note that because authentication is traditionally an SMTP operation,
27270 the &%authenticated%& ACL condition cannot be used in
27271 a connect- or helo-ACL.
27272
27273
27274
27275 . ////////////////////////////////////////////////////////////////////////////
27276 . ////////////////////////////////////////////////////////////////////////////
27277
27278 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
27279          "Encrypted SMTP connections"
27280 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
27281 .scindex IIDencsmtp2 "SMTP" "encryption"
27282 .cindex "TLS" "on SMTP connection"
27283 .cindex "OpenSSL"
27284 .cindex "GnuTLS"
27285 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
27286 Sockets Layer), is implemented by making use of the OpenSSL library or the
27287 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
27288 cryptographic code in the Exim distribution itself for implementing TLS. In
27289 order to use this feature you must install OpenSSL or GnuTLS, and then build a
27290 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
27291 You also need to understand the basic concepts of encryption at a managerial
27292 level, and in particular, the way that public keys, private keys, and
27293 certificates are used.
27294
27295 RFC 3207 defines how SMTP connections can make use of encryption. Once a
27296 connection is established, the client issues a STARTTLS command. If the
27297 server accepts this, the client and the server negotiate an encryption
27298 mechanism. If the negotiation succeeds, the data that subsequently passes
27299 between them is encrypted.
27300
27301 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
27302 and if so, what cipher suite is in use, whether the client supplied a
27303 certificate, and whether or not that certificate was verified. This makes it
27304 possible for an Exim server to deny or accept certain commands based on the
27305 encryption state.
27306
27307 &*Warning*&: Certain types of firewall and certain anti-virus products can
27308 disrupt TLS connections. You need to turn off SMTP scanning for these products
27309 in order to get TLS to work.
27310
27311
27312
27313 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
27314          "SECID284"
27315 .cindex "submissions protocol"
27316 .cindex "ssmtp protocol"
27317 .cindex "smtps protocol"
27318 .cindex "SMTP" "submissions protocol"
27319 .cindex "SMTP" "ssmtp protocol"
27320 .cindex "SMTP" "smtps protocol"
27321 The history of port numbers for TLS in SMTP is a little messy and has been
27322 contentious.  As of RFC 8314, the common practice of using the historically
27323 allocated port 465 for "email submission but with TLS immediately upon connect
27324 instead of using STARTTLS" is officially blessed by the IETF, and recommended
27325 by them in preference to STARTTLS.
27326
27327 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
27328 clarity emerged over the dual roles of SMTP, for MX delivery and Email
27329 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
27330
27331 This approach was, for a while, officially abandoned when encrypted SMTP was
27332 standardized, but many clients kept using it, even as the TCP port number was
27333 reassigned for other use.
27334 Thus you may encounter guidance claiming that you shouldn't enable use of
27335 this port.
27336 In practice, a number of mail-clients have only ever supported submissions,
27337 not submission with STARTTLS upgrade.
27338 Ideally, offer both submission (587) and submissions (465) service.
27339
27340 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
27341 global option. Its value must be a list of port numbers;
27342 the most common use is expected to be:
27343 .code
27344 tls_on_connect_ports = 465
27345 .endd
27346 The port numbers specified by this option apply to all SMTP connections, both
27347 via the daemon and via &'inetd'&. You still need to specify all the ports that
27348 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
27349 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
27350 an extra port &-- rather, it specifies different behaviour on a port that is
27351 defined elsewhere.
27352
27353 There is also a &%-tls-on-connect%& command line option. This overrides
27354 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
27355
27356
27357
27358
27359
27360
27361 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
27362 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
27363 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
27364 followed later, when the first versions of GnuTLS were released. To build Exim
27365 to use GnuTLS, you need to set
27366 .code
27367 USE_GNUTLS=yes
27368 .endd
27369 in Local/Makefile, in addition to
27370 .code
27371 SUPPORT_TLS=yes
27372 .endd
27373 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
27374 include files and libraries for GnuTLS can be found.
27375
27376 There are some differences in usage when using GnuTLS instead of OpenSSL:
27377
27378 .ilist
27379 The &%tls_verify_certificates%& option
27380 cannot be the path of a directory
27381 for GnuTLS versions before 3.3.6
27382 (for later versions, or OpenSSL, it can be either).
27383 .next
27384 The default value for &%tls_dhparam%& differs for historical reasons.
27385 .next
27386 .vindex "&$tls_in_peerdn$&"
27387 .vindex "&$tls_out_peerdn$&"
27388 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
27389 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
27390 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
27391 .next
27392 OpenSSL identifies cipher suites using hyphens as separators, for example:
27393 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
27394 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
27395 in a cipher list. To make life simpler, Exim changes underscores to hyphens
27396 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
27397 to handle its own older variants) when processing lists of cipher suites in the
27398 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
27399 option).
27400 .next
27401 The &%tls_require_ciphers%& options operate differently, as described in the
27402 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
27403 .next
27404 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
27405 When using OpenSSL, this option is ignored.
27406 (If an API is found to let OpenSSL be configured in this way,
27407 let the Exim Maintainers know and we'll likely use it).
27408 .next
27409 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
27410 main option, it must be ordered to match the &%tls_certificate%& list.
27411 .next
27412 Some other recently added features may only be available in one or the other.
27413 This should be documented with the feature.  If the documentation does not
27414 explicitly state that the feature is infeasible in the other TLS
27415 implementation, then patches are welcome.
27416 .endlist
27417
27418
27419 .section "GnuTLS parameter computation" "SECTgnutlsparam"
27420 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
27421 an explicit path; if the latter, then the text about generation still applies,
27422 but not the chosen filename.
27423 By default, as of Exim 4.80 a hard-coded D-H prime is used.
27424 See the documentation of &%tls_dhparam%& for more information.
27425
27426 GnuTLS uses D-H parameters that may take a substantial amount of time
27427 to compute. It is unreasonable to re-compute them for every TLS session.
27428 Therefore, Exim keeps this data in a file in its spool directory, called
27429 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
27430 of bits requested.
27431 The file is owned by the Exim user and is readable only by
27432 its owner. Every Exim process that start up GnuTLS reads the D-H
27433 parameters from this file. If the file does not exist, the first Exim process
27434 that needs it computes the data and writes it to a temporary file which is
27435 renamed once it is complete. It does not matter if several Exim processes do
27436 this simultaneously (apart from wasting a few resources). Once a file is in
27437 place, new Exim processes immediately start using it.
27438
27439 For maximum security, the parameters that are stored in this file should be
27440 recalculated periodically, the frequency depending on your paranoia level.
27441 If you are avoiding using the fixed D-H primes published in RFCs, then you
27442 are concerned about some advanced attacks and will wish to do this; if you do
27443 not regenerate then you might as well stick to the standard primes.
27444
27445 Arranging this is easy in principle; just delete the file when you want new
27446 values to be computed. However, there may be a problem. The calculation of new
27447 parameters needs random numbers, and these are obtained from &_/dev/random_&.
27448 If the system is not very active, &_/dev/random_& may delay returning data
27449 until enough randomness (entropy) is available. This may cause Exim to hang for
27450 a substantial amount of time, causing timeouts on incoming connections.
27451
27452 The solution is to generate the parameters externally to Exim. They are stored
27453 in &_gnutls-params-N_& in PEM format, which means that they can be
27454 generated externally using the &(certtool)& command that is part of GnuTLS.
27455
27456 To replace the parameters with new ones, instead of deleting the file
27457 and letting Exim re-create it, you can generate new parameters using
27458 &(certtool)& and, when this has been done, replace Exim's cache file by
27459 renaming. The relevant commands are something like this:
27460 .code
27461 # ls
27462 [ look for file; assume gnutls-params-2236 is the most recent ]
27463 # rm -f new-params
27464 # touch new-params
27465 # chown exim:exim new-params
27466 # chmod 0600 new-params
27467 # certtool --generate-dh-params --bits 2236 >>new-params
27468 # openssl dhparam -noout -text -in new-params | head
27469 [ check the first line, make sure it's not more than 2236;
27470   if it is, then go back to the start ("rm") and repeat
27471   until the size generated is at most the size requested ]
27472 # chmod 0400 new-params
27473 # mv new-params gnutls-params-2236
27474 .endd
27475 If Exim never has to generate the parameters itself, the possibility of
27476 stalling is removed.
27477
27478 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
27479 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
27480 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
27481 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
27482 and Exim does so.  This attempt to remove Exim from TLS policy decisions
27483 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
27484 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
27485 which applies to all D-H usage, client or server.  If the value returned by
27486 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
27487 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
27488 limit, which is still much higher than Exim historically used.
27489
27490 The filename and bits used will change as the GnuTLS maintainers change the
27491 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
27492 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
27493 2432 bits, while NSS is limited to 2236 bits.
27494
27495 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
27496 increase the chance of the generated prime actually being within acceptable
27497 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
27498 procedure above.  There is no sane procedure available to Exim to double-check
27499 the size of the generated prime, so it might still be too large.
27500
27501
27502 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
27503 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
27504 .oindex "&%tls_require_ciphers%&" "OpenSSL"
27505 There is a function in the OpenSSL library that can be passed a list of cipher
27506 suites before the cipher negotiation takes place. This specifies which ciphers
27507 .new
27508 are acceptable for TLS versions prior to 1.3.
27509 .wen
27510 The list is colon separated and may contain names like
27511 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
27512 directly to this function call.
27513 Many systems will install the OpenSSL manual-pages, so you may have
27514 &'ciphers(1)'& available to you.
27515 The following quotation from the OpenSSL
27516 documentation specifies what forms of item are allowed in the cipher string:
27517
27518 .ilist
27519 It can consist of a single cipher suite such as RC4-SHA.
27520 .next
27521 It can represent a list of cipher suites containing a certain algorithm,
27522 or cipher suites of a certain type. For example SHA1 represents all
27523 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
27524 SSL v3 algorithms.
27525 .next
27526 Lists of cipher suites can be combined in a single cipher string using
27527 the + character. This is used as a logical and operation. For example
27528 SHA1+DES represents all cipher suites containing the SHA1 and the DES
27529 algorithms.
27530 .endlist
27531
27532 Each cipher string can be optionally preceded by one of the characters &`!`&,
27533 &`-`& or &`+`&.
27534 .ilist
27535 If &`!`& is used, the ciphers are permanently deleted from the list. The
27536 ciphers deleted can never reappear in the list even if they are explicitly
27537 stated.
27538 .next
27539 If &`-`& is used, the ciphers are deleted from the list, but some or all
27540 of the ciphers can be added again by later options.
27541 .next
27542 If &`+`& is used, the ciphers are moved to the end of the list. This
27543 option does not add any new ciphers; it just moves matching existing ones.
27544 .endlist
27545
27546 If none of these characters is present, the string is interpreted as
27547 a list of ciphers to be appended to the current preference list. If the list
27548 includes any ciphers already present they will be ignored: that is, they will
27549 not be moved to the end of the list.
27550 .endlist
27551
27552 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
27553 string:
27554 .code
27555 # note single-quotes to get ! past any shell history expansion
27556 $ openssl ciphers 'HIGH:!MD5:!SHA1'
27557 .endd
27558
27559 This example will let the library defaults be permitted on the MX port, where
27560 there's probably no identity verification anyway, but ups the ante on the
27561 submission ports where the administrator might have some influence on the
27562 choice of clients used:
27563 .code
27564 # OpenSSL variant; see man ciphers(1)
27565 tls_require_ciphers = ${if =={$received_port}{25}\
27566                            {DEFAULT}\
27567                            {HIGH:!MD5:!SHA1}}
27568 .endd
27569
27570 This example will prefer ECDSA-authenticated ciphers over RSA ones:
27571 .code
27572 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
27573 .endd
27574
27575 .new
27576 For TLS version 1.3 the control available is less fine-grained
27577 and Exim does not provide access to it at present.
27578 The value of the &%tls_require_ciphers%& option is ignored when
27579 TLS version 1.3 is negotiated.
27580
27581 As of writing the library default cipher suite list for TLSv1.3 is
27582 .code
27583 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
27584 .endd
27585 .wen
27586
27587
27588 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
27589          "SECTreqciphgnu"
27590 .cindex "GnuTLS" "specifying parameters for"
27591 .cindex "TLS" "specifying ciphers (GnuTLS)"
27592 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
27593 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
27594 .cindex "TLS" "specifying protocols (GnuTLS)"
27595 .cindex "TLS" "specifying priority string (GnuTLS)"
27596 .oindex "&%tls_require_ciphers%&" "GnuTLS"
27597 The GnuTLS library allows the caller to provide a "priority string", documented
27598 as part of the &[gnutls_priority_init]& function.  This is very similar to the
27599 ciphersuite specification in OpenSSL.
27600
27601 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
27602 and controls both protocols and ciphers.
27603
27604 The &%tls_require_ciphers%& option is available both as an global option,
27605 controlling how Exim behaves as a server, and also as an option of the
27606 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
27607 the value is string expanded.  The resulting string is not an Exim list and
27608 the string is given to the GnuTLS library, so that Exim does not need to be
27609 aware of future feature enhancements of GnuTLS.
27610
27611 Documentation of the strings accepted may be found in the GnuTLS manual, under
27612 "Priority strings".  This is online as
27613 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
27614 but beware that this relates to GnuTLS 3, which may be newer than the version
27615 installed on your system.  If you are using GnuTLS 3,
27616 then the example code
27617 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
27618 on that site can be used to test a given string.
27619
27620 For example:
27621 .code
27622 # Disable older versions of protocols
27623 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
27624 .endd
27625
27626 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
27627 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
27628 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
27629
27630 This example will let the library defaults be permitted on the MX port, where
27631 there's probably no identity verification anyway, and lowers security further
27632 by increasing compatibility; but this ups the ante on the submission ports
27633 where the administrator might have some influence on the choice of clients
27634 used:
27635 .code
27636 # GnuTLS variant
27637 tls_require_ciphers = ${if =={$received_port}{25}\
27638                            {NORMAL:%COMPAT}\
27639                            {SECURE128}}
27640 .endd
27641
27642
27643 .section "Configuring an Exim server to use TLS" "SECID182"
27644 .cindex "TLS" "configuring an Exim server"
27645 When Exim has been built with TLS support, it advertises the availability of
27646 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
27647 but not to any others. The default value of this option is *, which means
27648 that STARTTLS is always advertised.  Set it to blank to never advertise;
27649 this is reasonable for systems that want to use TLS only as a client.
27650
27651 If STARTTLS is to be used you
27652 need to set some other options in order to make TLS available.
27653
27654 If a client issues a STARTTLS command and there is some configuration
27655 problem in the server, the command is rejected with a 454 error. If the client
27656 persists in trying to issue SMTP commands, all except QUIT are rejected
27657 with the error
27658 .code
27659 554 Security failure
27660 .endd
27661 If a STARTTLS command is issued within an existing TLS session, it is
27662 rejected with a 554 error code.
27663
27664 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
27665 must be set to match some hosts. The default is * which matches all hosts.
27666
27667 If this is all you do, TLS encryption will be enabled but not authentication -
27668 meaning that the peer has no assurance it is actually you he is talking to.
27669 You gain protection from a passive sniffer listening on the wire but not
27670 from someone able to intercept the communication.
27671
27672 Further protection requires some further configuration at the server end.
27673
27674 To make TLS work you need to set, in the server,
27675 .code
27676 tls_certificate = /some/file/name
27677 tls_privatekey = /some/file/name
27678 .endd
27679 These options are, in fact, expanded strings, so you can make them depend on
27680 the identity of the client that is connected if you wish. The first file
27681 contains the server's X509 certificate, and the second contains the private key
27682 that goes with it. These files need to be
27683 PEM format and readable by the Exim user, and must
27684 always be given as full path names.
27685 The key must not be password-protected.
27686 They can be the same file if both the
27687 certificate and the key are contained within it. If &%tls_privatekey%& is not
27688 set, or if its expansion is forced to fail or results in an empty string, this
27689 is assumed to be the case. The certificate file may also contain intermediate
27690 certificates that need to be sent to the client to enable it to authenticate
27691 the server's certificate.
27692
27693 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
27694 colon-separated lists of file paths.  Ciphers using given authentication
27695 algorithms require the presence of a suitable certificate to supply the
27696 public-key.  The server selects among the certificates to present to the
27697 client depending on the selected cipher, hence the priority ordering for
27698 ciphers will affect which certificate is used.
27699
27700 If you do not understand about certificates and keys, please try to find a
27701 source of this background information, which is not Exim-specific. (There are a
27702 few comments below in section &<<SECTcerandall>>&.)
27703
27704 &*Note*&: These options do not apply when Exim is operating as a client &--
27705 they apply only in the case of a server. If you need to use a certificate in an
27706 Exim client, you must set the options of the same names in an &(smtp)&
27707 transport.
27708
27709 With just these options, an Exim server will be able to use TLS. It does not
27710 require the client to have a certificate (but see below for how to insist on
27711 this). There is one other option that may be needed in other situations. If
27712 .code
27713 tls_dhparam = /some/file/name
27714 .endd
27715 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
27716 with the parameters contained in the file.
27717 Set this to &`none`& to disable use of DH entirely, by making no prime
27718 available:
27719 .code
27720 tls_dhparam = none
27721 .endd
27722 This may also be set to a string identifying a standard prime to be used for
27723 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
27724 used is &`ike23`&.  There are a few standard primes available, see the
27725 documentation for &%tls_dhparam%& for the complete list.
27726
27727 See the command
27728 .code
27729 openssl dhparam
27730 .endd
27731 for a way of generating file data.
27732
27733 The strings supplied for these three options are expanded every time a client
27734 host connects. It is therefore possible to use different certificates and keys
27735 for different hosts, if you so wish, by making use of the client's IP address
27736 in &$sender_host_address$& to control the expansion. If a string expansion is
27737 forced to fail, Exim behaves as if the option is not set.
27738
27739 .cindex "cipher" "logging"
27740 .cindex "log" "TLS cipher"
27741 .vindex "&$tls_in_cipher$&"
27742 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
27743 an incoming TLS connection. It is included in the &'Received:'& header of an
27744 incoming message (by default &-- you can, of course, change this), and it is
27745 also included in the log line that records a message's arrival, keyed by
27746 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
27747 condition can be used to test for specific cipher suites in ACLs.
27748
27749 Once TLS has been established, the ACLs that run for subsequent SMTP commands
27750 can check the name of the cipher suite and vary their actions accordingly. The
27751 cipher suite names vary, depending on which TLS library is being used. For
27752 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
27753 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
27754 documentation for more details.
27755
27756 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
27757 (again depending on the &%tls_cipher%& log selector).
27758
27759
27760 .section "Requesting and verifying client certificates" "SECID183"
27761 .cindex "certificate" "verification of client"
27762 .cindex "TLS" "client certificate verification"
27763 If you want an Exim server to request a certificate when negotiating a TLS
27764 session with a client, you must set either &%tls_verify_hosts%& or
27765 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
27766 apply to all TLS connections. For any host that matches one of these options,
27767 Exim requests a certificate as part of the setup of the TLS session. The
27768 contents of the certificate are verified by comparing it with a list of
27769 expected certificates.
27770 These may be the system default set (depending on library version),
27771 an explicit file or,
27772 depending on library version, a directory, identified by
27773 &%tls_verify_certificates%&.
27774
27775 A file can contain multiple certificates, concatenated end to end. If a
27776 directory is used
27777 (OpenSSL only),
27778 each certificate must be in a separate file, with a name (or a symbolic link)
27779 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
27780 certificate. You can compute the relevant hash by running the command
27781 .code
27782 openssl x509 -hash -noout -in /cert/file
27783 .endd
27784 where &_/cert/file_& contains a single certificate.
27785
27786 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
27787 what happens if the client does not supply a certificate, or if the certificate
27788 does not match any of the certificates in the collection named by
27789 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
27790 attempt to set up a TLS session is aborted, and the incoming connection is
27791 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
27792 session continues. ACLs that run for subsequent SMTP commands can detect the
27793 fact that no certificate was verified, and vary their actions accordingly. For
27794 example, you can insist on a certificate before accepting a message for
27795 relaying, but not when the message is destined for local delivery.
27796
27797 .vindex "&$tls_in_peerdn$&"
27798 When a client supplies a certificate (whether it verifies or not), the value of
27799 the Distinguished Name of the certificate is made available in the variable
27800 &$tls_in_peerdn$& during subsequent processing of the message.
27801
27802 .cindex "log" "distinguished name"
27803 Because it is often a long text string, it is not included in the log line or
27804 &'Received:'& header by default. You can arrange for it to be logged, keyed by
27805 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
27806 &%received_header_text%& to change the &'Received:'& header. When no
27807 certificate is supplied, &$tls_in_peerdn$& is empty.
27808
27809
27810 .section "Revoked certificates" "SECID184"
27811 .cindex "TLS" "revoked certificates"
27812 .cindex "revocation list"
27813 .cindex "certificate" "revocation list"
27814 .cindex "OCSP" "stapling"
27815 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
27816 certificates are revoked. If you have such a list, you can pass it to an Exim
27817 server using the global option called &%tls_crl%& and to an Exim client using
27818 an identically named option for the &(smtp)& transport. In each case, the value
27819 of the option is expanded and must then be the name of a file that contains a
27820 CRL in PEM format.
27821 The downside is that clients have to periodically re-download a potentially huge
27822 file from every certificate authority they know of.
27823
27824 The way with most moving parts at query time is Online Certificate
27825 Status Protocol (OCSP), where the client verifies the certificate
27826 against an OCSP server run by the CA.  This lets the CA track all
27827 usage of the certs.  It requires running software with access to the
27828 private key of the CA, to sign the responses to the OCSP queries.  OCSP
27829 is based on HTTP and can be proxied accordingly.
27830
27831 The only widespread OCSP server implementation (known to this writer)
27832 comes as part of OpenSSL and aborts on an invalid request, such as
27833 connecting to the port and then disconnecting.  This requires
27834 re-entering the passphrase each time some random client does this.
27835
27836 The third way is OCSP Stapling; in this, the server using a certificate
27837 issued by the CA periodically requests an OCSP proof of validity from
27838 the OCSP server, then serves it up inline as part of the TLS
27839 negotiation.   This approach adds no extra round trips, does not let the
27840 CA track users, scales well with number of certs issued by the CA and is
27841 resilient to temporary OCSP server failures, as long as the server
27842 starts retrying to fetch an OCSP proof some time before its current
27843 proof expires.  The downside is that it requires server support.
27844
27845 Unless Exim is built with the support disabled,
27846 or with GnuTLS earlier than version 3.3.16 / 3.4.8
27847 support for OCSP stapling is included.
27848
27849 There is a global option called &%tls_ocsp_file%&.
27850 The file specified therein is expected to be in DER format, and contain
27851 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
27852 option will be re-expanded for SNI, if the &%tls_certificate%& option
27853 contains &`tls_in_sni`&, as per other TLS options.
27854
27855 Exim does not at this time implement any support for fetching a new OCSP
27856 proof.  The burden is on the administrator to handle this, outside of
27857 Exim.  The file specified should be replaced atomically, so that the
27858 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
27859 on each connection, so a new file will be handled transparently on the
27860 next connection.
27861
27862 When built with OpenSSL Exim will check for a valid next update timestamp
27863 in the OCSP proof; if not present, or if the proof has expired, it will be
27864 ignored.
27865
27866 For the client to be able to verify the stapled OCSP the server must
27867 also supply, in its stapled information, any intermediate
27868 certificates for the chain leading to the OCSP proof from the signer
27869 of the server certificate.  There may be zero or one such. These
27870 intermediate certificates should be added to the server OCSP stapling
27871 file named by &%tls_ocsp_file%&.
27872
27873 Note that the proof only covers the terminal server certificate,
27874 not any of the chain from CA to it.
27875
27876 There is no current way to staple a proof for a client certificate.
27877
27878 .code
27879   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
27880   OCSP server is supplied.  The server URL may be included in the
27881   server certificate, if the CA is helpful.
27882
27883   One failure mode seen was the OCSP Signer cert expiring before the end
27884   of validity of the OCSP proof. The checking done by Exim/OpenSSL
27885   noted this as invalid overall, but the re-fetch script did not.
27886 .endd
27887
27888
27889
27890
27891 .section "Configuring an Exim client to use TLS" "SECID185"
27892 .cindex "cipher" "logging"
27893 .cindex "log" "TLS cipher"
27894 .cindex "log" "distinguished name"
27895 .cindex "TLS" "configuring an Exim client"
27896 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
27897 deliveries as well as to incoming, the latter one causing logging of the
27898 server certificate's DN. The remaining client configuration for TLS is all
27899 within the &(smtp)& transport.
27900
27901 It is not necessary to set any options to have TLS work in the &(smtp)&
27902 transport. If Exim is built with TLS support, and TLS is advertised by a
27903 server, the &(smtp)& transport always tries to start a TLS session. However,
27904 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
27905 transport) to a list of server hosts for which TLS should not be used.
27906
27907 If you do not want Exim to attempt to send messages unencrypted when an attempt
27908 to set up an encrypted connection fails in any way, you can set
27909 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
27910 those hosts, delivery is always deferred if an encrypted connection cannot be
27911 set up. If there are any other hosts for the address, they are tried in the
27912 usual way.
27913
27914 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
27915 the message unencrypted. It always does this if the response to STARTTLS is
27916 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
27917 session after a success response code, what happens is controlled by the
27918 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
27919 delivery to this host is deferred, and other hosts (if available) are tried. If
27920 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
27921 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
27922 negotiation fails, Exim closes the current connection (because it is in an
27923 unknown state), opens a new one to the same host, and then tries the delivery
27924 unencrypted.
27925
27926 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
27927 transport provide the client with a certificate, which is passed to the server
27928 if it requests it. If the server is Exim, it will request a certificate only if
27929 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
27930
27931 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
27932 specifies a collection of expected server certificates.
27933 These may be
27934 the system default set (depending on library version),
27935 a file,
27936 or (depending on library version) a directory.
27937 The client verifies the server's certificate
27938 against this collection, taking into account any revoked certificates that are
27939 in the list defined by &%tls_crl%&.
27940 Failure to verify fails the TLS connection unless either of the
27941 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
27942
27943 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
27944 certificate verification to the listed servers.  Verification either must
27945 or need not succeed respectively.
27946
27947 The &(smtp)& transport has two OCSP-related options:
27948 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
27949 is requested and required for the connection to proceed.  The default
27950 value is empty.
27951 &%hosts_request_ocsp%&; a host-list for which (additionally)
27952 a Certificate Status is requested (but not necessarily verified).  The default
27953 value is "*" meaning that requests are made unless configured
27954 otherwise.
27955
27956 The host(s) should also be in &%hosts_require_tls%&, and
27957 &%tls_verify_certificates%& configured for the transport,
27958 for OCSP to be relevant.
27959
27960 If
27961 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
27962 list of permitted cipher suites. If either of these checks fails, delivery to
27963 the current host is abandoned, and the &(smtp)& transport tries to deliver to
27964 alternative hosts, if any.
27965
27966  &*Note*&:
27967 These options must be set in the &(smtp)& transport for Exim to use TLS when it
27968 is operating as a client. Exim does not assume that a server certificate (set
27969 by the global options of the same name) should also be used when operating as a
27970 client.
27971
27972 .vindex "&$host$&"
27973 .vindex "&$host_address$&"
27974 All the TLS options in the &(smtp)& transport are expanded before use, with
27975 &$host$& and &$host_address$& containing the name and address of the server to
27976 which the client is connected. Forced failure of an expansion causes Exim to
27977 behave as if the relevant option were unset.
27978
27979 .vindex &$tls_out_bits$&
27980 .vindex &$tls_out_cipher$&
27981 .vindex &$tls_out_peerdn$&
27982 .vindex &$tls_out_sni$&
27983 Before an SMTP connection is established, the
27984 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
27985 variables are emptied. (Until the first connection, they contain the values
27986 that were set when the message was received.) If STARTTLS is subsequently
27987 successfully obeyed, these variables are set to the relevant values for the
27988 outgoing connection.
27989
27990
27991
27992 .section "Use of TLS Server Name Indication" "SECTtlssni"
27993 .cindex "TLS" "Server Name Indication"
27994 .vindex "&$tls_in_sni$&"
27995 .oindex "&%tls_in_sni%&"
27996 With TLS1.0 or above, there is an extension mechanism by which extra
27997 information can be included at various points in the protocol.  One of these
27998 extensions, documented in RFC 6066 (and before that RFC 4366) is
27999 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
28000 client in the initial handshake, so that the server can examine the servername
28001 within and possibly choose to use different certificates and keys (and more)
28002 for this session.
28003
28004 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
28005 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
28006 address.
28007
28008 With SMTP to MX, there are the same problems here as in choosing the identity
28009 against which to validate a certificate: you can't rely on insecure DNS to
28010 provide the identity which you then cryptographically verify.  So this will
28011 be of limited use in that environment.
28012
28013 With SMTP to Submission, there is a well-defined hostname which clients are
28014 connecting to and can validate certificates against.  Thus clients &*can*&
28015 choose to include this information in the TLS negotiation.  If this becomes
28016 wide-spread, then hosters can choose to present different certificates to
28017 different clients.  Or even negotiate different cipher suites.
28018
28019 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
28020 if not empty, will be sent on a TLS session as part of the handshake.  There's
28021 nothing more to it.  Choosing a sensible value not derived insecurely is the
28022 only point of caution.  The &$tls_out_sni$& variable will be set to this string
28023 for the lifetime of the client connection (including during authentication).
28024
28025 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
28026 received from a client.
28027 It can be logged with the &%log_selector%& item &`+tls_sni`&.
28028
28029 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
28030 option (prior to expansion) then the following options will be re-expanded
28031 during TLS session handshake, to permit alternative values to be chosen:
28032
28033 .ilist
28034 &%tls_certificate%&
28035 .next
28036 &%tls_crl%&
28037 .next
28038 &%tls_privatekey%&
28039 .next
28040 &%tls_verify_certificates%&
28041 .next
28042 &%tls_ocsp_file%&
28043 .endlist
28044
28045 Great care should be taken to deal with matters of case, various injection
28046 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
28047 can always be referenced; it is important to remember that &$tls_in_sni$& is
28048 arbitrary unverified data provided prior to authentication.
28049 Further, the initial certificate is loaded before SNI is arrived, so
28050 an expansion for &%tls_certificate%& must have a default which is used
28051 when &$tls_in_sni$& is empty.
28052
28053 The Exim developers are proceeding cautiously and so far no other TLS options
28054 are re-expanded.
28055
28056 When Exim is built against OpenSSL, OpenSSL must have been built with support
28057 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
28058 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
28059 see &`-servername`& in the output, then OpenSSL has support.
28060
28061 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
28062 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
28063 built, then you have SNI support).
28064
28065
28066
28067 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
28068          "SECTmulmessam"
28069 .cindex "multiple SMTP deliveries with TLS"
28070 .cindex "TLS" "multiple message deliveries"
28071 Exim sends multiple messages down the same TCP/IP connection by starting up
28072 an entirely new delivery process for each message, passing the socket from
28073 one process to the next. This implementation does not fit well with the use
28074 of TLS, because there is quite a lot of state information associated with a TLS
28075 connection, not just a socket identification. Passing all the state information
28076 to a new process is not feasible. Consequently, for sending using TLS Exim
28077 starts an additional proxy process for handling the encryption, piping the
28078 unencrypted data stream from and to the delivery processes.
28079
28080 An older mode of operation can be enabled on a per-host basis by the
28081 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
28082 this list the proxy process described above is not used; instead Exim
28083 shuts down an existing TLS session being run by the delivery process
28084 before passing the socket to a new process. The new process may then
28085 try to start a new TLS session, and if successful, may try to re-authenticate
28086 if AUTH is in use, before sending the next message.
28087
28088 The RFC is not clear as to whether or not an SMTP session continues in clear
28089 after TLS has been shut down, or whether TLS may be restarted again later, as
28090 just described. However, if the server is Exim, this shutdown and
28091 reinitialization works. It is not known which (if any) other servers operate
28092 successfully if the client closes a TLS session and continues with unencrypted
28093 SMTP, but there are certainly some that do not work. For such servers, Exim
28094 should not pass the socket to another process, because the failure of the
28095 subsequent attempt to use it would cause Exim to record a temporary host error,
28096 and delay other deliveries to that host.
28097
28098 To test for this case, Exim sends an EHLO command to the server after
28099 closing down the TLS session. If this fails in any way, the connection is
28100 closed instead of being passed to a new delivery process, but no retry
28101 information is recorded.
28102
28103 There is also a manual override; you can set &%hosts_nopass_tls%& on the
28104 &(smtp)& transport to match those hosts for which Exim should not pass
28105 connections to new processes if TLS has been used.
28106
28107
28108
28109
28110 .section "Certificates and all that" "SECTcerandall"
28111 .cindex "certificate" "references to discussion"
28112 In order to understand fully how TLS works, you need to know about
28113 certificates, certificate signing, and certificate authorities.
28114 This is a large topic and an introductory guide is unsuitable for the Exim
28115 reference manual, so instead we provide pointers to existing documentation.
28116
28117 The Apache web-server was for a long time the canonical guide, so their
28118 documentation is a good place to start; their SSL module's Introduction
28119 document is currently at
28120 .display
28121 .url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
28122 .endd
28123 and their FAQ is at
28124 .display
28125 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
28126 .endd
28127
28128 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
28129 0-201-61598-3) in 2001, contains both introductory and more in-depth
28130 descriptions.
28131 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
28132 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
28133 Ivan is the author of the popular TLS testing tools at
28134 &url(https://www.ssllabs.com/).
28135
28136
28137 .section "Certificate chains" "SECID186"
28138 The file named by &%tls_certificate%& may contain more than one
28139 certificate. This is useful in the case where the certificate that is being
28140 sent is validated by an intermediate certificate which the other end does
28141 not have. Multiple certificates must be in the correct order in the file.
28142 First the host's certificate itself, then the first intermediate
28143 certificate to validate the issuer of the host certificate, then the next
28144 intermediate certificate to validate the issuer of the first intermediate
28145 certificate, and so on, until finally (optionally) the root certificate.
28146 The root certificate must already be trusted by the recipient for
28147 validation to succeed, of course, but if it's not preinstalled, sending the
28148 root certificate along with the rest makes it available for the user to
28149 install if the receiving end is a client MUA that can interact with a user.
28150
28151 Note that certificates using MD5 are unlikely to work on today's Internet;
28152 even if your libraries allow loading them for use in Exim when acting as a
28153 server, increasingly clients will not accept such certificates.  The error
28154 diagnostics in such a case can be frustratingly vague.
28155
28156
28157
28158 .section "Self-signed certificates" "SECID187"
28159 .cindex "certificate" "self-signed"
28160 You can create a self-signed certificate using the &'req'& command provided
28161 with OpenSSL, like this:
28162 . ==== Do not shorten the duration here without reading and considering
28163 . ==== the text below.  Please leave it at 9999 days.
28164 .code
28165 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
28166             -days 9999 -nodes
28167 .endd
28168 &_file1_& and &_file2_& can be the same file; the key and the certificate are
28169 delimited and so can be identified independently. The &%-days%& option
28170 specifies a period for which the certificate is valid. The &%-nodes%& option is
28171 important: if you do not set it, the key is encrypted with a passphrase
28172 that you are prompted for, and any use that is made of the key causes more
28173 prompting for the passphrase. This is not helpful if you are going to use
28174 this certificate and key in an MTA, where prompting is not possible.
28175
28176 . ==== I expect to still be working 26 years from now.  The less technical
28177 . ==== debt I create, in terms of storing up trouble for my later years, the
28178 . ==== happier I will be then.  We really have reached the point where we
28179 . ==== should start, at the very least, provoking thought and making folks
28180 . ==== pause before proceeding, instead of leaving all the fixes until two
28181 . ==== years before 2^31 seconds after the 1970 Unix epoch.
28182 . ==== -pdp, 2012
28183 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
28184 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
28185 the above command might produce a date in the past.  Think carefully about
28186 the lifetime of the systems you're deploying, and either reduce the duration
28187 of the certificate or reconsider your platform deployment.  (At time of
28188 writing, reducing the duration is the most likely choice, but the inexorable
28189 progression of time takes us steadily towards an era where this will not
28190 be a sensible resolution).
28191
28192 A self-signed certificate made in this way is sufficient for testing, and
28193 may be adequate for all your requirements if you are mainly interested in
28194 encrypting transfers, and not in secure identification.
28195
28196 However, many clients require that the certificate presented by the server be a
28197 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
28198 certificate. In this situation, the self-signed certificate described above
28199 must be installed on the client host as a trusted root &'certification
28200 authority'& (CA), and the certificate used by Exim must be a user certificate
28201 signed with that self-signed certificate.
28202
28203 For information on creating self-signed CA certificates and using them to sign
28204 user certificates, see the &'General implementation overview'& chapter of the
28205 Open-source PKI book, available online at
28206 &url(https://sourceforge.net/projects/ospkibook/).
28207 .ecindex IIDencsmtp1
28208 .ecindex IIDencsmtp2
28209
28210
28211
28212 .section DANE "SECDANE"
28213 .cindex DANE
28214 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
28215 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
28216 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
28217 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
28218 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
28219 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
28220
28221 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
28222 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
28223 by (a) is thought to be smaller than that of the set of root CAs.
28224
28225 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
28226 fail to pass on a server's STARTTLS.
28227
28228 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
28229 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
28230 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
28231
28232 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
28233 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
28234 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
28235 DNSSEC.
28236 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
28237 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
28238
28239 There are no changes to Exim specific to server-side operation of DANE.
28240 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
28241 in &_Local/Makefile_&.
28242 If it has been included, the macro "_HAVE_DANE" will be defined.
28243
28244 The TLSA record for the server may have "certificate usage" of DANE-TA(2) or DANE-EE(3).
28245 These are the "Trust Anchor" and "End Entity" variants.
28246 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
28247 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
28248 this is appropriate for a single system, using a self-signed certificate.
28249 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
28250 well-known one.
28251 A private CA at simplest is just a self-signed certificate (with certain
28252 attributes) which is used to sign cerver certificates, but running one securely
28253 does require careful arrangement.
28254 With DANE-TA, as implemented in Exim and commonly in other MTAs,
28255 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
28256 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
28257 all of which point to a single TLSA record.
28258 DANE-TA and DANE-EE can both be used together.
28259
28260 .new
28261 Our recommendation is to use DANE with a certificate from a public CA,
28262 because this enables a variety of strategies for remote clients to verify
28263 your certificate.
28264 You can then publish information both via DANE and another technology,
28265 "MTA-STS", described below.
28266
28267 When you use DANE-TA to publish trust anchor information, you ask entities
28268 outside your administrative control to trust the Certificate Authority for
28269 connections to you.
28270 If using a private CA then you should expect others to still apply the
28271 technical criteria they'd use for a public CA to your certificates.
28272 In particular, you should probably try to follow current best practices for CA
28273 operation around hash algorithms and key sizes.
28274 Do not expect other organizations to lower their security expectations just
28275 because a particular profile might be reasonable for your own internal use.
28276
28277 When this text was last updated, this in practice means to avoid use of SHA-1
28278 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
28279 than 4096, for interoperability); to use keyUsage fields correctly; to use
28280 random serial numbers.
28281 The list of requirements is subject to change as best practices evolve.
28282 If you're not already using a private CA, or it doesn't meet these
28283 requirements, then we encourage you to avoid all these issues and use a public
28284 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
28285 .wen
28286
28287 The TLSA record should have a Selector field of SPKI(1) and a Matching Type field of SHA2-512(2).
28288
28289 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
28290 is useful for quickly generating TLSA records; and commands like
28291
28292 .code
28293   openssl x509 -in -pubkey -noout <certificate.pem \
28294   | openssl rsa -outform der -pubin 2>/dev/null \
28295   | openssl sha512 \
28296   | awk '{print $2}'
28297 .endd
28298
28299 are workable for 4th-field hashes.
28300
28301 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
28302
28303 .new
28304 The Certificate issued by the CA published in the DANE-TA model should be
28305 issued using a strong hash algorithm.
28306 Exim, and importantly various other MTAs sending to you, will not
28307 re-enable hash algorithms which have been disabled by default in TLS
28308 libraries.
28309 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
28310 interoperability (and probably the maximum too, in 2018).
28311 .wen
28312
28313 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
28314 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
28315 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
28316
28317 .code
28318   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
28319                                  {= {4}{$tls_out_tlsa_usage}} } \
28320                          {*}{}}
28321 .endd
28322
28323 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
28324 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
28325 found. If the definition of &%hosts_request_ocsp%& includes the
28326 string "tls_out_tlsa_usage", they are re-expanded in time to
28327 control the OCSP request.
28328
28329 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
28330 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
28331
28332
28333 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
28334 and &%dane_require_tls_ciphers%&.
28335 The require variant will result in failure if the target host is not DNSSEC-secured.
28336
28337 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
28338
28339 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
28340 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
28341 will be required for the host.  If it does not, the host will not
28342 be used; there is no fallback to non-DANE or non-TLS.
28343
28344 If DANE is requested and usable, then the TLS cipher list configuration
28345 prefers to use the option &%dane_require_tls_ciphers%& and falls
28346 back to &%tls_require_ciphers%& only if that is unset.
28347 This lets you configure "decent crypto" for DANE and "better than nothing
28348 crypto" as the default.  Note though that while GnuTLS lets the string control
28349 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
28350 limited to ciphersuite constraints.
28351
28352 If DANE is requested and useable (see above) the following transport options are ignored:
28353 .code
28354   hosts_require_tls
28355   tls_verify_hosts
28356   tls_try_verify_hosts
28357   tls_verify_certificates
28358   tls_crl
28359   tls_verify_cert_hostnames
28360 .endd
28361
28362 If DANE is not usable, whether requested or not, and CA-anchored
28363 verification evaluation is wanted, the above variables should be set appropriately.
28364
28365 Currently the &%dnssec_request_domains%& must be active and &%dnssec_require_domains%& is ignored.
28366
28367 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
28368
28369 There is a new variable &$tls_out_dane$& which will have "yes" if
28370 verification succeeded using DANE and "no" otherwise (only useful
28371 in combination with events; see &<<CHAPevents>>&),
28372 and a new variable &$tls_out_tlsa_usage$& (detailed above).
28373
28374 .cindex DANE reporting
28375 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
28376 to achieve DANE-verified connection, if one was either requested and offered, or
28377 required.  This is intended to support TLS-reporting as defined in
28378 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
28379 The &$event_data$& will be one of the Result Types defined in
28380 Section 4.3 of that document.
28381
28382 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
28383
28384 DANE is specified in published RFCs and decouples certificate authority trust
28385 selection from a "race to the bottom" of "you must trust everything for mail
28386 to get through".  There is an alternative technology called MTA-STS, which
28387 instead publishes MX trust anchor information on an HTTPS website.  At the
28388 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
28389 Exim has no support for MTA-STS as a client, but Exim mail server operators
28390 can choose to publish information describing their TLS configuration using
28391 MTA-STS to let those clients who do use that protocol derive trust
28392 information.
28393
28394 The MTA-STS design requires a certificate from a public Certificate Authority
28395 which is recognized by clients sending to you.
28396 That selection of which CAs are trusted by others is outside your control.
28397
28398 The most interoperable course of action is probably to use
28399 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
28400 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
28401 records for DANE clients (such as Exim and Postfix) and to publish anchor
28402 information for MTA-STS as well.  This is what is done for the &'exim.org'&
28403 domain itself (with caveats around occasionally broken MTA-STS because of
28404 incompatible specification changes prior to reaching RFC status).
28405
28406
28407
28408 . ////////////////////////////////////////////////////////////////////////////
28409 . ////////////////////////////////////////////////////////////////////////////
28410
28411 .chapter "Access control lists" "CHAPACL"
28412 .scindex IIDacl "&ACL;" "description"
28413 .cindex "control of incoming mail"
28414 .cindex "message" "controlling incoming"
28415 .cindex "policy control" "access control lists"
28416 Access Control Lists (ACLs) are defined in a separate section of the run time
28417 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
28418 name, terminated by a colon. Here is a complete ACL section that contains just
28419 one very small ACL:
28420 .code
28421 begin acl
28422 small_acl:
28423   accept   hosts = one.host.only
28424 .endd
28425 You can have as many lists as you like in the ACL section, and the order in
28426 which they appear does not matter. The lists are self-terminating.
28427
28428 The majority of ACLs are used to control Exim's behaviour when it receives
28429 certain SMTP commands. This applies both to incoming TCP/IP connections, and
28430 when a local process submits a message using SMTP by specifying the &%-bs%&
28431 option. The most common use is for controlling which recipients are accepted
28432 in incoming messages. In addition, you can define an ACL that is used to check
28433 local non-SMTP messages. The default configuration file contains an example of
28434 a realistic ACL for checking RCPT commands. This is discussed in chapter
28435 &<<CHAPdefconfil>>&.
28436
28437
28438 .section "Testing ACLs" "SECID188"
28439 The &%-bh%& command line option provides a way of testing your ACL
28440 configuration locally by running a fake SMTP session with which you interact.
28441
28442
28443 .section "Specifying when ACLs are used" "SECID189"
28444 .cindex "&ACL;" "options for specifying"
28445 In order to cause an ACL to be used, you have to name it in one of the relevant
28446 options in the main part of the configuration. These options are:
28447 .cindex "AUTH" "ACL for"
28448 .cindex "DATA" "ACLs for"
28449 .cindex "ETRN" "ACL for"
28450 .cindex "EXPN" "ACL for"
28451 .cindex "HELO" "ACL for"
28452 .cindex "EHLO" "ACL for"
28453 .cindex "DKIM" "ACL for"
28454 .cindex "MAIL" "ACL for"
28455 .cindex "QUIT, ACL for"
28456 .cindex "RCPT" "ACL for"
28457 .cindex "STARTTLS, ACL for"
28458 .cindex "VRFY" "ACL for"
28459 .cindex "SMTP" "connection, ACL for"
28460 .cindex "non-SMTP messages" "ACLs for"
28461 .cindex "MIME content scanning" "ACL for"
28462 .cindex "PRDR" "ACL for"
28463
28464 .table2 140pt
28465 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
28466 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
28467 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
28468 .irow &%acl_smtp_auth%&        "ACL for AUTH"
28469 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
28470 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
28471 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
28472 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
28473 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
28474 .irow &%acl_smtp_expn%&        "ACL for EXPN"
28475 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
28476 .irow &%acl_smtp_mail%&        "ACL for MAIL"
28477 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
28478 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
28479 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
28480 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
28481 .irow &%acl_smtp_quit%&        "ACL for QUIT"
28482 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
28483 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
28484 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
28485 .endtable
28486
28487 For example, if you set
28488 .code
28489 acl_smtp_rcpt = small_acl
28490 .endd
28491 the little ACL defined above is used whenever Exim receives a RCPT command
28492 in an SMTP dialogue. The majority of policy tests on incoming messages can be
28493 done when RCPT commands arrive. A rejection of RCPT should cause the
28494 sending MTA to give up on the recipient address contained in the RCPT
28495 command, whereas rejection at other times may cause the client MTA to keep on
28496 trying to deliver the message. It is therefore recommended that you do as much
28497 testing as possible at RCPT time.
28498
28499
28500 .section "The non-SMTP ACLs" "SECID190"
28501 .cindex "non-SMTP messages" "ACLs for"
28502 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
28503 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
28504 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
28505 the state of the SMTP connection such as encryption and authentication) are not
28506 relevant and are forbidden in these ACLs. However, the sender and recipients
28507 are known, so the &%senders%& and &%sender_domains%& conditions and the
28508 &$sender_address$& and &$recipients$& variables can be used. Variables such as
28509 &$authenticated_sender$& are also available. You can specify added header lines
28510 in any of these ACLs.
28511
28512 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
28513 non-SMTP message, before any of the message has been read. (This is the
28514 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
28515 batched SMTP input, it runs after the DATA command has been reached. The
28516 result of this ACL is ignored; it cannot be used to reject a message. If you
28517 really need to, you could set a value in an ACL variable here and reject based
28518 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
28519 controls, and in particular, it can be used to set
28520 .code
28521 control = suppress_local_fixups
28522 .endd
28523 This cannot be used in the other non-SMTP ACLs because by the time they are
28524 run, it is too late.
28525
28526 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
28527 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
28528
28529 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
28530 kind of rejection is treated as permanent, because there is no way of sending a
28531 temporary error for these kinds of message.
28532
28533
28534 .section "The SMTP connect ACL" "SECID191"
28535 .cindex "SMTP" "connection, ACL for"
28536 .oindex &%smtp_banner%&
28537 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
28538 session, after the test specified by &%host_reject_connection%& (which is now
28539 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
28540 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
28541 the message override the banner message that is otherwise specified by the
28542 &%smtp_banner%& option.
28543
28544
28545 .section "The EHLO/HELO ACL" "SECID192"
28546 .cindex "EHLO" "ACL for"
28547 .cindex "HELO" "ACL for"
28548 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
28549 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
28550 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
28551 Note that a client may issue more than one EHLO or HELO command in an SMTP
28552 session, and indeed is required to issue a new EHLO or HELO after successfully
28553 setting up encryption following a STARTTLS command.
28554
28555 Note also that a deny neither forces the client to go away nor means that
28556 mail will be refused on the connection.  Consider checking for
28557 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
28558
28559 If the command is accepted by an &%accept%& verb that has a &%message%&
28560 modifier, the message may not contain more than one line (it will be truncated
28561 at the first newline and a panic logged if it does). Such a message cannot
28562 affect the EHLO options that are listed on the second and subsequent lines of
28563 an EHLO response.
28564
28565
28566 .section "The DATA ACLs" "SECID193"
28567 .cindex "DATA" "ACLs for"
28568 Two ACLs are associated with the DATA command, because it is two-stage
28569 command, with two responses being sent to the client.
28570 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
28571 is obeyed. This gives you control after all the RCPT commands, but before
28572 the message itself is received. It offers the opportunity to give a negative
28573 response to the DATA command before the data is transmitted. Header lines
28574 added by MAIL or RCPT ACLs are not visible at this time, but any that
28575 are defined here are visible when the &%acl_smtp_data%& ACL is run.
28576
28577 You cannot test the contents of the message, for example, to verify addresses
28578 in the headers, at RCPT time or when the DATA command is received. Such
28579 tests have to appear in the ACL that is run after the message itself has been
28580 received, before the final response to the DATA command is sent. This is
28581 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
28582 associated with the DATA command.
28583
28584 .cindex CHUNKING "BDAT command"
28585 .cindex BDAT "SMTP command"
28586 .cindex "RFC 3030" CHUNKING
28587 If CHUNKING was advertised and a BDAT command sequence is received,
28588 the &%acl_smtp_predata%& ACL is not run.
28589 . XXX why not?  It should be possible, for the first BDAT.
28590 The &%acl_smtp_data%& is run after the last BDAT command and all of
28591 the data specified is received.
28592
28593 For both of these ACLs, it is not possible to reject individual recipients. An
28594 error response rejects the entire message. Unfortunately, it is known that some
28595 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
28596 before or after the data) correctly &-- they keep the message on their queues
28597 and try again later, but that is their problem, though it does waste some of
28598 your resources.
28599
28600 The &%acl_smtp_data%& ACL is run after
28601 the &%acl_smtp_data_prdr%&,
28602 the &%acl_smtp_dkim%&
28603 and the &%acl_smtp_mime%& ACLs.
28604
28605 .section "The SMTP DKIM ACL" "SECTDKIMACL"
28606 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
28607 enabled (which is the default).
28608
28609 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
28610 received, and is executed for each DKIM signature found in a message.  If not
28611 otherwise specified, the default action is to accept.
28612
28613 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
28614
28615 For details on the operation of DKIM, see section &<<SECDKIM>>&.
28616
28617
28618 .section "The SMTP MIME ACL" "SECID194"
28619 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
28620 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
28621
28622 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
28623
28624
28625 .section "The SMTP PRDR ACL" "SECTPRDRACL"
28626 .cindex "PRDR" "ACL for"
28627 .oindex "&%prdr_enable%&"
28628 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
28629 with PRDR support enabled (which is the default).
28630 It becomes active only when the PRDR feature is negotiated between
28631 client and server for a message, and more than one recipient
28632 has been accepted.
28633
28634 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
28635 has been received, and is executed once for each recipient of the message
28636 with &$local_part$& and &$domain$& valid.
28637 The test may accept, defer or deny for individual recipients.
28638 The &%acl_smtp_data%& will still be called after this ACL and
28639 can reject the message overall, even if this ACL has accepted it
28640 for some or all recipients.
28641
28642 PRDR may be used to support per-user content filtering.  Without it
28643 one must defer any recipient after the first that has a different
28644 content-filter configuration.  With PRDR, the RCPT-time check
28645 .cindex "PRDR" "variable for"
28646 for this can be disabled when the variable &$prdr_requested$&
28647 is &"yes"&.
28648 Any required difference in behaviour of the main DATA-time
28649 ACL should however depend on the PRDR-time ACL having run, as Exim
28650 will avoid doing so in some situations (e.g.  single-recipient mails).
28651
28652 See also the &%prdr_enable%& global option
28653 and the &%hosts_try_prdr%& smtp transport option.
28654
28655 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
28656 If the ACL is not defined, processing completes as if
28657 the feature was not requested by the client.
28658
28659 .section "The QUIT ACL" "SECTQUITACL"
28660 .cindex "QUIT, ACL for"
28661 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
28662 does not affect the response code to QUIT, which is always 221. Thus, the ACL
28663 does not in fact control any access.
28664 For this reason, it may only accept
28665 or warn as its final result.
28666
28667 This ACL can be used for tasks such as custom logging at the end of an SMTP
28668 session. For example, you can use ACL variables in other ACLs to count
28669 messages, recipients, etc., and log the totals at QUIT time using one or
28670 more &%logwrite%& modifiers on a &%warn%& verb.
28671
28672 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
28673 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
28674
28675 You do not need to have a final &%accept%&, but if you do, you can use a
28676 &%message%& modifier to specify custom text that is sent as part of the 221
28677 response to QUIT.
28678
28679 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
28680 failure (for example, failure to open a log file, or when Exim is bombing out
28681 because it has detected an unrecoverable error), all SMTP commands from the
28682 client are given temporary error responses until QUIT is received or the
28683 connection is closed. In these special cases, the QUIT ACL does not run.
28684
28685
28686 .section "The not-QUIT ACL" "SECTNOTQUITACL"
28687 .vindex &$acl_smtp_notquit$&
28688 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
28689 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
28690 trouble, such as being unable to write to its log files, this ACL is not run,
28691 because it might try to do things (such as write to log files) that make the
28692 situation even worse.
28693
28694 Like the QUIT ACL, this ACL is provided to make it possible to do customized
28695 logging or to gather statistics, and its outcome is ignored. The &%delay%&
28696 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
28697 and &%warn%&.
28698
28699 .vindex &$smtp_notquit_reason$&
28700 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
28701 to a string that indicates the reason for the termination of the SMTP
28702 connection. The possible values are:
28703 .table2
28704 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
28705 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
28706 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
28707 .irow &`connection-lost`&          "The SMTP connection has been lost"
28708 .irow &`data-timeout`&             "Timeout while reading message data"
28709 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
28710 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
28711 .irow &`signal-exit`&              "SIGTERM or SIGINT"
28712 .irow &`synchronization-error`&    "SMTP synchronization error"
28713 .irow &`tls-failed`&               "TLS failed to start"
28714 .endtable
28715 In most cases when an SMTP connection is closed without having received QUIT,
28716 Exim sends an SMTP response message before actually closing the connection.
28717 With the exception of the &`acl-drop`& case, the default message can be
28718 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
28719 &%drop%& verb in another ACL, it is the message from the other ACL that is
28720 used.
28721
28722
28723 .section "Finding an ACL to use" "SECID195"
28724 .cindex "&ACL;" "finding which to use"
28725 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
28726 you can use different ACLs in different circumstances. For example,
28727 .code
28728 acl_smtp_rcpt = ${if ={25}{$interface_port} \
28729                      {acl_check_rcpt} {acl_check_rcpt_submit} }
28730 .endd
28731 In the default configuration file there are some example settings for
28732 providing an RFC 4409 message &"submission"& service on port 587 and
28733 an RFC 8314 &"submissions"& service on port 465. You can use a string
28734 expansion like this to choose an ACL for MUAs on these ports which is
28735 more appropriate for this purpose than the default ACL on port 25.
28736
28737 The expanded string does not have to be the name of an ACL in the
28738 configuration file; there are other possibilities. Having expanded the
28739 string, Exim searches for an ACL as follows:
28740
28741 .ilist
28742 If the string begins with a slash, Exim uses it as a file name, and reads its
28743 contents as an ACL. The lines are processed in the same way as lines in the
28744 Exim configuration file. In particular, continuation lines are supported, blank
28745 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
28746 If the file does not exist or cannot be read, an error occurs (typically
28747 causing a temporary failure of whatever caused the ACL to be run). For example:
28748 .code
28749 acl_smtp_data = /etc/acls/\
28750   ${lookup{$sender_host_address}lsearch\
28751   {/etc/acllist}{$value}{default}}
28752 .endd
28753 This looks up an ACL file to use on the basis of the host's IP address, falling
28754 back to a default if the lookup fails. If an ACL is successfully read from a
28755 file, it is retained in memory for the duration of the Exim process, so that it
28756 can be re-used without having to re-read the file.
28757 .next
28758 If the string does not start with a slash, and does not contain any spaces,
28759 Exim searches the ACL section of the configuration for an ACL whose name
28760 matches the string.
28761 .next
28762 If no named ACL is found, or if the string contains spaces, Exim parses
28763 the string as an inline ACL. This can save typing in cases where you just
28764 want to have something like
28765 .code
28766 acl_smtp_vrfy = accept
28767 .endd
28768 in order to allow free use of the VRFY command. Such a string may contain
28769 newlines; it is processed in the same way as an ACL that is read from a file.
28770 .endlist
28771
28772
28773
28774
28775 .section "ACL return codes" "SECID196"
28776 .cindex "&ACL;" "return codes"
28777 Except for the QUIT ACL, which does not affect the SMTP return code (see
28778 section &<<SECTQUITACL>>& above), the result of running an ACL is either
28779 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
28780 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
28781 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
28782 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
28783 This also causes a 4&'xx'& return code.
28784
28785 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
28786 &"deny"&, because there is no mechanism for passing temporary errors to the
28787 submitters of non-SMTP messages.
28788
28789
28790 ACLs that are relevant to message reception may also return &"discard"&. This
28791 has the effect of &"accept"&, but causes either the entire message or an
28792 individual recipient address to be discarded. In other words, it is a
28793 blackholing facility. Use it with care.
28794
28795 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
28796 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
28797 RCPT ACL is to discard just the one recipient address. If there are no
28798 recipients left when the message's data is received, the DATA ACL is not
28799 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
28800 remaining recipients. The &"discard"& return is not permitted for the
28801 &%acl_smtp_predata%& ACL.
28802
28803 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
28804 is done on the address and the result determines the SMTP response.
28805
28806
28807 .cindex "&[local_scan()]& function" "when all recipients discarded"
28808 The &[local_scan()]& function is always run, even if there are no remaining
28809 recipients; it may create new recipients.
28810
28811
28812
28813 .section "Unset ACL options" "SECID197"
28814 .cindex "&ACL;" "unset options"
28815 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
28816 all the same. &*Note*&: These defaults apply only when the relevant ACL is
28817 not defined at all. For any defined ACL, the default action when control
28818 reaches the end of the ACL statements is &"deny"&.
28819
28820 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
28821 these two are ACLs that are used only for their side effects. They cannot be
28822 used to accept or reject anything.
28823
28824 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
28825 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
28826 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
28827 when the ACL is not defined is &"accept"&.
28828
28829 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
28830 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
28831 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
28832 messages over an SMTP connection. For an example, see the ACL in the default
28833 configuration file.
28834
28835
28836
28837
28838 .section "Data for message ACLs" "SECID198"
28839 .cindex "&ACL;" "data for message ACL"
28840 .vindex &$domain$&
28841 .vindex &$local_part$&
28842 .vindex &$sender_address$&
28843 .vindex &$sender_host_address$&
28844 .vindex &$smtp_command$&
28845 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
28846 that contain information about the host and the message's sender (for example,
28847 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
28848 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
28849 &$local_part$& are set from the argument address. The entire SMTP command
28850 is available in &$smtp_command$&.
28851
28852 When an ACL for the AUTH parameter of MAIL is running, the variables that
28853 contain information about the host are set, but &$sender_address$& is not yet
28854 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
28855 how it is used.
28856
28857 .vindex "&$message_size$&"
28858 The &$message_size$& variable is set to the value of the SIZE parameter on
28859 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
28860 that parameter is not given. The value is updated to the true message size by
28861 the time the final DATA ACL is run (after the message data has been
28862 received).
28863
28864 .vindex "&$rcpt_count$&"
28865 .vindex "&$recipients_count$&"
28866 The &$rcpt_count$& variable increases by one for each RCPT command received.
28867 The &$recipients_count$& variable increases by one each time a RCPT command is
28868 accepted, so while an ACL for RCPT is being processed, it contains the number
28869 of previously accepted recipients. At DATA time (for both the DATA ACLs),
28870 &$rcpt_count$& contains the total number of RCPT commands, and
28871 &$recipients_count$& contains the total number of accepted recipients.
28872
28873
28874
28875
28876
28877 .section "Data for non-message ACLs" "SECTdatfornon"
28878 .cindex "&ACL;" "data for non-message ACL"
28879 .vindex &$smtp_command_argument$&
28880 .vindex &$smtp_command$&
28881 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
28882 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
28883 and the entire SMTP command is available in &$smtp_command$&.
28884 These variables can be tested using a &%condition%& condition. For example,
28885 here is an ACL for use with AUTH, which insists that either the session is
28886 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
28887 does not permit authentication methods that use cleartext passwords on
28888 unencrypted connections.
28889 .code
28890 acl_check_auth:
28891   accept encrypted = *
28892   accept condition = ${if eq{${uc:$smtp_command_argument}}\
28893                      {CRAM-MD5}}
28894   deny   message   = TLS encryption or CRAM-MD5 required
28895 .endd
28896 (Another way of applying this restriction is to arrange for the authenticators
28897 that use cleartext passwords not to be advertised when the connection is not
28898 encrypted. You can use the generic &%server_advertise_condition%& authenticator
28899 option to do this.)
28900
28901
28902
28903 .section "Format of an ACL" "SECID199"
28904 .cindex "&ACL;" "format of"
28905 .cindex "&ACL;" "verbs, definition of"
28906 An individual ACL consists of a number of statements. Each statement starts
28907 with a verb, optionally followed by a number of conditions and &"modifiers"&.
28908 Modifiers can change the way the verb operates, define error and log messages,
28909 set variables, insert delays, and vary the processing of accepted messages.
28910
28911 If all the conditions are met, the verb is obeyed. The same condition may be
28912 used (with different arguments) more than once in the same statement. This
28913 provides a means of specifying an &"and"& conjunction between conditions. For
28914 example:
28915 .code
28916 deny  dnslists = list1.example
28917       dnslists = list2.example
28918 .endd
28919 If there are no conditions, the verb is always obeyed. Exim stops evaluating
28920 the conditions and modifiers when it reaches a condition that fails. What
28921 happens then depends on the verb (and in one case, on a special modifier). Not
28922 all the conditions make sense at every testing point. For example, you cannot
28923 test a sender address in the ACL that is run for a VRFY command.
28924
28925
28926 .section "ACL verbs" "SECID200"
28927 The ACL verbs are as follows:
28928
28929 .ilist
28930 .cindex "&%accept%& ACL verb"
28931 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
28932 of the conditions are not met, what happens depends on whether &%endpass%&
28933 appears among the conditions (for syntax see below). If the failing condition
28934 is before &%endpass%&, control is passed to the next ACL statement; if it is
28935 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
28936 check a RCPT command:
28937 .code
28938 accept domains = +local_domains
28939        endpass
28940        verify = recipient
28941 .endd
28942 If the recipient domain does not match the &%domains%& condition, control
28943 passes to the next statement. If it does match, the recipient is verified, and
28944 the command is accepted if verification succeeds. However, if verification
28945 fails, the ACL yields &"deny"&, because the failing condition is after
28946 &%endpass%&.
28947
28948 The &%endpass%& feature has turned out to be confusing to many people, so its
28949 use is not recommended nowadays. It is always possible to rewrite an ACL so
28950 that &%endpass%& is not needed, and it is no longer used in the default
28951 configuration.
28952
28953 .cindex "&%message%& ACL modifier" "with &%accept%&"
28954 If a &%message%& modifier appears on an &%accept%& statement, its action
28955 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
28956 (when an &%accept%& verb either accepts or passes control to the next
28957 statement), &%message%& can be used to vary the message that is sent when an
28958 SMTP command is accepted. For example, in a RCPT ACL you could have:
28959 .display
28960 &`accept  `&<&'some conditions'&>
28961 &`        message = OK, I will allow you through today`&
28962 .endd
28963 You can specify an SMTP response code, optionally followed by an &"extended
28964 response code"& at the start of the message, but the first digit must be the
28965 same as would be sent by default, which is 2 for an &%accept%& verb.
28966
28967 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
28968 an error message that is used when access is denied. This behaviour is retained
28969 for backward compatibility, but current &"best practice"& is to avoid the use
28970 of &%endpass%&.
28971
28972
28973 .next
28974 .cindex "&%defer%& ACL verb"
28975 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
28976 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
28977 &%defer%& is the same as &%deny%&, because there is no way of sending a
28978 temporary error. For a RCPT command, &%defer%& is much the same as using a
28979 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
28980 be used in any ACL, and even for a recipient it might be a simpler approach.
28981
28982
28983 .next
28984 .cindex "&%deny%& ACL verb"
28985 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
28986 the conditions are not met, control is passed to the next ACL statement. For
28987 example,
28988 .code
28989 deny dnslists = blackholes.mail-abuse.org
28990 .endd
28991 rejects commands from hosts that are on a DNS black list.
28992
28993
28994 .next
28995 .cindex "&%discard%& ACL verb"
28996 &%discard%&: This verb behaves like &%accept%&, except that it returns
28997 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
28998 that are concerned with receiving messages. When all the conditions are true,
28999 the sending entity receives a &"success"& response. However, &%discard%& causes
29000 recipients to be discarded. If it is used in an ACL for RCPT, just the one
29001 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
29002 message's recipients are discarded. Recipients that are discarded before DATA
29003 do not appear in the log line when the &%received_recipients%& log selector is set.
29004
29005 If the &%log_message%& modifier is set when &%discard%& operates,
29006 its contents are added to the line that is automatically written to the log.
29007 The &%message%& modifier operates exactly as it does for &%accept%&.
29008
29009
29010 .next
29011 .cindex "&%drop%& ACL verb"
29012 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
29013 forcibly closed after the 5&'xx'& error message has been sent. For example:
29014 .code
29015 drop   message   = I don't take more than 20 RCPTs
29016        condition = ${if > {$rcpt_count}{20}}
29017 .endd
29018 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
29019 The connection is always dropped after sending a 550 response.
29020
29021 .next
29022 .cindex "&%require%& ACL verb"
29023 &%require%&: If all the conditions are met, control is passed to the next ACL
29024 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
29025 example, when checking a RCPT command,
29026 .code
29027 require message = Sender did not verify
29028         verify  = sender
29029 .endd
29030 passes control to subsequent statements only if the message's sender can be
29031 verified. Otherwise, it rejects the command. Note the positioning of the
29032 &%message%& modifier, before the &%verify%& condition. The reason for this is
29033 discussed in section &<<SECTcondmodproc>>&.
29034
29035 .next
29036 .cindex "&%warn%& ACL verb"
29037 &%warn%&: If all the conditions are true, a line specified by the
29038 &%log_message%& modifier is written to Exim's main log. Control always passes
29039 to the next ACL statement. If any condition is false, the log line is not
29040 written. If an identical log line is requested several times in the same
29041 message, only one copy is actually written to the log. If you want to force
29042 duplicates to be written, use the &%logwrite%& modifier instead.
29043
29044 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
29045 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
29046 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
29047 first failing condition. There is more about adding header lines in section
29048 &<<SECTaddheadacl>>&.
29049
29050 If any condition on a &%warn%& statement cannot be completed (that is, there is
29051 some sort of defer), the log line specified by &%log_message%& is not written.
29052 This does not include the case of a forced failure from a lookup, which
29053 is considered to be a successful completion. After a defer, no further
29054 conditions or modifiers in the &%warn%& statement are processed. The incident
29055 is logged, and the ACL continues to be processed, from the next statement
29056 onwards.
29057
29058
29059 .vindex "&$acl_verify_message$&"
29060 When one of the &%warn%& conditions is an address verification that fails, the
29061 text of the verification failure message is in &$acl_verify_message$&. If you
29062 want this logged, you must set it up explicitly. For example:
29063 .code
29064 warn   !verify = sender
29065        log_message = sender verify failed: $acl_verify_message
29066 .endd
29067 .endlist
29068
29069 At the end of each ACL there is an implicit unconditional &%deny%&.
29070
29071 As you can see from the examples above, the conditions and modifiers are
29072 written one to a line, with the first one on the same line as the verb, and
29073 subsequent ones on following lines. If you have a very long condition, you can
29074 continue it onto several physical lines by the usual backslash continuation
29075 mechanism. It is conventional to align the conditions vertically.
29076
29077
29078
29079 .section "ACL variables" "SECTaclvariables"
29080 .cindex "&ACL;" "variables"
29081 There are some special variables that can be set during ACL processing. They
29082 can be used to pass information between different ACLs, different invocations
29083 of the same ACL in the same SMTP connection, and between ACLs and the routers,
29084 transports, and filters that are used to deliver a message. The names of these
29085 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
29086 an underscore, but the remainder of the name can be any sequence of
29087 alphanumeric characters and underscores that you choose. There is no limit on
29088 the number of ACL variables. The two sets act as follows:
29089 .ilist
29090 The values of those variables whose names begin with &$acl_c$& persist
29091 throughout an SMTP connection. They are never reset. Thus, a value that is set
29092 while receiving one message is still available when receiving the next message
29093 on the same SMTP connection.
29094 .next
29095 The values of those variables whose names begin with &$acl_m$& persist only
29096 while a message is being received. They are reset afterwards. They are also
29097 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
29098 .endlist
29099
29100 When a message is accepted, the current values of all the ACL variables are
29101 preserved with the message and are subsequently made available at delivery
29102 time. The ACL variables are set by a modifier called &%set%&. For example:
29103 .code
29104 accept hosts = whatever
29105        set acl_m4 = some value
29106 accept authenticated = *
29107        set acl_c_auth = yes
29108 .endd
29109 &*Note*&: A leading dollar sign is not used when naming a variable that is to
29110 be set. If you want to set a variable without taking any action, you can use a
29111 &%warn%& verb without any other modifiers or conditions.
29112
29113 .oindex &%strict_acl_vars%&
29114 What happens if a syntactically valid but undefined ACL variable is
29115 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
29116 false (the default), an empty string is substituted; if it is true, an
29117 error is generated.
29118
29119 Versions of Exim before 4.64 have a limited set of numbered variables, but
29120 their names are compatible, so there is no problem with upgrading.
29121
29122
29123 .section "Condition and modifier processing" "SECTcondmodproc"
29124 .cindex "&ACL;" "conditions; processing"
29125 .cindex "&ACL;" "modifiers; processing"
29126 An exclamation mark preceding a condition negates its result. For example:
29127 .code
29128 deny   domains = *.dom.example
29129       !verify  = recipient
29130 .endd
29131 causes the ACL to return &"deny"& if the recipient domain ends in
29132 &'dom.example'& and the recipient address cannot be verified. Sometimes
29133 negation can be used on the right-hand side of a condition. For example, these
29134 two statements are equivalent:
29135 .code
29136 deny  hosts = !192.168.3.4
29137 deny !hosts =  192.168.3.4
29138 .endd
29139 However, for many conditions (&%verify%& being a good example), only left-hand
29140 side negation of the whole condition is possible.
29141
29142 The arguments of conditions and modifiers are expanded. A forced failure
29143 of an expansion causes a condition to be ignored, that is, it behaves as if the
29144 condition is true. Consider these two statements:
29145 .code
29146 accept  senders = ${lookup{$host_name}lsearch\
29147                   {/some/file}{$value}fail}
29148 accept  senders = ${lookup{$host_name}lsearch\
29149                   {/some/file}{$value}{}}
29150 .endd
29151 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
29152 the returned list is searched, but if the lookup fails the behaviour is
29153 different in the two cases. The &%fail%& in the first statement causes the
29154 condition to be ignored, leaving no further conditions. The &%accept%& verb
29155 therefore succeeds. The second statement, however, generates an empty list when
29156 the lookup fails. No sender can match an empty list, so the condition fails,
29157 and therefore the &%accept%& also fails.
29158
29159 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
29160 specify actions that are taken as the conditions for a statement are checked;
29161 others specify text for messages that are used when access is denied or a
29162 warning is generated. The &%control%& modifier affects the way an incoming
29163 message is handled.
29164
29165 The positioning of the modifiers in an ACL statement is important, because the
29166 processing of a verb ceases as soon as its outcome is known. Only those
29167 modifiers that have already been encountered will take effect. For example,
29168 consider this use of the &%message%& modifier:
29169 .code
29170 require message = Can't verify sender
29171         verify  = sender
29172         message = Can't verify recipient
29173         verify  = recipient
29174         message = This message cannot be used
29175 .endd
29176 If sender verification fails, Exim knows that the result of the statement is
29177 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
29178 so its text is used as the error message. If sender verification succeeds, but
29179 recipient verification fails, the second message is used. If recipient
29180 verification succeeds, the third message becomes &"current"&, but is never used
29181 because there are no more conditions to cause failure.
29182
29183 For the &%deny%& verb, on the other hand, it is always the last &%message%&
29184 modifier that is used, because all the conditions must be true for rejection to
29185 happen. Specifying more than one &%message%& modifier does not make sense, and
29186 the message can even be specified after all the conditions. For example:
29187 .code
29188 deny   hosts = ...
29189       !senders = *@my.domain.example
29190        message = Invalid sender from client host
29191 .endd
29192 The &"deny"& result does not happen until the end of the statement is reached,
29193 by which time Exim has set up the message.
29194
29195
29196
29197 .section "ACL modifiers" "SECTACLmodi"
29198 .cindex "&ACL;" "modifiers; list of"
29199 The ACL modifiers are as follows:
29200
29201 .vlist
29202 .vitem &*add_header*&&~=&~<&'text'&>
29203 This modifier specifies one or more header lines that are to be added to an
29204 incoming message, assuming, of course, that the message is ultimately
29205 accepted. For details, see section &<<SECTaddheadacl>>&.
29206
29207 .vitem &*continue*&&~=&~<&'text'&>
29208 .cindex "&%continue%& ACL modifier"
29209 .cindex "database" "updating in ACL"
29210 This modifier does nothing of itself, and processing of the ACL always
29211 continues with the next condition or modifier. The value of &%continue%& is in
29212 the side effects of expanding its argument. Typically this could be used to
29213 update a database. It is really just a syntactic tidiness, to avoid having to
29214 write rather ugly lines like this:
29215 .display
29216 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
29217 .endd
29218 Instead, all you need is
29219 .display
29220 &`continue = `&<&'some expansion'&>
29221 .endd
29222
29223 .vitem &*control*&&~=&~<&'text'&>
29224 .cindex "&%control%& ACL modifier"
29225 This modifier affects the subsequent processing of the SMTP connection or of an
29226 incoming message that is accepted. The effect of the first type of control
29227 lasts for the duration of the connection, whereas the effect of the second type
29228 lasts only until the current message has been received. The message-specific
29229 controls always apply to the whole message, not to individual recipients,
29230 even if the &%control%& modifier appears in a RCPT ACL.
29231
29232 As there are now quite a few controls that can be applied, they are described
29233 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
29234 in several different ways. For example:
29235
29236 . ==== As this is a nested list, any displays it contains must be indented
29237 . ==== as otherwise they are too far to the left. That comment applies only
29238 . ==== when xmlto and fop are used; formatting with sdop gets it right either
29239 . ==== way.
29240
29241 .ilist
29242 It can be at the end of an &%accept%& statement:
29243 .code
29244     accept  ...some conditions
29245             control = queue_only
29246 .endd
29247 In this case, the control is applied when this statement yields &"accept"&, in
29248 other words, when the conditions are all true.
29249
29250 .next
29251 It can be in the middle of an &%accept%& statement:
29252 .code
29253     accept  ...some conditions...
29254             control = queue_only
29255             ...some more conditions...
29256 .endd
29257 If the first set of conditions are true, the control is applied, even if the
29258 statement does not accept because one of the second set of conditions is false.
29259 In this case, some subsequent statement must yield &"accept"& for the control
29260 to be relevant.
29261
29262 .next
29263 It can be used with &%warn%& to apply the control, leaving the
29264 decision about accepting or denying to a subsequent verb. For
29265 example:
29266 .code
29267     warn    ...some conditions...
29268             control = freeze
29269     accept  ...
29270 .endd
29271 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
29272 &%logwrite%&, so it does not add anything to the message and does not write a
29273 log entry.
29274
29275 .next
29276 If you want to apply a control unconditionally, you can use it with a
29277 &%require%& verb. For example:
29278 .code
29279     require  control = no_multiline_responses
29280 .endd
29281 .endlist
29282
29283 .vitem &*delay*&&~=&~<&'time'&>
29284 .cindex "&%delay%& ACL modifier"
29285 .oindex "&%-bh%&"
29286 This modifier may appear in any ACL except notquit. It causes Exim to wait for
29287 the time interval before proceeding. However, when testing Exim using the
29288 &%-bh%& option, the delay is not actually imposed (an appropriate message is
29289 output instead). The time is given in the usual Exim notation, and the delay
29290 happens as soon as the modifier is processed. In an SMTP session, pending
29291 output is flushed before the delay is imposed.
29292
29293 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
29294 example:
29295 .code
29296 deny    ...some conditions...
29297         delay = 30s
29298 .endd
29299 The delay happens if all the conditions are true, before the statement returns
29300 &"deny"&. Compare this with:
29301 .code
29302 deny    delay = 30s
29303         ...some conditions...
29304 .endd
29305 which waits for 30s before processing the conditions. The &%delay%& modifier
29306 can also be used with &%warn%& and together with &%control%&:
29307 .code
29308 warn    ...some conditions...
29309         delay = 2m
29310         control = freeze
29311 accept  ...
29312 .endd
29313
29314 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
29315 responses to several commands are no longer buffered and sent in one packet (as
29316 they would normally be) because all output is flushed before imposing the
29317 delay. This optimization is disabled so that a number of small delays do not
29318 appear to the client as one large aggregated delay that might provoke an
29319 unwanted timeout. You can, however, disable output flushing for &%delay%& by
29320 using a &%control%& modifier to set &%no_delay_flush%&.
29321
29322
29323 .vitem &*endpass*&
29324 .cindex "&%endpass%& ACL modifier"
29325 This modifier, which has no argument, is recognized only in &%accept%& and
29326 &%discard%& statements. It marks the boundary between the conditions whose
29327 failure causes control to pass to the next statement, and the conditions whose
29328 failure causes the ACL to return &"deny"&. This concept has proved to be
29329 confusing to some people, so the use of &%endpass%& is no longer recommended as
29330 &"best practice"&. See the description of &%accept%& above for more details.
29331
29332
29333 .vitem &*log_message*&&~=&~<&'text'&>
29334 .cindex "&%log_message%& ACL modifier"
29335 This modifier sets up a message that is used as part of the log message if the
29336 ACL denies access or a &%warn%& statement's conditions are true. For example:
29337 .code
29338 require log_message = wrong cipher suite $tls_in_cipher
29339         encrypted   = DES-CBC3-SHA
29340 .endd
29341 &%log_message%& is also used when recipients are discarded by &%discard%&. For
29342 example:
29343 .display
29344 &`discard `&<&'some conditions'&>
29345 &`        log_message = Discarded $local_part@$domain because...`&
29346 .endd
29347 When access is denied, &%log_message%& adds to any underlying error message
29348 that may exist because of a condition failure. For example, while verifying a
29349 recipient address, a &':fail:'& redirection might have already set up a
29350 message.
29351
29352 The message may be defined before the conditions to which it applies, because
29353 the string expansion does not happen until Exim decides that access is to be
29354 denied. This means that any variables that are set by the condition are
29355 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
29356 variables are set after a DNS black list lookup succeeds. If the expansion of
29357 &%log_message%& fails, or if the result is an empty string, the modifier is
29358 ignored.
29359
29360 .vindex "&$acl_verify_message$&"
29361 If you want to use a &%warn%& statement to log the result of an address
29362 verification, you can use &$acl_verify_message$& to include the verification
29363 error message.
29364
29365 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
29366 the start of the logged message. If the same warning log message is requested
29367 more than once while receiving  a single email message, only one copy is
29368 actually logged. If you want to log multiple copies, use &%logwrite%& instead
29369 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
29370 is logged for a successful &%warn%& statement.
29371
29372 If &%log_message%& is not present and there is no underlying error message (for
29373 example, from the failure of address verification), but &%message%& is present,
29374 the &%message%& text is used for logging rejections. However, if any text for
29375 logging contains newlines, only the first line is logged. In the absence of
29376 both &%log_message%& and &%message%&, a default built-in message is used for
29377 logging rejections.
29378
29379
29380 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
29381 .cindex "&%log_reject_target%& ACL modifier"
29382 .cindex "logging in ACL" "specifying which log"
29383 This modifier makes it possible to specify which logs are used for messages
29384 about ACL rejections. Its argument is a colon-separated list of words that can
29385 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
29386 may be empty, in which case a rejection is not logged at all. For example, this
29387 ACL fragment writes no logging information when access is denied:
29388 .display
29389 &`deny `&<&'some conditions'&>
29390 &`     log_reject_target =`&
29391 .endd
29392 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
29393 permanent and temporary rejections. Its effect lasts for the rest of the
29394 current ACL.
29395
29396
29397 .vitem &*logwrite*&&~=&~<&'text'&>
29398 .cindex "&%logwrite%& ACL modifier"
29399 .cindex "logging in ACL" "immediate"
29400 This modifier writes a message to a log file as soon as it is encountered when
29401 processing an ACL. (Compare &%log_message%&, which, except in the case of
29402 &%warn%& and &%discard%&, is used only if the ACL statement denies
29403 access.) The &%logwrite%& modifier can be used to log special incidents in
29404 ACLs. For example:
29405 .display
29406 &`accept `&<&'some special conditions'&>
29407 &`       control  = freeze`&
29408 &`       logwrite = froze message because ...`&
29409 .endd
29410 By default, the message is written to the main log. However, it may begin
29411 with a colon, followed by a comma-separated list of log names, and then
29412 another colon, to specify exactly which logs are to be written. For
29413 example:
29414 .code
29415 logwrite = :main,reject: text for main and reject logs
29416 logwrite = :panic: text for panic log only
29417 .endd
29418
29419
29420 .vitem &*message*&&~=&~<&'text'&>
29421 .cindex "&%message%& ACL modifier"
29422 This modifier sets up a text string that is expanded and used as a response
29423 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
29424 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
29425 there is some complication if &%endpass%& is involved; see the description of
29426 &%accept%& for details.)
29427
29428 The expansion of the message happens at the time Exim decides that the ACL is
29429 to end, not at the time it processes &%message%&. If the expansion fails, or
29430 generates an empty string, the modifier is ignored. Here is an example where
29431 &%message%& must be specified first, because the ACL ends with a rejection if
29432 the &%hosts%& condition fails:
29433 .code
29434 require  message = Host not recognized
29435          hosts = 10.0.0.0/8
29436 .endd
29437 (Once a condition has failed, no further conditions or modifiers are
29438 processed.)
29439
29440 .cindex "SMTP" "error codes"
29441 .oindex "&%smtp_banner%&
29442 For ACLs that are triggered by SMTP commands, the message is returned as part
29443 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
29444 is meaningful only for SMTP, as no message is returned when a non-SMTP message
29445 is accepted. In the case of the connect ACL, accepting with a message modifier
29446 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
29447 accept message may not contain more than one line (otherwise it will be
29448 truncated at the first newline and a panic logged), and it cannot affect the
29449 EHLO options.
29450
29451 When SMTP is involved, the message may begin with an overriding response code,
29452 consisting of three digits optionally followed by an &"extended response code"&
29453 of the form &'n.n.n'&, each code being followed by a space. For example:
29454 .code
29455 deny  message = 599 1.2.3 Host not welcome
29456       hosts = 192.168.34.0/24
29457 .endd
29458 The first digit of the supplied response code must be the same as would be sent
29459 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
29460 access, but for the predata ACL, note that the default success code is 354, not
29461 2&'xx'&.
29462
29463 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
29464 the message modifier cannot override the 221 response code.
29465
29466 The text in a &%message%& modifier is literal; any quotes are taken as
29467 literals, but because the string is expanded, backslash escapes are processed
29468 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
29469 response.
29470
29471 .vindex "&$acl_verify_message$&"
29472 For ACLs that are called by an &%acl =%& ACL condition, the message is
29473 stored in &$acl_verify_message$&, from which the calling ACL may use it.
29474
29475 If &%message%& is used on a statement that verifies an address, the message
29476 specified overrides any message that is generated by the verification process.
29477 However, the original message is available in the variable
29478 &$acl_verify_message$&, so you can incorporate it into your message if you
29479 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
29480 routers to be passed back as part of the SMTP response, you should either not
29481 use a &%message%& modifier, or make use of &$acl_verify_message$&.
29482
29483 For compatibility with previous releases of Exim, a &%message%& modifier that
29484 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
29485 modifier, but this usage is now deprecated. However, &%message%& acts only when
29486 all the conditions are true, wherever it appears in an ACL command, whereas
29487 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
29488 &%warn%& in an ACL that is not concerned with receiving a message, it has no
29489 effect.
29490
29491
29492 .vitem &*queue*&&~=&~<&'text'&>
29493 .cindex "&%queue%& ACL modifier"
29494 .cindex "named queues" "selecting in ACL"
29495 This modifier specifies the use of a named queue for spool files
29496 for the message.
29497 It can only be used before the message is received (i.e. not in
29498 the DATA ACL).
29499 This could be used, for example, for known high-volume burst sources
29500 of traffic, or for quarantine of messages.
29501 Separate queue-runner processes will be needed for named queues.
29502 If the text after expansion is empty, the default queue is used.
29503
29504
29505 .vitem &*remove_header*&&~=&~<&'text'&>
29506 This modifier specifies one or more header names in a colon-separated list
29507  that are to be removed from an incoming message, assuming, of course, that
29508 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
29509
29510
29511 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
29512 .cindex "&%set%& ACL modifier"
29513 This modifier puts a value into one of the ACL variables (see section
29514 &<<SECTaclvariables>>&).
29515
29516
29517 .vitem &*udpsend*&&~=&~<&'parameters'&>
29518 .cindex "UDP communications"
29519 This modifier sends a UDP packet, for purposes such as statistics
29520 collection or behaviour monitoring. The parameters are expanded, and
29521 the result of the expansion must be a colon-separated list consisting
29522 of a destination server, port number, and the packet contents. The
29523 server can be specified as a host name or IPv4 or IPv6 address. The
29524 separator can be changed with the usual angle bracket syntax. For
29525 example, you might want to collect information on which hosts connect
29526 when:
29527 .code
29528 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
29529              $tod_zulu $sender_host_address
29530 .endd
29531 .endlist
29532
29533
29534
29535
29536 .section "Use of the control modifier" "SECTcontrols"
29537 .cindex "&%control%& ACL modifier"
29538 The &%control%& modifier supports the following settings:
29539
29540 .vlist
29541 .vitem &*control&~=&~allow_auth_unadvertised*&
29542 This modifier allows a client host to use the SMTP AUTH command even when it
29543 has not been advertised in response to EHLO. Furthermore, because there are
29544 apparently some really broken clients that do this, Exim will accept AUTH after
29545 HELO (rather than EHLO) when this control is set. It should be used only if you
29546 really need it, and you should limit its use to those broken clients that do
29547 not work without it. For example:
29548 .code
29549 warn hosts   = 192.168.34.25
29550      control = allow_auth_unadvertised
29551 .endd
29552 Normally, when an Exim server receives an AUTH command, it checks the name of
29553 the authentication mechanism that is given in the command to ensure that it
29554 matches an advertised mechanism. When this control is set, the check that a
29555 mechanism has been advertised is bypassed. Any configured mechanism can be used
29556 by the client. This control is permitted only in the connection and HELO ACLs.
29557
29558
29559 .vitem &*control&~=&~caseful_local_part*& &&&
29560        &*control&~=&~caselower_local_part*&
29561 .cindex "&ACL;" "case of local part in"
29562 .cindex "case of local parts"
29563 .vindex "&$local_part$&"
29564 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
29565 (that is, during RCPT processing). By default, the contents of &$local_part$&
29566 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
29567 any uppercase letters in the original local part are restored in &$local_part$&
29568 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
29569 is encountered.
29570
29571 These controls affect only the current recipient. Moreover, they apply only to
29572 local part handling that takes place directly in the ACL (for example, as a key
29573 in lookups). If a test to verify the recipient is obeyed, the case-related
29574 handling of the local part during the verification is controlled by the router
29575 configuration (see the &%caseful_local_part%& generic router option).
29576
29577 This facility could be used, for example, to add a spam score to local parts
29578 containing upper case letters. For example, using &$acl_m4$& to accumulate the
29579 spam score:
29580 .code
29581 warn  control = caseful_local_part
29582       set acl_m4 = ${eval:\
29583                      $acl_m4 + \
29584                      ${if match{$local_part}{[A-Z]}{1}{0}}\
29585                     }
29586       control = caselower_local_part
29587 .endd
29588 Notice that we put back the lower cased version afterwards, assuming that
29589 is what is wanted for subsequent tests.
29590
29591
29592 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
29593 .cindex "&ACL;" "cutthrough routing"
29594 .cindex "cutthrough" "requesting"
29595 This option requests delivery be attempted while the item is being received.
29596
29597 The option is usable in the RCPT ACL.
29598 If enabled for a message received via smtp and routed to an smtp transport,
29599 and only one transport, interface, destination host and port combination
29600 is used for all recipients of the message,
29601 then the delivery connection is made while the receiving connection is open
29602 and data is copied from one to the other.
29603
29604 An attempt to set this option for any recipient but the first
29605 for a mail will be quietly ignored.
29606 If a recipient-verify callout
29607 (with use_sender)
29608 connection is subsequently
29609 requested in the same ACL it is held open and used for
29610 any subsequent recipients and the data,
29611 otherwise one is made after the initial RCPT ACL completes.
29612
29613 Note that routers are used in verify mode,
29614 and cannot depend on content of received headers.
29615 Note also that headers cannot be
29616 modified by any of the post-data ACLs (DATA, MIME and DKIM).
29617 Headers may be modified by routers (subject to the above) and transports.
29618 The &'Received-By:'& header is generated as soon as the body reception starts,
29619 rather than the traditional time after the full message is received;
29620 this will affect the timestamp.
29621
29622 All the usual ACLs are called; if one results in the message being
29623 rejected, all effort spent in delivery (including the costs on
29624 the ultimate destination) will be wasted.
29625 Note that in the case of data-time ACLs this includes the entire
29626 message body.
29627
29628 Cutthrough delivery is not supported via transport-filters or when DKIM signing
29629 of outgoing messages is done, because it sends data to the ultimate destination
29630 before the entire message has been received from the source.
29631 It is not supported for messages received with the SMTP PRDR
29632 or CHUNKING
29633 options in use.
29634
29635 Should the ultimate destination system positively accept or reject the mail,
29636 a corresponding indication is given to the source system and nothing is queued.
29637 If the item is successfully delivered in cutthrough mode
29638 the delivery log lines are tagged with ">>" rather than "=>" and appear
29639 before the acceptance "<=" line.
29640
29641 If there is a temporary error the item is queued for later delivery in the
29642 usual fashion.
29643 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
29644 to the control; the default value is &"spool"& and the alternate value
29645 &"pass"& copies an SMTP defer response from the target back to the initiator
29646 and does not queue the message.
29647 Note that this is independent of any recipient verify conditions in the ACL.
29648
29649 Delivery in this mode avoids the generation of a bounce mail to a
29650 (possibly faked)
29651 sender when the destination system is doing content-scan based rejection.
29652
29653
29654 .vitem &*control&~=&~debug/*&<&'options'&>
29655 .cindex "&ACL;" "enabling debug logging"
29656 .cindex "debugging" "enabling from an ACL"
29657 This control turns on debug logging, almost as though Exim had been invoked
29658 with &`-d`&, with the output going to a new logfile in the usual logs directory,
29659 by default called &'debuglog'&.
29660 The filename can be adjusted with the &'tag'& option, which
29661 may access any variables already defined.  The logging may be adjusted with
29662 the &'opts'& option, which takes the same values as the &`-d`& command-line
29663 option.
29664 Logging started this way may be stopped, and the file removed,
29665 with the &'kill'& option.
29666 Some examples (which depend on variables that don't exist in all
29667 contexts):
29668 .code
29669       control = debug
29670       control = debug/tag=.$sender_host_address
29671       control = debug/opts=+expand+acl
29672       control = debug/tag=.$message_exim_id/opts=+expand
29673       control = debug/kill
29674 .endd
29675
29676
29677 .vitem &*control&~=&~dkim_disable_verify*&
29678 .cindex "disable DKIM verify"
29679 .cindex "DKIM" "disable verify"
29680 This control turns off DKIM verification processing entirely.  For details on
29681 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
29682
29683
29684 .vitem &*control&~=&~dscp/*&<&'value'&>
29685 .cindex "&ACL;" "setting DSCP value"
29686 .cindex "DSCP" "inbound"
29687 This option causes the DSCP value associated with the socket for the inbound
29688 connection to be adjusted to a given value, given as one of a number of fixed
29689 strings or to numeric value.
29690 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
29691 Common values include &`throughput`&, &`mincost`&, and on newer systems
29692 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
29693
29694 The outbound packets from Exim will be marked with this value in the header
29695 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
29696 that these values will have any effect, not be stripped by networking
29697 equipment, or do much of anything without cooperation with your Network
29698 Engineer and those of all network operators between the source and destination.
29699
29700
29701 .vitem &*control&~=&~enforce_sync*& &&&
29702        &*control&~=&~no_enforce_sync*&
29703 .cindex "SMTP" "synchronization checking"
29704 .cindex "synchronization checking in SMTP"
29705 These controls make it possible to be selective about when SMTP synchronization
29706 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
29707 state of the switch (it is true by default). See the description of this option
29708 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
29709
29710 The effect of these two controls lasts for the remainder of the SMTP
29711 connection. They can appear in any ACL except the one for the non-SMTP
29712 messages. The most straightforward place to put them is in the ACL defined by
29713 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
29714 before the first synchronization check. The expected use is to turn off the
29715 synchronization checks for badly-behaved hosts that you nevertheless need to
29716 work with.
29717
29718
29719 .vitem &*control&~=&~fakedefer/*&<&'message'&>
29720 .cindex "fake defer"
29721 .cindex "defer, fake"
29722 This control works in exactly the same way as &%fakereject%& (described below)
29723 except that it causes an SMTP 450 response after the message data instead of a
29724 550 response. You must take care when using &%fakedefer%& because it causes the
29725 messages to be duplicated when the sender retries. Therefore, you should not
29726 use &%fakedefer%& if the message is to be delivered normally.
29727
29728 .vitem &*control&~=&~fakereject/*&<&'message'&>
29729 .cindex "fake rejection"
29730 .cindex "rejection, fake"
29731 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
29732 words, only when an SMTP message is being received. If Exim accepts the
29733 message, instead the final 250 response, a 550 rejection message is sent.
29734 However, Exim proceeds to deliver the message as normal. The control applies
29735 only to the current message, not to any subsequent ones that may be received in
29736 the same SMTP connection.
29737
29738 The text for the 550 response is taken from the &%control%& modifier. If no
29739 message is supplied, the following is used:
29740 .code
29741 550-Your message has been rejected but is being
29742 550-kept for evaluation.
29743 550-If it was a legitimate message, it may still be
29744 550 delivered to the target recipient(s).
29745 .endd
29746 This facility should be used with extreme caution.
29747
29748 .vitem &*control&~=&~freeze*&
29749 .cindex "frozen messages" "forcing in ACL"
29750 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29751 other words, only when a message is being received. If the message is accepted,
29752 it is placed on Exim's queue and frozen. The control applies only to the
29753 current message, not to any subsequent ones that may be received in the same
29754 SMTP connection.
29755
29756 This modifier can optionally be followed by &`/no_tell`&. If the global option
29757 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
29758 is told about the freezing), provided all the &*control=freeze*& modifiers that
29759 are obeyed for the current message have the &`/no_tell`& option.
29760
29761 .vitem &*control&~=&~no_delay_flush*&
29762 .cindex "SMTP" "output flushing, disabling for delay"
29763 Exim normally flushes SMTP output before implementing a delay in an ACL, to
29764 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29765 use. This control, as long as it is encountered before the &%delay%& modifier,
29766 disables such output flushing.
29767
29768 .vitem &*control&~=&~no_callout_flush*&
29769 .cindex "SMTP" "output flushing, disabling for callout"
29770 Exim normally flushes SMTP output before performing a callout in an ACL, to
29771 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29772 use. This control, as long as it is encountered before the &%verify%& condition
29773 that causes the callout, disables such output flushing.
29774
29775 .vitem &*control&~=&~no_mbox_unspool*&
29776 This control is available when Exim is compiled with the content scanning
29777 extension. Content scanning may require a copy of the current message, or parts
29778 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
29779 or spam scanner. Normally, such copies are deleted when they are no longer
29780 needed. If this control is set, the copies are not deleted. The control applies
29781 only to the current message, not to any subsequent ones that may be received in
29782 the same SMTP connection. It is provided for debugging purposes and is unlikely
29783 to be useful in production.
29784
29785 .vitem &*control&~=&~no_multiline_responses*&
29786 .cindex "multiline responses, suppressing"
29787 This control is permitted for any ACL except the one for non-SMTP messages.
29788 It seems that there are broken clients in use that cannot handle multiline
29789 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
29790
29791 If this control is set, multiline SMTP responses from ACL rejections are
29792 suppressed. One way of doing this would have been to put out these responses as
29793 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
29794 (&"use multiline responses for more"& it says &-- ha!), and some of the
29795 responses might get close to that. So this facility, which is after all only a
29796 sop to broken clients, is implemented by doing two very easy things:
29797
29798 .ilist
29799 Extra information that is normally output as part of a rejection caused by
29800 sender verification failure is omitted. Only the final line (typically &"sender
29801 verification failed"&) is sent.
29802 .next
29803 If a &%message%& modifier supplies a multiline response, only the first
29804 line is output.
29805 .endlist
29806
29807 The setting of the switch can, of course, be made conditional on the
29808 calling host. Its effect lasts until the end of the SMTP connection.
29809
29810 .vitem &*control&~=&~no_pipelining*&
29811 .cindex "PIPELINING" "suppressing advertising"
29812 This control turns off the advertising of the PIPELINING extension to SMTP in
29813 the current session. To be useful, it must be obeyed before Exim sends its
29814 response to an EHLO command. Therefore, it should normally appear in an ACL
29815 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
29816 &%pipelining_advertise_hosts%&.
29817
29818 .vitem &*control&~=&~queue_only*&
29819 .oindex "&%queue_only%&"
29820 .cindex "queueing incoming messages"
29821 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29822 other words, only when a message is being received. If the message is accepted,
29823 it is placed on Exim's queue and left there for delivery by a subsequent queue
29824 runner. No immediate delivery process is started. In other words, it has the
29825 effect as the &%queue_only%& global option. However, the control applies only
29826 to the current message, not to any subsequent ones that may be received in the
29827 same SMTP connection.
29828
29829 .vitem &*control&~=&~submission/*&<&'options'&>
29830 .cindex "message" "submission"
29831 .cindex "submission mode"
29832 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
29833 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
29834 the current message is a submission from a local MUA. In this case, Exim
29835 operates in &"submission mode"&, and applies certain fixups to the message if
29836 necessary. For example, it adds a &'Date:'& header line if one is not present.
29837 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
29838 late (the message has already been created).
29839
29840 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
29841 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
29842 submission mode; the available options for this control are described there.
29843 The control applies only to the current message, not to any subsequent ones
29844 that may be received in the same SMTP connection.
29845
29846 .vitem &*control&~=&~suppress_local_fixups*&
29847 .cindex "submission fixups, suppressing"
29848 This control applies to locally submitted (non TCP/IP) messages, and is the
29849 complement of &`control = submission`&. It disables the fixups that are
29850 normally applied to locally-submitted messages. Specifically:
29851
29852 .ilist
29853 Any &'Sender:'& header line is left alone (in this respect, it is a
29854 dynamic version of &%local_sender_retain%&).
29855 .next
29856 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
29857 .next
29858 There is no check that &'From:'& corresponds to the actual sender.
29859 .endlist ilist
29860
29861 This control may be useful when a remotely-originated message is accepted,
29862 passed to some scanning program, and then re-submitted for delivery. It can be
29863 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29864 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
29865 data is read.
29866
29867 &*Note:*& This control applies only to the current message, not to any others
29868 that are being submitted at the same time using &%-bs%& or &%-bS%&.
29869
29870 .vitem &*control&~=&~utf8_downconvert*&
29871 This control enables conversion of UTF-8 in message addresses
29872 to a-label form.
29873 For details see section &<<SECTi18nMTA>>&.
29874 .endlist vlist
29875
29876
29877 .section "Summary of message fixup control" "SECTsummesfix"
29878 All four possibilities for message fixups can be specified:
29879
29880 .ilist
29881 Locally submitted, fixups applied: the default.
29882 .next
29883 Locally submitted, no fixups applied: use
29884 &`control = suppress_local_fixups`&.
29885 .next
29886 Remotely submitted, no fixups applied: the default.
29887 .next
29888 Remotely submitted, fixups applied: use &`control = submission`&.
29889 .endlist
29890
29891
29892
29893 .section "Adding header lines in ACLs" "SECTaddheadacl"
29894 .cindex "header lines" "adding in an ACL"
29895 .cindex "header lines" "position of added lines"
29896 .cindex "&%add_header%& ACL modifier"
29897 The &%add_header%& modifier can be used to add one or more extra header lines
29898 to an incoming message, as in this example:
29899 .code
29900 warn dnslists = sbl.spamhaus.org : \
29901                 dialup.mail-abuse.org
29902      add_header = X-blacklisted-at: $dnslist_domain
29903 .endd
29904 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29905 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29906 receiving a message). The message must ultimately be accepted for
29907 &%add_header%& to have any significant effect. You can use &%add_header%& with
29908 any ACL verb, including &%deny%& (though this is potentially useful only in a
29909 RCPT ACL).
29910
29911 Headers will not be added to the message if the modifier is used in
29912 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29913
29914 Leading and trailing newlines are removed from
29915 the data for the &%add_header%& modifier; if it then
29916 contains one or more newlines that
29917 are not followed by a space or a tab, it is assumed to contain multiple header
29918 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
29919 front of any line that is not a valid header line.
29920
29921 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29922 They are added to the message before processing the DATA and MIME ACLs.
29923 However, if an identical header line is requested more than once, only one copy
29924 is actually added to the message. Further header lines may be accumulated
29925 during the DATA and MIME ACLs, after which they are added to the message, again
29926 with duplicates suppressed. Thus, it is possible to add two identical header
29927 lines to an SMTP message, but only if one is added before DATA and one after.
29928 In the case of non-SMTP messages, new headers are accumulated during the
29929 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
29930 message is rejected after DATA or by the non-SMTP ACL, all added header lines
29931 are included in the entry that is written to the reject log.
29932
29933 .cindex "header lines" "added; visibility of"
29934 Header lines are not visible in string expansions
29935 of message headers
29936 until they are added to the
29937 message. It follows that header lines defined in the MAIL, RCPT, and predata
29938 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
29939 header lines that are added by the DATA or MIME ACLs are not visible in those
29940 ACLs. Because of this restriction, you cannot use header lines as a way of
29941 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
29942 this, you can use ACL variables, as described in section
29943 &<<SECTaclvariables>>&.
29944
29945 The list of headers yet to be added is given by the &%$headers_added%& variable.
29946
29947 The &%add_header%& modifier acts immediately as it is encountered during the
29948 processing of an ACL. Notice the difference between these two cases:
29949 .display
29950 &`accept add_header = ADDED: some text`&
29951 &`       `&<&'some condition'&>
29952
29953 &`accept `&<&'some condition'&>
29954 &`       add_header = ADDED: some text`&
29955 .endd
29956 In the first case, the header line is always added, whether or not the
29957 condition is true. In the second case, the header line is added only if the
29958 condition is true. Multiple occurrences of &%add_header%& may occur in the same
29959 ACL statement. All those that are encountered before a condition fails are
29960 honoured.
29961
29962 .cindex "&%warn%& ACL verb"
29963 For compatibility with previous versions of Exim, a &%message%& modifier for a
29964 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
29965 effect only if all the conditions are true, even if it appears before some of
29966 them. Furthermore, only the last occurrence of &%message%& is honoured. This
29967 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
29968 are present on a &%warn%& verb, both are processed according to their
29969 specifications.
29970
29971 By default, new header lines are added to a message at the end of the existing
29972 header lines. However, you can specify that any particular header line should
29973 be added right at the start (before all the &'Received:'& lines), immediately
29974 after the first block of &'Received:'& lines, or immediately before any line
29975 that is not a &'Received:'& or &'Resent-something:'& header.
29976
29977 This is done by specifying &":at_start:"&, &":after_received:"&, or
29978 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
29979 header line, respectively. (Header text cannot start with a colon, as there has
29980 to be a header name first.) For example:
29981 .code
29982 warn add_header = \
29983        :after_received:X-My-Header: something or other...
29984 .endd
29985 If more than one header line is supplied in a single &%add_header%& modifier,
29986 each one is treated independently and can therefore be placed differently. If
29987 you add more than one line at the start, or after the Received: block, they end
29988 up in reverse order.
29989
29990 &*Warning*&: This facility currently applies only to header lines that are
29991 added in an ACL. It does NOT work for header lines that are added in a
29992 system filter or in a router or transport.
29993
29994
29995
29996 .section "Removing header lines in ACLs" "SECTremoveheadacl"
29997 .cindex "header lines" "removing in an ACL"
29998 .cindex "header lines" "position of removed lines"
29999 .cindex "&%remove_header%& ACL modifier"
30000 The &%remove_header%& modifier can be used to remove one or more header lines
30001 from an incoming message, as in this example:
30002 .code
30003 warn   message        = Remove internal headers
30004        remove_header  = x-route-mail1 : x-route-mail2
30005 .endd
30006 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30007 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30008 receiving a message). The message must ultimately be accepted for
30009 &%remove_header%& to have any significant effect. You can use &%remove_header%&
30010 with any ACL verb, including &%deny%&, though this is really not useful for
30011 any verb that doesn't result in a delivered message.
30012
30013 Headers will not be removed from the message if the modifier is used in
30014 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30015
30016 More than one header can be removed at the same time by using a colon separated
30017 list of header names. The header matching is case insensitive. Wildcards are
30018 not permitted, nor is list expansion performed, so you cannot use hostlists to
30019 create a list of headers, however both connection and message variable expansion
30020 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
30021 .code
30022 warn   hosts           = +internal_hosts
30023        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
30024 warn   message         = Remove internal headers
30025        remove_header   = $acl_c_ihdrs
30026 .endd
30027 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
30028 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
30029 If multiple header lines match, all are removed.
30030 There is no harm in attempting to remove the same header twice nor in removing
30031 a non-existent header. Further header lines to be removed may be accumulated
30032 during the DATA and MIME ACLs, after which they are removed from the message,
30033 if present. In the case of non-SMTP messages, headers to be removed are
30034 accumulated during the non-SMTP ACLs, and are removed from the message after
30035 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
30036 ACL, there really is no effect because there is no logging of what headers
30037 would have been removed.
30038
30039 .cindex "header lines" "removed; visibility of"
30040 Header lines are not visible in string expansions until the DATA phase when it
30041 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
30042 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
30043 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
30044 this restriction, you cannot use header lines as a way of controlling data
30045 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
30046 you should instead use ACL variables, as described in section
30047 &<<SECTaclvariables>>&.
30048
30049 The &%remove_header%& modifier acts immediately as it is encountered during the
30050 processing of an ACL. Notice the difference between these two cases:
30051 .display
30052 &`accept remove_header = X-Internal`&
30053 &`       `&<&'some condition'&>
30054
30055 &`accept `&<&'some condition'&>
30056 &`       remove_header = X-Internal`&
30057 .endd
30058 In the first case, the header line is always removed, whether or not the
30059 condition is true. In the second case, the header line is removed only if the
30060 condition is true. Multiple occurrences of &%remove_header%& may occur in the
30061 same ACL statement. All those that are encountered before a condition fails
30062 are honoured.
30063
30064 &*Warning*&: This facility currently applies only to header lines that are
30065 present during ACL processing. It does NOT remove header lines that are added
30066 in a system filter or in a router or transport.
30067
30068
30069
30070
30071 .section "ACL conditions" "SECTaclconditions"
30072 .cindex "&ACL;" "conditions; list of"
30073 Some of the conditions listed in this section are available only when Exim is
30074 compiled with the content-scanning extension. They are included here briefly
30075 for completeness. More detailed descriptions can be found in the discussion on
30076 content scanning in chapter &<<CHAPexiscan>>&.
30077
30078 Not all conditions are relevant in all circumstances. For example, testing
30079 senders and recipients does not make sense in an ACL that is being run as the
30080 result of the arrival of an ETRN command, and checks on message headers can be
30081 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
30082 can use the same condition (with different parameters) more than once in the
30083 same ACL statement. This provides a way of specifying an &"and"& conjunction.
30084 The conditions are as follows:
30085
30086
30087 .vlist
30088 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
30089 .cindex "&ACL;" "nested"
30090 .cindex "&ACL;" "indirect"
30091 .cindex "&ACL;" "arguments"
30092 .cindex "&%acl%& ACL condition"
30093 The possible values of the argument are the same as for the
30094 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
30095 &"accept"& the condition is true; if it returns &"deny"& the condition is
30096 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
30097 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
30098 condition false. This means that further processing of the &%warn%& verb
30099 ceases, but processing of the ACL continues.
30100
30101 If the argument is a named ACL, up to nine space-separated optional values
30102 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
30103 and $acl_narg is set to the count of values.
30104 Previous values of these variables are restored after the call returns.
30105 The name and values are expanded separately.
30106 Note that spaces in complex expansions which are used as arguments
30107 will act as argument separators.
30108
30109 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
30110 the connection is dropped. If it returns &"discard"&, the verb must be
30111 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
30112 conditions are tested.
30113
30114 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
30115 loops. This condition allows you to use different ACLs in different
30116 circumstances. For example, different ACLs can be used to handle RCPT commands
30117 for different local users or different local domains.
30118
30119 .vitem &*authenticated&~=&~*&<&'string&~list'&>
30120 .cindex "&%authenticated%& ACL condition"
30121 .cindex "authentication" "ACL checking"
30122 .cindex "&ACL;" "testing for authentication"
30123 If the SMTP connection is not authenticated, the condition is false. Otherwise,
30124 the name of the authenticator is tested against the list. To test for
30125 authentication by any authenticator, you can set
30126 .code
30127 authenticated = *
30128 .endd
30129
30130 .vitem &*condition&~=&~*&<&'string'&>
30131 .cindex "&%condition%& ACL condition"
30132 .cindex "customizing" "ACL condition"
30133 .cindex "&ACL;" "customized test"
30134 .cindex "&ACL;" "testing, customized"
30135 This feature allows you to make up custom conditions. If the result of
30136 expanding the string is an empty string, the number zero, or one of the strings
30137 &"no"& or &"false"&, the condition is false. If the result is any non-zero
30138 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
30139 any other value, some error is assumed to have occurred, and the ACL returns
30140 &"defer"&. However, if the expansion is forced to fail, the condition is
30141 ignored. The effect is to treat it as true, whether it is positive or
30142 negative.
30143
30144 .vitem &*decode&~=&~*&<&'location'&>
30145 .cindex "&%decode%& ACL condition"
30146 This condition is available only when Exim is compiled with the
30147 content-scanning extension, and it is allowed only in the ACL defined by
30148 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
30149 If all goes well, the condition is true. It is false only if there are
30150 problems such as a syntax error or a memory shortage. For more details, see
30151 chapter &<<CHAPexiscan>>&.
30152
30153 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
30154 .cindex "&%dnslists%& ACL condition"
30155 .cindex "DNS list" "in ACL"
30156 .cindex "black list (DNS)"
30157 .cindex "&ACL;" "testing a DNS list"
30158 This condition checks for entries in DNS black lists. These are also known as
30159 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
30160 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
30161 different variants of this condition to describe briefly here. See sections
30162 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
30163
30164 .vitem &*domains&~=&~*&<&'domain&~list'&>
30165 .cindex "&%domains%& ACL condition"
30166 .cindex "domain" "ACL checking"
30167 .cindex "&ACL;" "testing a recipient domain"
30168 .vindex "&$domain_data$&"
30169 This condition is relevant only after a RCPT command. It checks that the domain
30170 of the recipient address is in the domain list. If percent-hack processing is
30171 enabled, it is done before this test is done. If the check succeeds with a
30172 lookup, the result of the lookup is placed in &$domain_data$& until the next
30173 &%domains%& test.
30174
30175 &*Note carefully*& (because many people seem to fall foul of this): you cannot
30176 use &%domains%& in a DATA ACL.
30177
30178
30179 .vitem &*encrypted&~=&~*&<&'string&~list'&>
30180 .cindex "&%encrypted%& ACL condition"
30181 .cindex "encryption" "checking in an ACL"
30182 .cindex "&ACL;" "testing for encryption"
30183 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
30184 name of the cipher suite in use is tested against the list. To test for
30185 encryption without testing for any specific cipher suite(s), set
30186 .code
30187 encrypted = *
30188 .endd
30189
30190
30191 .vitem &*hosts&~=&~*&<&'host&~list'&>
30192 .cindex "&%hosts%& ACL condition"
30193 .cindex "host" "ACL checking"
30194 .cindex "&ACL;" "testing the client host"
30195 This condition tests that the calling host matches the host list. If you have
30196 name lookups or wildcarded host names and IP addresses in the same host list,
30197 you should normally put the IP addresses first. For example, you could have:
30198 .code
30199 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
30200 .endd
30201 The lookup in this example uses the host name for its key. This is implied by
30202 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
30203 and it wouldn't matter which way round you had these two items.)
30204
30205 The reason for the problem with host names lies in the left-to-right way that
30206 Exim processes lists. It can test IP addresses without doing any DNS lookups,
30207 but when it reaches an item that requires a host name, it fails if it cannot
30208 find a host name to compare with the pattern. If the above list is given in the
30209 opposite order, the &%accept%& statement fails for a host whose name cannot be
30210 found, even if its IP address is 10.9.8.7.
30211
30212 If you really do want to do the name check first, and still recognize the IP
30213 address even if the name lookup fails, you can rewrite the ACL like this:
30214 .code
30215 accept hosts = dbm;/etc/friendly/hosts
30216 accept hosts = 10.9.8.7
30217 .endd
30218 The default action on failing to find the host name is to assume that the host
30219 is not in the list, so the first &%accept%& statement fails. The second
30220 statement can then check the IP address.
30221
30222 .vindex "&$host_data$&"
30223 If a &%hosts%& condition is satisfied by means of a lookup, the result
30224 of the lookup is made available in the &$host_data$& variable. This
30225 allows you, for example, to set up a statement like this:
30226 .code
30227 deny  hosts = net-lsearch;/some/file
30228 message = $host_data
30229 .endd
30230 which gives a custom error message for each denied host.
30231
30232 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
30233 .cindex "&%local_parts%& ACL condition"
30234 .cindex "local part" "ACL checking"
30235 .cindex "&ACL;" "testing a local part"
30236 .vindex "&$local_part_data$&"
30237 This condition is relevant only after a RCPT command. It checks that the local
30238 part of the recipient address is in the list. If percent-hack processing is
30239 enabled, it is done before this test. If the check succeeds with a lookup, the
30240 result of the lookup is placed in &$local_part_data$&, which remains set until
30241 the next &%local_parts%& test.
30242
30243 .vitem &*malware&~=&~*&<&'option'&>
30244 .cindex "&%malware%& ACL condition"
30245 .cindex "&ACL;" "virus scanning"
30246 .cindex "&ACL;" "scanning for viruses"
30247 This condition is available only when Exim is compiled with the
30248 content-scanning extension. It causes the incoming message to be scanned for
30249 viruses. For details, see chapter &<<CHAPexiscan>>&.
30250
30251 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30252 .cindex "&%mime_regex%& ACL condition"
30253 .cindex "&ACL;" "testing by regex matching"
30254 This condition is available only when Exim is compiled with the
30255 content-scanning extension, and it is allowed only in the ACL defined by
30256 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
30257 with any of the regular expressions. For details, see chapter
30258 &<<CHAPexiscan>>&.
30259
30260 .vitem &*ratelimit&~=&~*&<&'parameters'&>
30261 .cindex "rate limiting"
30262 This condition can be used to limit the rate at which a user or host submits
30263 messages. Details are given in section &<<SECTratelimiting>>&.
30264
30265 .vitem &*recipients&~=&~*&<&'address&~list'&>
30266 .cindex "&%recipients%& ACL condition"
30267 .cindex "recipient" "ACL checking"
30268 .cindex "&ACL;" "testing a recipient"
30269 This condition is relevant only after a RCPT command. It checks the entire
30270 recipient address against a list of recipients.
30271
30272 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30273 .cindex "&%regex%& ACL condition"
30274 .cindex "&ACL;" "testing by regex matching"
30275 This condition is available only when Exim is compiled with the
30276 content-scanning extension, and is available only in the DATA, MIME, and
30277 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
30278 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
30279
30280 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
30281 .cindex "&%sender_domains%& ACL condition"
30282 .cindex "sender" "ACL checking"
30283 .cindex "&ACL;" "testing a sender domain"
30284 .vindex "&$domain$&"
30285 .vindex "&$sender_address_domain$&"
30286 This condition tests the domain of the sender of the message against the given
30287 domain list. &*Note*&: The domain of the sender address is in
30288 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
30289 of this condition. This is an exception to the general rule for testing domain
30290 lists. It is done this way so that, if this condition is used in an ACL for a
30291 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
30292 influence the sender checking.
30293
30294 &*Warning*&: It is a bad idea to use this condition on its own as a control on
30295 relaying, because sender addresses are easily, and commonly, forged.
30296
30297 .vitem &*senders&~=&~*&<&'address&~list'&>
30298 .cindex "&%senders%& ACL condition"
30299 .cindex "sender" "ACL checking"
30300 .cindex "&ACL;" "testing a sender"
30301 This condition tests the sender of the message against the given list. To test
30302 for a bounce message, which has an empty sender, set
30303 .code
30304 senders = :
30305 .endd
30306 &*Warning*&: It is a bad idea to use this condition on its own as a control on
30307 relaying, because sender addresses are easily, and commonly, forged.
30308
30309 .vitem &*spam&~=&~*&<&'username'&>
30310 .cindex "&%spam%& ACL condition"
30311 .cindex "&ACL;" "scanning for spam"
30312 This condition is available only when Exim is compiled with the
30313 content-scanning extension. It causes the incoming message to be scanned by
30314 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
30315
30316 .vitem &*verify&~=&~certificate*&
30317 .cindex "&%verify%& ACL condition"
30318 .cindex "TLS" "client certificate verification"
30319 .cindex "certificate" "verification of client"
30320 .cindex "&ACL;" "certificate verification"
30321 .cindex "&ACL;" "testing a TLS certificate"
30322 This condition is true in an SMTP session if the session is encrypted, and a
30323 certificate was received from the client, and the certificate was verified. The
30324 server requests a certificate only if the client matches &%tls_verify_hosts%&
30325 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
30326
30327 .vitem &*verify&~=&~csa*&
30328 .cindex "CSA verification"
30329 This condition checks whether the sending host (the client) is authorized to
30330 send email. Details of how this works are given in section
30331 &<<SECTverifyCSA>>&.
30332
30333 .vitem &*verify&~=&~header_names_ascii*&
30334 .cindex "&%verify%& ACL condition"
30335 .cindex "&ACL;" "verifying header names only ASCII"
30336 .cindex "header lines" "verifying header names only ASCII"
30337 .cindex "verifying" "header names only ASCII"
30338 This condition is relevant only in an ACL that is run after a message has been
30339 received, that is, in an ACL specified by &%acl_smtp_data%& or
30340 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
30341 there are no non-ASCII characters, also excluding control characters.  The
30342 allowable characters are decimal ASCII values 33 through 126.
30343
30344 Exim itself will handle headers with non-ASCII characters, but it can cause
30345 problems for downstream applications, so this option will allow their
30346 detection and rejection in the DATA ACL's.
30347
30348 .vitem &*verify&~=&~header_sender/*&<&'options'&>
30349 .cindex "&%verify%& ACL condition"
30350 .cindex "&ACL;" "verifying sender in the header"
30351 .cindex "header lines" "verifying the sender in"
30352 .cindex "sender" "verifying in header"
30353 .cindex "verifying" "sender in header"
30354 This condition is relevant only in an ACL that is run after a message has been
30355 received, that is, in an ACL specified by &%acl_smtp_data%& or
30356 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
30357 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
30358 is loosely thought of as a &"sender"& address (hence the name of the test).
30359 However, an address that appears in one of these headers need not be an address
30360 that accepts bounce messages; only sender addresses in envelopes are required
30361 to accept bounces. Therefore, if you use the callout option on this check, you
30362 might want to arrange for a non-empty address in the MAIL command.
30363
30364 Details of address verification and the options are given later, starting at
30365 section &<<SECTaddressverification>>& (callouts are described in section
30366 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
30367 condition to restrict it to bounce messages only:
30368 .code
30369 deny    senders = :
30370         message = A valid sender header is required for bounces
30371        !verify  = header_sender
30372 .endd
30373
30374 .vitem &*verify&~=&~header_syntax*&
30375 .cindex "&%verify%& ACL condition"
30376 .cindex "&ACL;" "verifying header syntax"
30377 .cindex "header lines" "verifying syntax"
30378 .cindex "verifying" "header syntax"
30379 This condition is relevant only in an ACL that is run after a message has been
30380 received, that is, in an ACL specified by &%acl_smtp_data%& or
30381 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
30382 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
30383 and &'Bcc:'&), returning true if there are no problems.
30384 Unqualified addresses (local parts without domains) are
30385 permitted only in locally generated messages and from hosts that match
30386 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
30387 appropriate.
30388
30389 Note that this condition is a syntax check only. However, a common spamming
30390 ploy used to be to send syntactically invalid headers such as
30391 .code
30392 To: @
30393 .endd
30394 and this condition can be used to reject such messages, though they are not as
30395 common as they used to be.
30396
30397 .vitem &*verify&~=&~helo*&
30398 .cindex "&%verify%& ACL condition"
30399 .cindex "&ACL;" "verifying HELO/EHLO"
30400 .cindex "HELO" "verifying"
30401 .cindex "EHLO" "verifying"
30402 .cindex "verifying" "EHLO"
30403 .cindex "verifying" "HELO"
30404 This condition is true if a HELO or EHLO command has been received from the
30405 client host, and its contents have been verified. If there has been no previous
30406 attempt to verify the HELO/EHLO contents, it is carried out when this
30407 condition is encountered. See the description of the &%helo_verify_hosts%& and
30408 &%helo_try_verify_hosts%& options for details of how to request verification
30409 independently of this condition.
30410
30411 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
30412 option), this condition is always true.
30413
30414
30415 .vitem &*verify&~=&~not_blind*&
30416 .cindex "verifying" "not blind"
30417 .cindex "bcc recipients, verifying none"
30418 This condition checks that there are no blind (bcc) recipients in the message.
30419 Every envelope recipient must appear either in a &'To:'& header line or in a
30420 &'Cc:'& header line for this condition to be true. Local parts are checked
30421 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
30422 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
30423 used only in a DATA or non-SMTP ACL.
30424
30425 There are, of course, many legitimate messages that make use of blind (bcc)
30426 recipients. This check should not be used on its own for blocking messages.
30427
30428
30429 .vitem &*verify&~=&~recipient/*&<&'options'&>
30430 .cindex "&%verify%& ACL condition"
30431 .cindex "&ACL;" "verifying recipient"
30432 .cindex "recipient" "verifying"
30433 .cindex "verifying" "recipient"
30434 .vindex "&$address_data$&"
30435 This condition is relevant only after a RCPT command. It verifies the current
30436 recipient. Details of address verification are given later, starting at section
30437 &<<SECTaddressverification>>&. After a recipient has been verified, the value
30438 of &$address_data$& is the last value that was set while routing the address.
30439 This applies even if the verification fails. When an address that is being
30440 verified is redirected to a single address, verification continues with the new
30441 address, and in that case, the subsequent value of &$address_data$& is the
30442 value for the child address.
30443
30444 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
30445 .cindex "&%verify%& ACL condition"
30446 .cindex "&ACL;" "verifying host reverse lookup"
30447 .cindex "host" "verifying reverse lookup"
30448 This condition ensures that a verified host name has been looked up from the IP
30449 address of the client host. (This may have happened already if the host name
30450 was needed for checking a host list, or if the host matched &%host_lookup%&.)
30451 Verification ensures that the host name obtained from a reverse DNS lookup, or
30452 one of its aliases, does, when it is itself looked up in the DNS, yield the
30453 original IP address.
30454
30455 There is one possible option, &`defer_ok`&.  If this is present and a
30456 DNS operation returns a temporary error, the verify condition succeeds.
30457
30458 If this condition is used for a locally generated message (that is, when there
30459 is no client host involved), it always succeeds.
30460
30461 .vitem &*verify&~=&~sender/*&<&'options'&>
30462 .cindex "&%verify%& ACL condition"
30463 .cindex "&ACL;" "verifying sender"
30464 .cindex "sender" "verifying"
30465 .cindex "verifying" "sender"
30466 This condition is relevant only after a MAIL or RCPT command, or after a
30467 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
30468 the message's sender is empty (that is, this is a bounce message), the
30469 condition is true. Otherwise, the sender address is verified.
30470
30471 .vindex "&$address_data$&"
30472 .vindex "&$sender_address_data$&"
30473 If there is data in the &$address_data$& variable at the end of routing, its
30474 value is placed in &$sender_address_data$& at the end of verification. This
30475 value can be used in subsequent conditions and modifiers in the same ACL
30476 statement. It does not persist after the end of the current statement. If you
30477 want to preserve the value for longer, you can save it in an ACL variable.
30478
30479 Details of verification are given later, starting at section
30480 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
30481 to avoid doing it more than once per message.
30482
30483 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
30484 .cindex "&%verify%& ACL condition"
30485 This is a variation of the previous option, in which a modified address is
30486 verified as a sender.
30487
30488 Note that '/' is legal in local-parts; if the address may have such
30489 (eg. is generated from the received message)
30490 they must be protected from the options parsing by doubling:
30491 .code
30492 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
30493 .endd
30494 .endlist
30495
30496
30497
30498 .section "Using DNS lists" "SECTmorednslists"
30499 .cindex "DNS list" "in ACL"
30500 .cindex "black list (DNS)"
30501 .cindex "&ACL;" "testing a DNS list"
30502 In its simplest form, the &%dnslists%& condition tests whether the calling host
30503 is on at least one of a number of DNS lists by looking up the inverted IP
30504 address in one or more DNS domains. (Note that DNS list domains are not mail
30505 domains, so the &`+`& syntax for named lists doesn't work - it is used for
30506 special options instead.) For example, if the calling host's IP
30507 address is 192.168.62.43, and the ACL statement is
30508 .code
30509 deny dnslists = blackholes.mail-abuse.org : \
30510                 dialups.mail-abuse.org
30511 .endd
30512 the following records are looked up:
30513 .code
30514 43.62.168.192.blackholes.mail-abuse.org
30515 43.62.168.192.dialups.mail-abuse.org
30516 .endd
30517 As soon as Exim finds an existing DNS record, processing of the list stops.
30518 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
30519 to test that a host is on more than one list (an &"and"& conjunction), you can
30520 use two separate conditions:
30521 .code
30522 deny dnslists = blackholes.mail-abuse.org
30523      dnslists = dialups.mail-abuse.org
30524 .endd
30525 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
30526 behaves as if the host does not match the list item, that is, as if the DNS
30527 record does not exist. If there are further items in the DNS list, they are
30528 processed.
30529
30530 This is usually the required action when &%dnslists%& is used with &%deny%&
30531 (which is the most common usage), because it prevents a DNS failure from
30532 blocking mail. However, you can change this behaviour by putting one of the
30533 following special items in the list:
30534 .display
30535 &`+include_unknown `&   behave as if the item is on the list
30536 &`+exclude_unknown `&   behave as if the item is not on the list (default)
30537 &`+defer_unknown   `&   give a temporary error
30538 .endd
30539 .cindex "&`+include_unknown`&"
30540 .cindex "&`+exclude_unknown`&"
30541 .cindex "&`+defer_unknown`&"
30542 Each of these applies to any subsequent items on the list. For example:
30543 .code
30544 deny dnslists = +defer_unknown : foo.bar.example
30545 .endd
30546 Testing the list of domains stops as soon as a match is found. If you want to
30547 warn for one list and block for another, you can use two different statements:
30548 .code
30549 deny  dnslists = blackholes.mail-abuse.org
30550 warn  message  = X-Warn: sending host is on dialups list
30551       dnslists = dialups.mail-abuse.org
30552 .endd
30553 .cindex caching "of dns lookup"
30554 .cindex DNS TTL
30555 DNS list lookups are cached by Exim for the duration of the SMTP session
30556 (but limited by the DNS return TTL value),
30557 so a lookup based on the IP address is done at most once for any incoming
30558 connection (assuming long-enough TTL).
30559 Exim does not share information between multiple incoming
30560 connections (but your local name server cache should be active).
30561
30562 There are a number of DNS lists to choose from, some commercial, some free,
30563 or free for small deployments.  An overview can be found at
30564 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
30565
30566
30567
30568 .section "Specifying the IP address for a DNS list lookup" "SECID201"
30569 .cindex "DNS list" "keyed by explicit IP address"
30570 By default, the IP address that is used in a DNS list lookup is the IP address
30571 of the calling host. However, you can specify another IP address by listing it
30572 after the domain name, introduced by a slash. For example:
30573 .code
30574 deny dnslists = black.list.tld/192.168.1.2
30575 .endd
30576 This feature is not very helpful with explicit IP addresses; it is intended for
30577 use with IP addresses that are looked up, for example, the IP addresses of the
30578 MX hosts or nameservers of an email sender address. For an example, see section
30579 &<<SECTmulkeyfor>>& below.
30580
30581
30582
30583
30584 .section "DNS lists keyed on domain names" "SECID202"
30585 .cindex "DNS list" "keyed by domain name"
30586 There are some lists that are keyed on domain names rather than inverted IP
30587 addresses.  No reversing of components is used
30588 with these lists. You can change the name that is looked up in a DNS list by
30589 listing it after the domain name, introduced by a slash. For example,
30590 .code
30591 deny  message  = Sender's domain is listed at $dnslist_domain
30592       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
30593 .endd
30594 This particular example is useful only in ACLs that are obeyed after the
30595 RCPT or DATA commands, when a sender address is available. If (for
30596 example) the message's sender is &'user@tld.example'& the name that is looked
30597 up by this example is
30598 .code
30599 tld.example.dsn.rfc-ignorant.org
30600 .endd
30601 A single &%dnslists%& condition can contain entries for both names and IP
30602 addresses. For example:
30603 .code
30604 deny dnslists = sbl.spamhaus.org : \
30605                 dsn.rfc-ignorant.org/$sender_address_domain
30606 .endd
30607 The first item checks the sending host's IP address; the second checks a domain
30608 name. The whole condition is true if either of the DNS lookups succeeds.
30609
30610
30611
30612
30613 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
30614 .cindex "DNS list" "multiple keys for"
30615 The syntax described above for looking up explicitly-defined values (either
30616 names or IP addresses) in a DNS blacklist is a simplification. After the domain
30617 name for the DNS list, what follows the slash can in fact be a list of items.
30618 As with all lists in Exim, the default separator is a colon. However, because
30619 this is a sublist within the list of DNS blacklist domains, it is necessary
30620 either to double the separators like this:
30621 .code
30622 dnslists = black.list.tld/name.1::name.2
30623 .endd
30624 or to change the separator character, like this:
30625 .code
30626 dnslists = black.list.tld/<;name.1;name.2
30627 .endd
30628 If an item in the list is an IP address, it is inverted before the DNS
30629 blacklist domain is appended. If it is not an IP address, no inversion
30630 occurs. Consider this condition:
30631 .code
30632 dnslists = black.list.tld/<;192.168.1.2;a.domain
30633 .endd
30634 The DNS lookups that occur are:
30635 .code
30636 2.1.168.192.black.list.tld
30637 a.domain.black.list.tld
30638 .endd
30639 Once a DNS record has been found (that matches a specific IP return
30640 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
30641 are done. If there is a temporary DNS error, the rest of the sublist of domains
30642 or IP addresses is tried. A temporary error for the whole dnslists item occurs
30643 only if no other DNS lookup in this sublist succeeds. In other words, a
30644 successful lookup for any of the items in the sublist overrides a temporary
30645 error for a previous item.
30646
30647 The ability to supply a list of items after the slash is in some sense just a
30648 syntactic convenience. These two examples have the same effect:
30649 .code
30650 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
30651 dnslists = black.list.tld/a.domain::b.domain
30652 .endd
30653 However, when the data for the list is obtained from a lookup, the second form
30654 is usually much more convenient. Consider this example:
30655 .code
30656 deny message  = The mail servers for the domain \
30657                 $sender_address_domain \
30658                 are listed at $dnslist_domain ($dnslist_value); \
30659                 see $dnslist_text.
30660      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
30661                                    ${lookup dnsdb {>|mxh=\
30662                                    $sender_address_domain} }} }
30663 .endd
30664 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
30665 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
30666 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
30667 of expanding the condition might be something like this:
30668 .code
30669 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
30670 .endd
30671 Thus, this example checks whether or not the IP addresses of the sender
30672 domain's mail servers are on the Spamhaus black list.
30673
30674 The key that was used for a successful DNS list lookup is put into the variable
30675 &$dnslist_matched$& (see section &<<SECID204>>&).
30676
30677
30678
30679
30680 .section "Data returned by DNS lists" "SECID203"
30681 .cindex "DNS list" "data returned from"
30682 DNS lists are constructed using address records in the DNS. The original RBL
30683 just used the address 127.0.0.1 on the right hand side of each record, but the
30684 RBL+ list and some other lists use a number of values with different meanings.
30685 The values used on the RBL+ list are:
30686 .display
30687 127.1.0.1  RBL
30688 127.1.0.2  DUL
30689 127.1.0.3  DUL and RBL
30690 127.1.0.4  RSS
30691 127.1.0.5  RSS and RBL
30692 127.1.0.6  RSS and DUL
30693 127.1.0.7  RSS and DUL and RBL
30694 .endd
30695 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
30696 different values. Some DNS lists may return more than one address record;
30697 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
30698
30699
30700 .section "Variables set from DNS lists" "SECID204"
30701 .cindex "expansion" "variables, set from DNS list"
30702 .cindex "DNS list" "variables set from"
30703 .vindex "&$dnslist_domain$&"
30704 .vindex "&$dnslist_matched$&"
30705 .vindex "&$dnslist_text$&"
30706 .vindex "&$dnslist_value$&"
30707 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
30708 the name of the overall domain that matched (for example,
30709 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
30710 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
30711 the DNS record. When the key is an IP address, it is not reversed in
30712 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
30713 cases, for example:
30714 .code
30715 deny dnslists = spamhaus.example
30716 .endd
30717 the key is also available in another variable (in this case,
30718 &$sender_host_address$&). In more complicated cases, however, this is not true.
30719 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
30720 might generate a dnslists lookup like this:
30721 .code
30722 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
30723 .endd
30724 If this condition succeeds, the value in &$dnslist_matched$& might be
30725 &`192.168.6.7`& (for example).
30726
30727 If more than one address record is returned by the DNS lookup, all the IP
30728 addresses are included in &$dnslist_value$&, separated by commas and spaces.
30729 The variable &$dnslist_text$& contains the contents of any associated TXT
30730 record. For lists such as RBL+ the TXT record for a merged entry is often not
30731 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
30732 information.
30733
30734 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
30735 &-- although these appear before the condition in the ACL, they are not
30736 expanded until after it has failed. For example:
30737 .code
30738 deny    hosts = !+local_networks
30739         message = $sender_host_address is listed \
30740                   at $dnslist_domain
30741         dnslists = rbl-plus.mail-abuse.example
30742 .endd
30743
30744
30745
30746 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
30747 .cindex "DNS list" "matching specific returned data"
30748 You can add an equals sign and an IP address after a &%dnslists%& domain name
30749 in order to restrict its action to DNS records with a matching right hand side.
30750 For example,
30751 .code
30752 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
30753 .endd
30754 rejects only those hosts that yield 127.0.0.2. Without this additional data,
30755 any address record is considered to be a match. For the moment, we assume
30756 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
30757 describes how multiple records are handled.
30758
30759 More than one IP address may be given for checking, using a comma as a
30760 separator. These are alternatives &-- if any one of them matches, the
30761 &%dnslists%& condition is true. For example:
30762 .code
30763 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30764 .endd
30765 If you want to specify a constraining address list and also specify names or IP
30766 addresses to be looked up, the constraining address list must be specified
30767 first. For example:
30768 .code
30769 deny dnslists = dsn.rfc-ignorant.org\
30770                 =127.0.0.2/$sender_address_domain
30771 .endd
30772
30773 If the character &`&&`& is used instead of &`=`&, the comparison for each
30774 listed IP address is done by a bitwise &"and"& instead of by an equality test.
30775 In other words, the listed addresses are used as bit masks. The comparison is
30776 true if all the bits in the mask are present in the address that is being
30777 tested. For example:
30778 .code
30779 dnslists = a.b.c&0.0.0.3
30780 .endd
30781 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
30782 want to test whether one bit or another bit is present (as opposed to both
30783 being present), you must use multiple values. For example:
30784 .code
30785 dnslists = a.b.c&0.0.0.1,0.0.0.2
30786 .endd
30787 matches if the final component of the address is an odd number or two times
30788 an odd number.
30789
30790
30791
30792 .section "Negated DNS matching conditions" "SECID205"
30793 You can supply a negative list of IP addresses as part of a &%dnslists%&
30794 condition. Whereas
30795 .code
30796 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30797 .endd
30798 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30799 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
30800 .code
30801 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
30802 .endd
30803 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30804 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
30805 words, the result of the test is inverted if an exclamation mark appears before
30806 the &`=`& (or the &`&&`&) sign.
30807
30808 &*Note*&: This kind of negation is not the same as negation in a domain,
30809 host, or address list (which is why the syntax is different).
30810
30811 If you are using just one list, the negation syntax does not gain you much. The
30812 previous example is precisely equivalent to
30813 .code
30814 deny  dnslists = a.b.c
30815      !dnslists = a.b.c=127.0.0.2,127.0.0.3
30816 .endd
30817 However, if you are using multiple lists, the negation syntax is clearer.
30818 Consider this example:
30819 .code
30820 deny  dnslists = sbl.spamhaus.org : \
30821                  list.dsbl.org : \
30822                  dnsbl.njabl.org!=127.0.0.3 : \
30823                  relays.ordb.org
30824 .endd
30825 Using only positive lists, this would have to be:
30826 .code
30827 deny  dnslists = sbl.spamhaus.org : \
30828                  list.dsbl.org
30829 deny  dnslists = dnsbl.njabl.org
30830      !dnslists = dnsbl.njabl.org=127.0.0.3
30831 deny  dnslists = relays.ordb.org
30832 .endd
30833 which is less clear, and harder to maintain.
30834
30835
30836
30837
30838 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
30839 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
30840 thereby providing more than one IP address. When an item in a &%dnslists%& list
30841 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
30842 the match to specific results from the DNS lookup, there are two ways in which
30843 the checking can be handled. For example, consider the condition:
30844 .code
30845 dnslists = a.b.c=127.0.0.1
30846 .endd
30847 What happens if the DNS lookup for the incoming IP address yields both
30848 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
30849 condition true because at least one given value was found, or is it false
30850 because at least one of the found values was not listed? And how does this
30851 affect negated conditions? Both possibilities are provided for with the help of
30852 additional separators &`==`& and &`=&&`&.
30853
30854 .ilist
30855 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
30856 IP addresses matches one of the listed addresses. For the example above, the
30857 condition is true because 127.0.0.1 matches.
30858 .next
30859 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
30860 looked up IP addresses matches one of the listed addresses. If the condition is
30861 changed to:
30862 .code
30863 dnslists = a.b.c==127.0.0.1
30864 .endd
30865 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30866 false because 127.0.0.2 is not listed. You would need to have:
30867 .code
30868 dnslists = a.b.c==127.0.0.1,127.0.0.2
30869 .endd
30870 for the condition to be true.
30871 .endlist
30872
30873 When &`!`& is used to negate IP address matching, it inverts the result, giving
30874 the precise opposite of the behaviour above. Thus:
30875 .ilist
30876 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
30877 addresses matches one of the listed addresses. Consider:
30878 .code
30879 dnslists = a.b.c!&0.0.0.1
30880 .endd
30881 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30882 false because 127.0.0.1 matches.
30883 .next
30884 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
30885 looked up IP address that does not match. Consider:
30886 .code
30887 dnslists = a.b.c!=&0.0.0.1
30888 .endd
30889 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30890 true, because 127.0.0.2 does not match. You would need to have:
30891 .code
30892 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
30893 .endd
30894 for the condition to be false.
30895 .endlist
30896 When the DNS lookup yields only a single IP address, there is no difference
30897 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
30898
30899
30900
30901
30902 .section "Detailed information from merged DNS lists" "SECTmordetinf"
30903 .cindex "DNS list" "information from merged"
30904 When the facility for restricting the matching IP values in a DNS list is used,
30905 the text from the TXT record that is set in &$dnslist_text$& may not reflect
30906 the true reason for rejection. This happens when lists are merged and the IP
30907 address in the A record is used to distinguish them; unfortunately there is
30908 only one TXT record. One way round this is not to use merged lists, but that
30909 can be inefficient because it requires multiple DNS lookups where one would do
30910 in the vast majority of cases when the host of interest is not on any of the
30911 lists.
30912
30913 A less inefficient way of solving this problem is available. If
30914 two domain names, comma-separated, are given, the second is used first to
30915 do an initial check, making use of any IP value restrictions that are set.
30916 If there is a match, the first domain is used, without any IP value
30917 restrictions, to get the TXT record. As a byproduct of this, there is also
30918 a check that the IP being tested is indeed on the first list. The first
30919 domain is the one that is put in &$dnslist_domain$&. For example:
30920 .code
30921 deny message  = \
30922          rejected because $sender_host_address is blacklisted \
30923          at $dnslist_domain\n$dnslist_text
30924        dnslists = \
30925          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
30926          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30927 .endd
30928 For the first blacklist item, this starts by doing a lookup in
30929 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
30930 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
30931 value, and as long as something is found, it looks for the corresponding TXT
30932 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
30933 The second blacklist item is processed similarly.
30934
30935 If you are interested in more than one merged list, the same list must be
30936 given several times, but because the results of the DNS lookups are cached,
30937 the DNS calls themselves are not repeated. For example:
30938 .code
30939 deny dnslists = \
30940          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
30941          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
30942          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
30943          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30944 .endd
30945 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
30946 values matches (or if no record is found), this is the only lookup that is
30947 done. Only if there is a match is one of the more specific lists consulted.
30948
30949
30950
30951 .section "DNS lists and IPv6" "SECTmorednslistslast"
30952 .cindex "IPv6" "DNS black lists"
30953 .cindex "DNS list" "IPv6 usage"
30954 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
30955 nibble by nibble. For example, if the calling host's IP address is
30956 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
30957 .code
30958 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
30959   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
30960 .endd
30961 (split over two lines here to fit on the page). Unfortunately, some of the DNS
30962 lists contain wildcard records, intended for IPv4, that interact badly with
30963 IPv6. For example, the DNS entry
30964 .code
30965 *.3.some.list.example.    A    127.0.0.1
30966 .endd
30967 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
30968 Unfortunately, it also matches the entire 3::/4 IPv6 network.
30969
30970 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
30971 &%condition%& condition, as in this example:
30972 .code
30973 deny   condition = ${if isip4{$sender_host_address}}
30974        dnslists  = some.list.example
30975 .endd
30976
30977 If an explicit key is being used for a DNS lookup and it may be an IPv6
30978 address you should specify alternate list separators for both the outer
30979 (DNS list name) list and inner (lookup keys) list:
30980 .code
30981        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
30982 .endd
30983
30984 .section "Rate limiting incoming messages" "SECTratelimiting"
30985 .cindex "rate limiting" "client sending"
30986 .cindex "limiting client sending rates"
30987 .oindex "&%smtp_ratelimit_*%&"
30988 The &%ratelimit%& ACL condition can be used to measure and control the rate at
30989 which clients can send email. This is more powerful than the
30990 &%smtp_ratelimit_*%& options, because those options control the rate of
30991 commands in a single SMTP session only, whereas the &%ratelimit%& condition
30992 works across all connections (concurrent and sequential) from the same client
30993 host. The syntax of the &%ratelimit%& condition is:
30994 .display
30995 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
30996 .endd
30997 If the average client sending rate is less than &'m'& messages per time
30998 period &'p'& then the condition is false; otherwise it is true.
30999
31000 As a side-effect, the &%ratelimit%& condition sets the expansion variable
31001 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
31002 configured value of &'m'&, and &$sender_rate_period$& to the configured value
31003 of &'p'&.
31004
31005 The parameter &'p'& is the smoothing time constant, in the form of an Exim
31006 time interval, for example, &`8h`& for eight hours. A larger time constant
31007 means that it takes Exim longer to forget a client's past behaviour. The
31008 parameter &'m'& is the maximum number of messages that a client is permitted to
31009 send in each time interval. It also specifies the number of messages permitted
31010 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
31011 constant, you can allow a client to send more messages in a burst without
31012 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
31013 both small, messages must be sent at an even rate.
31014
31015 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
31016 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
31017 when deploying the &%ratelimit%& ACL condition. The script prints usage
31018 instructions when it is run with no arguments.
31019
31020 The key is used to look up the data for calculating the client's average
31021 sending rate. This data is stored in Exim's spool directory, alongside the
31022 retry and other hints databases. The default key is &$sender_host_address$&,
31023 which means Exim computes the sending rate of each client host IP address.
31024 By changing the key you can change how Exim identifies clients for the purpose
31025 of ratelimiting. For example, to limit the sending rate of each authenticated
31026 user, independent of the computer they are sending from, set the key to
31027 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
31028 example, &$authenticated_id$& is only meaningful if the client has
31029 authenticated (which you can check with the &%authenticated%& ACL condition).
31030
31031 The lookup key does not have to identify clients: If you want to limit the
31032 rate at which a recipient receives messages, you can use the key
31033 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
31034 ACL.
31035
31036 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
31037 specifies what Exim measures the rate of, for example messages or recipients
31038 or bytes. You can adjust the measurement using the &%unique=%& and/or
31039 &%count=%& options. You can also control when Exim updates the recorded rate
31040 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
31041 separated by a slash, like the other parameters. They may appear in any order.
31042
31043 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
31044 any options that alter the meaning of the stored data. The limit &'m'& is not
31045 stored, so you can alter the configured maximum rate and Exim will still
31046 remember clients' past behaviour. If you change the &%per_*%& mode or add or
31047 remove the &%unique=%& option, the lookup key changes so Exim will forget past
31048 behaviour. The lookup key is not affected by changes to the update mode and
31049 the &%count=%& option.
31050
31051
31052 .section "Ratelimit options for what is being measured" "ratoptmea"
31053 .cindex "rate limiting" "per_* options"
31054 The &%per_conn%& option limits the client's connection rate. It is not
31055 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
31056 &%acl_not_smtp_start%& ACLs.
31057
31058 The &%per_mail%& option limits the client's rate of sending messages. This is
31059 the default if none of the &%per_*%& options is specified. It can be used in
31060 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
31061 &%acl_smtp_data%&, or &%acl_not_smtp%&.
31062
31063 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
31064 the same ACLs as the &%per_mail%& option, though it is best to use this option
31065 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
31066 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
31067 in its MAIL command, which may be inaccurate or completely missing. You can
31068 follow the limit &'m'& in the configuration with K, M, or G to specify limits
31069 in kilobytes, megabytes, or gigabytes, respectively.
31070
31071 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
31072 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31073 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
31074 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
31075 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
31076 in either case the rate limiting engine will see a message with many
31077 recipients as a large high-speed burst.
31078
31079 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
31080 number of different recipients that the client has sent messages to in the
31081 last time period. That is, if the client repeatedly sends messages to the same
31082 recipient, its measured rate is not increased. This option can only be used in
31083 &%acl_smtp_rcpt%&.
31084
31085 The &%per_cmd%& option causes Exim to recompute the rate every time the
31086 condition is processed. This can be used to limit the rate of any SMTP
31087 command. If it is used in multiple ACLs it can limit the aggregate rate of
31088 multiple different commands.
31089
31090 The &%count=%& option can be used to alter how much Exim adds to the client's
31091 measured rate. For example, the &%per_byte%& option is equivalent to
31092 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
31093 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
31094 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
31095
31096 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
31097
31098
31099 .section "Ratelimit update modes" "ratoptupd"
31100 .cindex "rate limiting" "reading data without updating"
31101 You can specify one of three options with the &%ratelimit%& condition to
31102 control when its database is updated. This section describes the &%readonly%&
31103 mode, and the next section describes the &%strict%& and &%leaky%& modes.
31104
31105 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
31106 previously-computed rate to check against the limit.
31107
31108 For example, you can test the client's sending rate and deny it access (when
31109 it is too fast) in the connect ACL. If the client passes this check then it
31110 can go on to send a message, in which case its recorded rate will be updated
31111 in the MAIL ACL. Subsequent connections from the same client will check this
31112 new rate.
31113 .code
31114 acl_check_connect:
31115  deny ratelimit = 100 / 5m / readonly
31116     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
31117                   (max $sender_rate_limit)
31118 # ...
31119 acl_check_mail:
31120  warn ratelimit = 100 / 5m / strict
31121     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
31122                   (max $sender_rate_limit)
31123 .endd
31124
31125 If Exim encounters multiple &%ratelimit%& conditions with the same key when
31126 processing a message then it may increase the client's measured rate more than
31127 it should. For example, this will happen if you check the &%per_rcpt%& option
31128 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
31129 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
31130 multiple update problems by using the &%readonly%& option on later ratelimit
31131 checks.
31132
31133 The &%per_*%& options described above do not make sense in some ACLs. If you
31134 use a &%per_*%& option in an ACL where it is not normally permitted then the
31135 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
31136 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
31137 next section) so you must specify the &%readonly%& option explicitly.
31138
31139
31140 .section "Ratelimit options for handling fast clients" "ratoptfast"
31141 .cindex "rate limiting" "strict and leaky modes"
31142 If a client's average rate is greater than the maximum, the rate limiting
31143 engine can react in two possible ways, depending on the presence of the
31144 &%strict%& or &%leaky%& update modes. This is independent of the other
31145 counter-measures (such as rejecting the message) that may be specified by the
31146 rest of the ACL.
31147
31148 The &%leaky%& (default) option means that the client's recorded rate is not
31149 updated if it is above the limit. The effect of this is that Exim measures the
31150 client's average rate of successfully sent email,
31151 .new
31152 up to the given limit.
31153 This is appropriate if the countermeasure when the condition is true
31154 consists of refusing the message, and
31155 is generally the better choice if you have clients that retry automatically.
31156 If the action when true is anything more complex then this option is
31157 likely not what is wanted.
31158 .wen
31159
31160 The &%strict%& option means that the client's recorded rate is always
31161 updated. The effect of this is that Exim measures the client's average rate
31162 of attempts to send email, which can be much higher than the maximum it is
31163 actually allowed. If the client is over the limit it may be subjected to
31164 counter-measures by the ACL. It must slow down and allow sufficient time to
31165 pass that its computed rate falls below the maximum before it can send email
31166 again. The time (the number of smoothing periods) it must wait and not
31167 attempt to send mail can be calculated with this formula:
31168 .code
31169         ln(peakrate/maxrate)
31170 .endd
31171
31172
31173 .section "Limiting the rate of different events" "ratoptuniq"
31174 .cindex "rate limiting" "counting unique events"
31175 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
31176 rate of different events. For example, the &%per_addr%& option uses this
31177 mechanism to count the number of different recipients that the client has
31178 sent messages to in the last time period; it is equivalent to
31179 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
31180 measure the rate that a client uses different sender addresses with the
31181 options &`per_mail/unique=$sender_address`&.
31182
31183 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
31184 has seen for that key. The whole set is thrown away when it is older than the
31185 rate smoothing period &'p'&, so each different event is counted at most once
31186 per period. In the &%leaky%& update mode, an event that causes the client to
31187 go over the limit is not added to the set, in the same way that the client's
31188 recorded rate is not updated in the same situation.
31189
31190 When you combine the &%unique=%& and &%readonly%& options, the specific
31191 &%unique=%& value is ignored, and Exim just retrieves the client's stored
31192 rate.
31193
31194 The &%unique=%& mechanism needs more space in the ratelimit database than the
31195 other &%ratelimit%& options in order to store the event set. The number of
31196 unique values is potentially as large as the rate limit, so the extra space
31197 required increases with larger limits.
31198
31199 The uniqueification is not perfect: there is a small probability that Exim
31200 will think a new event has happened before. If the sender's rate is less than
31201 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
31202 the measured rate can go above the limit, in which case Exim may under-count
31203 events by a significant margin. Fortunately, if the rate is high enough (2.7
31204 times the limit) that the false positive rate goes above 9%, then Exim will
31205 throw away the over-full event set before the measured rate falls below the
31206 limit. Therefore the only harm should be that exceptionally high sending rates
31207 are logged incorrectly; any countermeasures you configure will be as effective
31208 as intended.
31209
31210
31211 .section "Using rate limiting" "useratlim"
31212 Exim's other ACL facilities are used to define what counter-measures are taken
31213 when the rate limit is exceeded. This might be anything from logging a warning
31214 (for example, while measuring existing sending rates in order to define
31215 policy), through time delays to slow down fast senders, up to rejecting the
31216 message. For example:
31217 .code
31218 # Log all senders' rates
31219 warn ratelimit = 0 / 1h / strict
31220      log_message = Sender rate $sender_rate / $sender_rate_period
31221
31222 # Slow down fast senders; note the need to truncate $sender_rate
31223 # at the decimal point.
31224 warn ratelimit = 100 / 1h / per_rcpt / strict
31225      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
31226                    $sender_rate_limit }s
31227
31228 # Keep authenticated users under control
31229 deny authenticated = *
31230      ratelimit = 100 / 1d / strict / $authenticated_id
31231
31232 # System-wide rate limit
31233 defer message = Sorry, too busy. Try again later.
31234      ratelimit = 10 / 1s / $primary_hostname
31235
31236 # Restrict incoming rate from each host, with a default
31237 # set using a macro and special cases looked up in a table.
31238 defer message = Sender rate exceeds $sender_rate_limit \
31239                messages per $sender_rate_period
31240      ratelimit = ${lookup {$sender_host_address} \
31241                    cdb {DB/ratelimits.cdb} \
31242                    {$value} {RATELIMIT} }
31243 .endd
31244 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
31245 especially with the &%per_rcpt%& option, you may suffer from a performance
31246 bottleneck caused by locking on the ratelimit hints database. Apart from
31247 making your ACLs less complicated, you can reduce the problem by using a
31248 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
31249 this means that Exim will lose its hints data after a reboot (including retry
31250 hints, the callout cache, and ratelimit data).
31251
31252
31253
31254 .section "Address verification" "SECTaddressverification"
31255 .cindex "verifying address" "options for"
31256 .cindex "policy control" "address verification"
31257 Several of the &%verify%& conditions described in section
31258 &<<SECTaclconditions>>& cause addresses to be verified. Section
31259 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
31260 The verification conditions can be followed by options that modify the
31261 verification process. The options are separated from the keyword and from each
31262 other by slashes, and some of them contain parameters. For example:
31263 .code
31264 verify = sender/callout
31265 verify = recipient/defer_ok/callout=10s,defer_ok
31266 .endd
31267 The first stage of address verification, which always happens, is to run the
31268 address through the routers, in &"verify mode"&. Routers can detect the
31269 difference between verification and routing for delivery, and their actions can
31270 be varied by a number of generic options such as &%verify%& and &%verify_only%&
31271 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
31272 The available options are as follows:
31273
31274 .ilist
31275 If the &%callout%& option is specified, successful routing to one or more
31276 remote hosts is followed by a &"callout"& to those hosts as an additional
31277 check. Callouts and their sub-options are discussed in the next section.
31278 .next
31279 If there is a defer error while doing verification routing, the ACL
31280 normally returns &"defer"&. However, if you include &%defer_ok%& in the
31281 options, the condition is forced to be true instead. Note that this is a main
31282 verification option as well as a suboption for callouts.
31283 .next
31284 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
31285 discusses the reporting of sender address verification failures.
31286 .next
31287 The &%success_on_redirect%& option causes verification always to succeed
31288 immediately after a successful redirection. By default, if a redirection
31289 generates just one address, that address is also verified. See further
31290 discussion in section &<<SECTredirwhilveri>>&.
31291 .endlist
31292
31293 .cindex "verifying address" "differentiating failures"
31294 .vindex "&$recipient_verify_failure$&"
31295 .vindex "&$sender_verify_failure$&"
31296 .vindex "&$acl_verify_message$&"
31297 After an address verification failure, &$acl_verify_message$& contains the
31298 error message that is associated with the failure. It can be preserved by
31299 coding like this:
31300 .code
31301 warn  !verify = sender
31302        set acl_m0 = $acl_verify_message
31303 .endd
31304 If you are writing your own custom rejection message or log message when
31305 denying access, you can use this variable to include information about the
31306 verification failure.
31307
31308 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
31309 appropriate) contains one of the following words:
31310
31311 .ilist
31312 &%qualify%&: The address was unqualified (no domain), and the message
31313 was neither local nor came from an exempted host.
31314 .next
31315 &%route%&: Routing failed.
31316 .next
31317 &%mail%&: Routing succeeded, and a callout was attempted; rejection
31318 occurred at or before the MAIL command (that is, on initial
31319 connection, HELO, or MAIL).
31320 .next
31321 &%recipient%&: The RCPT command in a callout was rejected.
31322 .next
31323 &%postmaster%&: The postmaster check in a callout was rejected.
31324 .endlist
31325
31326 The main use of these variables is expected to be to distinguish between
31327 rejections of MAIL and rejections of RCPT in callouts.
31328
31329 .new
31330 The above variables may also be set after a &*successful*&
31331 address verification to:
31332
31333 .ilist
31334 &%random%&: A random local-part callout succeeded
31335 .endlist
31336 .wen
31337
31338
31339
31340
31341 .section "Callout verification" "SECTcallver"
31342 .cindex "verifying address" "by callout"
31343 .cindex "callout" "verification"
31344 .cindex "SMTP" "callout verification"
31345 For non-local addresses, routing verifies the domain, but is unable to do any
31346 checking of the local part. There are situations where some means of verifying
31347 the local part is desirable. One way this can be done is to make an SMTP
31348 &'callback'& to a delivery host for the sender address or a &'callforward'& to
31349 a subsequent host for a recipient address, to see if the host accepts the
31350 address. We use the term &'callout'& to cover both cases. Note that for a
31351 sender address, the callback is not to the client host that is trying to
31352 deliver the message, but to one of the hosts that accepts incoming mail for the
31353 sender's domain.
31354
31355 Exim does not do callouts by default. If you want them to happen, you must
31356 request them by setting appropriate options on the &%verify%& condition, as
31357 described below. This facility should be used with care, because it can add a
31358 lot of resource usage to the cost of verifying an address. However, Exim does
31359 cache the results of callouts, which helps to reduce the cost. Details of
31360 caching are in section &<<SECTcallvercache>>&.
31361
31362 Recipient callouts are usually used only between hosts that are controlled by
31363 the same administration. For example, a corporate gateway host could use
31364 callouts to check for valid recipients on an internal mailserver. A successful
31365 callout does not guarantee that a real delivery to the address would succeed;
31366 on the other hand, a failing callout does guarantee that a delivery would fail.
31367
31368 If the &%callout%& option is present on a condition that verifies an address, a
31369 second stage of verification occurs if the address is successfully routed to
31370 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
31371 &(manualroute)& router, where the router specifies the hosts. However, if a
31372 router that does not set up hosts routes to an &(smtp)& transport with a
31373 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
31374 &%hosts_override%& set, its hosts are always used, whether or not the router
31375 supplies a host list.
31376 Callouts are only supported on &(smtp)& transports.
31377
31378 The port that is used is taken from the transport, if it is specified and is a
31379 remote transport. (For routers that do verification only, no transport need be
31380 specified.) Otherwise, the default SMTP port is used. If a remote transport
31381 specifies an outgoing interface, this is used; otherwise the interface is not
31382 specified. Likewise, the text that is used for the HELO command is taken from
31383 the transport's &%helo_data%& option; if there is no transport, the value of
31384 &$smtp_active_hostname$& is used.
31385
31386 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
31387 test whether a bounce message could be delivered to the sender address. The
31388 following SMTP commands are sent:
31389 .display
31390 &`HELO `&<&'local host name'&>
31391 &`MAIL FROM:<>`&
31392 &`RCPT TO:`&<&'the address to be tested'&>
31393 &`QUIT`&
31394 .endd
31395 LHLO is used instead of HELO if the transport's &%protocol%& option is
31396 set to &"lmtp"&.
31397
31398 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
31399 settings.
31400
31401 A recipient callout check is similar. By default, it also uses an empty address
31402 for the sender. This default is chosen because most hosts do not make use of
31403 the sender address when verifying a recipient. Using the same address means
31404 that a single cache entry can be used for each recipient. Some sites, however,
31405 do make use of the sender address when verifying. These are catered for by the
31406 &%use_sender%& and &%use_postmaster%& options, described in the next section.
31407
31408 If the response to the RCPT command is a 2&'xx'& code, the verification
31409 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
31410 Exim tries the next host, if any. If there is a problem with all the remote
31411 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
31412 &%callout%& option is given, in which case the condition is forced to succeed.
31413
31414 .cindex "SMTP" "output flushing, disabling for callout"
31415 A callout may take a little time. For this reason, Exim normally flushes SMTP
31416 output before performing a callout in an ACL, to avoid unexpected timeouts in
31417 clients when the SMTP PIPELINING extension is in use. The flushing can be
31418 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
31419
31420
31421
31422
31423 .section "Additional parameters for callouts" "CALLaddparcall"
31424 .cindex "callout" "additional parameters for"
31425 The &%callout%& option can be followed by an equals sign and a number of
31426 optional parameters, separated by commas. For example:
31427 .code
31428 verify = recipient/callout=10s,defer_ok
31429 .endd
31430 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
31431 separate verify options, is retained for backwards compatibility, but is now
31432 deprecated. The additional parameters for &%callout%& are as follows:
31433
31434
31435 .vlist
31436 .vitem <&'a&~time&~interval'&>
31437 .cindex "callout" "timeout, specifying"
31438 This specifies the timeout that applies for the callout attempt to each host.
31439 For example:
31440 .code
31441 verify = sender/callout=5s
31442 .endd
31443 The default is 30 seconds. The timeout is used for each response from the
31444 remote host. It is also used for the initial connection, unless overridden by
31445 the &%connect%& parameter.
31446
31447
31448 .vitem &*connect&~=&~*&<&'time&~interval'&>
31449 .cindex "callout" "connection timeout, specifying"
31450 This parameter makes it possible to set a different (usually smaller) timeout
31451 for making the SMTP connection. For example:
31452 .code
31453 verify = sender/callout=5s,connect=1s
31454 .endd
31455 If not specified, this timeout defaults to the general timeout value.
31456
31457 .vitem &*defer_ok*&
31458 .cindex "callout" "defer, action on"
31459 When this parameter is present, failure to contact any host, or any other kind
31460 of temporary error, is treated as success by the ACL. However, the cache is not
31461 updated in this circumstance.
31462
31463 .vitem &*fullpostmaster*&
31464 .cindex "callout" "full postmaster check"
31465 This operates like the &%postmaster%& option (see below), but if the check for
31466 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
31467 accordance with the specification in RFC 2821. The RFC states that the
31468 unqualified address &'postmaster'& should be accepted.
31469
31470
31471 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
31472 .cindex "callout" "sender when verifying header"
31473 When verifying addresses in header lines using the &%header_sender%&
31474 verification option, Exim behaves by default as if the addresses are envelope
31475 sender addresses from a message. Callout verification therefore tests to see
31476 whether a bounce message could be delivered, by using an empty address in the
31477 MAIL command. However, it is arguable that these addresses might never be used
31478 as envelope senders, and could therefore justifiably reject bounce messages
31479 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
31480 address to use in the MAIL command. For example:
31481 .code
31482 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
31483 .endd
31484 This parameter is available only for the &%header_sender%& verification option.
31485
31486
31487 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
31488 .cindex "callout" "overall timeout, specifying"
31489 This parameter sets an overall timeout for performing a callout verification.
31490 For example:
31491 .code
31492 verify = sender/callout=5s,maxwait=30s
31493 .endd
31494 This timeout defaults to four times the callout timeout for individual SMTP
31495 commands. The overall timeout applies when there is more than one host that can
31496 be tried. The timeout is checked before trying the next host. This prevents
31497 very long delays if there are a large number of hosts and all are timing out
31498 (for example, when network connections are timing out).
31499
31500
31501 .vitem &*no_cache*&
31502 .cindex "callout" "cache, suppressing"
31503 .cindex "caching callout, suppressing"
31504 When this parameter is given, the callout cache is neither read nor updated.
31505
31506 .vitem &*postmaster*&
31507 .cindex "callout" "postmaster; checking"
31508 When this parameter is set, a successful callout check is followed by a similar
31509 check for the local part &'postmaster'& at the same domain. If this address is
31510 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
31511 the postmaster check is recorded in a cache record; if it is a failure, this is
31512 used to fail subsequent callouts for the domain without a connection being
31513 made, until the cache record expires.
31514
31515 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
31516 The postmaster check uses an empty sender in the MAIL command by default.
31517 You can use this parameter to do a postmaster check using a different address.
31518 For example:
31519 .code
31520 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
31521 .endd
31522 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
31523 one overrides. The &%postmaster%& parameter is equivalent to this example:
31524 .code
31525 require  verify = sender/callout=postmaster_mailfrom=
31526 .endd
31527 &*Warning*&: The caching arrangements for postmaster checking do not take
31528 account of the sender address. It is assumed that either the empty address or
31529 a fixed non-empty address will be used. All that Exim remembers is that the
31530 postmaster check for the domain succeeded or failed.
31531
31532
31533 .vitem &*random*&
31534 .cindex "callout" "&""random""& check"
31535 When this parameter is set, before doing the normal callout check, Exim does a
31536 check for a &"random"& local part at the same domain. The local part is not
31537 really random &-- it is defined by the expansion of the option
31538 &%callout_random_local_part%&, which defaults to
31539 .code
31540 $primary_hostname-$tod_epoch-testing
31541 .endd
31542 The idea here is to try to determine whether the remote host accepts all local
31543 parts without checking. If it does, there is no point in doing callouts for
31544 specific local parts. If the &"random"& check succeeds, the result is saved in
31545 a cache record, and used to force the current and subsequent callout checks to
31546 succeed without a connection being made, until the cache record expires.
31547
31548 .vitem &*use_postmaster*&
31549 .cindex "callout" "sender for recipient check"
31550 This parameter applies to recipient callouts only. For example:
31551 .code
31552 deny  !verify = recipient/callout=use_postmaster
31553 .endd
31554 .vindex "&$qualify_domain$&"
31555 It causes a non-empty postmaster address to be used in the MAIL command when
31556 performing the callout for the recipient, and also for a &"random"& check if
31557 that is configured. The local part of the address is &`postmaster`& and the
31558 domain is the contents of &$qualify_domain$&.
31559
31560 .vitem &*use_sender*&
31561 This option applies to recipient callouts only. For example:
31562 .code
31563 require  verify = recipient/callout=use_sender
31564 .endd
31565 It causes the message's actual sender address to be used in the MAIL
31566 command when performing the callout, instead of an empty address. There is no
31567 need to use this option unless you know that the called hosts make use of the
31568 sender when checking recipients. If used indiscriminately, it reduces the
31569 usefulness of callout caching.
31570
31571 .vitem &*hold*&
31572 This option applies to recipient callouts only. For example:
31573 .code
31574 require  verify = recipient/callout=use_sender,hold
31575 .endd
31576 It causes the connection to be held open and used for any further recipients
31577 and for eventual delivery (should that be done quickly).
31578 Doing this saves on TCP and SMTP startup costs, and TLS costs also
31579 when that is used for the connections.
31580 The advantage is only gained if there are no callout cache hits
31581 (which could be enforced by the no_cache option),
31582 if the use_sender option is used,
31583 if neither the random nor the use_postmaster option is used,
31584 and if no other callouts intervene.
31585 .endlist
31586
31587 If you use any of the parameters that set a non-empty sender for the MAIL
31588 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
31589 &%use_sender%&), you should think about possible loops. Recipient checking is
31590 usually done between two hosts that are under the same management, and the host
31591 that receives the callouts is not normally configured to do callouts itself.
31592 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
31593 these circumstances.
31594
31595 However, if you use a non-empty sender address for a callout to an arbitrary
31596 host, there is the likelihood that the remote host will itself initiate a
31597 callout check back to your host. As it is checking what appears to be a message
31598 sender, it is likely to use an empty address in MAIL, thus avoiding a
31599 callout loop. However, to be on the safe side it would be best to set up your
31600 own ACLs so that they do not do sender verification checks when the recipient
31601 is the address you use for header sender or postmaster callout checking.
31602
31603 Another issue to think about when using non-empty senders for callouts is
31604 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
31605 by the sender/recipient combination; thus, for any given recipient, many more
31606 actual callouts are performed than when an empty sender or postmaster is used.
31607
31608
31609
31610
31611 .section "Callout caching" "SECTcallvercache"
31612 .cindex "hints database" "callout cache"
31613 .cindex "callout" "cache, description of"
31614 .cindex "caching" "callout"
31615 Exim caches the results of callouts in order to reduce the amount of resources
31616 used, unless you specify the &%no_cache%& parameter with the &%callout%&
31617 option. A hints database called &"callout"& is used for the cache. Two
31618 different record types are used: one records the result of a callout check for
31619 a specific address, and the other records information that applies to the
31620 entire domain (for example, that it accepts the local part &'postmaster'&).
31621
31622 When an original callout fails, a detailed SMTP error message is given about
31623 the failure. However, for subsequent failures use the cache data, this message
31624 is not available.
31625
31626 The expiry times for negative and positive address cache records are
31627 independent, and can be set by the global options &%callout_negative_expire%&
31628 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
31629
31630 If a host gives a negative response to an SMTP connection, or rejects any
31631 commands up to and including
31632 .code
31633 MAIL FROM:<>
31634 .endd
31635 (but not including the MAIL command with a non-empty address),
31636 any callout attempt is bound to fail. Exim remembers such failures in a
31637 domain cache record, which it uses to fail callouts for the domain without
31638 making new connections, until the domain record times out. There are two
31639 separate expiry times for domain cache records:
31640 &%callout_domain_negative_expire%& (default 3h) and
31641 &%callout_domain_positive_expire%& (default 7d).
31642
31643 Domain records expire when the negative expiry time is reached if callouts
31644 cannot be made for the domain, or if the postmaster check failed.
31645 Otherwise, they expire when the positive expiry time is reached. This
31646 ensures that, for example, a host that stops accepting &"random"& local parts
31647 will eventually be noticed.
31648
31649 The callout caching mechanism is based on the domain of the address that is
31650 being tested. If the domain routes to several hosts, it is assumed that their
31651 behaviour will be the same.
31652
31653
31654
31655 .section "Sender address verification reporting" "SECTsenaddver"
31656 .cindex "verifying" "suppressing error details"
31657 See section &<<SECTaddressverification>>& for a general discussion of
31658 verification. When sender verification fails in an ACL, the details of the
31659 failure are given as additional output lines before the 550 response to the
31660 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
31661 you might see:
31662 .code
31663 MAIL FROM:<xyz@abc.example>
31664 250 OK
31665 RCPT TO:<pqr@def.example>
31666 550-Verification failed for <xyz@abc.example>
31667 550-Called:   192.168.34.43
31668 550-Sent:     RCPT TO:<xyz@abc.example>
31669 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
31670 550 Sender verification failed
31671 .endd
31672 If more than one RCPT command fails in the same way, the details are given
31673 only for the first of them. However, some administrators do not want to send
31674 out this much information. You can suppress the details by adding
31675 &`/no_details`& to the ACL statement that requests sender verification. For
31676 example:
31677 .code
31678 verify = sender/no_details
31679 .endd
31680
31681 .section "Redirection while verifying" "SECTredirwhilveri"
31682 .cindex "verifying" "redirection while"
31683 .cindex "address redirection" "while verifying"
31684 A dilemma arises when a local address is redirected by aliasing or forwarding
31685 during verification: should the generated addresses themselves be verified,
31686 or should the successful expansion of the original address be enough to verify
31687 it? By default, Exim takes the following pragmatic approach:
31688
31689 .ilist
31690 When an incoming address is redirected to just one child address, verification
31691 continues with the child address, and if that fails to verify, the original
31692 verification also fails.
31693 .next
31694 When an incoming address is redirected to more than one child address,
31695 verification does not continue. A success result is returned.
31696 .endlist
31697
31698 This seems the most reasonable behaviour for the common use of aliasing as a
31699 way of redirecting different local parts to the same mailbox. It means, for
31700 example, that a pair of alias entries of the form
31701 .code
31702 A.Wol:   aw123
31703 aw123:   :fail: Gone away, no forwarding address
31704 .endd
31705 work as expected, with both local parts causing verification failure. When a
31706 redirection generates more than one address, the behaviour is more like a
31707 mailing list, where the existence of the alias itself is sufficient for
31708 verification to succeed.
31709
31710 It is possible, however, to change the default behaviour so that all successful
31711 redirections count as successful verifications, however many new addresses are
31712 generated. This is specified by the &%success_on_redirect%& verification
31713 option. For example:
31714 .code
31715 require verify = recipient/success_on_redirect/callout=10s
31716 .endd
31717 In this example, verification succeeds if a router generates a new address, and
31718 the callout does not occur, because no address was routed to a remote host.
31719
31720 When verification is being tested via the &%-bv%& option, the treatment of
31721 redirections is as just described, unless the &%-v%& or any debugging option is
31722 also specified. In that case, full verification is done for every generated
31723 address and a report is output for each of them.
31724
31725
31726
31727 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
31728 .cindex "CSA" "verifying"
31729 Client SMTP Authorization is a system that allows a site to advertise
31730 which machines are and are not permitted to send email. This is done by placing
31731 special SRV records in the DNS; these are looked up using the client's HELO
31732 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
31733 Authorization checks in Exim are performed by the ACL condition:
31734 .code
31735 verify = csa
31736 .endd
31737 This fails if the client is not authorized. If there is a DNS problem, or if no
31738 valid CSA SRV record is found, or if the client is authorized, the condition
31739 succeeds. These three cases can be distinguished using the expansion variable
31740 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
31741 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
31742 be likely to cause problems for legitimate email.
31743
31744 The error messages produced by the CSA code include slightly more
31745 detail. If &$csa_status$& is &"defer"&, this may be because of problems
31746 looking up the CSA SRV record, or problems looking up the CSA target
31747 address record. There are four reasons for &$csa_status$& being &"fail"&:
31748
31749 .ilist
31750 The client's host name is explicitly not authorized.
31751 .next
31752 The client's IP address does not match any of the CSA target IP addresses.
31753 .next
31754 The client's host name is authorized but it has no valid target IP addresses
31755 (for example, the target's addresses are IPv6 and the client is using IPv4).
31756 .next
31757 The client's host name has no CSA SRV record but a parent domain has asserted
31758 that all subdomains must be explicitly authorized.
31759 .endlist
31760
31761 The &%csa%& verification condition can take an argument which is the domain to
31762 use for the DNS query. The default is:
31763 .code
31764 verify = csa/$sender_helo_name
31765 .endd
31766 This implementation includes an extension to CSA. If the query domain
31767 is an address literal such as [192.0.2.95], or if it is a bare IP
31768 address, Exim searches for CSA SRV records in the reverse DNS as if
31769 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
31770 meaningful to say:
31771 .code
31772 verify = csa/$sender_host_address
31773 .endd
31774 In fact, this is the check that Exim performs if the client does not say HELO.
31775 This extension can be turned off by setting the main configuration option
31776 &%dns_csa_use_reverse%& to be false.
31777
31778 If a CSA SRV record is not found for the domain itself, a search
31779 is performed through its parent domains for a record which might be
31780 making assertions about subdomains. The maximum depth of this search is limited
31781 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
31782 default. Exim does not look for CSA SRV records in a top level domain, so the
31783 default settings handle HELO domains as long as seven
31784 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
31785 of legitimate HELO domains.
31786
31787 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
31788 direct SRV lookups, this is not sufficient because of the extra parent domain
31789 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
31790 addresses into lookups in the reverse DNS space. The result of a successful
31791 lookup such as:
31792 .code
31793 ${lookup dnsdb {csa=$sender_helo_name}}
31794 .endd
31795 has two space-separated fields: an authorization code and a target host name.
31796 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
31797 authorization required but absent, or &"?"& for unknown.
31798
31799
31800
31801
31802 .section "Bounce address tag validation" "SECTverifyPRVS"
31803 .cindex "BATV, verifying"
31804 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
31805 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
31806 Genuine incoming bounce messages should therefore always be addressed to
31807 recipients that have a valid tag. This scheme is a way of detecting unwanted
31808 bounce messages caused by sender address forgeries (often called &"collateral
31809 spam"&), because the recipients of such messages do not include valid tags.
31810
31811 There are two expansion items to help with the implementation of the BATV
31812 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
31813 the original envelope sender address by using a simple key to add a hash of the
31814 address and some time-based randomizing information. The &%prvs%& expansion
31815 item creates a signed address, and the &%prvscheck%& expansion item checks one.
31816 The syntax of these expansion items is described in section
31817 &<<SECTexpansionitems>>&.
31818 The validity period on signed addresses is seven days.
31819
31820 As an example, suppose the secret per-address keys are stored in an MySQL
31821 database. A query to look up the key for an address could be defined as a macro
31822 like this:
31823 .code
31824 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
31825                 WHERE sender='${quote_mysql:$prvscheck_address}'\
31826                 }{$value}}
31827 .endd
31828 Suppose also that the senders who make use of BATV are defined by an address
31829 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
31830 use this:
31831 .code
31832 # Bounces: drop unsigned addresses for BATV senders
31833 deny message = This address does not send an unsigned reverse path
31834      senders = :
31835      recipients = +batv_senders
31836
31837 # Bounces: In case of prvs-signed address, check signature.
31838 deny message = Invalid reverse path signature.
31839      senders = :
31840      condition  = ${prvscheck {$local_part@$domain}\
31841                   {PRVSCHECK_SQL}{1}}
31842      !condition = $prvscheck_result
31843 .endd
31844 The first statement rejects recipients for bounce messages that are addressed
31845 to plain BATV sender addresses, because it is known that BATV senders do not
31846 send out messages with plain sender addresses. The second statement rejects
31847 recipients that are prvs-signed, but with invalid signatures (either because
31848 the key is wrong, or the signature has timed out).
31849
31850 A non-prvs-signed address is not rejected by the second statement, because the
31851 &%prvscheck%& expansion yields an empty string if its first argument is not a
31852 prvs-signed address, thus causing the &%condition%& condition to be false. If
31853 the first argument is a syntactically valid prvs-signed address, the yield is
31854 the third string (in this case &"1"&), whether or not the cryptographic and
31855 timeout checks succeed. The &$prvscheck_result$& variable contains the result
31856 of the checks (empty for failure, &"1"& for success).
31857
31858 There is one more issue you must consider when implementing prvs-signing:
31859 you have to ensure that the routers accept prvs-signed addresses and
31860 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
31861 router to remove the signature with a configuration along these lines:
31862 .code
31863 batv_redirect:
31864   driver = redirect
31865   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
31866 .endd
31867 This works because, if the third argument of &%prvscheck%& is empty, the result
31868 of the expansion of a prvs-signed address is the decoded value of the original
31869 address. This router should probably be the first of your routers that handles
31870 local addresses.
31871
31872 To create BATV-signed addresses in the first place, a transport of this form
31873 can be used:
31874 .code
31875 external_smtp_batv:
31876   driver = smtp
31877   return_path = ${prvs {$return_path} \
31878                        {${lookup mysql{SELECT \
31879                        secret FROM batv_prvs WHERE \
31880                        sender='${quote_mysql:$sender_address}'} \
31881                        {$value}fail}}}
31882 .endd
31883 If no key can be found for the existing return path, no signing takes place.
31884
31885
31886
31887 .section "Using an ACL to control relaying" "SECTrelaycontrol"
31888 .cindex "&ACL;" "relay control"
31889 .cindex "relaying" "control by ACL"
31890 .cindex "policy control" "relay control"
31891 An MTA is said to &'relay'& a message if it receives it from some host and
31892 delivers it directly to another host as a result of a remote address contained
31893 within it. Redirecting a local address via an alias or forward file and then
31894 passing the message on to another host is not relaying,
31895 .cindex "&""percent hack""&"
31896 but a redirection as a result of the &"percent hack"& is.
31897
31898 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
31899 A host which is acting as a gateway or an MX backup is concerned with incoming
31900 relaying from arbitrary hosts to a specific set of domains. On the other hand,
31901 a host which is acting as a smart host for a number of clients is concerned
31902 with outgoing relaying from those clients to the Internet at large. Often the
31903 same host is fulfilling both functions,
31904 . ///
31905 . as illustrated in the diagram below,
31906 . ///
31907 but in principle these two kinds of relaying are entirely independent. What is
31908 not wanted is the transmission of mail from arbitrary remote hosts through your
31909 system to arbitrary domains.
31910
31911
31912 You can implement relay control by means of suitable statements in the ACL that
31913 runs for each RCPT command. For convenience, it is often easiest to use
31914 Exim's named list facility to define the domains and hosts involved. For
31915 example, suppose you want to do the following:
31916
31917 .ilist
31918 Deliver a number of domains to mailboxes on the local host (or process them
31919 locally in some other way). Let's say these are &'my.dom1.example'& and
31920 &'my.dom2.example'&.
31921 .next
31922 Relay mail for a number of other domains for which you are the secondary MX.
31923 These might be &'friend1.example'& and &'friend2.example'&.
31924 .next
31925 Relay mail from the hosts on your local LAN, to whatever domains are involved.
31926 Suppose your LAN is 192.168.45.0/24.
31927 .endlist
31928
31929
31930 In the main part of the configuration, you put the following definitions:
31931 .code
31932 domainlist local_domains    = my.dom1.example : my.dom2.example
31933 domainlist relay_to_domains = friend1.example : friend2.example
31934 hostlist   relay_from_hosts = 192.168.45.0/24
31935 .endd
31936 Now you can use these definitions in the ACL that is run for every RCPT
31937 command:
31938 .code
31939 acl_check_rcpt:
31940   accept domains = +local_domains : +relay_to_domains
31941   accept hosts   = +relay_from_hosts
31942 .endd
31943 The first statement accepts any RCPT command that contains an address in
31944 the local or relay domains. For any other domain, control passes to the second
31945 statement, which accepts the command only if it comes from one of the relay
31946 hosts. In practice, you will probably want to make your ACL more sophisticated
31947 than this, for example, by including sender and recipient verification. The
31948 default configuration includes a more comprehensive example, which is described
31949 in chapter &<<CHAPdefconfil>>&.
31950
31951
31952
31953 .section "Checking a relay configuration" "SECTcheralcon"
31954 .cindex "relaying" "checking control of"
31955 You can check the relay characteristics of your configuration in the same way
31956 that you can test any ACL behaviour for an incoming SMTP connection, by using
31957 the &%-bh%& option to run a fake SMTP session with which you interact.
31958 .ecindex IIDacl
31959
31960
31961
31962 . ////////////////////////////////////////////////////////////////////////////
31963 . ////////////////////////////////////////////////////////////////////////////
31964
31965 .chapter "Content scanning at ACL time" "CHAPexiscan"
31966 .scindex IIDcosca "content scanning" "at ACL time"
31967 The extension of Exim to include content scanning at ACL time, formerly known
31968 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
31969 was integrated into the main source for Exim release 4.50, and Tom continues to
31970 maintain it. Most of the wording of this chapter is taken from Tom's
31971 specification.
31972
31973 It is also possible to scan the content of messages at other times. The
31974 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
31975 scanning after all the ACLs have run. A transport filter can be used to scan
31976 messages at delivery time (see the &%transport_filter%& option, described in
31977 chapter &<<CHAPtransportgeneric>>&).
31978
31979 If you want to include the ACL-time content-scanning features when you compile
31980 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
31981 &_Local/Makefile_&. When you do that, the Exim binary is built with:
31982
31983 .ilist
31984 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
31985 for all MIME parts for SMTP and non-SMTP messages, respectively.
31986 .next
31987 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
31988 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
31989 run at the end of message reception (the &%acl_smtp_data%& ACL).
31990 .next
31991 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
31992 of messages, or parts of messages, for debugging purposes.
31993 .next
31994 Additional expansion variables that are set in the new ACL and by the new
31995 conditions.
31996 .next
31997 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
31998 .endlist
31999
32000 Content-scanning is continually evolving, and new features are still being
32001 added. While such features are still unstable and liable to incompatible
32002 changes, they are made available in Exim by setting options whose names begin
32003 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
32004 this manual. You can find out about them by reading the file called
32005 &_doc/experimental.txt_&.
32006
32007 All the content-scanning facilities work on a MBOX copy of the message that is
32008 temporarily created in a file called:
32009 .display
32010 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
32011 .endd
32012 The &_.eml_& extension is a friendly hint to virus scanners that they can
32013 expect an MBOX-like structure inside that file. The file is created when the
32014 first content scanning facility is called. Subsequent calls to content
32015 scanning conditions open the same file again. The directory is recursively
32016 removed when the &%acl_smtp_data%& ACL has finished running, unless
32017 .code
32018 control = no_mbox_unspool
32019 .endd
32020 has been encountered. When the MIME ACL decodes files, they are put into the
32021 same directory by default.
32022
32023
32024
32025 .section "Scanning for viruses" "SECTscanvirus"
32026 .cindex "virus scanning"
32027 .cindex "content scanning" "for viruses"
32028 .cindex "content scanning" "the &%malware%& condition"
32029 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
32030 It supports a &"generic"& interface to scanners called via the shell, and
32031 specialized interfaces for &"daemon"& type virus scanners, which are resident
32032 in memory and thus are much faster.
32033
32034 A timeout of 2 minutes is applied to a scanner call (by default);
32035 if it expires then a defer action is taken.
32036
32037 .oindex "&%av_scanner%&"
32038 You can set the &%av_scanner%& option in the main part of the configuration
32039 to specify which scanner to use, together with any additional options that
32040 are needed. The basic syntax is as follows:
32041 .display
32042 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
32043 .endd
32044 If you do not set &%av_scanner%&, it defaults to
32045 .code
32046 av_scanner = sophie:/var/run/sophie
32047 .endd
32048 If the value of &%av_scanner%& starts with a dollar character, it is expanded
32049 before use.
32050 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
32051 The following scanner types are supported in this release,
32052 though individual ones can be included or not at build time:
32053
32054 .vlist
32055 .vitem &%avast%&
32056 .cindex "virus scanners" "avast"
32057 This is the scanner daemon of Avast. It has been tested with Avast Core
32058 Security (currently at version 2.2.0).
32059 You can get a trial version at &url(https://www.avast.com) or for Linux
32060 at &url(https://www.avast.com/linux-server-antivirus).
32061 This scanner type takes one option,
32062 which can be either a full path to a UNIX socket,
32063 or host and port specifiers separated by white space.
32064 The host may be a name or an IP address; the port is either a
32065 single number or a pair of numbers with a dash between.
32066 A list of options may follow. These options are interpreted on the
32067 Exim's side of the malware scanner, or are given on separate lines to
32068 the daemon as options before the main scan command.
32069
32070 .cindex &`pass_unscanned`& "avast"
32071 If &`pass_unscanned`&
32072 is set, any files the Avast scanner can't scan (e.g.
32073 decompression bombs, or invalid archives) are considered clean. Use with
32074 care.
32075
32076 For example:
32077 .code
32078 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
32079 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
32080 av_scanner = avast:192.168.2.22 5036
32081 .endd
32082 If you omit the argument, the default path
32083 &_/var/run/avast/scan.sock_&
32084 is used.
32085 If you use a remote host,
32086 you need to make Exim's spool directory available to it,
32087 as the scanner is passed a file path, not file contents.
32088 For information about available commands and their options you may use
32089 .code
32090 $ socat UNIX:/var/run/avast/scan.sock STDIO:
32091     FLAGS
32092     SENSITIVITY
32093     PACK
32094 .endd
32095
32096 If the scanner returns a temporary failure (e.g. license issues, or
32097 permission problems), the message is deferred and a paniclog entry is
32098 written.  The usual &`defer_ok`& option is available.
32099
32100 .vitem &%aveserver%&
32101 .cindex "virus scanners" "Kaspersky"
32102 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
32103 at &url(https://www.kaspersky.com/). This scanner type takes one option,
32104 which is the path to the daemon's UNIX socket. The default is shown in this
32105 example:
32106 .code
32107 av_scanner = aveserver:/var/run/aveserver
32108 .endd
32109
32110
32111 .vitem &%clamd%&
32112 .cindex "virus scanners" "clamd"
32113 This daemon-type scanner is GPL and free. You can get it at
32114 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
32115 unpack MIME containers, so it used to be recommended to unpack MIME attachments
32116 in the MIME ACL. This is no longer believed to be necessary.
32117
32118 The options are a list of server specifiers, which may be
32119 a UNIX socket specification,
32120 a TCP socket specification,
32121 or a (global) option.
32122
32123 A socket specification consists of a space-separated list.
32124 For a Unix socket the first element is a full path for the socket,
32125 for a TCP socket the first element is the IP address
32126 and the second a port number,
32127 Any further elements are per-server (non-global) options.
32128 These per-server options are supported:
32129 .code
32130 retry=<timespec>        Retry on connect fail
32131 .endd
32132
32133 The &`retry`& option specifies a time after which a single retry for
32134 a failed connect is made.  The default is to not retry.
32135
32136 If a Unix socket file is specified, only one server is supported.
32137
32138 Examples:
32139 .code
32140 av_scanner = clamd:/opt/clamd/socket
32141 av_scanner = clamd:192.0.2.3 1234
32142 av_scanner = clamd:192.0.2.3 1234:local
32143 av_scanner = clamd:192.0.2.3 1234 retry=10s
32144 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
32145 .endd
32146 If the value of av_scanner points to a UNIX socket file or contains the
32147 &`local`&
32148 option, then the ClamAV interface will pass a filename containing the data
32149 to be scanned, which should normally result in less I/O happening and be
32150 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
32151 Exim does not assume that there is a common filesystem with the remote host.
32152
32153 The final example shows that multiple TCP targets can be specified.  Exim will
32154 randomly use one for each incoming email (i.e. it load balances them).  Note
32155 that only TCP targets may be used if specifying a list of scanners; a UNIX
32156 socket cannot be mixed in with TCP targets.  If one of the servers becomes
32157 unavailable, Exim will try the remaining one(s) until it finds one that works.
32158 When a clamd server becomes unreachable, Exim will log a message.  Exim does
32159 not keep track of scanner state between multiple messages, and the scanner
32160 selection is random, so the message will get logged in the mainlog for each
32161 email that the down scanner gets chosen first (message wrapped to be readable):
32162 .code
32163 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
32164    clamd: connection to localhost, port 3310 failed
32165    (Connection refused)
32166 .endd
32167
32168 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
32169 contributing the code for this scanner.
32170
32171 .vitem &%cmdline%&
32172 .cindex "virus scanners" "command line interface"
32173 This is the keyword for the generic command line scanner interface. It can be
32174 used to attach virus scanners that are invoked from the shell. This scanner
32175 type takes 3 mandatory options:
32176
32177 .olist
32178 The full path and name of the scanner binary, with all command line options,
32179 and a placeholder (&`%s`&) for the directory to scan.
32180
32181 .next
32182 A regular expression to match against the STDOUT and STDERR output of the
32183 virus scanner. If the expression matches, a virus was found. You must make
32184 absolutely sure that this expression matches on &"virus found"&. This is called
32185 the &"trigger"& expression.
32186
32187 .next
32188 Another regular expression, containing exactly one pair of parentheses, to
32189 match the name of the virus found in the scanners output. This is called the
32190 &"name"& expression.
32191 .endlist olist
32192
32193 For example, Sophos Sweep reports a virus on a line like this:
32194 .code
32195 Virus 'W32/Magistr-B' found in file ./those.bat
32196 .endd
32197 For the trigger expression, we can match the phrase &"found in file"&. For the
32198 name expression, we want to extract the W32/Magistr-B string, so we can match
32199 for the single quotes left and right of it. Altogether, this makes the
32200 configuration setting:
32201 .code
32202 av_scanner = cmdline:\
32203              /path/to/sweep -ss -all -rec -archive %s:\
32204              found in file:'(.+)'
32205 .endd
32206 .vitem &%drweb%&
32207 .cindex "virus scanners" "DrWeb"
32208 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
32209 takes one option,
32210 either a full path to a UNIX socket,
32211 or host and port specifiers separated by white space.
32212 The host may be a name or an IP address; the port is either a
32213 single number or a pair of numbers with a dash between.
32214 For example:
32215 .code
32216 av_scanner = drweb:/var/run/drwebd.sock
32217 av_scanner = drweb:192.168.2.20 31337
32218 .endd
32219 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
32220 is used. Thanks to Alex Miller for contributing the code for this scanner.
32221
32222 .vitem &%f-protd%&
32223 .cindex "virus scanners" "f-protd"
32224 The f-protd scanner is accessed via HTTP over TCP.
32225 One argument is taken, being a space-separated hostname and port number
32226 (or port-range).
32227 For example:
32228 .code
32229 av_scanner = f-protd:localhost 10200-10204
32230 .endd
32231 If you omit the argument, the default values shown above are used.
32232
32233 .vitem &%f-prot6d%&
32234 .cindex "virus scanners" "f-prot6d"
32235 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
32236 One argument is taken, being a space-separated hostname and port number.
32237 For example:
32238 .code
32239 av_scanner = f-prot6d:localhost 10200
32240 .endd
32241 If you omit the argument, the default values show above are used.
32242
32243 .vitem &%fsecure%&
32244 .cindex "virus scanners" "F-Secure"
32245 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
32246 argument which is the path to a UNIX socket. For example:
32247 .code
32248 av_scanner = fsecure:/path/to/.fsav
32249 .endd
32250 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
32251 Thelmen for contributing the code for this scanner.
32252
32253 .vitem &%kavdaemon%&
32254 .cindex "virus scanners" "Kaspersky"
32255 This is the scanner daemon of Kaspersky Version 4. This version of the
32256 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
32257 scanner type takes one option, which is the path to the daemon's UNIX socket.
32258 For example:
32259 .code
32260 av_scanner = kavdaemon:/opt/AVP/AvpCtl
32261 .endd
32262 The default path is &_/var/run/AvpCtl_&.
32263
32264 .vitem &%mksd%&
32265 .cindex "virus scanners" "mksd"
32266 This was a daemon type scanner that is aimed mainly at Polish users,
32267 though some documentation was available in English.
32268 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
32269 and this appears to be a candidate for removal from Exim, unless
32270 we are informed of other virus scanners which use the same protocol
32271 to integrate.
32272 The only option for this scanner type is
32273 the maximum number of processes used simultaneously to scan the attachments,
32274 provided that mksd has
32275 been run with at least the same number of child processes. For example:
32276 .code
32277 av_scanner = mksd:2
32278 .endd
32279 You can safely omit this option (the default value is 1).
32280
32281 .vitem &%sock%&
32282 .cindex "virus scanners" "simple socket-connected"
32283 This is a general-purpose way of talking to simple scanner daemons
32284 running on the local machine.
32285 There are four options:
32286 an address (which may be an IP address and port, or the path of a Unix socket),
32287 a commandline to send (may include a single %s which will be replaced with
32288 the path to the mail file to be scanned),
32289 an RE to trigger on from the returned data,
32290 and an RE to extract malware_name from the returned data.
32291 For example:
32292 .code
32293 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
32294 .endd
32295 Note that surrounding whitespace is stripped from each option, meaning
32296 there is no way to specify a trailing newline.
32297 The socket specifier and both regular-expressions are required.
32298 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
32299 specify an empty element to get this.
32300
32301 .vitem &%sophie%&
32302 .cindex "virus scanners" "Sophos and Sophie"
32303 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
32304 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
32305 for this scanner type is the path to the UNIX socket that Sophie uses for
32306 client communication. For example:
32307 .code
32308 av_scanner = sophie:/tmp/sophie
32309 .endd
32310 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
32311 the option.
32312 .endlist
32313
32314 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
32315 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
32316 ACL.
32317
32318 The &%av_scanner%& option is expanded each time &%malware%& is called. This
32319 makes it possible to use different scanners. See further below for an example.
32320 The &%malware%& condition caches its results, so when you use it multiple times
32321 for the same message, the actual scanning process is only carried out once.
32322 However, using expandable items in &%av_scanner%& disables this caching, in
32323 which case each use of the &%malware%& condition causes a new scan of the
32324 message.
32325
32326 The &%malware%& condition takes a right-hand argument that is expanded before
32327 use and taken as a list, slash-separated by default.
32328 The first element can then be one of
32329
32330 .ilist
32331 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
32332 The condition succeeds if a virus was found, and fail otherwise. This is the
32333 recommended usage.
32334 .next
32335 &"false"& or &"0"& or an empty string, in which case no scanning is done and
32336 the condition fails immediately.
32337 .next
32338 A regular expression, in which case the message is scanned for viruses. The
32339 condition succeeds if a virus is found and its name matches the regular
32340 expression. This allows you to take special actions on certain types of virus.
32341 Note that &"/"& characters in the RE must be doubled due to the list-processing,
32342 unless the separator is changed (in the usual way).
32343 .endlist
32344
32345 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
32346 messages even if there is a problem with the virus scanner.
32347 Otherwise, such a problem causes the ACL to defer.
32348
32349 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
32350 specify a non-default timeout.  The default is two minutes.
32351 For example:
32352 .code
32353 malware = * / defer_ok / tmo=10s
32354 .endd
32355 A timeout causes the ACL to defer.
32356
32357 .vindex "&$callout_address$&"
32358 When a connection is made to the scanner the expansion variable &$callout_address$&
32359 is set to record the actual address used.
32360
32361 .vindex "&$malware_name$&"
32362 When a virus is found, the condition sets up an expansion variable called
32363 &$malware_name$& that contains the name of the virus. You can use it in a
32364 &%message%& modifier that specifies the error returned to the sender, and/or in
32365 logging data.
32366
32367 Beware the interaction of Exim's &%message_size_limit%& with any size limits
32368 imposed by your anti-virus scanner.
32369
32370 Here is a very simple scanning example:
32371 .code
32372 deny message = This message contains malware ($malware_name)
32373      malware = *
32374 .endd
32375 The next example accepts messages when there is a problem with the scanner:
32376 .code
32377 deny message = This message contains malware ($malware_name)
32378      malware = */defer_ok
32379 .endd
32380 The next example shows how to use an ACL variable to scan with both sophie and
32381 aveserver. It assumes you have set:
32382 .code
32383 av_scanner = $acl_m0
32384 .endd
32385 in the main Exim configuration.
32386 .code
32387 deny message = This message contains malware ($malware_name)
32388      set acl_m0 = sophie
32389      malware = *
32390
32391 deny message = This message contains malware ($malware_name)
32392      set acl_m0 = aveserver
32393      malware = *
32394 .endd
32395
32396
32397 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
32398 .cindex "content scanning" "for spam"
32399 .cindex "spam scanning"
32400 .cindex "SpamAssassin"
32401 .cindex "Rspamd"
32402 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
32403 score and a report for the message.
32404 Support is also provided for Rspamd.
32405
32406 For more information about installation and configuration of SpamAssassin or
32407 Rspamd refer to their respective websites at
32408 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
32409
32410 SpamAssassin can be installed with CPAN by running:
32411 .code
32412 perl -MCPAN -e 'install Mail::SpamAssassin'
32413 .endd
32414 SpamAssassin has its own set of configuration files. Please review its
32415 documentation to see how you can tweak it. The default installation should work
32416 nicely, however.
32417
32418 .oindex "&%spamd_address%&"
32419 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
32420 intend to use an instance running on the local host you do not need to set
32421 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
32422 you must set the &%spamd_address%& option in the global part of the Exim
32423 configuration as follows (example):
32424 .code
32425 spamd_address = 192.168.99.45 387
32426 .endd
32427 The SpamAssassin protocol relies on a TCP half-close from the client.
32428 If your SpamAssassin client side is running a Linux system with an
32429 iptables firewall, consider setting
32430 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
32431 timeout, Exim uses when waiting for a response from the SpamAssassin
32432 server (currently defaulting to 120s).  With a lower value the Linux
32433 connection tracking may consider your half-closed connection as dead too
32434 soon.
32435
32436
32437 To use Rspamd (which by default listens on all local addresses
32438 on TCP port 11333)
32439 you should add &%variant=rspamd%& after the address/port pair, for example:
32440 .code
32441 spamd_address = 127.0.0.1 11333 variant=rspamd
32442 .endd
32443
32444 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
32445 sockets. If you want to us these, supply &%spamd_address%& with an absolute
32446 file name instead of an address/port pair:
32447 .code
32448 spamd_address = /var/run/spamd_socket
32449 .endd
32450 You can have multiple &%spamd%& servers to improve scalability. These can
32451 reside on other hardware reachable over the network. To specify multiple
32452 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
32453 option, separated with colons (the separator can be changed in the usual way):
32454 .code
32455 spamd_address = 192.168.2.10 783 : \
32456                 192.168.2.11 783 : \
32457                 192.168.2.12 783
32458 .endd
32459 Up to 32 &%spamd%& servers are supported.
32460 When a server fails to respond to the connection attempt, all other
32461 servers are tried until one succeeds. If no server responds, the &%spam%&
32462 condition defers.
32463
32464 Unix and TCP socket specifications may be mixed in any order.
32465 Each element of the list is a list itself, space-separated by default
32466 and changeable in the usual way; take care to not double the separator.
32467
32468 For TCP socket specifications a host name or IP (v4 or v6, but
32469 subject to list-separator quoting rules) address can be used,
32470 and the port can be one or a dash-separated pair.
32471 In the latter case, the range is tried in strict order.
32472
32473 Elements after the first for Unix sockets, or second for TCP socket,
32474 are options.
32475 The supported options are:
32476 .code
32477 pri=<priority>      Selection priority
32478 weight=<value>      Selection bias
32479 time=<start>-<end>  Use only between these times of day
32480 retry=<timespec>    Retry on connect fail
32481 tmo=<timespec>      Connection time limit
32482 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
32483 .endd
32484
32485 The &`pri`& option specifies a priority for the server within the list,
32486 higher values being tried first.
32487 The default priority is 1.
32488
32489 The &`weight`& option specifies a selection bias.
32490 Within a priority set
32491 servers are queried in a random fashion, weighted by this value.
32492 The default value for selection bias is 1.
32493
32494 Time specifications for the &`time`& option are <hour>.<minute>.<second>
32495 in the local time zone; each element being one or more digits.
32496 Either the seconds or both minutes and seconds, plus the leading &`.`&
32497 characters, may be omitted and will be taken as zero.
32498
32499 Timeout specifications for the &`retry`& and &`tmo`& options
32500 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
32501
32502 The &`tmo`& option specifies an overall timeout for communication.
32503 The default value is two minutes.
32504
32505 The &`retry`& option specifies a time after which a single retry for
32506 a failed connect is made.
32507 The default is to not retry.
32508
32509 The &%spamd_address%& variable is expanded before use if it starts with
32510 a dollar sign. In this case, the expansion may return a string that is
32511 used as the list so that multiple spamd servers can be the result of an
32512 expansion.
32513
32514 .vindex "&$callout_address$&"
32515 When a connection is made to the server the expansion variable &$callout_address$&
32516 is set to record the actual address used.
32517
32518 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
32519 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
32520 .code
32521 deny message = This message was classified as SPAM
32522      spam = joe
32523 .endd
32524 The right-hand side of the &%spam%& condition specifies a name. This is
32525 relevant if you have set up multiple SpamAssassin profiles. If you do not want
32526 to scan using a specific profile, but rather use the SpamAssassin system-wide
32527 default profile, you can scan for an unknown name, or simply use &"nobody"&.
32528 Rspamd does not use this setting. However, you must put something on the
32529 right-hand side.
32530
32531 The name allows you to use per-domain or per-user antispam profiles in
32532 principle, but this is not straightforward in practice, because a message may
32533 have multiple recipients, not necessarily all in the same domain. Because the
32534 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
32535 read the contents of the message, the variables &$local_part$& and &$domain$&
32536 are not set.
32537 Careful enforcement of single-recipient messages
32538 (e.g. by responding with defer in the recipient ACL for all recipients
32539 after the first),
32540 or the use of PRDR,
32541 .cindex "PRDR" "use for per-user SpamAssassin profiles"
32542 are needed to use this feature.
32543
32544 The right-hand side of the &%spam%& condition is expanded before being used, so
32545 you can put lookups or conditions there. When the right-hand side evaluates to
32546 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
32547
32548
32549 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
32550 large ones may cause significant performance degradation. As most spam messages
32551 are quite small, it is recommended that you do not scan the big ones. For
32552 example:
32553 .code
32554 deny message = This message was classified as SPAM
32555      condition = ${if < {$message_size}{10K}}
32556      spam = nobody
32557 .endd
32558
32559 The &%spam%& condition returns true if the threshold specified in the user's
32560 SpamAssassin profile has been matched or exceeded. If you want to use the
32561 &%spam%& condition for its side effects (see the variables below), you can make
32562 it always return &"true"& by appending &`:true`& to the username.
32563
32564 .cindex "spam scanning" "returned variables"
32565 When the &%spam%& condition is run, it sets up a number of expansion
32566 variables.
32567 Except for &$spam_report$&,
32568 these variables are saved with the received message so are
32569 available for use at delivery time.
32570
32571 .vlist
32572 .vitem &$spam_score$&
32573 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
32574 for inclusion in log or reject messages.
32575
32576 .vitem &$spam_score_int$&
32577 The spam score of the message, multiplied by ten, as an integer value. For
32578 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
32579 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
32580 The integer value is useful for numeric comparisons in conditions.
32581
32582 .vitem &$spam_bar$&
32583 A string consisting of a number of &"+"& or &"-"& characters, representing the
32584 integer part of the spam score value. A spam score of 4.4 would have a
32585 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
32586 headers, since MUAs can match on such strings. The maximum length of the
32587 spam bar is 50 characters.
32588
32589 .vitem &$spam_report$&
32590 A multiline text table, containing the full SpamAssassin report for the
32591 message. Useful for inclusion in headers or reject messages.
32592 This variable is only usable in a DATA-time ACL.
32593 Beware that SpamAssassin may return non-ASCII characters, especially
32594 when running in country-specific locales, which are not legal
32595 unencoded in headers.
32596
32597 .vitem &$spam_action$&
32598 For SpamAssassin either 'reject' or 'no action' depending on the
32599 spam score versus threshold.
32600 For Rspamd, the recommended action.
32601
32602 .endlist
32603
32604 The &%spam%& condition caches its results unless expansion in
32605 spamd_address was used. If you call it again with the same user name, it
32606 does not scan again, but rather returns the same values as before.
32607
32608 The &%spam%& condition returns DEFER if there is any error while running
32609 the message through SpamAssassin or if the expansion of spamd_address
32610 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
32611 statement block), append &`/defer_ok`& to the right-hand side of the
32612 spam condition, like this:
32613 .code
32614 deny message = This message was classified as SPAM
32615      spam    = joe/defer_ok
32616 .endd
32617 This causes messages to be accepted even if there is a problem with &%spamd%&.
32618
32619 Here is a longer, commented example of the use of the &%spam%&
32620 condition:
32621 .code
32622 # put headers in all messages (no matter if spam or not)
32623 warn  spam = nobody:true
32624       add_header = X-Spam-Score: $spam_score ($spam_bar)
32625       add_header = X-Spam-Report: $spam_report
32626
32627 # add second subject line with *SPAM* marker when message
32628 # is over threshold
32629 warn  spam = nobody
32630       add_header = Subject: *SPAM* $h_Subject:
32631
32632 # reject spam at high scores (> 12)
32633 deny  message = This message scored $spam_score spam points.
32634       spam = nobody:true
32635       condition = ${if >{$spam_score_int}{120}{1}{0}}
32636 .endd
32637
32638
32639
32640 .section "Scanning MIME parts" "SECTscanmimepart"
32641 .cindex "content scanning" "MIME parts"
32642 .cindex "MIME content scanning"
32643 .oindex "&%acl_smtp_mime%&"
32644 .oindex "&%acl_not_smtp_mime%&"
32645 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
32646 each MIME part of an SMTP message, including multipart types, in the sequence
32647 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
32648 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
32649 options may both refer to the same ACL if you want the same processing in both
32650 cases.
32651
32652 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
32653 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
32654 the case of a non-SMTP message. However, a MIME ACL is called only if the
32655 message contains a &'Content-Type:'& header line. When a call to a MIME
32656 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
32657 result code is sent to the client. In the case of an SMTP message, the
32658 &%acl_smtp_data%& ACL is not called when this happens.
32659
32660 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
32661 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
32662 condition to match against the raw MIME part. You can also use the
32663 &%mime_regex%& condition to match against the decoded MIME part (see section
32664 &<<SECTscanregex>>&).
32665
32666 At the start of a MIME ACL, a number of variables are set from the header
32667 information for the relevant MIME part. These are described below. The contents
32668 of the MIME part are not by default decoded into a disk file except for MIME
32669 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
32670 part into a disk file, you can use the &%decode%& condition. The general
32671 syntax is:
32672 .display
32673 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
32674 .endd
32675 The right hand side is expanded before use. After expansion,
32676 the value can be:
32677
32678 .olist
32679 &"0"& or &"false"&, in which case no decoding is done.
32680 .next
32681 The string &"default"&. In that case, the file is put in the temporary
32682 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
32683 a sequential file name consisting of the message id and a sequence number. The
32684 full path and name is available in &$mime_decoded_filename$& after decoding.
32685 .next
32686 A full path name starting with a slash. If the full name is an existing
32687 directory, it is used as a replacement for the default directory. The filename
32688 is then sequentially assigned. If the path does not exist, it is used as
32689 the full path and file name.
32690 .next
32691 If the string does not start with a slash, it is used as the
32692 filename, and the default path is then used.
32693 .endlist
32694 The &%decode%& condition normally succeeds. It is only false for syntax
32695 errors or unusual circumstances such as memory shortages. You can easily decode
32696 a file with its original, proposed filename using
32697 .code
32698 decode = $mime_filename
32699 .endd
32700 However, you should keep in mind that &$mime_filename$& might contain
32701 anything. If you place files outside of the default path, they are not
32702 automatically unlinked.
32703
32704 For RFC822 attachments (these are messages attached to messages, with a
32705 content-type of &"message/rfc822"&), the ACL is called again in the same manner
32706 as for the primary message, only that the &$mime_is_rfc822$& expansion
32707 variable is set (see below). Attached messages are always decoded to disk
32708 before being checked, and the files are unlinked once the check is done.
32709
32710 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
32711 used to match regular expressions against raw and decoded MIME parts,
32712 respectively. They are described in section &<<SECTscanregex>>&.
32713
32714 .cindex "MIME content scanning" "returned variables"
32715 The following list describes all expansion variables that are
32716 available in the MIME ACL:
32717
32718 .vlist
32719 .vitem &$mime_boundary$&
32720 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
32721 have a boundary string, which is stored in this variable. If the current part
32722 has no boundary parameter in the &'Content-Type:'& header, this variable
32723 contains the empty string.
32724
32725 .vitem &$mime_charset$&
32726 This variable contains the character set identifier, if one was found in the
32727 &'Content-Type:'& header. Examples for charset identifiers are:
32728 .code
32729 us-ascii
32730 gb2312 (Chinese)
32731 iso-8859-1
32732 .endd
32733 Please note that this value is not normalized, so you should do matches
32734 case-insensitively.
32735
32736 .vitem &$mime_content_description$&
32737 This variable contains the normalized content of the &'Content-Description:'&
32738 header. It can contain a human-readable description of the parts content. Some
32739 implementations repeat the filename for attachments here, but they are usually
32740 only used for display purposes.
32741
32742 .vitem &$mime_content_disposition$&
32743 This variable contains the normalized content of the &'Content-Disposition:'&
32744 header. You can expect strings like &"attachment"& or &"inline"& here.
32745
32746 .vitem &$mime_content_id$&
32747 This variable contains the normalized content of the &'Content-ID:'& header.
32748 This is a unique ID that can be used to reference a part from another part.
32749
32750 .vitem &$mime_content_size$&
32751 This variable is set only after the &%decode%& modifier (see above) has been
32752 successfully run. It contains the size of the decoded part in kilobytes. The
32753 size is always rounded up to full kilobytes, so only a completely empty part
32754 has a &$mime_content_size$& of zero.
32755
32756 .vitem &$mime_content_transfer_encoding$&
32757 This variable contains the normalized content of the
32758 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
32759 type. Typical values are &"base64"& and &"quoted-printable"&.
32760
32761 .vitem &$mime_content_type$&
32762 If the MIME part has a &'Content-Type:'& header, this variable contains its
32763 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
32764 are some examples of popular MIME types, as they may appear in this variable:
32765 .code
32766 text/plain
32767 text/html
32768 application/octet-stream
32769 image/jpeg
32770 audio/midi
32771 .endd
32772 If the MIME part has no &'Content-Type:'& header, this variable contains the
32773 empty string.
32774
32775 .vitem &$mime_decoded_filename$&
32776 This variable is set only after the &%decode%& modifier (see above) has been
32777 successfully run. It contains the full path and file name of the file
32778 containing the decoded data.
32779 .endlist
32780
32781 .cindex "RFC 2047"
32782 .vlist
32783 .vitem &$mime_filename$&
32784 This is perhaps the most important of the MIME variables. It contains a
32785 proposed filename for an attachment, if one was found in either the
32786 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
32787 RFC2047
32788 or RFC2231
32789 decoded, but no additional sanity checks are done.
32790  If no filename was
32791 found, this variable contains the empty string.
32792
32793 .vitem &$mime_is_coverletter$&
32794 This variable attempts to differentiate the &"cover letter"& of an e-mail from
32795 attached data. It can be used to clamp down on flashy or unnecessarily encoded
32796 content in the cover letter, while not restricting attachments at all.
32797
32798 The variable contains 1 (true) for a MIME part believed to be part of the
32799 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
32800 follows:
32801
32802 .olist
32803 The outermost MIME part of a message is always a cover letter.
32804
32805 .next
32806 If a multipart/alternative or multipart/related MIME part is a cover letter,
32807 so are all MIME subparts within that multipart.
32808
32809 .next
32810 If any other multipart is a cover letter, the first subpart is a cover letter,
32811 and the rest are attachments.
32812
32813 .next
32814 All parts contained within an attachment multipart are attachments.
32815 .endlist olist
32816
32817 As an example, the following will ban &"HTML mail"& (including that sent with
32818 alternative plain text), while allowing HTML files to be attached. HTML
32819 coverletter mail attached to non-HTML coverletter mail will also be allowed:
32820 .code
32821 deny message = HTML mail is not accepted here
32822 !condition = $mime_is_rfc822
32823 condition = $mime_is_coverletter
32824 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
32825 .endd
32826 .vitem &$mime_is_multipart$&
32827 This variable has the value 1 (true) when the current part has the main type
32828 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
32829 Since multipart entities only serve as containers for other parts, you may not
32830 want to carry out specific actions on them.
32831
32832 .vitem &$mime_is_rfc822$&
32833 This variable has the value 1 (true) if the current part is not a part of the
32834 checked message itself, but part of an attached message. Attached message
32835 decoding is fully recursive.
32836
32837 .vitem &$mime_part_count$&
32838 This variable is a counter that is raised for each processed MIME part. It
32839 starts at zero for the very first part (which is usually a multipart). The
32840 counter is per-message, so it is reset when processing RFC822 attachments (see
32841 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
32842 complete, so you can use it in the DATA ACL to determine the number of MIME
32843 parts of a message. For non-MIME messages, this variable contains the value -1.
32844 .endlist
32845
32846
32847
32848 .section "Scanning with regular expressions" "SECTscanregex"
32849 .cindex "content scanning" "with regular expressions"
32850 .cindex "regular expressions" "content scanning with"
32851 You can specify your own custom regular expression matches on the full body of
32852 the message, or on individual MIME parts.
32853
32854 The &%regex%& condition takes one or more regular expressions as arguments and
32855 matches them against the full message (when called in the DATA ACL) or a raw
32856 MIME part (when called in the MIME ACL). The &%regex%& condition matches
32857 linewise, with a maximum line length of 32K characters. That means you cannot
32858 have multiline matches with the &%regex%& condition.
32859
32860 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
32861 to 32K of decoded content (the whole content at once, not linewise). If the
32862 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
32863 is decoded automatically when &%mime_regex%& is executed (using default path
32864 and filename values). If the decoded data is larger than  32K, only the first
32865 32K characters are checked.
32866
32867 The regular expressions are passed as a colon-separated list. To include a
32868 literal colon, you must double it. Since the whole right-hand side string is
32869 expanded before being used, you must also escape dollar signs and backslashes
32870 with more backslashes, or use the &`\N`& facility to disable expansion.
32871 Here is a simple example that contains two regular expressions:
32872 .code
32873 deny message = contains blacklisted regex ($regex_match_string)
32874      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
32875 .endd
32876 The conditions returns true if any one of the regular expressions matches. The
32877 &$regex_match_string$& expansion variable is then set up and contains the
32878 matching regular expression.
32879 The expansion variables &$regex1$& &$regex2$& etc
32880 are set to any substrings captured by the regular expression.
32881
32882 &*Warning*&: With large messages, these conditions can be fairly
32883 CPU-intensive.
32884
32885 .ecindex IIDcosca
32886
32887
32888
32889
32890 . ////////////////////////////////////////////////////////////////////////////
32891 . ////////////////////////////////////////////////////////////////////////////
32892
32893 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
32894          "Local scan function"
32895 .scindex IIDlosca "&[local_scan()]& function" "description of"
32896 .cindex "customizing" "input scan using C function"
32897 .cindex "policy control" "by local scan function"
32898 In these days of email worms, viruses, and ever-increasing spam, some sites
32899 want to apply a lot of checking to messages before accepting them.
32900
32901 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
32902 passing messages to external virus and spam scanning software. You can also do
32903 a certain amount in Exim itself through string expansions and the &%condition%&
32904 condition in the ACL that runs after the SMTP DATA command or the ACL for
32905 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
32906
32907 To allow for further customization to a site's own requirements, there is the
32908 possibility of linking Exim with a private message scanning function, written
32909 in C. If you want to run code that is written in something other than C, you
32910 can of course use a little C stub to call it.
32911
32912 The local scan function is run once for every incoming message, at the point
32913 when Exim is just about to accept the message.
32914 It can therefore be used to control non-SMTP messages from local processes as
32915 well as messages arriving via SMTP.
32916
32917 Exim applies a timeout to calls of the local scan function, and there is an
32918 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
32919 Zero means &"no timeout"&.
32920 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
32921 before calling the local scan function, so that the most common types of crash
32922 are caught. If the timeout is exceeded or one of those signals is caught, the
32923 incoming message is rejected with a temporary error if it is an SMTP message.
32924 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
32925 code. The incident is logged on the main and reject logs.
32926
32927
32928
32929 .section "Building Exim to use a local scan function" "SECID207"
32930 .cindex "&[local_scan()]& function" "building Exim to use"
32931 To make use of the local scan function feature, you must tell Exim where your
32932 function is before building Exim, by setting
32933 .new
32934 both HAVE_LOCAL_SCAN and
32935 .wen
32936 LOCAL_SCAN_SOURCE in your
32937 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
32938 directory, so you might set
32939 .code
32940 HAVE_LOCAL_SCAN=yes
32941 LOCAL_SCAN_SOURCE=Local/local_scan.c
32942 .endd
32943 for example. The function must be called &[local_scan()]&. It is called by
32944 Exim after it has received a message, when the success return code is about to
32945 be sent. This is after all the ACLs have been run. The return code from your
32946 function controls whether the message is actually accepted or not. There is a
32947 commented template function (that just accepts the message) in the file
32948 _src/local_scan.c_.
32949
32950 If you want to make use of Exim's run time configuration file to set options
32951 for your &[local_scan()]& function, you must also set
32952 .code
32953 LOCAL_SCAN_HAS_OPTIONS=yes
32954 .endd
32955 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
32956
32957
32958
32959
32960 .section "API for local_scan()" "SECTapiforloc"
32961 .cindex "&[local_scan()]& function" "API description"
32962 You must include this line near the start of your code:
32963 .code
32964 #include "local_scan.h"
32965 .endd
32966 This header file defines a number of variables and other values, and the
32967 prototype for the function itself. Exim is coded to use unsigned char values
32968 almost exclusively, and one of the things this header defines is a shorthand
32969 for &`unsigned char`& called &`uschar`&.
32970 It also contains the following macro definitions, to simplify casting character
32971 strings and pointers to character strings:
32972 .code
32973 #define CS   (char *)
32974 #define CCS  (const char *)
32975 #define CSS  (char **)
32976 #define US   (unsigned char *)
32977 #define CUS  (const unsigned char *)
32978 #define USS  (unsigned char **)
32979 .endd
32980 The function prototype for &[local_scan()]& is:
32981 .code
32982 extern int local_scan(int fd, uschar **return_text);
32983 .endd
32984 The arguments are as follows:
32985
32986 .ilist
32987 &%fd%& is a file descriptor for the file that contains the body of the message
32988 (the -D file). The file is open for reading and writing, but updating it is not
32989 recommended. &*Warning*&: You must &'not'& close this file descriptor.
32990
32991 The descriptor is positioned at character 19 of the file, which is the first
32992 character of the body itself, because the first 19 characters are the message
32993 id followed by &`-D`& and a newline. If you rewind the file, you should use the
32994 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
32995 case this changes in some future version.
32996 .next
32997 &%return_text%& is an address which you can use to return a pointer to a text
32998 string at the end of the function. The value it points to on entry is NULL.
32999 .endlist
33000
33001 The function must return an &%int%& value which is one of the following macros:
33002
33003 .vlist
33004 .vitem &`LOCAL_SCAN_ACCEPT`&
33005 .vindex "&$local_scan_data$&"
33006 The message is accepted. If you pass back a string of text, it is saved with
33007 the message, and made available in the variable &$local_scan_data$&. No
33008 newlines are permitted (if there are any, they are turned into spaces) and the
33009 maximum length of text is 1000 characters.
33010
33011 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
33012 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33013 queued without immediate delivery, and is frozen.
33014
33015 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
33016 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33017 queued without immediate delivery.
33018
33019 .vitem &`LOCAL_SCAN_REJECT`&
33020 The message is rejected; the returned text is used as an error message which is
33021 passed back to the sender and which is also logged. Newlines are permitted &--
33022 they cause a multiline response for SMTP rejections, but are converted to
33023 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
33024 used.
33025
33026 .vitem &`LOCAL_SCAN_TEMPREJECT`&
33027 The message is temporarily rejected; the returned text is used as an error
33028 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
33029 problem"& is used.
33030
33031 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
33032 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
33033 message is not written to the reject log. It has the effect of unsetting the
33034 &%rejected_header%& log selector for just this rejection. If
33035 &%rejected_header%& is already unset (see the discussion of the
33036 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
33037 same as LOCAL_SCAN_REJECT.
33038
33039 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
33040 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
33041 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
33042 .endlist
33043
33044 If the message is not being received by interactive SMTP, rejections are
33045 reported by writing to &%stderr%& or by sending an email, as configured by the
33046 &%-oe%& command line options.
33047
33048
33049
33050 .section "Configuration options for local_scan()" "SECTconoptloc"
33051 .cindex "&[local_scan()]& function" "configuration options"
33052 It is possible to have option settings in the main configuration file
33053 that set values in static variables in the &[local_scan()]& module. If you
33054 want to do this, you must have the line
33055 .code
33056 LOCAL_SCAN_HAS_OPTIONS=yes
33057 .endd
33058 in your &_Local/Makefile_& when you build Exim. (This line is in
33059 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
33060 file, you must define static variables to hold the option values, and a table
33061 to define them.
33062
33063 The table must be a vector called &%local_scan_options%&, of type
33064 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
33065 and a pointer to the variable that holds the value. The entries must appear in
33066 alphabetical order. Following &%local_scan_options%& you must also define a
33067 variable called &%local_scan_options_count%& that contains the number of
33068 entries in the table. Here is a short example, showing two kinds of option:
33069 .code
33070 static int my_integer_option = 42;
33071 static uschar *my_string_option = US"a default string";
33072
33073 optionlist local_scan_options[] = {
33074   { "my_integer", opt_int,       &my_integer_option },
33075   { "my_string",  opt_stringptr, &my_string_option }
33076 };
33077
33078 int local_scan_options_count =
33079   sizeof(local_scan_options)/sizeof(optionlist);
33080 .endd
33081 The values of the variables can now be changed from Exim's runtime
33082 configuration file by including a local scan section as in this example:
33083 .code
33084 begin local_scan
33085 my_integer = 99
33086 my_string = some string of text...
33087 .endd
33088 The available types of option data are as follows:
33089
33090 .vlist
33091 .vitem &*opt_bool*&
33092 This specifies a boolean (true/false) option. The address should point to a
33093 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
33094 that are defined as &"1"& and &"0"&, respectively. If you want to detect
33095 whether such a variable has been set at all, you can initialize it to
33096 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
33097 values.)
33098
33099 .vitem &*opt_fixed*&
33100 This specifies a fixed point number, such as is used for load averages.
33101 The address should point to a variable of type &`int`&. The value is stored
33102 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
33103
33104 .vitem &*opt_int*&
33105 This specifies an integer; the address should point to a variable of type
33106 &`int`&. The value may be specified in any of the integer formats accepted by
33107 Exim.
33108
33109 .vitem &*opt_mkint*&
33110 This is the same as &%opt_int%&, except that when such a value is output in a
33111 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
33112 printed with the suffix K or M.
33113
33114 .vitem &*opt_octint*&
33115 This also specifies an integer, but the value is always interpreted as an
33116 octal integer, whether or not it starts with the digit zero, and it is
33117 always output in octal.
33118
33119 .vitem &*opt_stringptr*&
33120 This specifies a string value; the address must be a pointer to a
33121 variable that points to a string (for example, of type &`uschar *`&).
33122
33123 .vitem &*opt_time*&
33124 This specifies a time interval value. The address must point to a variable of
33125 type &`int`&. The value that is placed there is a number of seconds.
33126 .endlist
33127
33128 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
33129 out the values of all the &[local_scan()]& options.
33130
33131
33132
33133 .section "Available Exim variables" "SECID208"
33134 .cindex "&[local_scan()]& function" "available Exim variables"
33135 The header &_local_scan.h_& gives you access to a number of C variables. These
33136 are the only ones that are guaranteed to be maintained from release to release.
33137 Note, however, that you can obtain the value of any Exim expansion variable,
33138 including &$recipients$&, by calling &'expand_string()'&. The exported
33139 C variables are as follows:
33140
33141 .vlist
33142 .vitem &*int&~body_linecount*&
33143 This variable contains the number of lines in the message's body.
33144 It is not valid if the &%spool_files_wireformat%& option is used.
33145
33146 .vitem &*int&~body_zerocount*&
33147 This variable contains the number of binary zero bytes in the message's body.
33148 It is not valid if the &%spool_files_wireformat%& option is used.
33149
33150 .vitem &*unsigned&~int&~debug_selector*&
33151 This variable is set to zero when no debugging is taking place. Otherwise, it
33152 is a bitmap of debugging selectors. Two bits are identified for use in
33153 &[local_scan()]&; they are defined as macros:
33154
33155 .ilist
33156 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
33157 testing option that is not privileged &-- any caller may set it. All the
33158 other selector bits can be set only by admin users.
33159
33160 .next
33161 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
33162 by the &`+local_scan`& debug selector. It is not included in the default set
33163 of debugging bits.
33164 .endlist ilist
33165
33166 Thus, to write to the debugging output only when &`+local_scan`& has been
33167 selected, you should use code like this:
33168 .code
33169 if ((debug_selector & D_local_scan) != 0)
33170   debug_printf("xxx", ...);
33171 .endd
33172 .vitem &*uschar&~*expand_string_message*&
33173 After a failing call to &'expand_string()'& (returned value NULL), the
33174 variable &%expand_string_message%& contains the error message, zero-terminated.
33175
33176 .vitem &*header_line&~*header_list*&
33177 A pointer to a chain of header lines. The &%header_line%& structure is
33178 discussed below.
33179
33180 .vitem &*header_line&~*header_last*&
33181 A pointer to the last of the header lines.
33182
33183 .vitem &*uschar&~*headers_charset*&
33184 The value of the &%headers_charset%& configuration option.
33185
33186 .vitem &*BOOL&~host_checking*&
33187 This variable is TRUE during a host checking session that is initiated by the
33188 &%-bh%& command line option.
33189
33190 .vitem &*uschar&~*interface_address*&
33191 The IP address of the interface that received the message, as a string. This
33192 is NULL for locally submitted messages.
33193
33194 .vitem &*int&~interface_port*&
33195 The port on which this message was received. When testing with the &%-bh%&
33196 command line option, the value of this variable is -1 unless a port has been
33197 specified via the &%-oMi%& option.
33198
33199 .vitem &*uschar&~*message_id*&
33200 This variable contains Exim's message id for the incoming message (the value of
33201 &$message_exim_id$&) as a zero-terminated string.
33202
33203 .vitem &*uschar&~*received_protocol*&
33204 The name of the protocol by which the message was received.
33205
33206 .vitem &*int&~recipients_count*&
33207 The number of accepted recipients.
33208
33209 .vitem &*recipient_item&~*recipients_list*&
33210 .cindex "recipient" "adding in local scan"
33211 .cindex "recipient" "removing in local scan"
33212 The list of accepted recipients, held in a vector of length
33213 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
33214 can add additional recipients by calling &'receive_add_recipient()'& (see
33215 below). You can delete recipients by removing them from the vector and
33216 adjusting the value in &%recipients_count%&. In particular, by setting
33217 &%recipients_count%& to zero you remove all recipients. If you then return the
33218 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
33219 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
33220 and then call &'receive_add_recipient()'& as often as needed.
33221
33222 .vitem &*uschar&~*sender_address*&
33223 The envelope sender address. For bounce messages this is the empty string.
33224
33225 .vitem &*uschar&~*sender_host_address*&
33226 The IP address of the sending host, as a string. This is NULL for
33227 locally-submitted messages.
33228
33229 .vitem &*uschar&~*sender_host_authenticated*&
33230 The name of the authentication mechanism that was used, or NULL if the message
33231 was not received over an authenticated SMTP connection.
33232
33233 .vitem &*uschar&~*sender_host_name*&
33234 The name of the sending host, if known.
33235
33236 .vitem &*int&~sender_host_port*&
33237 The port on the sending host.
33238
33239 .vitem &*BOOL&~smtp_input*&
33240 This variable is TRUE for all SMTP input, including BSMTP.
33241
33242 .vitem &*BOOL&~smtp_batched_input*&
33243 This variable is TRUE for BSMTP input.
33244
33245 .vitem &*int&~store_pool*&
33246 The contents of this variable control which pool of memory is used for new
33247 requests. See section &<<SECTmemhanloc>>& for details.
33248 .endlist
33249
33250
33251 .section "Structure of header lines" "SECID209"
33252 The &%header_line%& structure contains the members listed below.
33253 You can add additional header lines by calling the &'header_add()'& function
33254 (see below). You can cause header lines to be ignored (deleted) by setting
33255 their type to *.
33256
33257
33258 .vlist
33259 .vitem &*struct&~header_line&~*next*&
33260 A pointer to the next header line, or NULL for the last line.
33261
33262 .vitem &*int&~type*&
33263 A code identifying certain headers that Exim recognizes. The codes are printing
33264 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
33265 Notice in particular that any header line whose type is * is not transmitted
33266 with the message. This flagging is used for header lines that have been
33267 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
33268 lines.) Effectively, * means &"deleted"&.
33269
33270 .vitem &*int&~slen*&
33271 The number of characters in the header line, including the terminating and any
33272 internal newlines.
33273
33274 .vitem &*uschar&~*text*&
33275 A pointer to the text of the header. It always ends with a newline, followed by
33276 a zero byte. Internal newlines are preserved.
33277 .endlist
33278
33279
33280
33281 .section "Structure of recipient items" "SECID210"
33282 The &%recipient_item%& structure contains these members:
33283
33284 .vlist
33285 .vitem &*uschar&~*address*&
33286 This is a pointer to the recipient address as it was received.
33287
33288 .vitem &*int&~pno*&
33289 This is used in later Exim processing when top level addresses are created by
33290 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
33291 and must always contain -1 at this stage.
33292
33293 .vitem &*uschar&~*errors_to*&
33294 If this value is not NULL, bounce messages caused by failing to deliver to the
33295 recipient are sent to the address it contains. In other words, it overrides the
33296 envelope sender for this one recipient. (Compare the &%errors_to%& generic
33297 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
33298 an unqualified address, Exim qualifies it using the domain from
33299 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
33300 is NULL for all recipients.
33301 .endlist
33302
33303
33304
33305 .section "Available Exim functions" "SECID211"
33306 .cindex "&[local_scan()]& function" "available Exim functions"
33307 The header &_local_scan.h_& gives you access to a number of Exim functions.
33308 These are the only ones that are guaranteed to be maintained from release to
33309 release:
33310
33311 .vlist
33312 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
33313        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
33314
33315 This function creates a child process that runs the command specified by
33316 &%argv%&. The environment for the process is specified by &%envp%&, which can
33317 be NULL if no environment variables are to be passed. A new umask is supplied
33318 for the process in &%newumask%&.
33319
33320 Pipes to the standard input and output of the new process are set up
33321 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
33322 standard error is cloned to the standard output. If there are any file
33323 descriptors &"in the way"& in the new process, they are closed. If the final
33324 argument is TRUE, the new process is made into a process group leader.
33325
33326 The function returns the pid of the new process, or -1 if things go wrong.
33327
33328 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
33329 This function waits for a child process to terminate, or for a timeout (in
33330 seconds) to expire. A timeout value of zero means wait as long as it takes. The
33331 return value is as follows:
33332
33333 .ilist
33334 >= 0
33335
33336 The process terminated by a normal exit and the value is the process
33337 ending status.
33338
33339 .next
33340 < 0 and > &--256
33341
33342 The process was terminated by a signal and the value is the negation of the
33343 signal number.
33344
33345 .next
33346 &--256
33347
33348 The process timed out.
33349 .next
33350 &--257
33351
33352 The was some other error in wait(); &%errno%& is still set.
33353 .endlist
33354
33355 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
33356 This function provide you with a means of submitting a new message to
33357 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
33358 want, but this packages it all up for you.) The function creates a pipe,
33359 forks a subprocess that is running
33360 .code
33361 exim -t -oem -oi -f <>
33362 .endd
33363 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
33364 that is connected to the standard input. The yield of the function is the PID
33365 of the subprocess. You can then write a message to the file descriptor, with
33366 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
33367
33368 When you have finished, call &'child_close()'& to wait for the process to
33369 finish and to collect its ending status. A timeout value of zero is usually
33370 fine in this circumstance. Unless you have made a mistake with the recipient
33371 addresses, you should get a return code of zero.
33372
33373
33374 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
33375        *sender_authentication)*&
33376 This function is a more sophisticated version of &'child_open()'&. The command
33377 that it runs is:
33378 .display
33379 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
33380 .endd
33381 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
33382
33383
33384 .vitem &*void&~debug_printf(char&~*,&~...)*&
33385 This is Exim's debugging function, with arguments as for &'(printf()'&. The
33386 output is written to the standard error stream. If no debugging is selected,
33387 calls to &'debug_printf()'& have no effect. Normally, you should make calls
33388 conditional on the &`local_scan`& debug selector by coding like this:
33389 .code
33390 if ((debug_selector & D_local_scan) != 0)
33391   debug_printf("xxx", ...);
33392 .endd
33393
33394 .vitem &*uschar&~*expand_string(uschar&~*string)*&
33395 This is an interface to Exim's string expansion code. The return value is the
33396 expanded string, or NULL if there was an expansion failure.
33397 The C variable &%expand_string_message%& contains an error message after an
33398 expansion failure. If expansion does not change the string, the return value is
33399 the pointer to the input string. Otherwise, the return value points to a new
33400 block of memory that was obtained by a call to &'store_get()'&. See section
33401 &<<SECTmemhanloc>>& below for a discussion of memory handling.
33402
33403 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
33404 This function allows you to an add additional header line at the end of the
33405 existing ones. The first argument is the type, and should normally be a space
33406 character. The second argument is a format string and any number of
33407 substitution arguments as for &[sprintf()]&. You may include internal newlines
33408 if you want, and you must ensure that the string ends with a newline.
33409
33410 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
33411         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
33412 This function adds a new header line at a specified point in the header
33413 chain. The header itself is specified as for &'header_add()'&.
33414
33415 If &%name%& is NULL, the new header is added at the end of the chain if
33416 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
33417 NULL, the header lines are searched for the first non-deleted header that
33418 matches the name. If one is found, the new header is added before it if
33419 &%after%& is false. If &%after%& is true, the new header is added after the
33420 found header and any adjacent subsequent ones with the same name (even if
33421 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
33422 option controls where the header is added. If it is true, addition is at the
33423 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
33424 headers, or at the top if there are no &'Received:'& headers, you could use
33425 .code
33426 header_add_at_position(TRUE, US"Received", TRUE,
33427   ' ', "X-xxx: ...");
33428 .endd
33429 Normally, there is always at least one non-deleted &'Received:'& header, but
33430 there may not be if &%received_header_text%& expands to an empty string.
33431
33432
33433 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
33434 This function removes header lines. If &%occurrence%& is zero or negative, all
33435 occurrences of the header are removed. If occurrence is greater than zero, that
33436 particular instance of the header is removed. If no header(s) can be found that
33437 match the specification, the function does nothing.
33438
33439
33440 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
33441         int&~length,&~BOOL&~notdel)*&"
33442 This function tests whether the given header has the given name. It is not just
33443 a string comparison, because white space is permitted between the name and the
33444 colon. If the &%notdel%& argument is true, a false return is forced for all
33445 &"deleted"& headers; otherwise they are not treated specially. For example:
33446 .code
33447 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
33448 .endd
33449 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
33450 .cindex "base64 encoding" "functions for &[local_scan()]& use"
33451 This function base64-encodes a string, which is passed by address and length.
33452 The text may contain bytes of any value, including zero. The result is passed
33453 back in dynamic memory that is obtained by calling &'store_get()'&. It is
33454 zero-terminated.
33455
33456 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
33457 This function decodes a base64-encoded string. Its arguments are a
33458 zero-terminated base64-encoded string and the address of a variable that is set
33459 to point to the result, which is in dynamic memory. The length of the decoded
33460 string is the yield of the function. If the input is invalid base64 data, the
33461 yield is -1. A zero byte is added to the end of the output string to make it
33462 easy to interpret as a C string (assuming it contains no zeros of its own). The
33463 added zero byte is not included in the returned count.
33464
33465 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
33466 This function checks for a match in a domain list. Domains are always
33467 matched caselessly. The return value is one of the following:
33468 .display
33469 &`OK     `& match succeeded
33470 &`FAIL   `& match failed
33471 &`DEFER  `& match deferred
33472 .endd
33473 DEFER is usually caused by some kind of lookup defer, such as the
33474 inability to contact a database.
33475
33476 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
33477         BOOL&~caseless)*&"
33478 This function checks for a match in a local part list. The third argument
33479 controls case-sensitivity. The return values are as for
33480 &'lss_match_domain()'&.
33481
33482 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
33483         BOOL&~caseless)*&"
33484 This function checks for a match in an address list. The third argument
33485 controls the case-sensitivity of the local part match. The domain is always
33486 matched caselessly. The return values are as for &'lss_match_domain()'&.
33487
33488 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
33489         uschar&~*list)*&"
33490 This function checks for a match in a host list. The most common usage is
33491 expected to be
33492 .code
33493 lss_match_host(sender_host_name, sender_host_address, ...)
33494 .endd
33495 .vindex "&$sender_host_address$&"
33496 An empty address field matches an empty item in the host list. If the host name
33497 is NULL, the name corresponding to &$sender_host_address$& is automatically
33498 looked up if a host name is required to match an item in the list. The return
33499 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
33500 returns ERROR in the case when it had to look up a host name, but the lookup
33501 failed.
33502
33503 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
33504         *format,&~...)*&"
33505 This function writes to Exim's log files. The first argument should be zero (it
33506 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
33507 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
33508 them. It specifies to which log or logs the message is written. The remaining
33509 arguments are a format and relevant insertion arguments. The string should not
33510 contain any newlines, not even at the end.
33511
33512
33513 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
33514 This function adds an additional recipient to the message. The first argument
33515 is the recipient address. If it is unqualified (has no domain), it is qualified
33516 with the &%qualify_recipient%& domain. The second argument must always be -1.
33517
33518 This function does not allow you to specify a private &%errors_to%& address (as
33519 described with the structure of &%recipient_item%& above), because it pre-dates
33520 the addition of that field to the structure. However, it is easy to add such a
33521 value afterwards. For example:
33522 .code
33523  receive_add_recipient(US"monitor@mydom.example", -1);
33524  recipients_list[recipients_count-1].errors_to =
33525    US"postmaster@mydom.example";
33526 .endd
33527
33528 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
33529 This is a convenience function to remove a named recipient from the list of
33530 recipients. It returns true if a recipient was removed, and false if no
33531 matching recipient could be found. The argument must be a complete email
33532 address.
33533 .endlist
33534
33535
33536 .cindex "RFC 2047"
33537 .vlist
33538 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
33539   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
33540 This function decodes strings that are encoded according to RFC 2047. Typically
33541 these are the contents of header lines. First, each &"encoded word"& is decoded
33542 from the Q or B encoding into a byte-string. Then, if provided with the name of
33543 a charset encoding, and if the &[iconv()]& function is available, an attempt is
33544 made  to translate the result to the named character set. If this fails, the
33545 binary string is returned with an error message.
33546
33547 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
33548 maximum MIME word length is enforced. The third argument is the target
33549 encoding, or NULL if no translation is wanted.
33550
33551 .cindex "binary zero" "in RFC 2047 decoding"
33552 .cindex "RFC 2047" "binary zero in"
33553 If a binary zero is encountered in the decoded string, it is replaced by the
33554 contents of the &%zeroval%& argument. For use with Exim headers, the value must
33555 not be 0 because header lines are handled as zero-terminated strings.
33556
33557 The function returns the result of processing the string, zero-terminated; if
33558 &%lenptr%& is not NULL, the length of the result is set in the variable to
33559 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
33560
33561 If an error is encountered, the function returns NULL and uses the &%error%&
33562 argument to return an error message. The variable pointed to by &%error%& is
33563 set to NULL if there is no error; it may be set non-NULL even when the function
33564 returns a non-NULL value if decoding was successful, but there was a problem
33565 with translation.
33566
33567
33568 .vitem &*int&~smtp_fflush(void)*&
33569 This function is used in conjunction with &'smtp_printf()'&, as described
33570 below.
33571
33572 .vitem &*void&~smtp_printf(char&~*,&~...)*&
33573 The arguments of this function are like &[printf()]&; it writes to the SMTP
33574 output stream. You should use this function only when there is an SMTP output
33575 stream, that is, when the incoming message is being received via interactive
33576 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
33577 is FALSE. If you want to test for an incoming message from another host (as
33578 opposed to a local process that used the &%-bs%& command line option), you can
33579 test the value of &%sender_host_address%&, which is non-NULL when a remote host
33580 is involved.
33581
33582 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
33583 output function, so it can be used for all forms of SMTP connection.
33584
33585 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
33586 must start with an appropriate response code: 550 if you are going to return
33587 LOCAL_SCAN_REJECT, 451 if you are going to return
33588 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
33589 initial lines of a multi-line response, the code must be followed by a hyphen
33590 to indicate that the line is not the final response line. You must also ensure
33591 that the lines you write terminate with CRLF. For example:
33592 .code
33593 smtp_printf("550-this is some extra info\r\n");
33594 return LOCAL_SCAN_REJECT;
33595 .endd
33596 Note that you can also create multi-line responses by including newlines in
33597 the data returned via the &%return_text%& argument. The added value of using
33598 &'smtp_printf()'& is that, for instance, you could introduce delays between
33599 multiple output lines.
33600
33601 The &'smtp_printf()'& function does not return any error indication, because it
33602 does not automatically flush pending output, and therefore does not test
33603 the state of the stream. (In the main code of Exim, flushing and error
33604 detection is done when Exim is ready for the next SMTP input command.) If
33605 you want to flush the output and check for an error (for example, the
33606 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
33607 arguments. It flushes the output stream, and returns a non-zero value if there
33608 is an error.
33609
33610 .vitem &*void&~*store_get(int)*&
33611 This function accesses Exim's internal store (memory) manager. It gets a new
33612 chunk of memory whose size is given by the argument. Exim bombs out if it ever
33613 runs out of memory. See the next section for a discussion of memory handling.
33614
33615 .vitem &*void&~*store_get_perm(int)*&
33616 This function is like &'store_get()'&, but it always gets memory from the
33617 permanent pool. See the next section for a discussion of memory handling.
33618
33619 .vitem &*uschar&~*string_copy(uschar&~*string)*&
33620 See below.
33621
33622 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
33623 See below.
33624
33625 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
33626 These three functions create strings using Exim's dynamic memory facilities.
33627 The first makes a copy of an entire string. The second copies up to a maximum
33628 number of characters, indicated by the second argument. The third uses a format
33629 and insertion arguments to create a new string. In each case, the result is a
33630 pointer to a new string in the current memory pool. See the next section for
33631 more discussion.
33632 .endlist
33633
33634
33635
33636 .section "More about Exim's memory handling" "SECTmemhanloc"
33637 .cindex "&[local_scan()]& function" "memory handling"
33638 No function is provided for freeing memory, because that is never needed.
33639 The dynamic memory that Exim uses when receiving a message is automatically
33640 recycled if another message is received by the same process (this applies only
33641 to incoming SMTP connections &-- other input methods can supply only one
33642 message at a time). After receiving the last message, a reception process
33643 terminates.
33644
33645 Because it is recycled, the normal dynamic memory cannot be used for holding
33646 data that must be preserved over a number of incoming messages on the same SMTP
33647 connection. However, Exim in fact uses two pools of dynamic memory; the second
33648 one is not recycled, and can be used for this purpose.
33649
33650 If you want to allocate memory that remains available for subsequent messages
33651 in the same SMTP connection, you should set
33652 .code
33653 store_pool = POOL_PERM
33654 .endd
33655 before calling the function that does the allocation. There is no need to
33656 restore the value if you do not need to; however, if you do want to revert to
33657 the normal pool, you can either restore the previous value of &%store_pool%& or
33658 set it explicitly to POOL_MAIN.
33659
33660 The pool setting applies to all functions that get dynamic memory, including
33661 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
33662 There is also a convenience function called &'store_get_perm()'& that gets a
33663 block of memory from the permanent pool while preserving the value of
33664 &%store_pool%&.
33665 .ecindex IIDlosca
33666
33667
33668
33669
33670 . ////////////////////////////////////////////////////////////////////////////
33671 . ////////////////////////////////////////////////////////////////////////////
33672
33673 .chapter "System-wide message filtering" "CHAPsystemfilter"
33674 .scindex IIDsysfil1 "filter" "system filter"
33675 .scindex IIDsysfil2 "filtering all mail"
33676 .scindex IIDsysfil3 "system filter"
33677 The previous chapters (on ACLs and the local scan function) describe checks
33678 that can be applied to messages before they are accepted by a host. There is
33679 also a mechanism for checking messages once they have been received, but before
33680 they are delivered. This is called the &'system filter'&.
33681
33682 The system filter operates in a similar manner to users' filter files, but it
33683 is run just once per message (however many recipients the message has).
33684 It should not normally be used as a substitute for routing, because &%deliver%&
33685 commands in a system router provide new envelope recipient addresses.
33686 The system filter must be an Exim filter. It cannot be a Sieve filter.
33687
33688 The system filter is run at the start of a delivery attempt, before any routing
33689 is done. If a message fails to be completely delivered at the first attempt,
33690 the system filter is run again at the start of every retry.
33691 If you want your filter to do something only once per message, you can make use
33692 of the &%first_delivery%& condition in an &%if%& command in the filter to
33693 prevent it happening on retries.
33694
33695 .vindex "&$domain$&"
33696 .vindex "&$local_part$&"
33697 &*Warning*&: Because the system filter runs just once, variables that are
33698 specific to individual recipient addresses, such as &$local_part$& and
33699 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
33700 you want to run a centrally-specified filter for each recipient address
33701 independently, you can do so by setting up a suitable &(redirect)& router, as
33702 described in section &<<SECTperaddfil>>& below.
33703
33704
33705 .section "Specifying a system filter" "SECID212"
33706 .cindex "uid (user id)" "system filter"
33707 .cindex "gid (group id)" "system filter"
33708 The name of the file that contains the system filter must be specified by
33709 setting &%system_filter%&. If you want the filter to run under a uid and gid
33710 other than root, you must also set &%system_filter_user%& and
33711 &%system_filter_group%& as appropriate. For example:
33712 .code
33713 system_filter = /etc/mail/exim.filter
33714 system_filter_user = exim
33715 .endd
33716 If a system filter generates any deliveries directly to files or pipes (via the
33717 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
33718 specified by setting &%system_filter_file_transport%& and
33719 &%system_filter_pipe_transport%&, respectively. Similarly,
33720 &%system_filter_reply_transport%& must be set to handle any messages generated
33721 by the &%reply%& command.
33722
33723
33724 .section "Testing a system filter" "SECID213"
33725 You can run simple tests of a system filter in the same way as for a user
33726 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
33727 are permitted only in system filters are recognized.
33728
33729 If you want to test the combined effect of a system filter and a user filter,
33730 you can use both &%-bF%& and &%-bf%& on the same command line.
33731
33732
33733
33734 .section "Contents of a system filter" "SECID214"
33735 The language used to specify system filters is the same as for users' filter
33736 files. It is described in the separate end-user document &'Exim's interface to
33737 mail filtering'&. However, there are some additional features that are
33738 available only in system filters; these are described in subsequent sections.
33739 If they are encountered in a user's filter file or when testing with &%-bf%&,
33740 they cause errors.
33741
33742 .cindex "frozen messages" "manual thaw; testing in filter"
33743 There are two special conditions which, though available in users' filter
33744 files, are designed for use in system filters. The condition &%first_delivery%&
33745 is true only for the first attempt at delivering a message, and
33746 &%manually_thawed%& is true only if the message has been frozen, and
33747 subsequently thawed by an admin user. An explicit forced delivery counts as a
33748 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
33749
33750 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
33751 specify an &"unseen"& (non-significant) delivery, and that delivery does not
33752 succeed, it will not be tried again.
33753 If you want Exim to retry an unseen delivery until it succeeds, you should
33754 arrange to set it up every time the filter runs.
33755
33756 When a system filter finishes running, the values of the variables &$n0$& &--
33757 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
33758 users' filter files. Thus a system filter can, for example, set up &"scores"&
33759 to which users' filter files can refer.
33760
33761
33762
33763 .section "Additional variable for system filters" "SECID215"
33764 .vindex "&$recipients$&"
33765 The expansion variable &$recipients$&, containing a list of all the recipients
33766 of the message (separated by commas and white space), is available in system
33767 filters. It is not available in users' filters for privacy reasons.
33768
33769
33770
33771 .section "Defer, freeze, and fail commands for system filters" "SECID216"
33772 .cindex "freezing messages"
33773 .cindex "message" "freezing"
33774 .cindex "message" "forced failure"
33775 .cindex "&%fail%&" "in system filter"
33776 .cindex "&%freeze%& in system filter"
33777 .cindex "&%defer%& in system filter"
33778 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
33779 always available in system filters, but are not normally enabled in users'
33780 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
33781 for the &(redirect)& router.) These commands can optionally be followed by the
33782 word &%text%& and a string containing an error message, for example:
33783 .code
33784 fail text "this message looks like spam to me"
33785 .endd
33786 The keyword &%text%& is optional if the next character is a double quote.
33787
33788 The &%defer%& command defers delivery of the original recipients of the
33789 message. The &%fail%& command causes all the original recipients to be failed,
33790 and a bounce message to be created. The &%freeze%& command suspends all
33791 delivery attempts for the original recipients. In all cases, any new deliveries
33792 that are specified by the filter are attempted as normal after the filter has
33793 run.
33794
33795 The &%freeze%& command is ignored if the message has been manually unfrozen and
33796 not manually frozen since. This means that automatic freezing by a system
33797 filter can be used as a way of checking out suspicious messages. If a message
33798 is found to be all right, manually unfreezing it allows it to be delivered.
33799
33800 .cindex "log" "&%fail%& command log line"
33801 .cindex "&%fail%&" "log line; reducing"
33802 The text given with a fail command is used as part of the bounce message as
33803 well as being written to the log. If the message is quite long, this can fill
33804 up a lot of log space when such failures are common. To reduce the size of the
33805 log message, Exim interprets the text in a special way if it starts with the
33806 two characters &`<<`& and contains &`>>`& later. The text between these two
33807 strings is written to the log, and the rest of the text is used in the bounce
33808 message. For example:
33809 .code
33810 fail "<<filter test 1>>Your message is rejected \
33811      because it contains attachments that we are \
33812      not prepared to receive."
33813 .endd
33814
33815 .cindex "loop" "caused by &%fail%&"
33816 Take great care with the &%fail%& command when basing the decision to fail on
33817 the contents of the message, because the bounce message will of course include
33818 the contents of the original message and will therefore trigger the &%fail%&
33819 command again (causing a mail loop) unless steps are taken to prevent this.
33820 Testing the &%error_message%& condition is one way to prevent this. You could
33821 use, for example
33822 .code
33823 if $message_body contains "this is spam" and not error_message
33824 then fail text "spam is not wanted here" endif
33825 .endd
33826 though of course that might let through unwanted bounce messages. The
33827 alternative is clever checking of the body and/or headers to detect bounces
33828 generated by the filter.
33829
33830 The interpretation of a system filter file ceases after a
33831 &%defer%&,
33832 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
33833 set up earlier in the filter file are honoured, so you can use a sequence such
33834 as
33835 .code
33836 mail ...
33837 freeze
33838 .endd
33839 to send a specified message when the system filter is freezing (or deferring or
33840 failing) a message. The normal deliveries for the message do not, of course,
33841 take place.
33842
33843
33844
33845 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
33846 .cindex "header lines" "adding; in system filter"
33847 .cindex "header lines" "removing; in system filter"
33848 .cindex "filter" "header lines; adding/removing"
33849 Two filter commands that are available only in system filters are:
33850 .code
33851 headers add <string>
33852 headers remove <string>
33853 .endd
33854 The argument for the &%headers add%& is a string that is expanded and then
33855 added to the end of the message's headers. It is the responsibility of the
33856 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
33857 space is ignored, and if the string is otherwise empty, or if the expansion is
33858 forced to fail, the command has no effect.
33859
33860 You can use &"\n"& within the string, followed by white space, to specify
33861 continued header lines. More than one header may be added in one command by
33862 including &"\n"& within the string without any following white space. For
33863 example:
33864 .code
33865 headers add "X-header-1: ....\n  \
33866              continuation of X-header-1 ...\n\
33867              X-header-2: ...."
33868 .endd
33869 Note that the header line continuation white space after the first newline must
33870 be placed before the backslash that continues the input string, because white
33871 space after input continuations is ignored.
33872
33873 The argument for &%headers remove%& is a colon-separated list of header names.
33874 This command applies only to those headers that are stored with the message;
33875 those that are added at delivery time (such as &'Envelope-To:'& and
33876 &'Return-Path:'&) cannot be removed by this means. If there is more than one
33877 header with the same name, they are all removed.
33878
33879 The &%headers%& command in a system filter makes an immediate change to the set
33880 of header lines that was received with the message (with possible additions
33881 from ACL processing). Subsequent commands in the system filter operate on the
33882 modified set, which also forms the basis for subsequent message delivery.
33883 Unless further modified during routing or transporting, this set of headers is
33884 used for all recipients of the message.
33885
33886 During routing and transporting, the variables that refer to the contents of
33887 header lines refer only to those lines that are in this set. Thus, header lines
33888 that are added by a system filter are visible to users' filter files and to all
33889 routers and transports. This contrasts with the manipulation of header lines by
33890 routers and transports, which is not immediate, but which instead is saved up
33891 until the message is actually being written (see section
33892 &<<SECTheadersaddrem>>&).
33893
33894 If the message is not delivered at the first attempt, header lines that were
33895 added by the system filter are stored with the message, and so are still
33896 present at the next delivery attempt. Header lines that were removed are still
33897 present, but marked &"deleted"& so that they are not transported with the
33898 message. For this reason, it is usual to make the &%headers%& command
33899 conditional on &%first_delivery%& so that the set of header lines is not
33900 modified more than once.
33901
33902 Because header modification in a system filter acts immediately, you have to
33903 use an indirect approach if you want to modify the contents of a header line.
33904 For example:
33905 .code
33906 headers add "Old-Subject: $h_subject:"
33907 headers remove "Subject"
33908 headers add "Subject: new subject (was: $h_old-subject:)"
33909 headers remove "Old-Subject"
33910 .endd
33911
33912
33913
33914 .section "Setting an errors address in a system filter" "SECID217"
33915 .cindex "envelope sender"
33916 In a system filter, if a &%deliver%& command is followed by
33917 .code
33918 errors_to <some address>
33919 .endd
33920 in order to change the envelope sender (and hence the error reporting) for that
33921 delivery, any address may be specified. (In a user filter, only the current
33922 user's address can be set.) For example, if some mail is being monitored, you
33923 might use
33924 .code
33925 unseen deliver monitor@spying.example errors_to root@local.example
33926 .endd
33927 to take a copy which would not be sent back to the normal error reporting
33928 address if its delivery failed.
33929
33930
33931
33932 .section "Per-address filtering" "SECTperaddfil"
33933 .vindex "&$domain$&"
33934 .vindex "&$local_part$&"
33935 In contrast to the system filter, which is run just once per message for each
33936 delivery attempt, it is also possible to set up a system-wide filtering
33937 operation that runs once for each recipient address. In this case, variables
33938 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
33939 filter file could be made dependent on them. This is an example of a router
33940 which implements such a filter:
33941 .code
33942 central_filter:
33943   check_local_user
33944   driver = redirect
33945   domains = +local_domains
33946   file = /central/filters/$local_part
33947   no_verify
33948   allow_filter
33949   allow_freeze
33950 .endd
33951 The filter is run in a separate process under its own uid. Therefore, either
33952 &%check_local_user%& must be set (as above), in which case the filter is run as
33953 the local user, or the &%user%& option must be used to specify which user to
33954 use. If both are set, &%user%& overrides.
33955
33956 Care should be taken to ensure that none of the commands in the filter file
33957 specify a significant delivery if the message is to go on to be delivered to
33958 its intended recipient. The router will not then claim to have dealt with the
33959 address, so it will be passed on to subsequent routers to be delivered in the
33960 normal way.
33961 .ecindex IIDsysfil1
33962 .ecindex IIDsysfil2
33963 .ecindex IIDsysfil3
33964
33965
33966
33967
33968
33969
33970 . ////////////////////////////////////////////////////////////////////////////
33971 . ////////////////////////////////////////////////////////////////////////////
33972
33973 .chapter "Message processing" "CHAPmsgproc"
33974 .scindex IIDmesproc "message" "general processing"
33975 Exim performs various transformations on the sender and recipient addresses of
33976 all messages that it handles, and also on the messages' header lines. Some of
33977 these are optional and configurable, while others always take place. All of
33978 this processing, except rewriting as a result of routing, and the addition or
33979 removal of header lines while delivering, happens when a message is received,
33980 before it is placed on Exim's queue.
33981
33982 Some of the automatic processing takes place by default only for
33983 &"locally-originated"& messages. This adjective is used to describe messages
33984 that are not received over TCP/IP, but instead are passed to an Exim process on
33985 its standard input. This includes the interactive &"local SMTP"& case that is
33986 set up by the &%-bs%& command line option.
33987
33988 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
33989 or ::1) are not considered to be locally-originated. Exim does not treat the
33990 loopback interface specially in any way.
33991
33992 If you want the loopback interface to be treated specially, you must ensure
33993 that there are appropriate entries in your ACLs.
33994
33995
33996
33997
33998 .section "Submission mode for non-local messages" "SECTsubmodnon"
33999 .cindex "message" "submission"
34000 .cindex "submission mode"
34001 Processing that happens automatically for locally-originated messages (unless
34002 &%suppress_local_fixups%& is set) can also be requested for messages that are
34003 received over TCP/IP. The term &"submission mode"& is used to describe this
34004 state. Submission mode is set by the modifier
34005 .code
34006 control = submission
34007 .endd
34008 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
34009 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
34010 a local submission, and is normally used when the source of the message is
34011 known to be an MUA running on a client host (as opposed to an MTA). For
34012 example, to set submission mode for messages originating on the IPv4 loopback
34013 interface, you could include the following in the MAIL ACL:
34014 .code
34015 warn  hosts = 127.0.0.1
34016       control = submission
34017 .endd
34018 .cindex "&%sender_retain%& submission option"
34019 There are some options that can be used when setting submission mode. A slash
34020 is used to separate options. For example:
34021 .code
34022 control = submission/sender_retain
34023 .endd
34024 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
34025 true and &%local_from_check%& false for the current incoming message. The first
34026 of these allows an existing &'Sender:'& header in the message to remain, and
34027 the second suppresses the check to ensure that &'From:'& matches the
34028 authenticated sender. With this setting, Exim still fixes up messages by adding
34029 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
34030 attempt to check sender authenticity in header lines.
34031
34032 When &%sender_retain%& is not set, a submission mode setting may specify a
34033 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
34034 example:
34035 .code
34036 control = submission/domain=some.domain
34037 .endd
34038 The domain may be empty. How this value is used is described in sections
34039 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
34040 that allows you to specify the user's full name for inclusion in a created
34041 &'Sender:'& or &'From:'& header line. For example:
34042 .code
34043 accept authenticated = *
34044        control = submission/domain=wonderland.example/\
34045                             name=${lookup {$authenticated_id} \
34046                                    lsearch {/etc/exim/namelist}}
34047 .endd
34048 Because the name may contain any characters, including slashes, the &%name%&
34049 option must be given last. The remainder of the string is used as the name. For
34050 the example above, if &_/etc/exim/namelist_& contains:
34051 .code
34052 bigegg:  Humpty Dumpty
34053 .endd
34054 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
34055 line would be:
34056 .code
34057 Sender: Humpty Dumpty <bigegg@wonderland.example>
34058 .endd
34059 .cindex "return path" "in submission mode"
34060 By default, submission mode forces the return path to the same address as is
34061 used to create the &'Sender:'& header. However, if &%sender_retain%& is
34062 specified, the return path is also left unchanged.
34063
34064 &*Note*&: The changes caused by submission mode take effect after the predata
34065 ACL. This means that any sender checks performed before the fix-ups use the
34066 untrusted sender address specified by the user, not the trusted sender address
34067 specified by submission mode. Although this might be slightly unexpected, it
34068 does mean that you can configure ACL checks to spot that a user is trying to
34069 spoof another's address.
34070
34071 .section "Line endings" "SECTlineendings"
34072 .cindex "line endings"
34073 .cindex "carriage return"
34074 .cindex "linefeed"
34075 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
34076 linefeed) is the line ending for messages transmitted over the Internet using
34077 SMTP over TCP/IP. However, within individual operating systems, different
34078 conventions are used. For example, Unix-like systems use just LF, but others
34079 use CRLF or just CR.
34080
34081 Exim was designed for Unix-like systems, and internally, it stores messages
34082 using the system's convention of a single LF as a line terminator. When
34083 receiving a message, all line endings are translated to this standard format.
34084 Originally, it was thought that programs that passed messages directly to an
34085 MTA within an operating system would use that system's convention. Experience
34086 has shown that this is not the case; for example, there are Unix applications
34087 that use CRLF in this circumstance. For this reason, and for compatibility with
34088 other MTAs, the way Exim handles line endings for all messages is now as
34089 follows:
34090
34091 .ilist
34092 LF not preceded by CR is treated as a line ending.
34093 .next
34094 CR is treated as a line ending; if it is immediately followed by LF, the LF
34095 is ignored.
34096 .next
34097 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
34098 nor a local message in the state where a line containing only a dot is a
34099 terminator.
34100 .next
34101 If a bare CR is encountered within a header line, an extra space is added after
34102 the line terminator so as not to end the header line. The reasoning behind this
34103 is that bare CRs in header lines are most likely either to be mistakes, or
34104 people trying to play silly games.
34105 .next
34106 If the first header line received in a message ends with CRLF, a subsequent
34107 bare LF in a header line is treated in the same way as a bare CR in a header
34108 line.
34109 .endlist
34110
34111
34112
34113
34114
34115 .section "Unqualified addresses" "SECID218"
34116 .cindex "unqualified addresses"
34117 .cindex "address" "qualification"
34118 By default, Exim expects every envelope address it receives from an external
34119 host to be fully qualified. Unqualified addresses cause negative responses to
34120 SMTP commands. However, because SMTP is used as a means of transporting
34121 messages from MUAs running on personal workstations, there is sometimes a
34122 requirement to accept unqualified addresses from specific hosts or IP networks.
34123
34124 Exim has two options that separately control which hosts may send unqualified
34125 sender or recipient addresses in SMTP commands, namely
34126 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
34127 cases, if an unqualified address is accepted, it is qualified by adding the
34128 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
34129
34130 .oindex "&%qualify_domain%&"
34131 .oindex "&%qualify_recipient%&"
34132 Unqualified addresses in header lines are automatically qualified for messages
34133 that are locally originated, unless the &%-bnq%& option is given on the command
34134 line. For messages received over SMTP, unqualified addresses in header lines
34135 are qualified only if unqualified addresses are permitted in SMTP commands. In
34136 other words, such qualification is also controlled by
34137 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
34138
34139
34140
34141
34142 .section "The UUCP From line" "SECID219"
34143 .cindex "&""From""& line"
34144 .cindex "UUCP" "&""From""& line"
34145 .cindex "sender" "address"
34146 .oindex "&%uucp_from_pattern%&"
34147 .oindex "&%uucp_from_sender%&"
34148 .cindex "envelope sender"
34149 .cindex "Sendmail compatibility" "&""From""& line"
34150 Messages that have come from UUCP (and some other applications) often begin
34151 with a line containing the envelope sender and a timestamp, following the word
34152 &"From"&. Examples of two common formats are:
34153 .code
34154 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
34155 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
34156 .endd
34157 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
34158 Exim recognizes such lines at the start of messages that are submitted to it
34159 via the command line (that is, on the standard input). It does not recognize
34160 such lines in incoming SMTP messages, unless the sending host matches
34161 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
34162 and &%ignore_fromline_local%& is set. The recognition is controlled by a
34163 regular expression that is defined by the &%uucp_from_pattern%& option, whose
34164 default value matches the two common cases shown above and puts the address
34165 that follows &"From"& into &$1$&.
34166
34167 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
34168 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
34169 a trusted user, the message's sender address is constructed by expanding the
34170 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
34171 then parsed as an RFC 2822 address. If there is no domain, the local part is
34172 qualified with &%qualify_domain%& unless it is the empty string. However, if
34173 the command line &%-f%& option is used, it overrides the &"From"& line.
34174
34175 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
34176 sender address is not changed. This is also the case for incoming SMTP messages
34177 that are permitted to contain &"From"& lines.
34178
34179 Only one &"From"& line is recognized. If there is more than one, the second is
34180 treated as a data line that starts the body of the message, as it is not valid
34181 as a header line. This also happens if a &"From"& line is present in an
34182 incoming SMTP message from a source that is not permitted to send them.
34183
34184
34185
34186 .section "Resent- header lines" "SECID220"
34187 .cindex "&%Resent-%& header lines"
34188 .cindex "header lines" "Resent-"
34189 RFC 2822 makes provision for sets of header lines starting with the string
34190 &`Resent-`& to be added to a message when it is resent by the original
34191 recipient to somebody else. These headers are &'Resent-Date:'&,
34192 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
34193 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
34194
34195 .blockquote
34196 &'Resent fields are strictly informational. They MUST NOT be used in the normal
34197 processing of replies or other such automatic actions on messages.'&
34198 .endblockquote
34199
34200 This leaves things a bit vague as far as other processing actions such as
34201 address rewriting are concerned. Exim treats &%Resent-%& header lines as
34202 follows:
34203
34204 .ilist
34205 A &'Resent-From:'& line that just contains the login id of the submitting user
34206 is automatically rewritten in the same way as &'From:'& (see below).
34207 .next
34208 If there's a rewriting rule for a particular header line, it is also applied to
34209 &%Resent-%& header lines of the same type. For example, a rule that rewrites
34210 &'From:'& also rewrites &'Resent-From:'&.
34211 .next
34212 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
34213 also removed.
34214 .next
34215 For a locally-submitted message,
34216 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
34217 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
34218 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
34219 included in log lines in this case.
34220 .next
34221 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
34222 &%Resent-%& header lines are present.
34223 .endlist
34224
34225
34226
34227
34228 .section "The Auto-Submitted: header line" "SECID221"
34229 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
34230 includes the header line:
34231 .code
34232 Auto-Submitted: auto-replied
34233 .endd
34234
34235 .section "The Bcc: header line" "SECID222"
34236 .cindex "&'Bcc:'& header line"
34237 If Exim is called with the &%-t%& option, to take recipient addresses from a
34238 message's header, it removes any &'Bcc:'& header line that may exist (after
34239 extracting its addresses). If &%-t%& is not present on the command line, any
34240 existing &'Bcc:'& is not removed.
34241
34242
34243 .section "The Date: header line" "SECID223"
34244 .cindex "&'Date:'& header line"
34245 .cindex "header lines" "Date:"
34246 If a locally-generated or submission-mode message has no &'Date:'& header line,
34247 Exim adds one, using the current date and time, unless the
34248 &%suppress_local_fixups%& control has been specified.
34249
34250 .section "The Delivery-date: header line" "SECID224"
34251 .cindex "&'Delivery-date:'& header line"
34252 .oindex "&%delivery_date_remove%&"
34253 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
34254 set. Exim can be configured to add them to the final delivery of messages. (See
34255 the generic &%delivery_date_add%& transport option.) They should not be present
34256 in messages in transit. If the &%delivery_date_remove%& configuration option is
34257 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
34258 messages.
34259
34260
34261 .section "The Envelope-to: header line" "SECID225"
34262 .cindex "&'Envelope-to:'& header line"
34263 .cindex "header lines" "Envelope-to:"
34264 .oindex "&%envelope_to_remove%&"
34265 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
34266 Exim can be configured to add them to the final delivery of messages. (See the
34267 generic &%envelope_to_add%& transport option.) They should not be present in
34268 messages in transit. If the &%envelope_to_remove%& configuration option is set
34269 (the default), Exim removes &'Envelope-to:'& header lines from incoming
34270 messages.
34271
34272
34273 .section "The From: header line" "SECTthefrohea"
34274 .cindex "&'From:'& header line"
34275 .cindex "header lines" "From:"
34276 .cindex "Sendmail compatibility" "&""From""& line"
34277 .cindex "message" "submission"
34278 .cindex "submission mode"
34279 If a submission-mode message does not contain a &'From:'& header line, Exim
34280 adds one if either of the following conditions is true:
34281
34282 .ilist
34283 The envelope sender address is not empty (that is, this is not a bounce
34284 message). The added header line copies the envelope sender address.
34285 .next
34286 .vindex "&$authenticated_id$&"
34287 The SMTP session is authenticated and &$authenticated_id$& is not empty.
34288 .olist
34289 .vindex "&$qualify_domain$&"
34290 If no domain is specified by the submission control, the local part is
34291 &$authenticated_id$& and the domain is &$qualify_domain$&.
34292 .next
34293 If a non-empty domain is specified by the submission control, the local
34294 part is &$authenticated_id$&, and the domain is the specified domain.
34295 .next
34296 If an empty domain is specified by the submission control,
34297 &$authenticated_id$& is assumed to be the complete address.
34298 .endlist
34299 .endlist
34300
34301 A non-empty envelope sender takes precedence.
34302
34303 If a locally-generated incoming message does not contain a &'From:'& header
34304 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
34305 containing the sender's address. The calling user's login name and full name
34306 are used to construct the address, as described in section &<<SECTconstr>>&.
34307 They are obtained from the password data by calling &[getpwuid()]& (but see the
34308 &%unknown_login%& configuration option). The address is qualified with
34309 &%qualify_domain%&.
34310
34311 For compatibility with Sendmail, if an incoming, non-SMTP message has a
34312 &'From:'& header line containing just the unqualified login name of the calling
34313 user, this is replaced by an address containing the user's login name and full
34314 name as described in section &<<SECTconstr>>&.
34315
34316
34317 .section "The Message-ID: header line" "SECID226"
34318 .cindex "&'Message-ID:'& header line"
34319 .cindex "header lines" "Message-ID:"
34320 .cindex "message" "submission"
34321 .oindex "&%message_id_header_text%&"
34322 If a locally-generated or submission-mode incoming message does not contain a
34323 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
34324 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
34325 to the message. If there are any &'Resent-:'& headers in the message, it
34326 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
34327 message id, preceded by the letter E to ensure it starts with a letter, and
34328 followed by @ and the primary host name. Additional information can be included
34329 in this header line by setting the &%message_id_header_text%& and/or
34330 &%message_id_header_domain%& options.
34331
34332
34333 .section "The Received: header line" "SECID227"
34334 .cindex "&'Received:'& header line"
34335 .cindex "header lines" "Received:"
34336 A &'Received:'& header line is added at the start of every message. The
34337 contents are defined by the &%received_header_text%& configuration option, and
34338 Exim automatically adds a semicolon and a timestamp to the configured string.
34339
34340 The &'Received:'& header is generated as soon as the message's header lines
34341 have been received. At this stage, the timestamp in the &'Received:'& header
34342 line is the time that the message started to be received. This is the value
34343 that is seen by the DATA ACL and by the &[local_scan()]& function.
34344
34345 Once a message is accepted, the timestamp in the &'Received:'& header line is
34346 changed to the time of acceptance, which is (apart from a small delay while the
34347 -H spool file is written) the earliest time at which delivery could start.
34348
34349
34350 .section "The References: header line" "SECID228"
34351 .cindex "&'References:'& header line"
34352 .cindex "header lines" "References:"
34353 Messages created by the &(autoreply)& transport include a &'References:'&
34354 header line. This is constructed according to the rules that are described in
34355 section 3.64 of RFC 2822 (which states that replies should contain such a
34356 header line), and section 3.14 of RFC 3834 (which states that automatic
34357 responses are not different in this respect). However, because some mail
34358 processing software does not cope well with very long header lines, no more
34359 than 12 message IDs are copied from the &'References:'& header line in the
34360 incoming message. If there are more than 12, the first one and then the final
34361 11 are copied, before adding the message ID of the incoming message.
34362
34363
34364
34365 .section "The Return-path: header line" "SECID229"
34366 .cindex "&'Return-path:'& header line"
34367 .cindex "header lines" "Return-path:"
34368 .oindex "&%return_path_remove%&"
34369 &'Return-path:'& header lines are defined as something an MTA may insert when
34370 it does the final delivery of messages. (See the generic &%return_path_add%&
34371 transport option.) Therefore, they should not be present in messages in
34372 transit. If the &%return_path_remove%& configuration option is set (the
34373 default), Exim removes &'Return-path:'& header lines from incoming messages.
34374
34375
34376
34377 .section "The Sender: header line" "SECTthesenhea"
34378 .cindex "&'Sender:'& header line"
34379 .cindex "message" "submission"
34380 .cindex "header lines" "Sender:"
34381 For a locally-originated message from an untrusted user, Exim may remove an
34382 existing &'Sender:'& header line, and it may add a new one. You can modify
34383 these actions by setting the &%local_sender_retain%& option true, the
34384 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
34385 control setting.
34386
34387 When a local message is received from an untrusted user and
34388 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
34389 control has not been set, a check is made to see if the address given in the
34390 &'From:'& header line is the correct (local) sender of the message. The address
34391 that is expected has the login name as the local part and the value of
34392 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
34393 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
34394 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
34395 line is added to the message.
34396
34397 If you set &%local_from_check%& false, this checking does not occur. However,
34398 the removal of an existing &'Sender:'& line still happens, unless you also set
34399 &%local_sender_retain%& to be true. It is not possible to set both of these
34400 options true at the same time.
34401
34402 .cindex "submission mode"
34403 By default, no processing of &'Sender:'& header lines is done for messages
34404 received over TCP/IP or for messages submitted by trusted users. However, when
34405 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
34406 not specified on the submission control, the following processing takes place:
34407
34408 .vindex "&$authenticated_id$&"
34409 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
34410 authenticated, and &$authenticated_id$& is not empty, a sender address is
34411 created as follows:
34412
34413 .ilist
34414 .vindex "&$qualify_domain$&"
34415 If no domain is specified by the submission control, the local part is
34416 &$authenticated_id$& and the domain is &$qualify_domain$&.
34417 .next
34418 If a non-empty domain is specified by the submission control, the local part
34419 is &$authenticated_id$&, and the domain is the specified domain.
34420 .next
34421 If an empty domain is specified by the submission control,
34422 &$authenticated_id$& is assumed to be the complete address.
34423 .endlist
34424
34425 This address is compared with the address in the &'From:'& header line. If they
34426 are different, a &'Sender:'& header line containing the created address is
34427 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
34428 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
34429
34430 .cindex "return path" "created from &'Sender:'&"
34431 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
34432 the message (the envelope sender address) is changed to be the same address,
34433 except in the case of submission mode when &%sender_retain%& is specified.
34434
34435
34436
34437 .section "Adding and removing header lines in routers and transports" &&&
34438          "SECTheadersaddrem"
34439 .cindex "header lines" "adding; in router or transport"
34440 .cindex "header lines" "removing; in router or transport"
34441 When a message is delivered, the addition and removal of header lines can be
34442 specified in a system filter, or on any of the routers and transports that
34443 process the message. Section &<<SECTaddremheasys>>& contains details about
34444 modifying headers in a system filter. Header lines can also be added in an ACL
34445 as a message is received (see section &<<SECTaddheadacl>>&).
34446
34447 In contrast to what happens in a system filter, header modifications that are
34448 specified on routers and transports apply only to the particular recipient
34449 addresses that are being processed by those routers and transports. These
34450 changes do not actually take place until a copy of the message is being
34451 transported. Therefore, they do not affect the basic set of header lines, and
34452 they do not affect the values of the variables that refer to header lines.
34453
34454 &*Note*&: In particular, this means that any expansions in the configuration of
34455 the transport cannot refer to the modified header lines, because such
34456 expansions all occur before the message is actually transported.
34457
34458 For both routers and transports, the argument of a &%headers_add%&
34459 option must be in the form of one or more RFC 2822 header lines, separated by
34460 newlines (coded as &"\n"&). For example:
34461 .code
34462 headers_add = X-added-header: added by $primary_hostname\n\
34463               X-added-second: another added header line
34464 .endd
34465 Exim does not check the syntax of these added header lines.
34466
34467 Multiple &%headers_add%& options for a single router or transport can be
34468 specified; the values will append to a single list of header lines.
34469 Each header-line is separately expanded.
34470
34471 The argument of a &%headers_remove%& option must consist of a colon-separated
34472 list of header names. This is confusing, because header names themselves are
34473 often terminated by colons. In this case, the colons are the list separators,
34474 not part of the names. For example:
34475 .code
34476 headers_remove = return-receipt-to:acknowledge-to
34477 .endd
34478
34479 Multiple &%headers_remove%& options for a single router or transport can be
34480 specified; the arguments will append to a single header-names list.
34481 Each item is separately expanded.
34482 Note that colons in complex expansions which are used to
34483 form all or part of a &%headers_remove%& list
34484 will act as list separators.
34485
34486 When &%headers_add%& or &%headers_remove%& is specified on a router,
34487 items are expanded at routing time,
34488 and then associated with all addresses that are
34489 accepted by that router, and also with any new addresses that it generates. If
34490 an address passes through several routers as a result of aliasing or
34491 forwarding, the changes are cumulative.
34492
34493 .oindex "&%unseen%&"
34494 However, this does not apply to multiple routers that result from the use of
34495 the &%unseen%& option. Any header modifications that were specified by the
34496 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
34497
34498 Addresses that end up with different &%headers_add%& or &%headers_remove%&
34499 settings cannot be delivered together in a batch, so a transport is always
34500 dealing with a set of addresses that have the same header-processing
34501 requirements.
34502
34503 The transport starts by writing the original set of header lines that arrived
34504 with the message, possibly modified by the system filter. As it writes out
34505 these lines, it consults the list of header names that were attached to the
34506 recipient address(es) by &%headers_remove%& options in routers, and it also
34507 consults the transport's own &%headers_remove%& option. Header lines whose
34508 names are on either of these lists are not written out. If there are multiple
34509 instances of any listed header, they are all skipped.
34510
34511 After the remaining original header lines have been written, new header
34512 lines that were specified by routers' &%headers_add%& options are written, in
34513 the order in which they were attached to the address. These are followed by any
34514 header lines specified by the transport's &%headers_add%& option.
34515
34516 This way of handling header line modifications in routers and transports has
34517 the following consequences:
34518
34519 .ilist
34520 The original set of header lines, possibly modified by the system filter,
34521 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
34522 to it, at all times.
34523 .next
34524 Header lines that are added by a router's
34525 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
34526 expansion syntax in subsequent routers or the transport.
34527 .next
34528 Conversely, header lines that are specified for removal by &%headers_remove%&
34529 in a router remain visible to subsequent routers and the transport.
34530 .next
34531 Headers added to an address by &%headers_add%& in a router cannot be removed by
34532 a later router or by a transport.
34533 .next
34534 An added header can refer to the contents of an original header that is to be
34535 removed, even it has the same name as the added header. For example:
34536 .code
34537 headers_remove = subject
34538 headers_add = Subject: new subject (was: $h_subject:)
34539 .endd
34540 .endlist
34541
34542 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
34543 for a &(redirect)& router that has the &%one_time%& option set.
34544
34545
34546
34547
34548
34549 .section "Constructed addresses" "SECTconstr"
34550 .cindex "address" "constructed"
34551 .cindex "constructed address"
34552 When Exim constructs a sender address for a locally-generated message, it uses
34553 the form
34554 .display
34555 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
34556 .endd
34557 For example:
34558 .code
34559 Zaphod Beeblebrox <zaphod@end.univ.example>
34560 .endd
34561 The user name is obtained from the &%-F%& command line option if set, or
34562 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
34563 &"gecos"& field from the password entry. If the &"gecos"& field contains an
34564 ampersand character, this is replaced by the login name with the first letter
34565 upper cased, as is conventional in a number of operating systems. See the
34566 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
34567 The &%unknown_username%& option can be used to specify user names in cases when
34568 there is no password file entry.
34569
34570 .cindex "RFC 2047"
34571 In all cases, the user name is made to conform to RFC 2822 by quoting all or
34572 parts of it if necessary. In addition, if it contains any non-printing
34573 characters, it is encoded as described in RFC 2047, which defines a way of
34574 including non-ASCII characters in header lines. The value of the
34575 &%headers_charset%& option specifies the name of the encoding that is used (the
34576 characters are assumed to be in this encoding). The setting of
34577 &%print_topbitchars%& controls whether characters with the top bit set (that
34578 is, with codes greater than 127) count as printing characters or not.
34579
34580
34581
34582 .section "Case of local parts" "SECID230"
34583 .cindex "case of local parts"
34584 .cindex "local part" "case of"
34585 RFC 2822 states that the case of letters in the local parts of addresses cannot
34586 be assumed to be non-significant. Exim preserves the case of local parts of
34587 addresses, but by default it uses a lower-cased form when it is routing,
34588 because on most Unix systems, usernames are in lower case and case-insensitive
34589 routing is required. However, any particular router can be made to use the
34590 original case for local parts by setting the &%caseful_local_part%& generic
34591 router option.
34592
34593 .cindex "mixed-case login names"
34594 If you must have mixed-case user names on your system, the best way to proceed,
34595 assuming you want case-independent handling of incoming email, is to set up
34596 your first router to convert incoming local parts in your domains to the
34597 correct case by means of a file lookup. For example:
34598 .code
34599 correct_case:
34600   driver = redirect
34601   domains = +local_domains
34602   data = ${lookup{$local_part}cdb\
34603               {/etc/usercased.cdb}{$value}fail}\
34604               @$domain
34605 .endd
34606 For this router, the local part is forced to lower case by the default action
34607 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
34608 up a new local part in the correct case. If you then set &%caseful_local_part%&
34609 on any subsequent routers which process your domains, they will operate on
34610 local parts with the correct case in a case-sensitive manner.
34611
34612
34613
34614 .section "Dots in local parts" "SECID231"
34615 .cindex "dot" "in local part"
34616 .cindex "local part" "dots in"
34617 RFC 2822 forbids empty components in local parts. That is, an unquoted local
34618 part may not begin or end with a dot, nor have two consecutive dots in the
34619 middle. However, it seems that many MTAs do not enforce this, so Exim permits
34620 empty components for compatibility.
34621
34622
34623
34624 .section "Rewriting addresses" "SECID232"
34625 .cindex "rewriting" "addresses"
34626 Rewriting of sender and recipient addresses, and addresses in headers, can
34627 happen automatically, or as the result of configuration options, as described
34628 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
34629 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
34630
34631 Automatic rewriting includes qualification, as mentioned above. The other case
34632 in which it can happen is when an incomplete non-local domain is given. The
34633 routing process may cause this to be expanded into the full domain name. For
34634 example, a header such as
34635 .code
34636 To: hare@teaparty
34637 .endd
34638 might get rewritten as
34639 .code
34640 To: hare@teaparty.wonderland.fict.example
34641 .endd
34642 Rewriting as a result of routing is the one kind of message processing that
34643 does not happen at input time, as it cannot be done until the address has
34644 been routed.
34645
34646 Strictly, one should not do &'any'& deliveries of a message until all its
34647 addresses have been routed, in case any of the headers get changed as a
34648 result of routing. However, doing this in practice would hold up many
34649 deliveries for unreasonable amounts of time, just because one address could not
34650 immediately be routed. Exim therefore does not delay other deliveries when
34651 routing of one or more addresses is deferred.
34652 .ecindex IIDmesproc
34653
34654
34655
34656 . ////////////////////////////////////////////////////////////////////////////
34657 . ////////////////////////////////////////////////////////////////////////////
34658
34659 .chapter "SMTP processing" "CHAPSMTP"
34660 .scindex IIDsmtpproc1 "SMTP" "processing details"
34661 .scindex IIDsmtpproc2 "LMTP" "processing details"
34662 Exim supports a number of different ways of using the SMTP protocol, and its
34663 LMTP variant, which is an interactive protocol for transferring messages into a
34664 closed mail store application. This chapter contains details of how SMTP is
34665 processed. For incoming mail, the following are available:
34666
34667 .ilist
34668 SMTP over TCP/IP (Exim daemon or &'inetd'&);
34669 .next
34670 SMTP over the standard input and output (the &%-bs%& option);
34671 .next
34672 Batched SMTP on the standard input (the &%-bS%& option).
34673 .endlist
34674
34675 For mail delivery, the following are available:
34676
34677 .ilist
34678 SMTP over TCP/IP (the &(smtp)& transport);
34679 .next
34680 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
34681 &"lmtp"&);
34682 .next
34683 LMTP over a pipe to a process running in the local host (the &(lmtp)&
34684 transport);
34685 .next
34686 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
34687 the &%use_bsmtp%& option set).
34688 .endlist
34689
34690 &'Batched SMTP'& is the name for a process in which batches of messages are
34691 stored in or read from files (or pipes), in a format in which SMTP commands are
34692 used to contain the envelope information.
34693
34694
34695
34696 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
34697 .cindex "SMTP" "outgoing over TCP/IP"
34698 .cindex "outgoing SMTP over TCP/IP"
34699 .cindex "LMTP" "over TCP/IP"
34700 .cindex "outgoing LMTP over TCP/IP"
34701 .cindex "EHLO"
34702 .cindex "HELO"
34703 .cindex "SIZE option on MAIL command"
34704 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
34705 The &%protocol%& option selects which protocol is to be used, but the actual
34706 processing is the same in both cases.
34707
34708 If, in response to its EHLO command, Exim is told that the SIZE
34709 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
34710 command. The value of <&'n'&> is the message size plus the value of the
34711 &%size_addition%& option (default 1024) to allow for additions to the message
34712 such as per-transport header lines, or changes made in a
34713 .cindex "transport" "filter"
34714 .cindex "filter" "transport filter"
34715 transport filter. If &%size_addition%& is set negative, the use of SIZE is
34716 suppressed.
34717
34718 If the remote server advertises support for PIPELINING, Exim uses the
34719 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
34720 required for the transaction.
34721
34722 If the remote server advertises support for the STARTTLS command, and Exim
34723 was built to support TLS encryption, it tries to start a TLS session unless the
34724 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
34725 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
34726 is called for verification.
34727
34728 If the remote server advertises support for the AUTH command, Exim scans
34729 the authenticators configuration for any suitable client settings, as described
34730 in chapter &<<CHAPSMTPAUTH>>&.
34731
34732 .cindex "carriage return"
34733 .cindex "linefeed"
34734 Responses from the remote host are supposed to be terminated by CR followed by
34735 LF. However, there are known to be hosts that do not send CR characters, so in
34736 order to be able to interwork with such hosts, Exim treats LF on its own as a
34737 line terminator.
34738
34739 If a message contains a number of different addresses, all those with the same
34740 characteristics (for example, the same envelope sender) that resolve to the
34741 same set of hosts, in the same order, are sent in a single SMTP transaction,
34742 even if they are for different domains, unless there are more than the setting
34743 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
34744 they are split into groups containing no more than &%max_rcpt%&s addresses
34745 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
34746 in parallel sessions. The order of hosts with identical MX values is not
34747 significant when checking whether addresses can be batched in this way.
34748
34749 When the &(smtp)& transport suffers a temporary failure that is not
34750 message-related, Exim updates its transport-specific database, which contains
34751 records indexed by host name that remember which messages are waiting for each
34752 particular host. It also updates the retry database with new retry times.
34753
34754 .cindex "hints database" "retry keys"
34755 Exim's retry hints are based on host name plus IP address, so if one address of
34756 a multi-homed host is broken, it will soon be skipped most of the time.
34757 See the next section for more detail about error handling.
34758
34759 .cindex "SMTP" "passed connection"
34760 .cindex "SMTP" "batching over TCP/IP"
34761 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
34762 looks in the hints database for the transport to see if there are any queued
34763 messages waiting for the host to which it is connected. If it finds one, it
34764 creates a new Exim process using the &%-MC%& option (which can only be used by
34765 a process running as root or the Exim user) and passes the TCP/IP socket to it
34766 so that it can deliver another message using the same socket. The new process
34767 does only those deliveries that are routed to the connected host, and may in
34768 turn pass the socket on to a third process, and so on.
34769
34770 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
34771 limit the number of messages sent down a single TCP/IP connection.
34772
34773 .cindex "asterisk" "after IP address"
34774 The second and subsequent messages delivered down an existing connection are
34775 identified in the main log by the addition of an asterisk after the closing
34776 square bracket of the IP address.
34777
34778
34779
34780
34781 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
34782 .cindex "error" "in outgoing SMTP"
34783 .cindex "SMTP" "errors in outgoing"
34784 .cindex "host" "error"
34785 Three different kinds of error are recognized for outgoing SMTP: host errors,
34786 message errors, and recipient errors.
34787
34788 .vlist
34789 .vitem "&*Host errors*&"
34790 A host error is not associated with a particular message or with a
34791 particular recipient of a message. The host errors are:
34792
34793 .ilist
34794 Connection refused or timed out,
34795 .next
34796 Any error response code on connection,
34797 .next
34798 Any error response code to EHLO or HELO,
34799 .next
34800 Loss of connection at any time, except after &"."&,
34801 .next
34802 I/O errors at any time,
34803 .next
34804 Timeouts during the session, other than in response to MAIL, RCPT or
34805 the &"."& at the end of the data.
34806 .endlist ilist
34807
34808 For a host error, a permanent error response on connection, or in response to
34809 EHLO, causes all addresses routed to the host to be failed. Any other host
34810 error causes all addresses to be deferred, and retry data to be created for the
34811 host. It is not tried again, for any message, until its retry time arrives. If
34812 the current set of addresses are not all delivered in this run (to some
34813 alternative host), the message is added to the list of those waiting for this
34814 host, so if it is still undelivered when a subsequent successful delivery is
34815 made to the host, it will be sent down the same SMTP connection.
34816
34817 .vitem "&*Message errors*&"
34818 .cindex "message" "error"
34819 A message error is associated with a particular message when sent to a
34820 particular host, but not with a particular recipient of the message. The
34821 message errors are:
34822
34823 .ilist
34824 Any error response code to MAIL, DATA, or the &"."& that terminates
34825 the data,
34826 .next
34827 Timeout after MAIL,
34828 .next
34829 Timeout or loss of connection after the &"."& that terminates the data. A
34830 timeout after the DATA command itself is treated as a host error, as is loss of
34831 connection at any other time.
34832 .endlist ilist
34833
34834 For a message error, a permanent error response (5&'xx'&) causes all addresses
34835 to be failed, and a delivery error report to be returned to the sender. A
34836 temporary error response (4&'xx'&), or one of the timeouts, causes all
34837 addresses to be deferred. Retry data is not created for the host, but instead,
34838 a retry record for the combination of host plus message id is created. The
34839 message is not added to the list of those waiting for this host. This ensures
34840 that the failing message will not be sent to this host again until the retry
34841 time arrives. However, other messages that are routed to the host are not
34842 affected, so if it is some property of the message that is causing the error,
34843 it will not stop the delivery of other mail.
34844
34845 If the remote host specified support for the SIZE parameter in its response
34846 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
34847 over-large message will cause a message error because the error arrives as a
34848 response to MAIL.
34849
34850 .vitem "&*Recipient errors*&"
34851 .cindex "recipient" "error"
34852 A recipient error is associated with a particular recipient of a message. The
34853 recipient errors are:
34854
34855 .ilist
34856 Any error response to RCPT,
34857 .next
34858 Timeout after RCPT.
34859 .endlist
34860
34861 For a recipient error, a permanent error response (5&'xx'&) causes the
34862 recipient address to be failed, and a bounce message to be returned to the
34863 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
34864 address to be deferred, and routing retry data to be created for it. This is
34865 used to delay processing of the address in subsequent queue runs, until its
34866 routing retry time arrives. This applies to all messages, but because it
34867 operates only in queue runs, one attempt will be made to deliver a new message
34868 to the failing address before the delay starts to operate. This ensures that,
34869 if the failure is really related to the message rather than the recipient
34870 (&"message too big for this recipient"& is a possible example), other messages
34871 have a chance of getting delivered. If a delivery to the address does succeed,
34872 the retry information gets cleared, so all stuck messages get tried again, and
34873 the retry clock is reset.
34874
34875 The message is not added to the list of those waiting for this host. Use of the
34876 host for other messages is unaffected, and except in the case of a timeout,
34877 other recipients are processed independently, and may be successfully delivered
34878 in the current SMTP session. After a timeout it is of course impossible to
34879 proceed with the session, so all addresses get deferred. However, those other
34880 than the one that failed do not suffer any subsequent retry delays. Therefore,
34881 if one recipient is causing trouble, the others have a chance of getting
34882 through when a subsequent delivery attempt occurs before the failing
34883 recipient's retry time.
34884 .endlist
34885
34886 In all cases, if there are other hosts (or IP addresses) available for the
34887 current set of addresses (for example, from multiple MX records), they are
34888 tried in this run for any undelivered addresses, subject of course to their
34889 own retry data. In other words, recipient error retry data does not take effect
34890 until the next delivery attempt.
34891
34892 Some hosts have been observed to give temporary error responses to every
34893 MAIL command at certain times (&"insufficient space"& has been seen). It
34894 would be nice if such circumstances could be recognized, and defer data for the
34895 host itself created, but this is not possible within the current Exim design.
34896 What actually happens is that retry data for every (host, message) combination
34897 is created.
34898
34899 The reason that timeouts after MAIL and RCPT are treated specially is that
34900 these can sometimes arise as a result of the remote host's verification
34901 procedures. Exim makes this assumption, and treats them as if a temporary error
34902 response had been received. A timeout after &"."& is treated specially because
34903 it is known that some broken implementations fail to recognize the end of the
34904 message if the last character of the last line is a binary zero. Thus, it is
34905 helpful to treat this case as a message error.
34906
34907 Timeouts at other times are treated as host errors, assuming a problem with the
34908 host, or the connection to it. If a timeout after MAIL, RCPT,
34909 or &"."& is really a connection problem, the assumption is that at the next try
34910 the timeout is likely to occur at some other point in the dialogue, causing it
34911 then to be treated as a host error.
34912
34913 There is experimental evidence that some MTAs drop the connection after the
34914 terminating &"."& if they do not like the contents of the message for some
34915 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
34916 should be given. That is why Exim treats this case as a message rather than a
34917 host error, in order not to delay other messages to the same host.
34918
34919
34920
34921
34922 .section "Incoming SMTP messages over TCP/IP" "SECID233"
34923 .cindex "SMTP" "incoming over TCP/IP"
34924 .cindex "incoming SMTP over TCP/IP"
34925 .cindex "inetd"
34926 .cindex "daemon"
34927 Incoming SMTP messages can be accepted in one of two ways: by running a
34928 listening daemon, or by using &'inetd'&. In the latter case, the entry in
34929 &_/etc/inetd.conf_& should be like this:
34930 .code
34931 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
34932 .endd
34933 Exim distinguishes between this case and the case of a locally running user
34934 agent using the &%-bs%& option by checking whether or not the standard input is
34935 a socket. When it is, either the port must be privileged (less than 1024), or
34936 the caller must be root or the Exim user. If any other user passes a socket
34937 with an unprivileged port number, Exim prints a message on the standard error
34938 stream and exits with an error code.
34939
34940 By default, Exim does not make a log entry when a remote host connects or
34941 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
34942 unexpected. It can be made to write such log entries by setting the
34943 &%smtp_connection%& log selector.
34944
34945 .cindex "carriage return"
34946 .cindex "linefeed"
34947 Commands from the remote host are supposed to be terminated by CR followed by
34948 LF. However, there are known to be hosts that do not send CR characters. In
34949 order to be able to interwork with such hosts, Exim treats LF on its own as a
34950 line terminator.
34951 Furthermore, because common code is used for receiving messages from all
34952 sources, a CR on its own is also interpreted as a line terminator. However, the
34953 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
34954
34955 .cindex "EHLO" "invalid data"
34956 .cindex "HELO" "invalid data"
34957 One area that sometimes gives rise to problems concerns the EHLO or
34958 HELO commands. Some clients send syntactically invalid versions of these
34959 commands, which Exim rejects by default. (This is nothing to do with verifying
34960 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
34961 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
34962 match the broken hosts that send invalid commands.
34963
34964 .cindex "SIZE option on MAIL command"
34965 .cindex "MAIL" "SIZE option"
34966 The amount of disk space available is checked whenever SIZE is received on
34967 a MAIL command, independently of whether &%message_size_limit%& or
34968 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
34969 false. A temporary error is given if there is not enough space. If
34970 &%check_spool_space%& is set, the check is for that amount of space plus the
34971 value given with SIZE, that is, it checks that the addition of the incoming
34972 message will not reduce the space below the threshold.
34973
34974 When a message is successfully received, Exim includes the local message id in
34975 its response to the final &"."& that terminates the data. If the remote host
34976 logs this text it can help with tracing what has happened to a message.
34977
34978 The Exim daemon can limit the number of simultaneous incoming connections it is
34979 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
34980 number of simultaneous incoming connections from a single remote host (see the
34981 &%smtp_accept_max_per_host%& option). Additional connection attempts are
34982 rejected using the SMTP temporary error code 421.
34983
34984 The Exim daemon does not rely on the SIGCHLD signal to detect when a
34985 subprocess has finished, as this can get lost at busy times. Instead, it looks
34986 for completed subprocesses every time it wakes up. Provided there are other
34987 things happening (new incoming calls, starts of queue runs), completed
34988 processes will be noticed and tidied away. On very quiet systems you may
34989 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
34990 it will be noticed when the daemon next wakes up.
34991
34992 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
34993 and can also be set up to reject SMTP calls from non-reserved hosts at times of
34994 high system load &-- for details see the &%smtp_accept_reserve%&,
34995 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
34996 applies in both the daemon and &'inetd'& cases.
34997
34998 Exim normally starts a delivery process for each message received, though this
34999 can be varied by means of the &%-odq%& command line option and the
35000 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
35001 number of simultaneously running delivery processes started in this way from
35002 SMTP input can be limited by the &%smtp_accept_queue%& and
35003 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
35004 subsequently received messages are just put on the input queue without starting
35005 a delivery process.
35006
35007 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
35008 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
35009 started up from the &'inetd'& daemon, because in that case each connection is
35010 handled by an entirely independent Exim process. Control by load average is,
35011 however, available with &'inetd'&.
35012
35013 Exim can be configured to verify addresses in incoming SMTP commands as they
35014 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
35015 to rewrite addresses at this time &-- before any syntax checking is done. See
35016 section &<<SECTrewriteS>>&.
35017
35018 Exim can also be configured to limit the rate at which a client host submits
35019 MAIL and RCPT commands in a single SMTP session. See the
35020 &%smtp_ratelimit_hosts%& option.
35021
35022
35023
35024 .section "Unrecognized SMTP commands" "SECID234"
35025 .cindex "SMTP" "unrecognized commands"
35026 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
35027 commands during a single SMTP connection, it drops the connection after sending
35028 the error response to the last command. The default value for
35029 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
35030 abuse that subvert web servers into making connections to SMTP ports; in these
35031 circumstances, a number of non-SMTP lines are sent first.
35032
35033
35034 .section "Syntax and protocol errors in SMTP commands" "SECID235"
35035 .cindex "SMTP" "syntax errors"
35036 .cindex "SMTP" "protocol errors"
35037 A syntax error is detected if an SMTP command is recognized, but there is
35038 something syntactically wrong with its data, for example, a malformed email
35039 address in a RCPT command. Protocol errors include invalid command
35040 sequencing such as RCPT before MAIL. If Exim receives more than
35041 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
35042 drops the connection after sending the error response to the last command. The
35043 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
35044 broken clients that loop sending bad commands (yes, it has been seen).
35045
35046
35047
35048 .section "Use of non-mail SMTP commands" "SECID236"
35049 .cindex "SMTP" "non-mail commands"
35050 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
35051 DATA. Exim counts such commands, and drops the connection if there are too
35052 many of them in a single SMTP session. This action catches some
35053 denial-of-service attempts and things like repeated failing AUTHs, or a mad
35054 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
35055 defines what &"too many"& means. Its default value is 10.
35056
35057 When a new message is expected, one occurrence of RSET is not counted. This
35058 allows a client to send one RSET between messages (this is not necessary,
35059 but some clients do it). Exim also allows one uncounted occurrence of HELO
35060 or EHLO, and one occurrence of STARTTLS between messages. After
35061 starting up a TLS session, another EHLO is expected, and so it too is not
35062 counted.
35063
35064 The first occurrence of AUTH in a connection, or immediately following
35065 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
35066 RCPT, DATA, and QUIT are counted.
35067
35068 You can control which hosts are subject to the limit set by
35069 &%smtp_accept_max_nonmail%& by setting
35070 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
35071 the limit apply to all hosts. This option means that you can exclude any
35072 specific badly-behaved hosts that you have to live with.
35073
35074
35075
35076
35077 .section "The VRFY and EXPN commands" "SECID237"
35078 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
35079 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
35080 appropriate) in order to decide whether the command should be accepted or not.
35081
35082 .cindex "VRFY" "processing"
35083 When no ACL is defined for VRFY, or if it rejects without
35084 setting an explicit response code, the command is accepted
35085 (with a 252 SMTP response code)
35086 in order to support awkward clients that do a VRFY before every RCPT.
35087 When VRFY is accepted, it runs exactly the same code as when Exim is
35088 called with the &%-bv%& option, and returns 250/451/550
35089 SMTP response codes.
35090
35091 .cindex "EXPN" "processing"
35092 If no ACL for EXPN is defined, the command is rejected.
35093 When EXPN is accepted, a single-level expansion of the address is done.
35094 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
35095 than a verification (the &%-bv%& option). If an unqualified local part is given
35096 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
35097 of VRFY and EXPN commands are logged on the main and reject logs, and
35098 VRFY verification failures are logged on the main log for consistency with
35099 RCPT failures.
35100
35101
35102
35103 .section "The ETRN command" "SECTETRN"
35104 .cindex "ETRN" "processing"
35105 RFC 1985 describes an SMTP command called ETRN that is designed to
35106 overcome the security problems of the TURN command (which has fallen into
35107 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
35108 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
35109 should be accepted or not. If no ACL is defined, the command is rejected.
35110
35111 The ETRN command is concerned with &"releasing"& messages that are awaiting
35112 delivery to certain hosts. As Exim does not organize its message queue by host,
35113 the only form of ETRN that is supported by default is the one where the
35114 text starts with the &"#"& prefix, in which case the remainder of the text is
35115 specific to the SMTP server. A valid ETRN command causes a run of Exim with
35116 the &%-R%& option to happen, with the remainder of the ETRN text as its
35117 argument. For example,
35118 .code
35119 ETRN #brigadoon
35120 .endd
35121 runs the command
35122 .code
35123 exim -R brigadoon
35124 .endd
35125 which causes a delivery attempt on all messages with undelivered addresses
35126 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
35127 default), Exim prevents the simultaneous execution of more than one queue run
35128 for the same argument string as a result of an ETRN command. This stops
35129 a misbehaving client from starting more than one queue runner at once.
35130
35131 .cindex "hints database" "ETRN serialization"
35132 Exim implements the serialization by means of a hints database in which a
35133 record is written whenever a process is started by ETRN, and deleted when
35134 the process completes. However, Exim does not keep the SMTP session waiting for
35135 the ETRN process to complete. Once ETRN is accepted, the client is sent
35136 a &"success"& return code. Obviously there is scope for hints records to get
35137 left lying around if there is a system or program crash. To guard against this,
35138 Exim ignores any records that are more than six hours old.
35139
35140 .oindex "&%smtp_etrn_command%&"
35141 For more control over what ETRN does, the &%smtp_etrn_command%& option can
35142 used. This specifies a command that is run whenever ETRN is received,
35143 whatever the form of its argument. For
35144 example:
35145 .code
35146 smtp_etrn_command = /etc/etrn_command $domain \
35147                     $sender_host_address
35148 .endd
35149 .vindex "&$domain$&"
35150 The string is split up into arguments which are independently expanded. The
35151 expansion variable &$domain$& is set to the argument of the ETRN command,
35152 and no syntax checking is done on the contents of this argument. Exim does not
35153 wait for the command to complete, so its status code is not checked. Exim runs
35154 under its own uid and gid when receiving incoming SMTP, so it is not possible
35155 for it to change them before running the command.
35156
35157
35158
35159 .section "Incoming local SMTP" "SECID238"
35160 .cindex "SMTP" "local incoming"
35161 Some user agents use SMTP to pass messages to their local MTA using the
35162 standard input and output, as opposed to passing the envelope on the command
35163 line and writing the message to the standard input. This is supported by the
35164 &%-bs%& option. This form of SMTP is handled in the same way as incoming
35165 messages over TCP/IP (including the use of ACLs), except that the envelope
35166 sender given in a MAIL command is ignored unless the caller is trusted. In
35167 an ACL you can detect this form of SMTP input by testing for an empty host
35168 identification. It is common to have this as the first line in the ACL that
35169 runs for RCPT commands:
35170 .code
35171 accept hosts = :
35172 .endd
35173 This accepts SMTP messages from local processes without doing any other tests.
35174
35175
35176
35177 .section "Outgoing batched SMTP" "SECTbatchSMTP"
35178 .cindex "SMTP" "batched outgoing"
35179 .cindex "batched SMTP output"
35180 Both the &(appendfile)& and &(pipe)& transports can be used for handling
35181 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
35182 be output in BSMTP format. No SMTP responses are possible for this form of
35183 delivery. All it is doing is using SMTP commands as a way of transmitting the
35184 envelope along with the message.
35185
35186 The message is written to the file or pipe preceded by the SMTP commands
35187 MAIL and RCPT, and followed by a line containing a single dot. Lines in
35188 the message that start with a dot have an extra dot added. The SMTP command
35189 HELO is not normally used. If it is required, the &%message_prefix%& option
35190 can be used to specify it.
35191
35192 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
35193 one recipient address at a time by default. However, you can arrange for them
35194 to handle several addresses at once by setting the &%batch_max%& option. When
35195 this is done for BSMTP, messages may contain multiple RCPT commands. See
35196 chapter &<<CHAPbatching>>& for more details.
35197
35198 .vindex "&$host$&"
35199 When one or more addresses are routed to a BSMTP transport by a router that
35200 sets up a host list, the name of the first host on the list is available to the
35201 transport in the variable &$host$&. Here is an example of such a transport and
35202 router:
35203 .code
35204 begin routers
35205 route_append:
35206   driver = manualroute
35207   transport = smtp_appendfile
35208   route_list = domain.example  batch.host.example
35209
35210 begin transports
35211 smtp_appendfile:
35212   driver = appendfile
35213   directory = /var/bsmtp/$host
35214   batch_max = 1000
35215   use_bsmtp
35216   user = exim
35217 .endd
35218 This causes messages addressed to &'domain.example'& to be written in BSMTP
35219 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
35220 message (unless there are more than 1000 recipients).
35221
35222
35223
35224 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
35225 .cindex "SMTP" "batched incoming"
35226 .cindex "batched SMTP input"
35227 The &%-bS%& command line option causes Exim to accept one or more messages by
35228 reading SMTP on the standard input, but to generate no responses. If the caller
35229 is trusted, the senders in the MAIL commands are believed; otherwise the
35230 sender is always the caller of Exim. Unqualified senders and receivers are not
35231 rejected (there seems little point) but instead just get qualified. HELO
35232 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
35233 as NOOP; QUIT quits.
35234
35235 Minimal policy checking is done for BSMTP input. Only the non-SMTP
35236 ACL is run in the same way as for non-SMTP local input.
35237
35238 If an error is detected while reading a message, including a missing &"."& at
35239 the end, Exim gives up immediately. It writes details of the error to the
35240 standard output in a stylized way that the calling program should be able to
35241 make some use of automatically, for example:
35242 .code
35243 554 Unexpected end of file
35244 Transaction started in line 10
35245 Error detected in line 14
35246 .endd
35247 It writes a more verbose version, for human consumption, to the standard error
35248 file, for example:
35249 .code
35250 An error was detected while processing a file of BSMTP input.
35251 The error message was:
35252
35253 501 '>' missing at end of address
35254
35255 The SMTP transaction started in line 10.
35256 The error was detected in line 12.
35257 The SMTP command at fault was:
35258
35259 rcpt to:<malformed@in.com.plete
35260
35261 1 previous message was successfully processed.
35262 The rest of the batch was abandoned.
35263 .endd
35264 The return code from Exim is zero only if there were no errors. It is 1 if some
35265 messages were accepted before an error was detected, and 2 if no messages were
35266 accepted.
35267 .ecindex IIDsmtpproc1
35268 .ecindex IIDsmtpproc2
35269
35270
35271
35272 . ////////////////////////////////////////////////////////////////////////////
35273 . ////////////////////////////////////////////////////////////////////////////
35274
35275 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
35276          "Customizing messages"
35277 When a message fails to be delivered, or remains on the queue for more than a
35278 configured amount of time, Exim sends a message to the original sender, or
35279 to an alternative configured address. The text of these messages is built into
35280 the code of Exim, but it is possible to change it, either by adding a single
35281 string, or by replacing each of the paragraphs by text supplied in a file.
35282
35283 The &'From:'& and &'To:'& header lines are automatically generated; you can
35284 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
35285 option. Exim also adds the line
35286 .code
35287 Auto-Submitted: auto-generated
35288 .endd
35289 to all warning and bounce messages,
35290
35291
35292 .section "Customizing bounce messages" "SECID239"
35293 .cindex "customizing" "bounce message"
35294 .cindex "bounce message" "customizing"
35295 If &%bounce_message_text%& is set, its contents are included in the default
35296 message immediately after &"This message was created automatically by mail
35297 delivery software."& The string is not expanded. It is not used if
35298 &%bounce_message_file%& is set.
35299
35300 When &%bounce_message_file%& is set, it must point to a template file for
35301 constructing error messages. The file consists of a series of text items,
35302 separated by lines consisting of exactly four asterisks. If the file cannot be
35303 opened, default text is used and a message is written to the main and panic
35304 logs. If any text item in the file is empty, default text is used for that
35305 item.
35306
35307 .vindex "&$bounce_recipient$&"
35308 .vindex "&$bounce_return_size_limit$&"
35309 Each item of text that is read from the file is expanded, and there are two
35310 expansion variables which can be of use here: &$bounce_recipient$& is set to
35311 the recipient of an error message while it is being created, and
35312 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
35313 option, rounded to a whole number.
35314
35315 The items must appear in the file in the following order:
35316
35317 .ilist
35318 The first item is included in the headers, and should include at least a
35319 &'Subject:'& header. Exim does not check the syntax of these headers.
35320 .next
35321 The second item forms the start of the error message. After it, Exim lists the
35322 failing addresses with their error messages.
35323 .next
35324 The third item is used to introduce any text from pipe transports that is to be
35325 returned to the sender. It is omitted if there is no such text.
35326 .next
35327 The fourth, fifth and sixth items will be ignored and may be empty.
35328 The fields exist for back-compatibility
35329 .endlist
35330
35331 The default state (&%bounce_message_file%& unset) is equivalent to the
35332 following file, in which the sixth item is empty. The &'Subject:'& and some
35333 other lines have been split in order to fit them on the page:
35334 .code
35335 Subject: Mail delivery failed
35336   ${if eq{$sender_address}{$bounce_recipient}
35337   {: returning message to sender}}
35338 ****
35339 This message was created automatically by mail delivery software.
35340
35341 A message ${if eq{$sender_address}{$bounce_recipient}
35342   {that you sent }{sent by
35343
35344 <$sender_address>
35345
35346 }}could not be delivered to all of its recipients.
35347 This is a permanent error. The following address(es) failed:
35348 ****
35349 The following text was generated during the delivery attempt(s):
35350 ****
35351 ------ This is a copy of the message, including all the headers.
35352   ------
35353 ****
35354 ------ The body of the message is $message_size characters long;
35355   only the first
35356 ------ $bounce_return_size_limit or so are included here.
35357 ****
35358 .endd
35359 .section "Customizing warning messages" "SECTcustwarn"
35360 .cindex "customizing" "warning message"
35361 .cindex "warning of delay" "customizing the message"
35362 The option &%warn_message_file%& can be pointed at a template file for use when
35363 warnings about message delays are created. In this case there are only three
35364 text sections:
35365
35366 .ilist
35367 The first item is included in the headers, and should include at least a
35368 &'Subject:'& header. Exim does not check the syntax of these headers.
35369 .next
35370 The second item forms the start of the warning message. After it, Exim lists
35371 the delayed addresses.
35372 .next
35373 The third item then ends the message.
35374 .endlist
35375
35376 The default state is equivalent to the following file, except that some lines
35377 have been split here, in order to fit them on the page:
35378 .code
35379 Subject: Warning: message $message_exim_id delayed
35380   $warn_message_delay
35381 ****
35382 This message was created automatically by mail delivery software.
35383
35384 A message ${if eq{$sender_address}{$warn_message_recipients}
35385 {that you sent }{sent by
35386
35387 <$sender_address>
35388
35389 }}has not been delivered to all of its recipients after
35390 more than $warn_message_delay on the queue on $primary_hostname.
35391
35392 The message identifier is:     $message_exim_id
35393 The subject of the message is: $h_subject
35394 The date of the message is:    $h_date
35395
35396 The following address(es) have not yet been delivered:
35397 ****
35398 No action is required on your part. Delivery attempts will
35399 continue for some time, and this warning may be repeated at
35400 intervals if the message remains undelivered. Eventually the
35401 mail delivery software will give up, and when that happens,
35402 the message will be returned to you.
35403 .endd
35404 .vindex "&$warn_message_delay$&"
35405 .vindex "&$warn_message_recipients$&"
35406 However, in the default state the subject and date lines are omitted if no
35407 appropriate headers exist. During the expansion of this file,
35408 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
35409 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
35410 of recipients for the warning message. There may be more than one if there are
35411 multiple addresses with different &%errors_to%& settings on the routers that
35412 handled them.
35413
35414
35415
35416
35417 . ////////////////////////////////////////////////////////////////////////////
35418 . ////////////////////////////////////////////////////////////////////////////
35419
35420 .chapter "Some common configuration settings" "CHAPcomconreq"
35421 This chapter discusses some configuration settings that seem to be fairly
35422 common. More examples and discussion can be found in the Exim book.
35423
35424
35425
35426 .section "Sending mail to a smart host" "SECID240"
35427 .cindex "smart host" "example router"
35428 If you want to send all mail for non-local domains to a &"smart host"&, you
35429 should replace the default &(dnslookup)& router with a router which does the
35430 routing explicitly:
35431 .code
35432 send_to_smart_host:
35433   driver = manualroute
35434   route_list = !+local_domains smart.host.name
35435   transport = remote_smtp
35436 .endd
35437 You can use the smart host's IP address instead of the name if you wish.
35438 If you are using Exim only to submit messages to a smart host, and not for
35439 receiving incoming messages, you can arrange for it to do the submission
35440 synchronously by setting the &%mua_wrapper%& option (see chapter
35441 &<<CHAPnonqueueing>>&).
35442
35443
35444
35445
35446 .section "Using Exim to handle mailing lists" "SECTmailinglists"
35447 .cindex "mailing lists"
35448 Exim can be used to run simple mailing lists, but for large and/or complicated
35449 requirements, the use of additional specialized mailing list software such as
35450 Majordomo or Mailman is recommended.
35451
35452 The &(redirect)& router can be used to handle mailing lists where each list
35453 is maintained in a separate file, which can therefore be managed by an
35454 independent manager. The &%domains%& router option can be used to run these
35455 lists in a separate domain from normal mail. For example:
35456 .code
35457 lists:
35458   driver = redirect
35459   domains = lists.example
35460   file = /usr/lists/$local_part
35461   forbid_pipe
35462   forbid_file
35463   errors_to = $local_part-request@lists.example
35464   no_more
35465 .endd
35466 This router is skipped for domains other than &'lists.example'&. For addresses
35467 in that domain, it looks for a file that matches the local part. If there is no
35468 such file, the router declines, but because &%no_more%& is set, no subsequent
35469 routers are tried, and so the whole delivery fails.
35470
35471 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
35472 expanded into a file name or a pipe delivery, which is usually inappropriate in
35473 a mailing list.
35474
35475 .oindex "&%errors_to%&"
35476 The &%errors_to%& option specifies that any delivery errors caused by addresses
35477 taken from a mailing list are to be sent to the given address rather than the
35478 original sender of the message. However, before acting on this, Exim verifies
35479 the error address, and ignores it if verification fails.
35480
35481 For example, using the configuration above, mail sent to
35482 &'dicts@lists.example'& is passed on to those addresses contained in
35483 &_/usr/lists/dicts_&, with error reports directed to
35484 &'dicts-request@lists.example'&, provided that this address can be verified.
35485 There could be a file called &_/usr/lists/dicts-request_& containing
35486 the address(es) of this particular list's manager(s), but other approaches,
35487 such as setting up an earlier router (possibly using the &%local_part_prefix%&
35488 or &%local_part_suffix%& options) to handle addresses of the form
35489 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
35490
35491
35492
35493 .section "Syntax errors in mailing lists" "SECID241"
35494 .cindex "mailing lists" "syntax errors in"
35495 If an entry in redirection data contains a syntax error, Exim normally defers
35496 delivery of the original address. That means that a syntax error in a mailing
35497 list holds up all deliveries to the list. This may not be appropriate when a
35498 list is being maintained automatically from data supplied by users, and the
35499 addresses are not rigorously checked.
35500
35501 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
35502 entries that fail to parse, noting the incident in the log. If in addition
35503 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
35504 whenever a broken address is skipped. It is usually appropriate to set
35505 &%syntax_errors_to%& to the same address as &%errors_to%&.
35506
35507
35508
35509 .section "Re-expansion of mailing lists" "SECID242"
35510 .cindex "mailing lists" "re-expansion of"
35511 Exim remembers every individual address to which a message has been delivered,
35512 in order to avoid duplication, but it normally stores only the original
35513 recipient addresses with a message. If all the deliveries to a mailing list
35514 cannot be done at the first attempt, the mailing list is re-expanded when the
35515 delivery is next tried. This means that alterations to the list are taken into
35516 account at each delivery attempt, so addresses that have been added to
35517 the list since the message arrived will therefore receive a copy of the
35518 message, even though it pre-dates their subscription.
35519
35520 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
35521 on the &(redirect)& router. If this is done, any addresses generated by the
35522 router that fail to deliver at the first attempt are added to the message as
35523 &"top level"& addresses, and the parent address that generated them is marked
35524 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
35525 subsequent delivery attempts. The disadvantage of this is that if any of the
35526 failing addresses are incorrect, correcting them in the file has no effect on
35527 pre-existing messages.
35528
35529 The original top-level address is remembered with each of the generated
35530 addresses, and is output in any log messages. However, any intermediate parent
35531 addresses are not recorded. This makes a difference to the log only if the
35532 &%all_parents%& selector is set, but for mailing lists there is normally only
35533 one level of expansion anyway.
35534
35535
35536
35537 .section "Closed mailing lists" "SECID243"
35538 .cindex "mailing lists" "closed"
35539 The examples so far have assumed open mailing lists, to which anybody may
35540 send mail. It is also possible to set up closed lists, where mail is accepted
35541 from specified senders only. This is done by making use of the generic
35542 &%senders%& option to restrict the router that handles the list.
35543
35544 The following example uses the same file as a list of recipients and as a list
35545 of permitted senders. It requires three routers:
35546 .code
35547 lists_request:
35548   driver = redirect
35549   domains = lists.example
35550   local_part_suffix = -request
35551   file = /usr/lists/$local_part$local_part_suffix
35552   no_more
35553
35554 lists_post:
35555   driver = redirect
35556   domains = lists.example
35557   senders = ${if exists {/usr/lists/$local_part}\
35558              {lsearch;/usr/lists/$local_part}{*}}
35559   file = /usr/lists/$local_part
35560   forbid_pipe
35561   forbid_file
35562   errors_to = $local_part-request@lists.example
35563   no_more
35564
35565 lists_closed:
35566   driver = redirect
35567   domains = lists.example
35568   allow_fail
35569   data = :fail: $local_part@lists.example is a closed mailing list
35570 .endd
35571 All three routers have the same &%domains%& setting, so for any other domains,
35572 they are all skipped. The first router runs only if the local part ends in
35573 &%-request%&. It handles messages to the list manager(s) by means of an open
35574 mailing list.
35575
35576 The second router runs only if the &%senders%& precondition is satisfied. It
35577 checks for the existence of a list that corresponds to the local part, and then
35578 checks that the sender is on the list by means of a linear search. It is
35579 necessary to check for the existence of the file before trying to search it,
35580 because otherwise Exim thinks there is a configuration error. If the file does
35581 not exist, the expansion of &%senders%& is *, which matches all senders. This
35582 means that the router runs, but because there is no list, declines, and
35583 &%no_more%& ensures that no further routers are run. The address fails with an
35584 &"unrouteable address"& error.
35585
35586 The third router runs only if the second router is skipped, which happens when
35587 a mailing list exists, but the sender is not on it. This router forcibly fails
35588 the address, giving a suitable error message.
35589
35590
35591
35592
35593 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
35594 .cindex "VERP"
35595 .cindex "Variable Envelope Return Paths"
35596 .cindex "envelope sender"
35597 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
35598 are a way of helping mailing list administrators discover which subscription
35599 address is the cause of a particular delivery failure. The idea is to encode
35600 the original recipient address in the outgoing envelope sender address, so that
35601 if the message is forwarded by another host and then subsequently bounces, the
35602 original recipient can be extracted from the recipient address of the bounce.
35603
35604 .oindex &%errors_to%&
35605 .oindex &%return_path%&
35606 Envelope sender addresses can be modified by Exim using two different
35607 facilities: the &%errors_to%& option on a router (as shown in previous mailing
35608 list examples), or the &%return_path%& option on a transport. The second of
35609 these is effective only if the message is successfully delivered to another
35610 host; it is not used for errors detected on the local host (see the description
35611 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
35612 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
35613 .code
35614 verp_smtp:
35615   driver = smtp
35616   max_rcpt = 1
35617   return_path = \
35618     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
35619       {$1-request+$local_part=$domain@your.dom.example}fail}
35620 .endd
35621 This has the effect of rewriting the return path (envelope sender) on outgoing
35622 SMTP messages, if the local part of the original return path ends in
35623 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
35624 local part and domain of the recipient into the return path. Suppose, for
35625 example, that a message whose return path has been set to
35626 &'somelist-request@your.dom.example'& is sent to
35627 &'subscriber@other.dom.example'&. In the transport, the return path is
35628 rewritten as
35629 .code
35630 somelist-request+subscriber=other.dom.example@your.dom.example
35631 .endd
35632 .vindex "&$local_part$&"
35633 For this to work, you must tell Exim to send multiple copies of messages that
35634 have more than one recipient, so that each copy has just one recipient. This is
35635 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
35636 might be sent to several different recipients in the same domain, in which case
35637 &$local_part$& is not available in the transport, because it is not unique.
35638
35639 Unless your host is doing nothing but mailing list deliveries, you should
35640 probably use a separate transport for the VERP deliveries, so as not to use
35641 extra resources in making one-per-recipient copies for other deliveries. This
35642 can easily be done by expanding the &%transport%& option in the router:
35643 .code
35644 dnslookup:
35645   driver = dnslookup
35646   domains = ! +local_domains
35647   transport = \
35648     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
35649       {verp_smtp}{remote_smtp}}
35650   no_more
35651 .endd
35652 If you want to change the return path using &%errors_to%& in a router instead
35653 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
35654 routers that handle mailing list addresses. This will ensure that all delivery
35655 errors, including those detected on the local host, are sent to the VERP
35656 address.
35657
35658 On a host that does no local deliveries and has no manual routing, only the
35659 &(dnslookup)& router needs to be changed. A special transport is not needed for
35660 SMTP deliveries. Every mailing list recipient has its own return path value,
35661 and so Exim must hand them to the transport one at a time. Here is an example
35662 of a &(dnslookup)& router that implements VERP:
35663 .code
35664 verp_dnslookup:
35665   driver = dnslookup
35666   domains = ! +local_domains
35667   transport = remote_smtp
35668   errors_to = \
35669     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
35670      {$1-request+$local_part=$domain@your.dom.example}fail}
35671   no_more
35672 .endd
35673 Before you start sending out messages with VERPed return paths, you must also
35674 configure Exim to accept the bounce messages that come back to those paths.
35675 Typically this is done by setting a &%local_part_suffix%& option for a
35676 router, and using this to route the messages to wherever you want to handle
35677 them.
35678
35679 The overhead incurred in using VERP depends very much on the size of the
35680 message, the number of recipient addresses that resolve to the same remote
35681 host, and the speed of the connection over which the message is being sent. If
35682 a lot of addresses resolve to the same host and the connection is slow, sending
35683 a separate copy of the message for each address may take substantially longer
35684 than sending a single copy with many recipients (for which VERP cannot be
35685 used).
35686
35687
35688
35689
35690
35691
35692 .section "Virtual domains" "SECTvirtualdomains"
35693 .cindex "virtual domains"
35694 .cindex "domain" "virtual"
35695 The phrase &'virtual domain'& is unfortunately used with two rather different
35696 meanings:
35697
35698 .ilist
35699 A domain for which there are no real mailboxes; all valid local parts are
35700 aliases for other email addresses. Common examples are organizational
35701 top-level domains and &"vanity"& domains.
35702 .next
35703 One of a number of independent domains that are all handled by the same host,
35704 with mailboxes on that host, but where the mailbox owners do not necessarily
35705 have login accounts on that host.
35706 .endlist
35707
35708 The first usage is probably more common, and does seem more &"virtual"& than
35709 the second. This kind of domain can be handled in Exim with a straightforward
35710 aliasing router. One approach is to create a separate alias file for each
35711 virtual domain. Exim can test for the existence of the alias file to determine
35712 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
35713 to a router of this form:
35714 .code
35715 virtual:
35716   driver = redirect
35717   domains = dsearch;/etc/mail/virtual
35718   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
35719   no_more
35720 .endd
35721 The &%domains%& option specifies that the router is to be skipped, unless there
35722 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
35723 domain that is being processed. When the router runs, it looks up the local
35724 part in the file to find a new address (or list of addresses). The &%no_more%&
35725 setting ensures that if the lookup fails (leading to &%data%& being an empty
35726 string), Exim gives up on the address without trying any subsequent routers.
35727
35728 This one router can handle all the virtual domains because the alias file names
35729 follow a fixed pattern. Permissions can be arranged so that appropriate people
35730 can edit the different alias files. A successful aliasing operation results in
35731 a new envelope recipient address, which is then routed from scratch.
35732
35733 The other kind of &"virtual"& domain can also be handled in a straightforward
35734 way. One approach is to create a file for each domain containing a list of
35735 valid local parts, and use it in a router like this:
35736 .code
35737 my_domains:
35738   driver = accept
35739   domains = dsearch;/etc/mail/domains
35740   local_parts = lsearch;/etc/mail/domains/$domain
35741   transport = my_mailboxes
35742 .endd
35743 The address is accepted if there is a file for the domain, and the local part
35744 can be found in the file. The &%domains%& option is used to check for the
35745 file's existence because &%domains%& is tested before the &%local_parts%&
35746 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
35747 because that option is tested after &%local_parts%&. The transport is as
35748 follows:
35749 .code
35750 my_mailboxes:
35751   driver = appendfile
35752   file = /var/mail/$domain/$local_part
35753   user = mail
35754 .endd
35755 This uses a directory of mailboxes for each domain. The &%user%& setting is
35756 required, to specify which uid is to be used for writing to the mailboxes.
35757
35758 The configuration shown here is just one example of how you might support this
35759 requirement. There are many other ways this kind of configuration can be set
35760 up, for example, by using a database instead of separate files to hold all the
35761 information about the domains.
35762
35763
35764
35765 .section "Multiple user mailboxes" "SECTmulbox"
35766 .cindex "multiple mailboxes"
35767 .cindex "mailbox" "multiple"
35768 .cindex "local part" "prefix"
35769 .cindex "local part" "suffix"
35770 Heavy email users often want to operate with multiple mailboxes, into which
35771 incoming mail is automatically sorted. A popular way of handling this is to
35772 allow users to use multiple sender addresses, so that replies can easily be
35773 identified. Users are permitted to add prefixes or suffixes to their local
35774 parts for this purpose. The wildcard facility of the generic router options
35775 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
35776 example, consider this router:
35777 .code
35778 userforward:
35779   driver = redirect
35780   check_local_user
35781   file = $home/.forward
35782   local_part_suffix = -*
35783   local_part_suffix_optional
35784   allow_filter
35785 .endd
35786 .vindex "&$local_part_suffix$&"
35787 It runs a user's &_.forward_& file for all local parts of the form
35788 &'username-*'&. Within the filter file the user can distinguish different
35789 cases by testing the variable &$local_part_suffix$&. For example:
35790 .code
35791 if $local_part_suffix contains -special then
35792 save /home/$local_part/Mail/special
35793 endif
35794 .endd
35795 If the filter file does not exist, or does not deal with such addresses, they
35796 fall through to subsequent routers, and, assuming no subsequent use of the
35797 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
35798 control over which suffixes are valid.
35799
35800 Alternatively, a suffix can be used to trigger the use of a different
35801 &_.forward_& file &-- which is the way a similar facility is implemented in
35802 another MTA:
35803 .code
35804 userforward:
35805   driver = redirect
35806   check_local_user
35807   file = $home/.forward$local_part_suffix
35808   local_part_suffix = -*
35809   local_part_suffix_optional
35810   allow_filter
35811 .endd
35812 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
35813 example, &_.forward-special_& is used. Once again, if the appropriate file
35814 does not exist, or does not deal with the address, it is passed on to
35815 subsequent routers, which could, if required, look for an unqualified
35816 &_.forward_& file to use as a default.
35817
35818
35819
35820 .section "Simplified vacation processing" "SECID244"
35821 .cindex "vacation processing"
35822 The traditional way of running the &'vacation'& program is for a user to set up
35823 a pipe command in a &_.forward_& file
35824 (see section &<<SECTspecitredli>>& for syntax details).
35825 This is prone to error by inexperienced users. There are two features of Exim
35826 that can be used to make this process simpler for users:
35827
35828 .ilist
35829 A local part prefix such as &"vacation-"& can be specified on a router which
35830 can cause the message to be delivered directly to the &'vacation'& program, or
35831 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
35832 &_.forward_& file are then much simpler. For example:
35833 .code
35834 spqr, vacation-spqr
35835 .endd
35836 .next
35837 The &%require_files%& generic router option can be used to trigger a
35838 vacation delivery by checking for the existence of a certain file in the
35839 user's home directory. The &%unseen%& generic option should also be used, to
35840 ensure that the original delivery also proceeds. In this case, all the user has
35841 to do is to create a file called, say, &_.vacation_&, containing a vacation
35842 message.
35843 .endlist
35844
35845 Another advantage of both these methods is that they both work even when the
35846 use of arbitrary pipes by users is locked out.
35847
35848
35849
35850 .section "Taking copies of mail" "SECID245"
35851 .cindex "message" "copying every"
35852 Some installations have policies that require archive copies of all messages to
35853 be made. A single copy of each message can easily be taken by an appropriate
35854 command in a system filter, which could, for example, use a different file for
35855 each day's messages.
35856
35857 There is also a shadow transport mechanism that can be used to take copies of
35858 messages that are successfully delivered by local transports, one copy per
35859 delivery. This could be used, &'inter alia'&, to implement automatic
35860 notification of delivery by sites that insist on doing such things.
35861
35862
35863
35864 .section "Intermittently connected hosts" "SECID246"
35865 .cindex "intermittently connected hosts"
35866 It has become quite common (because it is cheaper) for hosts to connect to the
35867 Internet periodically rather than remain connected all the time. The normal
35868 arrangement is that mail for such hosts accumulates on a system that is
35869 permanently connected.
35870
35871 Exim was designed for use on permanently connected hosts, and so it is not
35872 particularly well-suited to use in an intermittently connected environment.
35873 Nevertheless there are some features that can be used.
35874
35875
35876 .section "Exim on the upstream server host" "SECID247"
35877 It is tempting to arrange for incoming mail for the intermittently connected
35878 host to remain on Exim's queue until the client connects. However, this
35879 approach does not scale very well. Two different kinds of waiting message are
35880 being mixed up in the same queue &-- those that cannot be delivered because of
35881 some temporary problem, and those that are waiting for their destination host
35882 to connect. This makes it hard to manage the queue, as well as wasting
35883 resources, because each queue runner scans the entire queue.
35884
35885 A better approach is to separate off those messages that are waiting for an
35886 intermittently connected host. This can be done by delivering these messages
35887 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
35888 format, from where they are transmitted by other software when their
35889 destination connects. This makes it easy to collect all the mail for one host
35890 in a single directory, and to apply local timeout rules on a per-message basis
35891 if required.
35892
35893 On a very small scale, leaving the mail on Exim's queue can be made to work. If
35894 you are doing this, you should configure Exim with a long retry period for the
35895 intermittent host. For example:
35896 .code
35897 cheshire.wonderland.fict.example    *   F,5d,24h
35898 .endd
35899 This stops a lot of failed delivery attempts from occurring, but Exim remembers
35900 which messages it has queued up for that host. Once the intermittent host comes
35901 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
35902 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
35903 causes all the queued up messages to be delivered, often down a single SMTP
35904 connection. While the host remains connected, any new messages get delivered
35905 immediately.
35906
35907 If the connecting hosts do not have fixed IP addresses, that is, if a host is
35908 issued with a different IP address each time it connects, Exim's retry
35909 mechanisms on the holding host get confused, because the IP address is normally
35910 used as part of the key string for holding retry information. This can be
35911 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
35912 Since this has disadvantages for permanently connected hosts, it is best to
35913 arrange a separate transport for the intermittently connected ones.
35914
35915
35916
35917 .section "Exim on the intermittently connected client host" "SECID248"
35918 The value of &%smtp_accept_queue_per_connection%& should probably be
35919 increased, or even set to zero (that is, disabled) on the intermittently
35920 connected host, so that all incoming messages down a single connection get
35921 delivered immediately.
35922
35923 .cindex "SMTP" "passed connection"
35924 .cindex "SMTP" "multiple deliveries"
35925 .cindex "multiple SMTP deliveries"
35926 Mail waiting to be sent from an intermittently connected host will probably
35927 not have been routed, because without a connection DNS lookups are not
35928 possible. This means that if a normal queue run is done at connection time,
35929 each message is likely to be sent in a separate SMTP session. This can be
35930 avoided by starting the queue run with a command line option beginning with
35931 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
35932 first pass, routing is done but no deliveries take place. The second pass is a
35933 normal queue run; since all the messages have been previously routed, those
35934 destined for the same host are likely to get sent as multiple deliveries in a
35935 single SMTP connection.
35936
35937
35938
35939 . ////////////////////////////////////////////////////////////////////////////
35940 . ////////////////////////////////////////////////////////////////////////////
35941
35942 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
35943          "Exim as a non-queueing client"
35944 .cindex "client, non-queueing"
35945 .cindex "smart host" "suppressing queueing"
35946 On a personal computer, it is a common requirement for all
35947 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
35948 configured to operate that way, for all the popular operating systems.
35949 However, there are some MUAs for Unix-like systems that cannot be so
35950 configured: they submit messages using the command line interface of
35951 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
35952 messages this way.
35953
35954 If the personal computer runs continuously, there is no problem, because it can
35955 run a conventional MTA that handles delivery to the smart host, and deal with
35956 any delays via its queueing mechanism. However, if the computer does not run
35957 continuously or runs different operating systems at different times, queueing
35958 email is not desirable.
35959
35960 There is therefore a requirement for something that can provide the
35961 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
35962 any queueing or retrying facilities. Furthermore, the delivery to the smart
35963 host should be synchronous, so that if it fails, the sending MUA is immediately
35964 informed. In other words, we want something that extends an MUA that submits
35965 to a local MTA via the command line so that it behaves like one that submits
35966 to a remote smart host using TCP/SMTP.
35967
35968 There are a number of applications (for example, there is one called &'ssmtp'&)
35969 that do this job. However, people have found them to be lacking in various
35970 ways. For instance, you might want to allow aliasing and forwarding to be done
35971 before sending a message to the smart host.
35972
35973 Exim already had the necessary infrastructure for doing this job. Just a few
35974 tweaks were needed to make it behave as required, though it is somewhat of an
35975 overkill to use a fully-featured MTA for this purpose.
35976
35977 .oindex "&%mua_wrapper%&"
35978 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
35979 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
35980 assumes that it is being used to &"wrap"& a command-line MUA in the manner
35981 just described. As well as setting &%mua_wrapper%&, you also need to provide a
35982 compatible router and transport configuration. Typically there will be just one
35983 router and one transport, sending everything to a smart host.
35984
35985 When run in MUA wrapping mode, the behaviour of Exim changes in the
35986 following ways:
35987
35988 .ilist
35989 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
35990 In other words, the only way to submit messages is via the command line.
35991 .next
35992 Each message is synchronously delivered as soon as it is received (&%-odi%& is
35993 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
35994 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
35995 does not finish until the delivery attempt is complete. If the delivery is
35996 successful, a zero return code is given.
35997 .next
35998 Address redirection is permitted, but the final routing for all addresses must
35999 be to the same remote transport, and to the same list of hosts. Furthermore,
36000 the return address (envelope sender) must be the same for all recipients, as
36001 must any added or deleted header lines. In other words, it must be possible to
36002 deliver the message in a single SMTP transaction, however many recipients there
36003 are.
36004 .next
36005 If these conditions are not met, or if routing any address results in a
36006 failure or defer status, or if Exim is unable to deliver all the recipients
36007 successfully to one of the smart hosts, delivery of the entire message fails.
36008 .next
36009 Because no queueing is allowed, all failures are treated as permanent; there
36010 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
36011 smart host. Furthermore, because only a single yes/no response can be given to
36012 the caller, it is not possible to deliver to some recipients and not others. If
36013 there is an error (temporary or permanent) for any recipient, all are failed.
36014 .next
36015 If more than one smart host is listed, Exim will try another host after a
36016 connection failure or a timeout, in the normal way. However, if this kind of
36017 failure happens for all the hosts, the delivery fails.
36018 .next
36019 When delivery fails, an error message is written to the standard error stream
36020 (as well as to Exim's log), and Exim exits to the caller with a return code
36021 value 1. The message is expunged from Exim's spool files. No bounce messages
36022 are ever generated.
36023 .next
36024 No retry data is maintained, and any retry rules are ignored.
36025 .next
36026 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
36027 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
36028 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
36029 .endlist
36030
36031 The overall effect is that Exim makes a single synchronous attempt to deliver
36032 the message, failing if there is any kind of problem. Because no local
36033 deliveries are done and no daemon can be run, Exim does not need root
36034 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
36035 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
36036 the advantages and disadvantages of running without root privilege.
36037
36038
36039
36040
36041 . ////////////////////////////////////////////////////////////////////////////
36042 . ////////////////////////////////////////////////////////////////////////////
36043
36044 .chapter "Log files" "CHAPlog"
36045 .scindex IIDloggen "log" "general description"
36046 .cindex "log" "types of"
36047 Exim writes three different logs, referred to as the main log, the reject log,
36048 and the panic log:
36049
36050 .ilist
36051 .cindex "main log"
36052 The main log records the arrival of each message and each delivery in a single
36053 line in each case. The format is as compact as possible, in an attempt to keep
36054 down the size of log files. Two-character flag sequences make it easy to pick
36055 out these lines. A number of other events are recorded in the main log. Some of
36056 them are optional, in which case the &%log_selector%& option controls whether
36057 they are included or not. A Perl script called &'eximstats'&, which does simple
36058 analysis of main log files, is provided in the Exim distribution (see section
36059 &<<SECTmailstat>>&).
36060 .next
36061 .cindex "reject log"
36062 The reject log records information from messages that are rejected as a result
36063 of a configuration option (that is, for policy reasons).
36064 The first line of each rejection is a copy of the line that is also written to
36065 the main log. Then, if the message's header has been read at the time the log
36066 is written, its contents are written to this log. Only the original header
36067 lines are available; header lines added by ACLs are not logged. You can use the
36068 reject log to check that your policy controls are working correctly; on a busy
36069 host this may be easier than scanning the main log for rejection messages. You
36070 can suppress the writing of the reject log by setting &%write_rejectlog%&
36071 false.
36072 .next
36073 .cindex "panic log"
36074 .cindex "system log"
36075 When certain serious errors occur, Exim writes entries to its panic log. If the
36076 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
36077 are usually written to the main log as well, but can get lost amid the mass of
36078 other entries. The panic log should be empty under normal circumstances. It is
36079 therefore a good idea to check it (or to have a &'cron'& script check it)
36080 regularly, in order to become aware of any problems. When Exim cannot open its
36081 panic log, it tries as a last resort to write to the system log (syslog). This
36082 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
36083 message itself is written at priority LOG_CRIT.
36084 .endlist
36085
36086 Every log line starts with a timestamp, in the format shown in the following
36087 example. Note that many of the examples shown in this chapter are line-wrapped.
36088 In the log file, this would be all on one line:
36089 .code
36090 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
36091   by QUIT
36092 .endd
36093 By default, the timestamps are in the local timezone. There are two
36094 ways of changing this:
36095
36096 .ilist
36097 You can set the &%timezone%& option to a different time zone; in particular, if
36098 you set
36099 .code
36100 timezone = UTC
36101 .endd
36102 the timestamps will be in UTC (aka GMT).
36103 .next
36104 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
36105 example:
36106 .code
36107 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
36108 .endd
36109 .endlist
36110
36111 .cindex "log" "process ids in"
36112 .cindex "pid (process id)" "in log lines"
36113 Exim does not include its process id in log lines by default, but you can
36114 request that it does so by specifying the &`pid`& log selector (see section
36115 &<<SECTlogselector>>&). When this is set, the process id is output, in square
36116 brackets, immediately after the time and date.
36117
36118
36119
36120
36121 .section "Where the logs are written" "SECTwhelogwri"
36122 .cindex "log" "destination"
36123 .cindex "log" "to file"
36124 .cindex "log" "to syslog"
36125 .cindex "syslog"
36126 The logs may be written to local files, or to syslog, or both. However, it
36127 should be noted that many syslog implementations use UDP as a transport, and
36128 are therefore unreliable in the sense that messages are not guaranteed to
36129 arrive at the loghost, nor is the ordering of messages necessarily maintained.
36130 It has also been reported that on large log files (tens of megabytes) you may
36131 need to tweak syslog to prevent it syncing the file with each write &-- on
36132 Linux this has been seen to make syslog take 90% plus of CPU time.
36133
36134 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
36135 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
36136 configuration. This latter string is expanded, so it can contain, for example,
36137 references to the host name:
36138 .code
36139 log_file_path = /var/log/$primary_hostname/exim_%slog
36140 .endd
36141 It is generally advisable, however, to set the string in &_Local/Makefile_&
36142 rather than at run time, because then the setting is available right from the
36143 start of Exim's execution. Otherwise, if there's something it wants to log
36144 before it has read the configuration file (for example, an error in the
36145 configuration file) it will not use the path you want, and may not be able to
36146 log at all.
36147
36148 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
36149 list, currently limited to at most two items. This is one option where the
36150 facility for changing a list separator may not be used. The list must always be
36151 colon-separated. If an item in the list is &"syslog"& then syslog is used;
36152 otherwise the item must either be an absolute path, containing &`%s`& at the
36153 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
36154 implying the use of a default path.
36155
36156 When Exim encounters an empty item in the list, it searches the list defined by
36157 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
36158 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
36159 mean &"use the path specified at build time"&. It no such item exists, log
36160 files are written in the &_log_& subdirectory of the spool directory. This is
36161 equivalent to the setting:
36162 .code
36163 log_file_path = $spool_directory/log/%slog
36164 .endd
36165 If you do not specify anything at build time or run time,
36166 or if you unset the option at run time (i.e. &`log_file_path = `&),
36167 that is where the logs are written.
36168
36169 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
36170 are in use &-- see section &<<SECTdatlogfil>>& below.
36171
36172 Here are some examples of possible settings:
36173 .display
36174 &`LOG_FILE_PATH=syslog                    `& syslog only
36175 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
36176 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
36177 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
36178 .endd
36179 If there are more than two paths in the list, the first is used and a panic
36180 error is logged.
36181
36182
36183
36184 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
36185 .cindex "log" "cycling local files"
36186 .cindex "cycling logs"
36187 .cindex "&'exicyclog'&"
36188 .cindex "log" "local files; writing to"
36189 Some operating systems provide centralized and standardized methods for cycling
36190 log files. For those that do not, a utility script called &'exicyclog'& is
36191 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
36192 main and reject logs each time it is called. The maximum number of old logs to
36193 keep can be set. It is suggested this script is run as a daily &'cron'& job.
36194
36195 An Exim delivery process opens the main log when it first needs to write to it,
36196 and it keeps the file open in case subsequent entries are required &-- for
36197 example, if a number of different deliveries are being done for the same
36198 message. However, remote SMTP deliveries can take a long time, and this means
36199 that the file may be kept open long after it is renamed if &'exicyclog'& or
36200 something similar is being used to rename log files on a regular basis. To
36201 ensure that a switch of log files is noticed as soon as possible, Exim calls
36202 &[stat()]& on the main log's name before reusing an open file, and if the file
36203 does not exist, or its inode has changed, the old file is closed and Exim
36204 tries to open the main log from scratch. Thus, an old log file may remain open
36205 for quite some time, but no Exim processes should write to it once it has been
36206 renamed.
36207
36208
36209
36210 .section "Datestamped log files" "SECTdatlogfil"
36211 .cindex "log" "datestamped files"
36212 Instead of cycling the main and reject log files by renaming them
36213 periodically, some sites like to use files whose names contain a datestamp,
36214 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
36215 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
36216 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
36217 point where the datestamp is required. For example:
36218 .code
36219 log_file_path = /var/spool/exim/log/%slog-%D
36220 log_file_path = /var/log/exim-%s-%D.log
36221 log_file_path = /var/spool/exim/log/%D-%slog
36222 log_file_path = /var/log/exim/%s.%M
36223 .endd
36224 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
36225 examples of names generated by the above examples:
36226 .code
36227 /var/spool/exim/log/mainlog-20021225
36228 /var/log/exim-reject-20021225.log
36229 /var/spool/exim/log/20021225-mainlog
36230 /var/log/exim/main.200212
36231 .endd
36232 When this form of log file is specified, Exim automatically switches to new
36233 files at midnight. It does not make any attempt to compress old logs; you
36234 will need to write your own script if you require this. You should not
36235 run &'exicyclog'& with this form of logging.
36236
36237 The location of the panic log is also determined by &%log_file_path%&, but it
36238 is not datestamped, because rotation of the panic log does not make sense.
36239 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
36240 the string. In addition, if it immediately follows a slash, a following
36241 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
36242 character is removed. Thus, the four examples above would give these panic
36243 log names:
36244 .code
36245 /var/spool/exim/log/paniclog
36246 /var/log/exim-panic.log
36247 /var/spool/exim/log/paniclog
36248 /var/log/exim/panic
36249 .endd
36250
36251
36252 .section "Logging to syslog" "SECID249"
36253 .cindex "log" "syslog; writing to"
36254 The use of syslog does not change what Exim logs or the format of its messages,
36255 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
36256 Exim's log lines are omitted when these lines are sent to syslog. Apart from
36257 that, the same strings are written to syslog as to log files. The syslog
36258 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
36259 by default, but you can change these by setting the &%syslog_facility%& and
36260 &%syslog_processname%& options, respectively. If Exim was compiled with
36261 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
36262 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
36263 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
36264 the time and host name to each line.
36265 The three log streams are mapped onto syslog priorities as follows:
36266
36267 .ilist
36268 &'mainlog'& is mapped to LOG_INFO
36269 .next
36270 &'rejectlog'& is mapped to LOG_NOTICE
36271 .next
36272 &'paniclog'& is mapped to LOG_ALERT
36273 .endlist
36274
36275 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
36276 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
36277 these are routed by syslog to the same place. You can suppress this duplication
36278 by setting &%syslog_duplication%& false.
36279
36280 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
36281 entries contain multiple lines when headers are included. To cope with both
36282 these cases, entries written to syslog are split into separate &[syslog()]&
36283 calls at each internal newline, and also after a maximum of
36284 870 data characters. (This allows for a total syslog line length of 1024, when
36285 additions such as timestamps are added.) If you are running a syslog
36286 replacement that can handle lines longer than the 1024 characters allowed by
36287 RFC 3164, you should set
36288 .code
36289 SYSLOG_LONG_LINES=yes
36290 .endd
36291 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
36292 lines, but it still splits at internal newlines in &'reject'& log entries.
36293
36294 To make it easy to re-assemble split lines later, each component of a split
36295 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
36296 where <&'n'&> is the component number and <&'m'&> is the total number of
36297 components in the entry. The / delimiter is used when the line was split
36298 because it was too long; if it was split because of an internal newline, the \
36299 delimiter is used. For example, supposing the length limit to be 50 instead of
36300 870, the following would be the result of a typical rejection message to
36301 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
36302 name, and pid as added by syslog:
36303 .code
36304 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
36305 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
36306 [3/5]  when scanning for sender: missing or malformed lo
36307 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
36308 [5/5] mple>)
36309 .endd
36310 The same error might cause the following lines to be written to &"rejectlog"&
36311 (LOG_NOTICE):
36312 .code
36313 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
36314 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
36315 [3/18] er when scanning for sender: missing or malformed
36316 [4/18]  local part in "<>" (envelope sender is <ph10@cam
36317 [5\18] .example>)
36318 [6\18] Recipients: ph10@some.domain.cam.example
36319 [7\18] P Received: from [127.0.0.1] (ident=ph10)
36320 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
36321 [9\18]        id 16RdAL-0006pc-00
36322 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
36323 [11\18] 09:43 +0100
36324 [12\18] F From: <>
36325 [13\18]   Subject: this is a test header
36326 [18\18]   X-something: this is another header
36327 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
36328 [16\18] le>
36329 [17\18] B Bcc:
36330 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
36331 .endd
36332 Log lines that are neither too long nor contain newlines are written to syslog
36333 without modification.
36334
36335 If only syslog is being used, the Exim monitor is unable to provide a log tail
36336 display, unless syslog is routing &'mainlog'& to a file on the local host and
36337 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
36338 where it is.
36339
36340
36341
36342 .section "Log line flags" "SECID250"
36343 One line is written to the main log for each message received, and for each
36344 successful, unsuccessful, and delayed delivery. These lines can readily be
36345 picked out by the distinctive two-character flags that immediately follow the
36346 timestamp. The flags are:
36347 .display
36348 &`<=`&     message arrival
36349 &`(=`&     message fakereject
36350 &`=>`&     normal message delivery
36351 &`->`&     additional address in same delivery
36352 &`>>`&     cutthrough message delivery
36353 &`*>`&     delivery suppressed by &%-N%&
36354 &`**`&     delivery failed; address bounced
36355 &`==`&     delivery deferred; temporary problem
36356 .endd
36357
36358
36359 .section "Logging message reception" "SECID251"
36360 .cindex "log" "reception line"
36361 The format of the single-line entry in the main log that is written for every
36362 message received is shown in the basic example below, which is split over
36363 several lines in order to fit it on the page:
36364 .code
36365 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
36366   H=mailer.fict.example [192.168.123.123] U=exim
36367   P=smtp S=5678 id=<incoming message id>
36368 .endd
36369 The address immediately following &"<="& is the envelope sender address. A
36370 bounce message is shown with the sender address &"<>"&, and if it is locally
36371 generated, this is followed by an item of the form
36372 .code
36373 R=<message id>
36374 .endd
36375 which is a reference to the message that caused the bounce to be sent.
36376
36377 .cindex "HELO"
36378 .cindex "EHLO"
36379 For messages from other hosts, the H and U fields identify the remote host and
36380 record the RFC 1413 identity of the user that sent the message, if one was
36381 received. The number given in square brackets is the IP address of the sending
36382 host. If there is a single, unparenthesized  host name in the H field, as
36383 above, it has been verified to correspond to the IP address (see the
36384 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
36385 by the remote host in the SMTP HELO or EHLO command, and has not been
36386 verified. If verification yields a different name to that given for HELO or
36387 EHLO, the verified name appears first, followed by the HELO or EHLO
36388 name in parentheses.
36389
36390 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
36391 without brackets, in the HELO or EHLO command, leading to entries in
36392 the log containing text like these examples:
36393 .code
36394 H=(10.21.32.43) [192.168.8.34]
36395 H=([10.21.32.43]) [192.168.8.34]
36396 .endd
36397 This can be confusing. Only the final address in square brackets can be relied
36398 on.
36399
36400 For locally generated messages (that is, messages not received over TCP/IP),
36401 the H field is omitted, and the U field contains the login name of the caller
36402 of Exim.
36403
36404 .cindex "authentication" "logging"
36405 .cindex "AUTH" "logging"
36406 For all messages, the P field specifies the protocol used to receive the
36407 message. This is the value that is stored in &$received_protocol$&. In the case
36408 of incoming SMTP messages, the value indicates whether or not any SMTP
36409 extensions (ESMTP), encryption, or authentication were used. If the SMTP
36410 session was encrypted, there is an additional X field that records the cipher
36411 suite that was used.
36412
36413 .cindex log protocol
36414 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
36415 hosts that have authenticated themselves using the SMTP AUTH command. The first
36416 value is used when the SMTP connection was encrypted (&"secure"&). In this case
36417 there is an additional item A= followed by the name of the authenticator that
36418 was used. If an authenticated identification was set up by the authenticator's
36419 &%server_set_id%& option, this is logged too, separated by a colon from the
36420 authenticator name.
36421
36422 .cindex "size" "of message"
36423 The id field records the existing message id, if present. The size of the
36424 received message is given by the S field. When the message is delivered,
36425 headers may be removed or added, so that the size of delivered copies of the
36426 message may not correspond with this value (and indeed may be different to each
36427 other).
36428
36429 The &%log_selector%& option can be used to request the logging of additional
36430 data when a message is received. See section &<<SECTlogselector>>& below.
36431
36432
36433
36434 .section "Logging deliveries" "SECID252"
36435 .cindex "log" "delivery line"
36436 The format of the single-line entry in the main log that is written for every
36437 delivery is shown in one of the examples below, for local and remote
36438 deliveries, respectively. Each example has been split into multiple lines in order
36439 to fit it on the page:
36440 .code
36441 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
36442   <marv@hitch.fict.example> R=localuser T=local_delivery
36443 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
36444   monk@holistic.fict.example R=dnslookup T=remote_smtp
36445   H=holistic.fict.example [192.168.234.234]
36446 .endd
36447 For ordinary local deliveries, the original address is given in angle brackets
36448 after the final delivery address, which might be a pipe or a file. If
36449 intermediate address(es) exist between the original and the final address, the
36450 last of these is given in parentheses after the final address. The R and T
36451 fields record the router and transport that were used to process the address.
36452
36453 If SMTP AUTH was used for the delivery there is an additional item A=
36454 followed by the name of the authenticator that was used.
36455 If an authenticated identification was set up by the authenticator's &%client_set_id%&
36456 option, this is logged too, separated by a colon from the authenticator name.
36457
36458 If a shadow transport was run after a successful local delivery, the log line
36459 for the successful delivery has an item added on the end, of the form
36460 .display
36461 &`ST=<`&&'shadow transport name'&&`>`&
36462 .endd
36463 If the shadow transport did not succeed, the error message is put in
36464 parentheses afterwards.
36465
36466 .cindex "asterisk" "after IP address"
36467 When more than one address is included in a single delivery (for example, two
36468 SMTP RCPT commands in one transaction) the second and subsequent addresses are
36469 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
36470 down a single SMTP connection, an asterisk follows the IP address in the log
36471 lines for the second and subsequent messages.
36472 When two or more messages are delivered down a single TLS connection, the
36473 DNS and some TLS-related information logged for the first message delivered
36474 will not be present in the log lines for the second and subsequent messages.
36475 TLS cipher information is still available.
36476
36477 .cindex "delivery" "cutthrough; logging"
36478 .cindex "cutthrough" "logging"
36479 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
36480 line precedes the reception line, since cutthrough waits for a possible
36481 rejection from the destination in case it can reject the sourced item.
36482
36483 The generation of a reply message by a filter file gets logged as a
36484 &"delivery"& to the addressee, preceded by &">"&.
36485
36486 The &%log_selector%& option can be used to request the logging of additional
36487 data when a message is delivered. See section &<<SECTlogselector>>& below.
36488
36489
36490 .section "Discarded deliveries" "SECID253"
36491 .cindex "discarded messages"
36492 .cindex "message" "discarded"
36493 .cindex "delivery" "discarded; logging"
36494 When a message is discarded as a result of the command &"seen finish"& being
36495 obeyed in a filter file which generates no deliveries, a log entry of the form
36496 .code
36497 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
36498   <low.club@bridge.example> R=userforward
36499 .endd
36500 is written, to record why no deliveries are logged. When a message is discarded
36501 because it is aliased to &":blackhole:"& the log line is like this:
36502 .code
36503 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
36504   <hole@nowhere.example> R=blackhole_router
36505 .endd
36506
36507
36508 .section "Deferred deliveries" "SECID254"
36509 When a delivery is deferred, a line of the following form is logged:
36510 .code
36511 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
36512   R=dnslookup T=smtp defer (146): Connection refused
36513 .endd
36514 In the case of remote deliveries, the error is the one that was given for the
36515 last IP address that was tried. Details of individual SMTP failures are also
36516 written to the log, so the above line would be preceded by something like
36517 .code
36518 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
36519   mail1.endrest.example [192.168.239.239]: Connection refused
36520 .endd
36521 When a deferred address is skipped because its retry time has not been reached,
36522 a message is written to the log, but this can be suppressed by setting an
36523 appropriate value in &%log_selector%&.
36524
36525
36526
36527 .section "Delivery failures" "SECID255"
36528 .cindex "delivery" "failure; logging"
36529 If a delivery fails because an address cannot be routed, a line of the
36530 following form is logged:
36531 .code
36532 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
36533   <jim@trek99.example>: unknown mail domain
36534 .endd
36535 If a delivery fails at transport time, the router and transport are shown, and
36536 the response from the remote host is included, as in this example:
36537 .code
36538 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
36539   R=dnslookup T=remote_smtp: SMTP error from remote mailer
36540   after pipelined RCPT TO:<ace400@pb.example>: host
36541   pbmail3.py.example [192.168.63.111]: 553 5.3.0
36542   <ace400@pb.example>...Addressee unknown
36543 .endd
36544 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
36545 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
36546 disabling PIPELINING. The log lines for all forms of delivery failure are
36547 flagged with &`**`&.
36548
36549
36550
36551 .section "Fake deliveries" "SECID256"
36552 .cindex "delivery" "fake; logging"
36553 If a delivery does not actually take place because the &%-N%& option has been
36554 used to suppress it, a normal delivery line is written to the log, except that
36555 &"=>"& is replaced by &"*>"&.
36556
36557
36558
36559 .section "Completion" "SECID257"
36560 A line of the form
36561 .code
36562 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
36563 .endd
36564 is written to the main log when a message is about to be removed from the spool
36565 at the end of its processing.
36566
36567
36568
36569
36570 .section "Summary of Fields in Log Lines" "SECID258"
36571 .cindex "log" "summary of fields"
36572 A summary of the field identifiers that are used in log lines is shown in
36573 the following table:
36574 .display
36575 &`A   `&        authenticator name (and optional id and sender)
36576 &`C   `&        SMTP confirmation on delivery
36577 &`    `&        command list for &"no mail in SMTP session"&
36578 &`CV  `&        certificate verification status
36579 &`D   `&        duration of &"no mail in SMTP session"&
36580 &`DKIM`&        domain verified in incoming message
36581 &`DN  `&        distinguished name from peer certificate
36582 &`DS  `&        DNSSEC secured lookups
36583 &`DT  `&        on &`=>`& lines: time taken for a delivery
36584 &`F   `&        sender address (on delivery lines)
36585 &`H   `&        host name and IP address
36586 &`I   `&        local interface used
36587 &`id  `&        message id for incoming message
36588 &`K   `&        CHUNKING extension used
36589 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
36590 &`M8S `&        8BITMIME status for incoming message
36591 &`P   `&        on &`<=`& lines: protocol used
36592 &`    `&        on &`=>`& and &`**`& lines: return path
36593 &`PRDR`&        PRDR extension used
36594 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
36595 &`Q   `&        alternate queue name
36596 &`QT  `&        on &`=>`& lines: time spent on queue so far
36597 &`    `&        on &"Completed"& lines: time spent on queue
36598 &`R   `&        on &`<=`& lines: reference for local bounce
36599 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
36600 &`RT  `&        on &`<=`& lines: time taken for reception
36601 &`S   `&        size of message in bytes
36602 &`SNI `&        server name indication from TLS client hello
36603 &`ST  `&        shadow transport name
36604 &`T   `&        on &`<=`& lines: message subject (topic)
36605 &`TFO `&        connection took advantage of TCP Fast Open
36606 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
36607 &`U   `&        local user or RFC 1413 identity
36608 &`X   `&        TLS cipher suite
36609 .endd
36610
36611
36612 .section "Other log entries" "SECID259"
36613 Various other types of log entry are written from time to time. Most should be
36614 self-explanatory. Among the more common are:
36615
36616 .ilist
36617 .cindex "retry" "time not reached"
36618 &'retry time not reached'&&~&~An address previously suffered a temporary error
36619 during routing or local delivery, and the time to retry has not yet arrived.
36620 This message is not written to an individual message log file unless it happens
36621 during the first delivery attempt.
36622 .next
36623 &'retry time not reached for any host'&&~&~An address previously suffered
36624 temporary errors during remote delivery, and the retry time has not yet arrived
36625 for any of the hosts to which it is routed.
36626 .next
36627 .cindex "spool directory" "file locked"
36628 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
36629 some other Exim process is already working on the message. This can be quite
36630 common if queue running processes are started at frequent intervals. The
36631 &'exiwhat'& utility script can be used to find out what Exim processes are
36632 doing.
36633 .next
36634 .cindex "error" "ignored"
36635 &'error ignored'&&~&~There are several circumstances that give rise to this
36636 message:
36637 .olist
36638 Exim failed to deliver a bounce message whose age was greater than
36639 &%ignore_bounce_errors_after%&. The bounce was discarded.
36640 .next
36641 A filter file set up a delivery using the &"noerror"& option, and the delivery
36642 failed. The delivery was discarded.
36643 .next
36644 A delivery set up by a router configured with
36645 . ==== As this is a nested list, any displays it contains must be indented
36646 . ==== as otherwise they are too far to the left.
36647 .code
36648     errors_to = <>
36649 .endd
36650 failed. The delivery was discarded.
36651 .endlist olist
36652 .next
36653 .cindex DKIM "log line"
36654 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
36655 logging and the message has a DKIM signature header.
36656 .endlist ilist
36657
36658
36659
36660
36661
36662 .section "Reducing or increasing what is logged" "SECTlogselector"
36663 .cindex "log" "selectors"
36664 By setting the &%log_selector%& global option, you can disable some of Exim's
36665 default logging, or you can request additional logging. The value of
36666 &%log_selector%& is made up of names preceded by plus or minus characters. For
36667 example:
36668 .code
36669 log_selector = +arguments -retry_defer
36670 .endd
36671 The list of optional log items is in the following table, with the default
36672 selection marked by asterisks:
36673 .display
36674 &` 8bitmime                   `&  received 8BITMIME status
36675 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
36676 &` address_rewrite            `&  address rewriting
36677 &` all_parents                `&  all parents in => lines
36678 &` arguments                  `&  command line arguments
36679 &`*connection_reject          `&  connection rejections
36680 &`*delay_delivery             `&  immediate delivery delayed
36681 &` deliver_time               `&  time taken to perform delivery
36682 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
36683 &`*dkim                       `&  DKIM verified domain on <= lines
36684 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
36685 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
36686 &` dnssec                     `&  DNSSEC secured lookups
36687 &`*etrn                       `&  ETRN commands
36688 &`*host_lookup_failed         `&  as it says
36689 &` ident_timeout              `&  timeout for ident connection
36690 &` incoming_interface         `&  local interface on <= and => lines
36691 &` incoming_port              `&  remote port on <= lines
36692 &`*lost_incoming_connection   `&  as it says (includes timeouts)
36693 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
36694 &` outgoing_interface         `&  local interface on => lines
36695 &` outgoing_port              `&  add remote port to => lines
36696 &`*queue_run                  `&  start and end queue runs
36697 &` queue_time                 `&  time on queue for one recipient
36698 &` queue_time_overall         `&  time on queue for whole message
36699 &` pid                        `&  Exim process id
36700 &` pipelining                 `&  PIPELINING use, on <= and => lines
36701 &` proxy                      `&  proxy address on <= and => lines
36702 &` receive_time               `&  time taken to receive message
36703 &` received_recipients        `&  recipients on <= lines
36704 &` received_sender            `&  sender on <= lines
36705 &`*rejected_header            `&  header contents on reject log
36706 &`*retry_defer                `&  &"retry time not reached"&
36707 &` return_path_on_delivery    `&  put return path on => and ** lines
36708 &` sender_on_delivery         `&  add sender to => lines
36709 &`*sender_verify_fail         `&  sender verification failures
36710 &`*size_reject                `&  rejection because too big
36711 &`*skip_delivery              `&  delivery skipped in a queue run
36712 &`*smtp_confirmation          `&  SMTP confirmation on => lines
36713 &` smtp_connection            `&  incoming SMTP connections
36714 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
36715 &` smtp_mailauth              `&  AUTH argument to MAIL commands
36716 &` smtp_no_mail               `&  session with no MAIL commands
36717 &` smtp_protocol_error        `&  SMTP protocol errors
36718 &` smtp_syntax_error          `&  SMTP syntax errors
36719 &` subject                    `&  contents of &'Subject:'& on <= lines
36720 &`*tls_certificate_verified   `&  certificate verification status
36721 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
36722 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
36723 &` tls_sni                    `&  TLS SNI on <= lines
36724 &` unknown_in_list            `&  DNS lookup failed in list match
36725
36726 &` all                        `&  all of the above
36727 .endd
36728 See also the &%slow_lookup_log%& main configuration option,
36729 section &<<SECID99>>&
36730
36731 More details on each of these items follows:
36732
36733 .ilist
36734 .cindex "8BITMIME"
36735 .cindex "log" "8BITMIME"
36736 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
36737 which may help in tracking down interoperability issues with ancient MTAs
36738 that are not 8bit clean.  This is added to the &"<="& line, tagged with
36739 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
36740 &`7BIT`& and &`8BITMIME`& respectively.
36741 .next
36742 .cindex "&%warn%& ACL verb" "log when skipping"
36743 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
36744 its conditions cannot be evaluated, a log line to this effect is written if
36745 this log selector is set.
36746 .next
36747 .cindex "log" "rewriting"
36748 .cindex "rewriting" "logging"
36749 &%address_rewrite%&: This applies both to global rewrites and per-transport
36750 rewrites, but not to rewrites in filters run as an unprivileged user (because
36751 such users cannot access the log).
36752 .next
36753 .cindex "log" "full parentage"
36754 &%all_parents%&: Normally only the original and final addresses are logged on
36755 delivery lines; with this selector, intermediate parents are given in
36756 parentheses between them.
36757 .next
36758 .cindex "log" "Exim arguments"
36759 .cindex "Exim arguments, logging"
36760 &%arguments%&: This causes Exim to write the arguments with which it was called
36761 to the main log, preceded by the current working directory. This is a debugging
36762 feature, added to make it easier to find out how certain MUAs call
36763 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
36764 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
36765 that are empty or that contain white space are quoted. Non-printing characters
36766 are shown as escape sequences. This facility cannot log unrecognized arguments,
36767 because the arguments are checked before the configuration file is read. The
36768 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
36769 between the caller and Exim.
36770 .next
36771 .cindex "log" "connection rejections"
36772 &%connection_reject%&: A log entry is written whenever an incoming SMTP
36773 connection is rejected, for whatever reason.
36774 .next
36775 .cindex "log" "delayed delivery"
36776 .cindex "delayed delivery, logging"
36777 &%delay_delivery%&: A log entry is written whenever a delivery process is not
36778 started for an incoming message because the load is too high or too many
36779 messages were received on one connection. Logging does not occur if no delivery
36780 process is started because &%queue_only%& is set or &%-odq%& was used.
36781 .next
36782 .cindex "log" "delivery duration"
36783 &%deliver_time%&: For each delivery, the amount of real time it has taken to
36784 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
36785 If millisecond logging is enabled, short times will be shown with greater
36786 precision, eg. &`DT=0.304s`&.
36787 .next
36788 .cindex "log" "message size on delivery"
36789 .cindex "size" "of message"
36790 &%delivery_size%&: For each delivery, the size of message delivered is added to
36791 the &"=>"& line, tagged with S=.
36792 .next
36793 .cindex log "DKIM verification"
36794 .cindex DKIM "verification logging"
36795 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
36796 verifies successfully a tag of DKIM is added, with one of the verified domains.
36797 .next
36798 .cindex log "DKIM verification"
36799 .cindex DKIM "verification logging"
36800 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
36801 .next
36802 .cindex "log" "dnslist defer"
36803 .cindex "DNS list" "logging defer"
36804 .cindex "black list (DNS)"
36805 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
36806 DNS black list suffers a temporary error.
36807 .next
36808 .cindex log dnssec
36809 .cindex dnssec logging
36810 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
36811 dns lookups gave secure results a tag of DS is added.
36812 For acceptance this covers the reverse and forward lookups for host name verification.
36813 It does not cover helo-name verification.
36814 For delivery this covers the SRV, MX, A and/or AAAA lookups.
36815 .next
36816 .cindex "log" "ETRN commands"
36817 .cindex "ETRN" "logging"
36818 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
36819 is run to determine whether or not it is actually accepted. An invalid ETRN
36820 command, or one received within a message transaction is not logged by this
36821 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
36822 .next
36823 .cindex "log" "host lookup failure"
36824 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
36825 any addresses, or when a lookup of an IP address fails to find a host name, a
36826 log line is written. This logging does not apply to direct DNS lookups when
36827 routing email addresses, but it does apply to &"byname"& lookups.
36828 .next
36829 .cindex "log" "ident timeout"
36830 .cindex "RFC 1413" "logging timeout"
36831 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
36832 client's ident port times out.
36833 .next
36834 .cindex "log" "incoming interface"
36835 .cindex "log" "local interface"
36836 .cindex "log" "local address and port"
36837 .cindex "TCP/IP" "logging local address and port"
36838 .cindex "interface" "logging"
36839 &%incoming_interface%&: The interface on which a message was received is added
36840 to the &"<="& line as an IP address in square brackets, tagged by I= and
36841 followed by a colon and the port number. The local interface and port are also
36842 added to other SMTP log lines, for example &"SMTP connection from"&, to
36843 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
36844 The latter can be disabled by turning off the &%outgoing_interface%& option.
36845 .next
36846 .cindex log "incoming proxy address"
36847 .cindex proxy "logging proxy address"
36848 .cindex "TCP/IP" "logging proxy address"
36849 &%proxy%&: The internal (closest to the system running Exim) IP address
36850 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
36851 on a proxied connection
36852 or the &"=>"& line for a message delivered on a proxied connection.
36853 See &<<SECTproxyInbound>>& for more information.
36854 .next
36855 .cindex "log" "incoming remote port"
36856 .cindex "port" "logging remote"
36857 .cindex "TCP/IP" "logging incoming remote port"
36858 .vindex "&$sender_fullhost$&"
36859 .vindex "&$sender_rcvhost$&"
36860 &%incoming_port%&: The remote port number from which a message was received is
36861 added to log entries and &'Received:'& header lines, following the IP address
36862 in square brackets, and separated from it by a colon. This is implemented by
36863 changing the value that is put in the &$sender_fullhost$& and
36864 &$sender_rcvhost$& variables. Recording the remote port number has become more
36865 important with the widening use of NAT (see RFC 2505).
36866 .next
36867 .cindex "log" "dropped connection"
36868 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
36869 connection is unexpectedly dropped.
36870 .next
36871 .cindex "log" "millisecond timestamps"
36872 .cindex millisecond logging
36873 .cindex timestamps "millisecond, in logs"
36874 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
36875 appended to the seconds value.
36876 .next
36877 .cindex "log" "outgoing interface"
36878 .cindex "log" "local interface"
36879 .cindex "log" "local address and port"
36880 .cindex "TCP/IP" "logging local address and port"
36881 .cindex "interface" "logging"
36882 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
36883 interface on which a message was sent is added to delivery lines as an I= tag
36884 followed by IP address in square brackets. You can disable this by turning
36885 off the &%outgoing_interface%& option.
36886 .next
36887 .cindex "log" "outgoing remote port"
36888 .cindex "port" "logging outgoing remote"
36889 .cindex "TCP/IP" "logging outgoing remote port"
36890 &%outgoing_port%&: The remote port number is added to delivery log lines (those
36891 containing => tags) following the IP address.
36892 The local port is also added if &%incoming_interface%& and
36893 &%outgoing_interface%& are both enabled.
36894 This option is not included in the default setting, because for most ordinary
36895 configurations, the remote port number is always 25 (the SMTP port), and the
36896 local port is a random ephemeral port.
36897 .next
36898 .cindex "log" "process ids in"
36899 .cindex "pid (process id)" "in log lines"
36900 &%pid%&: The current process id is added to every log line, in square brackets,
36901 immediately after the time and date.
36902 .next
36903 .new
36904 .cindex log pipelining
36905 .cindex pipelining "logging outgoing"
36906 &%pipelining%&: A field is added to delivery and accept
36907 log lines when the ESMTP PIPELINING extension was used.
36908 The field is a single "L".
36909 On accept lines, where PIPELINING was offered but not used by the client,
36910 the field has a minus appended.
36911 .next
36912 .cindex "log" "queue run"
36913 .cindex "queue runner" "logging"
36914 &%queue_run%&: The start and end of every queue run are logged.
36915 .next
36916 .cindex "log" "queue time"
36917 &%queue_time%&: The amount of time the message has been in the queue on the
36918 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
36919 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
36920 includes reception time as well as the delivery time for the current address.
36921 This means that it may be longer than the difference between the arrival and
36922 delivery log line times, because the arrival log line is not written until the
36923 message has been successfully received.
36924 If millisecond logging is enabled, short times will be shown with greater
36925 precision, eg. &`QT=1.578s`&.
36926 .next
36927 &%queue_time_overall%&: The amount of time the message has been in the queue on
36928 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
36929 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
36930 message, so it includes reception time as well as the total delivery time.
36931 .next
36932 .cindex "log" "receive duration"
36933 &%receive_time%&: For each message, the amount of real time it has taken to
36934 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
36935 If millisecond logging is enabled, short times will be shown with greater
36936 precision, eg. &`RT=0.204s`&.
36937 .next
36938 .cindex "log" "recipients"
36939 &%received_recipients%&: The recipients of a message are listed in the main log
36940 as soon as the message is received. The list appears at the end of the log line
36941 that is written when a message is received, preceded by the word &"for"&. The
36942 addresses are listed after they have been qualified, but before any rewriting
36943 has taken place.
36944 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
36945 in the list.
36946 .next
36947 .cindex "log" "sender reception"
36948 &%received_sender%&: The unrewritten original sender of a message is added to
36949 the end of the log line that records the message's arrival, after the word
36950 &"from"& (before the recipients if &%received_recipients%& is also set).
36951 .next
36952 .cindex "log" "header lines for rejection"
36953 &%rejected_header%&: If a message's header has been received at the time a
36954 rejection is written to the reject log, the complete header is added to the
36955 log. Header logging can be turned off individually for messages that are
36956 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
36957 .next
36958 .cindex "log" "retry defer"
36959 &%retry_defer%&: A log line is written if a delivery is deferred because a
36960 retry time has not yet been reached. However, this &"retry time not reached"&
36961 message is always omitted from individual message logs after the first delivery
36962 attempt.
36963 .next
36964 .cindex "log" "return path"
36965 &%return_path_on_delivery%&: The return path that is being transmitted with
36966 the message is included in delivery and bounce lines, using the tag P=.
36967 This is omitted if no delivery actually happens, for example, if routing fails,
36968 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
36969 .next
36970 .cindex "log" "sender on delivery"
36971 &%sender_on_delivery%&: The message's sender address is added to every delivery
36972 and bounce line, tagged by F= (for &"from"&).
36973 This is the original sender that was received with the message; it is not
36974 necessarily the same as the outgoing return path.
36975 .next
36976 .cindex "log" "sender verify failure"
36977 &%sender_verify_fail%&: If this selector is unset, the separate log line that
36978 gives details of a sender verification failure is not written. Log lines for
36979 the rejection of SMTP commands contain just &"sender verify failed"&, so some
36980 detail is lost.
36981 .next
36982 .cindex "log" "size rejection"
36983 &%size_reject%&: A log line is written whenever a message is rejected because
36984 it is too big.
36985 .next
36986 .cindex "log" "frozen messages; skipped"
36987 .cindex "frozen messages" "logging skipping"
36988 &%skip_delivery%&: A log line is written whenever a message is skipped during a
36989 queue run because it is frozen or because another process is already delivering
36990 it.
36991 .cindex "&""spool file is locked""&"
36992 The message that is written is &"spool file is locked"&.
36993 .next
36994 .cindex "log" "smtp confirmation"
36995 .cindex "SMTP" "logging confirmation"
36996 .cindex "LMTP" "logging confirmation"
36997 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
36998 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
36999 A number of MTAs (including Exim) return an identifying string in this
37000 response.
37001 .next
37002 .cindex "log" "SMTP connections"
37003 .cindex "SMTP" "logging connections"
37004 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
37005 established or closed, unless the connection is from a host that matches
37006 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
37007 only when the closure is unexpected.) This applies to connections from local
37008 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
37009 dropped in the middle of a message, a log line is always written, whether or
37010 not this selector is set, but otherwise nothing is written at the start and end
37011 of connections unless this selector is enabled.
37012
37013 For TCP/IP connections to an Exim daemon, the current number of connections is
37014 included in the log message for each new connection, but note that the count is
37015 reset if the daemon is restarted.
37016 Also, because connections are closed (and the closure is logged) in
37017 subprocesses, the count may not include connections that have been closed but
37018 whose termination the daemon has not yet noticed. Thus, while it is possible to
37019 match up the opening and closing of connections in the log, the value of the
37020 logged counts may not be entirely accurate.
37021 .next
37022 .cindex "log" "SMTP transaction; incomplete"
37023 .cindex "SMTP" "logging incomplete transactions"
37024 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
37025 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
37026 and the message sender plus any accepted recipients are included in the log
37027 line. This can provide evidence of dictionary attacks.
37028 .next
37029 .cindex "log" "non-MAIL SMTP sessions"
37030 .cindex "MAIL" "logging session without"
37031 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
37032 connection terminates without having issued a MAIL command. This includes both
37033 the case when the connection is dropped, and the case when QUIT is used. It
37034 does not include cases where the connection is rejected right at the start (by
37035 an ACL, or because there are too many connections, or whatever). These cases
37036 already have their own log lines.
37037
37038 The log line that is written contains the identity of the client in the usual
37039 way, followed by D= and a time, which records the duration of the connection.
37040 If the connection was authenticated, this fact is logged exactly as it is for
37041 an incoming message, with an A= item. If the connection was encrypted, CV=,
37042 DN=, and X= items may appear as they do for an incoming message, controlled by
37043 the same logging options.
37044
37045 Finally, if any SMTP commands were issued during the connection, a C= item
37046 is added to the line, listing the commands that were used. For example,
37047 .code
37048 C=EHLO,QUIT
37049 .endd
37050 shows that the client issued QUIT straight after EHLO. If there were fewer
37051 than 20 commands, they are all listed. If there were more than 20 commands,
37052 the last 20 are listed, preceded by &"..."&. However, with the default
37053 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
37054 have been aborted before 20 non-mail commands are processed.
37055 .next
37056 &%smtp_mailauth%&: A third subfield with the authenticated sender,
37057 colon-separated, is appended to the A= item for a message arrival or delivery
37058 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
37059 was accepted or used.
37060 .next
37061 .cindex "log" "SMTP protocol error"
37062 .cindex "SMTP" "logging protocol error"
37063 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
37064 encountered. Exim does not have perfect detection of all protocol errors
37065 because of transmission delays and the use of pipelining. If PIPELINING has
37066 been advertised to a client, an Exim server assumes that the client will use
37067 it, and therefore it does not count &"expected"& errors (for example, RCPT
37068 received after rejecting MAIL) as protocol errors.
37069 .next
37070 .cindex "SMTP" "logging syntax errors"
37071 .cindex "SMTP" "syntax errors; logging"
37072 .cindex "SMTP" "unknown command; logging"
37073 .cindex "log" "unknown SMTP command"
37074 .cindex "log" "SMTP syntax error"
37075 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
37076 encountered. An unrecognized command is treated as a syntax error. For an
37077 external connection, the host identity is given; for an internal connection
37078 using &%-bs%& the sender identification (normally the calling user) is given.
37079 .next
37080 .cindex "log" "subject"
37081 .cindex "subject, logging"
37082 &%subject%&: The subject of the message is added to the arrival log line,
37083 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
37084 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
37085 specifies whether characters with values greater than 127 should be logged
37086 unchanged, or whether they should be rendered as escape sequences.
37087 .next
37088 .cindex "log" "certificate verification"
37089 .cindex log DANE
37090 .cindex DANE logging
37091 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
37092 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
37093 verified
37094 using a CA trust anchor,
37095 &`CA=dane`& if using a DNS trust anchor,
37096 and &`CV=no`& if not.
37097 .next
37098 .cindex "log" "TLS cipher"
37099 .cindex "TLS" "logging cipher"
37100 &%tls_cipher%&: When a message is sent or received over an encrypted
37101 connection, the cipher suite used is added to the log line, preceded by X=.
37102 .next
37103 .cindex "log" "TLS peer DN"
37104 .cindex "TLS" "logging peer DN"
37105 &%tls_peerdn%&: When a message is sent or received over an encrypted
37106 connection, and a certificate is supplied by the remote host, the peer DN is
37107 added to the log line, preceded by DN=.
37108 .next
37109 .cindex "log" "TLS SNI"
37110 .cindex "TLS" "logging SNI"
37111 &%tls_sni%&: When a message is received over an encrypted connection, and
37112 the remote host provided the Server Name Indication extension, the SNI is
37113 added to the log line, preceded by SNI=.
37114 .next
37115 .cindex "log" "DNS failure in list"
37116 &%unknown_in_list%&: This setting causes a log entry to be written when the
37117 result of a list match is failure because a DNS lookup failed.
37118 .endlist
37119
37120
37121 .section "Message log" "SECID260"
37122 .cindex "message" "log file for"
37123 .cindex "log" "message log; description of"
37124 .cindex "&_msglog_& directory"
37125 .oindex "&%preserve_message_logs%&"
37126 In addition to the general log files, Exim writes a log file for each message
37127 that it handles. The names of these per-message logs are the message ids, and
37128 they are kept in the &_msglog_& sub-directory of the spool directory. Each
37129 message log contains copies of the log lines that apply to the message. This
37130 makes it easier to inspect the status of an individual message without having
37131 to search the main log. A message log is deleted when processing of the message
37132 is complete, unless &%preserve_message_logs%& is set, but this should be used
37133 only with great care because they can fill up your disk very quickly.
37134
37135 On a heavily loaded system, it may be desirable to disable the use of
37136 per-message logs, in order to reduce disk I/O. This can be done by setting the
37137 &%message_logs%& option false.
37138 .ecindex IIDloggen
37139
37140
37141
37142
37143 . ////////////////////////////////////////////////////////////////////////////
37144 . ////////////////////////////////////////////////////////////////////////////
37145
37146 .chapter "Exim utilities" "CHAPutils"
37147 .scindex IIDutils "utilities"
37148 A number of utility scripts and programs are supplied with Exim and are
37149 described in this chapter. There is also the Exim Monitor, which is covered in
37150 the next chapter. The utilities described here are:
37151
37152 .itable none 0 0 3  7* left  15* left  40* left
37153 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
37154   "list what Exim processes are doing"
37155 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
37156 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
37157 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
37158 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
37159                                                 various criteria"
37160 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
37161 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
37162   "extract statistics from the log"
37163 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
37164   "check address acceptance from given IP"
37165 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
37166 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
37167 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
37168 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
37169 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
37170 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
37171 .endtable
37172
37173 Another utility that might be of use to sites with many MTAs is Tom Kistner's
37174 &'exilog'&. It provides log visualizations across multiple Exim servers. See
37175 &url(https://duncanthrax.net/exilog/) for details.
37176
37177
37178
37179
37180 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
37181 .cindex "&'exiwhat'&"
37182 .cindex "process, querying"
37183 .cindex "SIGUSR1"
37184 On operating systems that can restart a system call after receiving a signal
37185 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
37186 a line describing what it is doing to the file &_exim-process.info_& in the
37187 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
37188 processes it can find, having first emptied the file. It then waits for one
37189 second to allow the Exim processes to react before displaying the results. In
37190 order to run &'exiwhat'& successfully you have to have sufficient privilege to
37191 send the signal to the Exim processes, so it is normally run as root.
37192
37193 &*Warning*&: This is not an efficient process. It is intended for occasional
37194 use by system administrators. It is not sensible, for example, to set up a
37195 script that sends SIGUSR1 signals to Exim processes at short intervals.
37196
37197
37198 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
37199 varies in different operating systems. Not only are different options used,
37200 but the format of the output is different. For this reason, there are some
37201 system configuration options that configure exactly how &'exiwhat'& works. If
37202 it doesn't seem to be working for you, check the following compile-time
37203 options:
37204 .display
37205 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
37206 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
37207 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
37208 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
37209 .endd
37210 An example of typical output from &'exiwhat'& is
37211 .code
37212 164 daemon: -q1h, listening on port 25
37213 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
37214 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
37215   [10.19.42.42] (editor@ref.example)
37216 10592 handling incoming call from [192.168.243.242]
37217 10628 accepting a local non-SMTP message
37218 .endd
37219 The first number in the output line is the process number. The third line has
37220 been split here, in order to fit it on the page.
37221
37222
37223
37224 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
37225 .cindex "&'exiqgrep'&"
37226 .cindex "queue" "grepping"
37227 This utility is a Perl script contributed by Matt Hubbard. It runs
37228 .code
37229 exim -bpu
37230 .endd
37231 or (in case &*-a*& switch is specified)
37232 .code
37233 exim -bp
37234 .endd
37235 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
37236 contain alternate exim configuration the queue management might be using.
37237
37238 to obtain a queue listing, and then greps the output to select messages
37239 that match given criteria. The following selection options are available:
37240
37241 .vlist
37242 .vitem &*-f*&&~<&'regex'&>
37243 Match the sender address using a case-insensitive search. The field that is
37244 tested is enclosed in angle brackets, so you can test for bounce messages with
37245 .code
37246 exiqgrep -f '^<>$'
37247 .endd
37248 .vitem &*-r*&&~<&'regex'&>
37249 Match a recipient address using a case-insensitive search. The field that is
37250 tested is not enclosed in angle brackets.
37251
37252 .vitem &*-s*&&~<&'regex'&>
37253 Match against the size field.
37254
37255 .vitem &*-y*&&~<&'seconds'&>
37256 Match messages that are younger than the given time.
37257
37258 .vitem &*-o*&&~<&'seconds'&>
37259 Match messages that are older than the given time.
37260
37261 .vitem &*-z*&
37262 Match only frozen messages.
37263
37264 .vitem &*-x*&
37265 Match only non-frozen messages.
37266 .endlist
37267
37268 The following options control the format of the output:
37269
37270 .vlist
37271 .vitem &*-c*&
37272 Display only the count of matching messages.
37273
37274 .vitem &*-l*&
37275 Long format &-- display the full message information as output by Exim. This is
37276 the default.
37277
37278 .vitem &*-i*&
37279 Display message ids only.
37280
37281 .vitem &*-b*&
37282 Brief format &-- one line per message.
37283
37284 .vitem &*-R*&
37285 Display messages in reverse order.
37286
37287 .vitem &*-a*&
37288 Include delivered recipients in queue listing.
37289 .endlist
37290
37291 There is one more option, &%-h%&, which outputs a list of options.
37292
37293
37294
37295 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
37296 .cindex "&'exiqsumm'&"
37297 .cindex "queue" "summary"
37298 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
37299 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
37300 running a command such as
37301 .code
37302 exim -bp | exiqsumm
37303 .endd
37304 The output consists of one line for each domain that has messages waiting for
37305 it, as in the following example:
37306 .code
37307 3   2322   74m   66m  msn.com.example
37308 .endd
37309 Each line lists the number of pending deliveries for a domain, their total
37310 volume, and the length of time that the oldest and the newest messages have
37311 been waiting. Note that the number of pending deliveries is greater than the
37312 number of messages when messages have more than one recipient.
37313
37314 A summary line is output at the end. By default the output is sorted on the
37315 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
37316 the output to be sorted by oldest message and by count of messages,
37317 respectively. There are also three options that split the messages for each
37318 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
37319 separates frozen messages, and &%-s%& separates messages according to their
37320 sender.
37321
37322 The output of &'exim -bp'& contains the original addresses in the message, so
37323 this also applies to the output from &'exiqsumm'&. No domains from addresses
37324 generated by aliasing or forwarding are included (unless the &%one_time%&
37325 option of the &(redirect)& router has been used to convert them into &"top
37326 level"& addresses).
37327
37328
37329
37330
37331 .section "Extracting specific information from the log (exigrep)" &&&
37332          "SECTextspeinf"
37333 .cindex "&'exigrep'&"
37334 .cindex "log" "extracts; grepping for"
37335 The &'exigrep'& utility is a Perl script that searches one or more main log
37336 files for entries that match a given pattern. When it finds a match, it
37337 extracts all the log entries for the relevant message, not just those that
37338 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
37339 given message, or all mail for a given user, or for a given host, for example.
37340 The input files can be in Exim log format or syslog format.
37341 If a matching log line is not associated with a specific message, it is
37342 included in &'exigrep'&'s output without any additional lines. The usage is:
37343 .display
37344 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
37345 .endd
37346 If no log file names are given on the command line, the standard input is read.
37347
37348 The &%-t%& argument specifies a number of seconds. It adds an additional
37349 condition for message selection. Messages that are complete are shown only if
37350 they spent more than <&'n'&> seconds on the queue.
37351
37352 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
37353 makes it case-sensitive. This may give a performance improvement when searching
37354 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
37355 option; with &%-I%& they do not. In both cases it is possible to change the
37356 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
37357
37358 The &%-l%& option means &"literal"&, that is, treat all characters in the
37359 pattern as standing for themselves. Otherwise the pattern must be a Perl
37360 regular expression.
37361
37362 The &%-v%& option inverts the matching condition. That is, a line is selected
37363 if it does &'not'& match the pattern.
37364
37365 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
37366 that are generated as a result/response to a message that &'exigrep'& matched
37367 normally.
37368
37369 Example of &%-M%&:
37370 user_a sends a message to user_b, which generates a bounce back to user_b. If
37371 &'exigrep'& is used to search for &"user_a"&, only the first message will be
37372 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
37373 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
37374 when searching for &"user_a"& will show both messages since the bounce is
37375 &"related"& to or a &"result"& of the first message that was found by the
37376 search term.
37377
37378 If the location of a &'zcat'& command is known from the definition of
37379 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
37380 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
37381 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
37382 autodetection of some well known compression extensions.
37383
37384
37385 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
37386 .cindex "&'exipick'&"
37387 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
37388 lists messages from the queue according to a variety of criteria. For details
37389 of &'exipick'&'s facilities, run &'exipick'& with
37390 the &%--help%& option.
37391
37392
37393 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
37394 .cindex "log" "cycling local files"
37395 .cindex "cycling logs"
37396 .cindex "&'exicyclog'&"
37397 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
37398 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
37399 you are using log files with datestamps in their names (see section
37400 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
37401 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
37402 There are two command line options for &'exicyclog'&:
37403 .ilist
37404 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
37405 default that is set when Exim is built. The default default is 10.
37406 .next
37407 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
37408 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
37409 overriding the script's default, which is to find the setting from Exim's
37410 configuration.
37411 .endlist
37412
37413 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
37414 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
37415 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
37416 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
37417 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
37418 logs are handled similarly.
37419
37420 If the limit is greater than 99, the script uses 3-digit numbers such as
37421 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
37422 to one that is greater, or &'vice versa'&, you will have to fix the names of
37423 any existing log files.
37424
37425 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
37426 the end are deleted. All files with numbers greater than 01 are compressed,
37427 using a compression command which is configured by the COMPRESS_COMMAND
37428 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
37429 root &%crontab%& entry of the form
37430 .code
37431 1 0 * * * su exim -c /usr/exim/bin/exicyclog
37432 .endd
37433 assuming you have used the name &"exim"& for the Exim user. You can run
37434 &'exicyclog'& as root if you wish, but there is no need.
37435
37436
37437
37438 .section "Mail statistics (eximstats)" "SECTmailstat"
37439 .cindex "statistics"
37440 .cindex "&'eximstats'&"
37441 A Perl script called &'eximstats'& is provided for extracting statistical
37442 information from log files. The output is either plain text, or HTML.
37443 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
37444 . --- 404 error and everything else points to that.
37445
37446 The &'eximstats'& script has been hacked about quite a bit over time. The
37447 latest version is the result of some extensive revision by Steve Campbell. A
37448 lot of information is given by default, but there are options for suppressing
37449 various parts of it. Following any options, the arguments to the script are a
37450 list of files, which should be main log files. For example:
37451 .code
37452 eximstats -nr /var/spool/exim/log/mainlog.01
37453 .endd
37454 By default, &'eximstats'& extracts information about the number and volume of
37455 messages received from or delivered to various hosts. The information is sorted
37456 both by message count and by volume, and the top fifty hosts in each category
37457 are listed on the standard output. Similar information, based on email
37458 addresses or domains instead of hosts can be requested by means of various
37459 options. For messages delivered and received locally, similar statistics are
37460 also produced per user.
37461
37462 The output also includes total counts and statistics about delivery errors, and
37463 histograms showing the number of messages received and deliveries made in each
37464 hour of the day. A delivery with more than one address in its envelope (for
37465 example, an SMTP transaction with more than one RCPT command) is counted
37466 as a single delivery by &'eximstats'&.
37467
37468 Though normally more deliveries than receipts are reported (as messages may
37469 have multiple recipients), it is possible for &'eximstats'& to report more
37470 messages received than delivered, even though the queue is empty at the start
37471 and end of the period in question. If an incoming message contains no valid
37472 recipients, no deliveries are recorded for it. A bounce message is handled as
37473 an entirely separate message.
37474
37475 &'eximstats'& always outputs a grand total summary giving the volume and number
37476 of messages received and deliveries made, and the number of hosts involved in
37477 each case. It also outputs the number of messages that were delayed (that is,
37478 not completely delivered at the first attempt), and the number that had at
37479 least one address that failed.
37480
37481 The remainder of the output is in sections that can be independently disabled
37482 or modified by various options. It consists of a summary of deliveries by
37483 transport, histograms of messages received and delivered per time interval
37484 (default per hour), information about the time messages spent on the queue,
37485 a list of relayed messages, lists of the top fifty sending hosts, local
37486 senders, destination hosts, and destination local users by count and by volume,
37487 and a list of delivery errors that occurred.
37488
37489 The relay information lists messages that were actually relayed, that is, they
37490 came from a remote host and were directly delivered to some other remote host,
37491 without being processed (for example, for aliasing or forwarding) locally.
37492
37493 There are quite a few options for &'eximstats'& to control exactly what it
37494 outputs. These are documented in the Perl script itself, and can be extracted
37495 by running the command &(perldoc)& on the script. For example:
37496 .code
37497 perldoc /usr/exim/bin/eximstats
37498 .endd
37499
37500 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
37501 .cindex "&'exim_checkaccess'&"
37502 .cindex "policy control" "checking access"
37503 .cindex "checking access"
37504 The &%-bh%& command line argument allows you to run a fake SMTP session with
37505 debugging output, in order to check what Exim is doing when it is applying
37506 policy controls to incoming SMTP mail. However, not everybody is sufficiently
37507 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
37508 sometimes you just want to answer the question &"Does this address have
37509 access?"& without bothering with any further details.
37510
37511 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
37512 two arguments, an IP address and an email address:
37513 .code
37514 exim_checkaccess 10.9.8.7 A.User@a.domain.example
37515 .endd
37516 The utility runs a call to Exim with the &%-bh%& option, to test whether the
37517 given email address would be accepted in a RCPT command in a TCP/IP
37518 connection from the host with the given IP address. The output of the utility
37519 is either the word &"accepted"&, or the SMTP error response, for example:
37520 .code
37521 Rejected:
37522 550 Relay not permitted
37523 .endd
37524 When running this test, the utility uses &`<>`& as the envelope sender address
37525 for the MAIL command, but you can change this by providing additional
37526 options. These are passed directly to the Exim command. For example, to specify
37527 that the test is to be run with the sender address &'himself@there.example'&
37528 you can use:
37529 .code
37530 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
37531                  -f himself@there.example
37532 .endd
37533 Note that these additional Exim command line items must be given after the two
37534 mandatory arguments.
37535
37536 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
37537 while running its checks. You can run checks that include callouts by using
37538 &%-bhc%&, but this is not yet available in a &"packaged"& form.
37539
37540
37541
37542 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
37543 .cindex "DBM" "building dbm files"
37544 .cindex "building DBM files"
37545 .cindex "&'exim_dbmbuild'&"
37546 .cindex "lower casing"
37547 .cindex "binary zero" "in lookup key"
37548 The &'exim_dbmbuild'& program reads an input file containing keys and data in
37549 the format used by the &(lsearch)& lookup (see section
37550 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
37551 names as keys and the remainder of the information as data. The lower-casing
37552 can be prevented by calling the program with the &%-nolc%& option.
37553
37554 A terminating zero is included as part of the key string. This is expected by
37555 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
37556 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
37557 strings or the data strings. The &(dbmnz)& lookup type can be used with such
37558 files.
37559
37560 The program requires two arguments: the name of the input file (which can be a
37561 single hyphen to indicate the standard input), and the name of the output file.
37562 It creates the output under a temporary name, and then renames it if all went
37563 well.
37564
37565 .cindex "USE_DB"
37566 If the native DB interface is in use (USE_DB is set in a compile-time
37567 configuration file &-- this is common in free versions of Unix) the two file
37568 names must be different, because in this mode the Berkeley DB functions create
37569 a single output file using exactly the name given. For example,
37570 .code
37571 exim_dbmbuild /etc/aliases /etc/aliases.db
37572 .endd
37573 reads the system alias file and creates a DBM version of it in
37574 &_/etc/aliases.db_&.
37575
37576 In systems that use the &'ndbm'& routines (mostly proprietary versions of
37577 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
37578 environment, the suffixes are added to the second argument of
37579 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
37580 when the Berkeley functions are used in compatibility mode (though this is not
37581 recommended), because in that case it adds a &_.db_& suffix to the file name.
37582
37583 If a duplicate key is encountered, the program outputs a warning, and when it
37584 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
37585 option is used. By default, only the first of a set of duplicates is used &--
37586 this makes it compatible with &(lsearch)& lookups. There is an option
37587 &%-lastdup%& which causes it to use the data for the last duplicate instead.
37588 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
37589 &%stderr%&. For other errors, where it doesn't actually make a new file, the
37590 return code is 2.
37591
37592
37593
37594
37595 .section "Finding individual retry times (exinext)" "SECTfinindret"
37596 .cindex "retry" "times"
37597 .cindex "&'exinext'&"
37598 A utility called &'exinext'& (mostly a Perl script) provides the ability to
37599 fish specific information out of the retry database. Given a mail domain (or a
37600 complete address), it looks up the hosts for that domain, and outputs any retry
37601 information for the hosts or for the domain. At present, the retry information
37602 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
37603 output. For example:
37604 .code
37605 $ exinext piglet@milne.fict.example
37606 kanga.milne.example:192.168.8.1 error 146: Connection refused
37607   first failed: 21-Feb-1996 14:57:34
37608   last tried:   21-Feb-1996 14:57:34
37609   next try at:  21-Feb-1996 15:02:34
37610 roo.milne.example:192.168.8.3 error 146: Connection refused
37611   first failed: 20-Jan-1996 13:12:08
37612   last tried:   21-Feb-1996 11:42:03
37613   next try at:  21-Feb-1996 19:42:03
37614   past final cutoff time
37615 .endd
37616 You can also give &'exinext'& a local part, without a domain, and it
37617 will give any retry information for that local part in your default domain.
37618 A message id can be used to obtain retry information pertaining to a specific
37619 message. This exists only when an attempt to deliver a message to a remote host
37620 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
37621 &'exinext'& is not particularly efficient, but then it is not expected to be
37622 run very often.
37623
37624 The &'exinext'& utility calls Exim to find out information such as the location
37625 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
37626 passed on to the &'exim'& commands. The first specifies an alternate Exim
37627 configuration file, and the second sets macros for use within the configuration
37628 file. These features are mainly to help in testing, but might also be useful in
37629 environments where more than one configuration file is in use.
37630
37631
37632
37633 .section "Hints database maintenance" "SECThindatmai"
37634 .cindex "hints database" "maintenance"
37635 .cindex "maintaining Exim's hints database"
37636 Three utility programs are provided for maintaining the DBM files that Exim
37637 uses to contain its delivery hint information. Each program requires two
37638 arguments. The first specifies the name of Exim's spool directory, and the
37639 second is the name of the database it is to operate on. These are as follows:
37640
37641 .ilist
37642 &'retry'&: the database of retry information
37643 .next
37644 &'wait-'&<&'transport name'&>: databases of information about messages waiting
37645 for remote hosts
37646 .next
37647 &'callout'&: the callout cache
37648 .next
37649 &'ratelimit'&: the data for implementing the ratelimit ACL condition
37650 .next
37651 &'misc'&: other hints data
37652 .endlist
37653
37654 The &'misc'& database is used for
37655
37656 .ilist
37657 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
37658 .next
37659 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
37660 &(smtp)& transport)
37661 .next
37662 Limiting the concurrency of specific transports (when &%max_parallel%& is set
37663 in a transport)
37664 .endlist
37665
37666
37667
37668 .section "exim_dumpdb" "SECID261"
37669 .cindex "&'exim_dumpdb'&"
37670 The entire contents of a database are written to the standard output by the
37671 &'exim_dumpdb'& program, which has no options or arguments other than the
37672 spool and database names. For example, to dump the retry database:
37673 .code
37674 exim_dumpdb /var/spool/exim retry
37675 .endd
37676 Two lines of output are produced for each entry:
37677 .code
37678 T:mail.ref.example:192.168.242.242 146 77 Connection refused
37679 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
37680 .endd
37681 The first item on the first line is the key of the record. It starts with one
37682 of the letters R, or T, depending on whether it refers to a routing or
37683 transport retry. For a local delivery, the next part is the local address; for
37684 a remote delivery it is the name of the remote host, followed by its failing IP
37685 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
37686 transport). If the remote port is not the standard one (port 25), it is added
37687 to the IP address. Then there follows an error code, an additional error code,
37688 and a textual description of the error.
37689
37690 The three times on the second line are the time of first failure, the time of
37691 the last delivery attempt, and the computed time for the next attempt. The line
37692 ends with an asterisk if the cutoff time for the last retry rule has been
37693 exceeded.
37694
37695 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
37696 consists of a host name followed by a list of ids for messages that are or were
37697 waiting to be delivered to that host. If there are a very large number for any
37698 one host, continuation records, with a sequence number added to the host name,
37699 may be seen. The data in these records is often out of date, because a message
37700 may be routed to several alternative hosts, and Exim makes no effort to keep
37701 cross-references.
37702
37703
37704
37705 .section "exim_tidydb" "SECID262"
37706 .cindex "&'exim_tidydb'&"
37707 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
37708 database. If run with no options, it removes all records that are more than 30
37709 days old. The age is calculated from the date and time that the record was last
37710 updated. Note that, in the case of the retry database, it is &'not'& the time
37711 since the first delivery failure. Information about a host that has been down
37712 for more than 30 days will remain in the database, provided that the record is
37713 updated sufficiently often.
37714
37715 The cutoff date can be altered by means of the &%-t%& option, which must be
37716 followed by a time. For example, to remove all records older than a week from
37717 the retry database:
37718 .code
37719 exim_tidydb -t 7d /var/spool/exim retry
37720 .endd
37721 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
37722 message ids. In the former these appear as data in records keyed by host &--
37723 they were messages that were waiting for that host &-- and in the latter they
37724 are the keys for retry information for messages that have suffered certain
37725 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
37726 message ids in database records are those of messages that are still on the
37727 queue. Message ids for messages that no longer exist are removed from
37728 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
37729 For the &'retry'& database, records whose keys are non-existent message ids are
37730 removed. The &'exim_tidydb'& utility outputs comments on the standard output
37731 whenever it removes information from the database.
37732
37733 Certain records are automatically removed by Exim when they are no longer
37734 needed, but others are not. For example, if all the MX hosts for a domain are
37735 down, a retry record is created for each one. If the primary MX host comes back
37736 first, its record is removed when Exim successfully delivers to it, but the
37737 records for the others remain because Exim has not tried to use those hosts.
37738
37739 It is important, therefore, to run &'exim_tidydb'& periodically on all the
37740 hints databases. You should do this at a quiet time of day, because it requires
37741 a database to be locked (and therefore inaccessible to Exim) while it does its
37742 work. Removing records from a DBM file does not normally make the file smaller,
37743 but all the common DBM libraries are able to re-use the space that is released.
37744 After an initial phase of increasing in size, the databases normally reach a
37745 point at which they no longer get any bigger, as long as they are regularly
37746 tidied.
37747
37748 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
37749 databases is likely to keep on increasing.
37750
37751
37752
37753
37754 .section "exim_fixdb" "SECID263"
37755 .cindex "&'exim_fixdb'&"
37756 The &'exim_fixdb'& program is a utility for interactively modifying databases.
37757 Its main use is for testing Exim, but it might also be occasionally useful for
37758 getting round problems in a live system. It has no options, and its interface
37759 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
37760 key of a database record can then be entered, and the data for that record is
37761 displayed.
37762
37763 If &"d"& is typed at the next prompt, the entire record is deleted. For all
37764 except the &'retry'& database, that is the only operation that can be carried
37765 out. For the &'retry'& database, each field is output preceded by a number, and
37766 data for individual fields can be changed by typing the field number followed
37767 by new data, for example:
37768 .code
37769 > 4 951102:1000
37770 .endd
37771 resets the time of the next delivery attempt. Time values are given as a
37772 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
37773 used as optional separators.
37774
37775
37776
37777
37778 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
37779 .cindex "mailbox" "maintenance"
37780 .cindex "&'exim_lock'&"
37781 .cindex "locking mailboxes"
37782 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
37783 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
37784 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
37785 a user agent while investigating a problem. The utility requires the name of
37786 the file as its first argument. If the locking is successful, the second
37787 argument is run as a command (using C's &[system()]& function); if there is no
37788 second argument, the value of the SHELL environment variable is used; if this
37789 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
37790 is unlocked and the utility ends. The following options are available:
37791
37792 .vlist
37793 .vitem &%-fcntl%&
37794 Use &[fcntl()]& locking on the open mailbox.
37795
37796 .vitem &%-flock%&
37797 Use &[flock()]& locking on the open mailbox, provided the operating system
37798 supports it.
37799
37800 .vitem &%-interval%&
37801 This must be followed by a number, which is a number of seconds; it sets the
37802 interval to sleep between retries (default 3).
37803
37804 .vitem &%-lockfile%&
37805 Create a lock file before opening the mailbox.
37806
37807 .vitem &%-mbx%&
37808 Lock the mailbox using MBX rules.
37809
37810 .vitem &%-q%&
37811 Suppress verification output.
37812
37813 .vitem &%-retries%&
37814 This must be followed by a number; it sets the number of times to try to get
37815 the lock (default 10).
37816
37817 .vitem &%-restore_time%&
37818 This option causes &%exim_lock%& to restore the modified and read times to the
37819 locked file before exiting. This allows you to access a locked mailbox (for
37820 example, to take a backup copy) without disturbing the times that the user
37821 subsequently sees.
37822
37823 .vitem &%-timeout%&
37824 This must be followed by a number, which is a number of seconds; it sets a
37825 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
37826 default), a non-blocking call is used.
37827
37828 .vitem &%-v%&
37829 Generate verbose output.
37830 .endlist
37831
37832 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
37833 default is to create a lock file and also to use &[fcntl()]& locking on the
37834 mailbox, which is the same as Exim's default. The use of &%-flock%& or
37835 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
37836 requires that the directory containing the file be writeable. Locking by lock
37837 file does not last for ever; Exim assumes that a lock file is expired if it is
37838 more than 30 minutes old.
37839
37840 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
37841 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
37842 to be taken out on the open mailbox, and an exclusive lock on the file
37843 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
37844 number of the mailbox file. When the locking is released, if an exclusive lock
37845 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
37846
37847 The default output contains verification of the locking that takes place. The
37848 &%-v%& option causes some additional information to be given. The &%-q%& option
37849 suppresses all output except error messages.
37850
37851 A command such as
37852 .code
37853 exim_lock /var/spool/mail/spqr
37854 .endd
37855 runs an interactive shell while the file is locked, whereas
37856 .display
37857 &`exim_lock -q /var/spool/mail/spqr <<End`&
37858 <&'some commands'&>
37859 &`End`&
37860 .endd
37861 runs a specific non-interactive sequence of commands while the file is locked,
37862 suppressing all verification output. A single command can be run by a command
37863 such as
37864 .code
37865 exim_lock -q /var/spool/mail/spqr \
37866   "cp /var/spool/mail/spqr /some/where"
37867 .endd
37868 Note that if a command is supplied, it must be entirely contained within the
37869 second argument &-- hence the quotes.
37870 .ecindex IIDutils
37871
37872
37873 . ////////////////////////////////////////////////////////////////////////////
37874 . ////////////////////////////////////////////////////////////////////////////
37875
37876 .chapter "The Exim monitor" "CHAPeximon"
37877 .scindex IIDeximon "Exim monitor" "description"
37878 .cindex "X-windows"
37879 .cindex "&'eximon'&"
37880 .cindex "Local/eximon.conf"
37881 .cindex "&_exim_monitor/EDITME_&"
37882 The Exim monitor is an application which displays in an X window information
37883 about the state of Exim's queue and what Exim is doing. An admin user can
37884 perform certain operations on messages from this GUI interface; however all
37885 such facilities are also available from the command line, and indeed, the
37886 monitor itself makes use of the command line to perform any actions requested.
37887
37888
37889
37890 .section "Running the monitor" "SECID264"
37891 The monitor is started by running the script called &'eximon'&. This is a shell
37892 script that sets up a number of environment variables, and then runs the
37893 binary called &_eximon.bin_&. The default appearance of the monitor window can
37894 be changed by editing the &_Local/eximon.conf_& file created by editing
37895 &_exim_monitor/EDITME_&. Comments in that file describe what the various
37896 parameters are for.
37897
37898 The parameters that get built into the &'eximon'& script can be overridden for
37899 a particular invocation by setting up environment variables of the same names,
37900 preceded by &`EXIMON_`&. For example, a shell command such as
37901 .code
37902 EXIMON_LOG_DEPTH=400 eximon
37903 .endd
37904 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
37905 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
37906 overrides the Exim log file configuration. This makes it possible to have
37907 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
37908 syslog messages are routed to a file on the local host.
37909
37910 X resources can be used to change the appearance of the window in the normal
37911 way. For example, a resource setting of the form
37912 .code
37913 Eximon*background: gray94
37914 .endd
37915 changes the colour of the background to light grey rather than white. The
37916 stripcharts are drawn with both the data lines and the reference lines in
37917 black. This means that the reference lines are not visible when on top of the
37918 data. However, their colour can be changed by setting a resource called
37919 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
37920 For example, if your X server is running Unix, you could set up lighter
37921 reference lines in the stripcharts by obeying
37922 .code
37923 xrdb -merge <<End
37924 Eximon*highlight: gray
37925 End
37926 .endd
37927 .cindex "admin user"
37928 In order to see the contents of messages on the queue, and to operate on them,
37929 &'eximon'& must either be run as root or by an admin user.
37930
37931 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
37932 contain X11 resource parameters interpreted by the X11 library.  In addition,
37933 if the first parameter starts with the string "gdb" then it is removed and the
37934 binary is invoked under gdb (the parameter is used as the gdb command-name, so
37935 versioned variants of gdb can be invoked).
37936
37937 The monitor's window is divided into three parts. The first contains one or
37938 more stripcharts and two action buttons, the second contains a &"tail"& of the
37939 main log file, and the third is a display of the queue of messages awaiting
37940 delivery, with two more action buttons. The following sections describe these
37941 different parts of the display.
37942
37943
37944
37945
37946 .section "The stripcharts" "SECID265"
37947 .cindex "stripchart"
37948 The first stripchart is always a count of messages on the queue. Its name can
37949 be configured by setting QUEUE_STRIPCHART_NAME in the
37950 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
37951 configuration script by regular expression matches on log file entries, making
37952 it possible to display, for example, counts of messages delivered to certain
37953 hosts or using certain transports. The supplied defaults display counts of
37954 received and delivered messages, and of local and SMTP deliveries. The default
37955 period between stripchart updates is one minute; this can be adjusted by a
37956 parameter in the &_Local/eximon.conf_& file.
37957
37958 The stripchart displays rescale themselves automatically as the value they are
37959 displaying changes. There are always 10 horizontal lines in each chart; the
37960 title string indicates the value of each division when it is greater than one.
37961 For example, &"x2"& means that each division represents a value of 2.
37962
37963 It is also possible to have a stripchart which shows the percentage fullness of
37964 a particular disk partition, which is useful when local deliveries are confined
37965 to a single partition.
37966
37967 .cindex "&%statvfs%& function"
37968 This relies on the availability of the &[statvfs()]& function or equivalent in
37969 the operating system. Most, but not all versions of Unix that support Exim have
37970 this. For this particular stripchart, the top of the chart always represents
37971 100%, and the scale is given as &"x10%"&. This chart is configured by setting
37972 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
37973 &_Local/eximon.conf_& file.
37974
37975
37976
37977
37978 .section "Main action buttons" "SECID266"
37979 .cindex "size" "of monitor window"
37980 .cindex "Exim monitor" "window size"
37981 .cindex "window size"
37982 Below the stripcharts there is an action button for quitting the monitor. Next
37983 to this is another button marked &"Size"&. They are placed here so that
37984 shrinking the window to its default minimum size leaves just the queue count
37985 stripchart and these two buttons visible. Pressing the &"Size"& button causes
37986 the window to expand to its maximum size, unless it is already at the maximum,
37987 in which case it is reduced to its minimum.
37988
37989 When expanding to the maximum, if the window cannot be fully seen where it
37990 currently is, it is moved back to where it was the last time it was at full
37991 size. When it is expanding from its minimum size, the old position is
37992 remembered, and next time it is reduced to the minimum it is moved back there.
37993
37994 The idea is that you can keep a reduced window just showing one or two
37995 stripcharts at a convenient place on your screen, easily expand it to show
37996 the full window when required, and just as easily put it back to what it was.
37997 The idea is copied from what the &'twm'& window manager does for its
37998 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
37999 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
38000
38001 Normally, the monitor starts up with the window at its full size, but it can be
38002 built so that it starts up with the window at its smallest size, by setting
38003 START_SMALL=yes in &_Local/eximon.conf_&.
38004
38005
38006
38007 .section "The log display" "SECID267"
38008 .cindex "log" "tail of; in monitor"
38009 The second section of the window is an area in which a display of the tail of
38010 the main log is maintained.
38011 To save space on the screen, the timestamp on each log line is shortened by
38012 removing the date and, if &%log_timezone%& is set, the timezone.
38013 The log tail is not available when the only destination for logging data is
38014 syslog, unless the syslog lines are routed to a local file whose name is passed
38015 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
38016
38017 The log sub-window has a scroll bar at its lefthand side which can be used to
38018 move back to look at earlier text, and the up and down arrow keys also have a
38019 scrolling effect. The amount of log that is kept depends on the setting of
38020 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
38021 to use. When this is full, the earlier 50% of data is discarded &-- this is
38022 much more efficient than throwing it away line by line. The sub-window also has
38023 a horizontal scroll bar for accessing the ends of long log lines. This is the
38024 only means of horizontal scrolling; the right and left arrow keys are not
38025 available. Text can be cut from this part of the window using the mouse in the
38026 normal way. The size of this subwindow is controlled by parameters in the
38027 configuration file &_Local/eximon.conf_&.
38028
38029 Searches of the text in the log window can be carried out by means of the ^R
38030 and ^S keystrokes, which default to a reverse and a forward search,
38031 respectively. The search covers only the text that is displayed in the window.
38032 It cannot go further back up the log.
38033
38034 The point from which the search starts is indicated by a caret marker. This is
38035 normally at the end of the text in the window, but can be positioned explicitly
38036 by pointing and clicking with the left mouse button, and is moved automatically
38037 by a successful search. If new text arrives in the window when it is scrolled
38038 back, the caret remains where it is, but if the window is not scrolled back,
38039 the caret is moved to the end of the new text.
38040
38041 Pressing ^R or ^S pops up a window into which the search text can be typed.
38042 There are buttons for selecting forward or reverse searching, for carrying out
38043 the search, and for cancelling. If the &"Search"& button is pressed, the search
38044 happens and the window remains so that further searches can be done. If the
38045 &"Return"& key is pressed, a single search is done and the window is closed. If
38046 ^C is typed the search is cancelled.
38047
38048 The searching facility is implemented using the facilities of the Athena text
38049 widget. By default this pops up a window containing both &"search"& and
38050 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
38051 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
38052 However, the linkers in BSDI and HP-UX seem unable to handle an externally
38053 provided version of &%TextPop%& when the remaining parts of the text widget
38054 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
38055 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
38056 on these systems, at the expense of having unwanted items in the search popup
38057 window.
38058
38059
38060
38061 .section "The queue display" "SECID268"
38062 .cindex "queue" "display in monitor"
38063 The bottom section of the monitor window contains a list of all messages that
38064 are on the queue, which includes those currently being received or delivered,
38065 as well as those awaiting delivery. The size of this subwindow is controlled by
38066 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
38067 at which it is updated is controlled by another parameter in the same file &--
38068 the default is 5 minutes, since queue scans can be quite expensive. However,
38069 there is an &"Update"& action button just above the display which can be used
38070 to force an update of the queue display at any time.
38071
38072 When a host is down for some time, a lot of pending mail can build up for it,
38073 and this can make it hard to deal with other messages on the queue. To help
38074 with this situation there is a button next to &"Update"& called &"Hide"&. If
38075 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
38076 type anything in here and press &"Return"&, the text is added to a chain of
38077 such texts, and if every undelivered address in a message matches at least one
38078 of the texts, the message is not displayed.
38079
38080 If there is an address that does not match any of the texts, all the addresses
38081 are displayed as normal. The matching happens on the ends of addresses so, for
38082 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
38083 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
38084 has been set up, a button called &"Unhide"& is displayed. If pressed, it
38085 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
38086 a hide request is automatically cancelled after one hour.
38087
38088 While the dialogue box is displayed, you can't press any buttons or do anything
38089 else to the monitor window. For this reason, if you want to cut text from the
38090 queue display to use in the dialogue box, you have to do the cutting before
38091 pressing the &"Hide"& button.
38092
38093 The queue display contains, for each unhidden queued message, the length of
38094 time it has been on the queue, the size of the message, the message id, the
38095 message sender, and the first undelivered recipient, all on one line. If it is
38096 a bounce message, the sender is shown as &"<>"&. If there is more than one
38097 recipient to which the message has not yet been delivered, subsequent ones are
38098 listed on additional lines, up to a maximum configured number, following which
38099 an ellipsis is displayed. Recipients that have already received the message are
38100 not shown.
38101
38102 .cindex "frozen messages" "display"
38103 If a message is frozen, an asterisk is displayed at the left-hand side.
38104
38105 The queue display has a vertical scroll bar, and can also be scrolled by means
38106 of the arrow keys. Text can be cut from it using the mouse in the normal way.
38107 The text searching facilities, as described above for the log window, are also
38108 available, but the caret is always moved to the end of the text when the queue
38109 display is updated.
38110
38111
38112
38113 .section "The queue menu" "SECID269"
38114 .cindex "queue" "menu in monitor"
38115 If the &%shift%& key is held down and the left button is clicked when the mouse
38116 pointer is over the text for any message, an action menu pops up, and the first
38117 line of the queue display for the message is highlighted. This does not affect
38118 any selected text.
38119
38120 If you want to use some other event for popping up the menu, you can set the
38121 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
38122 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
38123 value set in this parameter is a standard X event description. For example, to
38124 run eximon using &%ctrl%& rather than &%shift%& you could use
38125 .code
38126 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
38127 .endd
38128 The title of the menu is the message id, and it contains entries which act as
38129 follows:
38130
38131 .ilist
38132 &'message log'&: The contents of the message log for the message are displayed
38133 in a new text window.
38134 .next
38135 &'headers'&: Information from the spool file that contains the envelope
38136 information and headers is displayed in a new text window. See chapter
38137 &<<CHAPspool>>& for a description of the format of spool files.
38138 .next
38139 &'body'&: The contents of the spool file containing the body of the message are
38140 displayed in a new text window. There is a default limit of 20,000 bytes to the
38141 amount of data displayed. This can be changed by setting the BODY_MAX
38142 option at compile time, or the EXIMON_BODY_MAX option at run time.
38143 .next
38144 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
38145 delivery of the message. This causes an automatic thaw if the message is
38146 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
38147 a new text window. The delivery is run in a separate process, to avoid holding
38148 up the monitor while the delivery proceeds.
38149 .next
38150 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
38151 that the message be frozen.
38152 .next
38153 .cindex "thawing messages"
38154 .cindex "unfreezing messages"
38155 .cindex "frozen messages" "thawing"
38156 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
38157 that the message be thawed.
38158 .next
38159 .cindex "delivery" "forcing failure"
38160 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
38161 that Exim gives up trying to deliver the message. A bounce message is generated
38162 for any remaining undelivered addresses.
38163 .next
38164 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
38165 that the message be deleted from the system without generating a bounce
38166 message.
38167 .next
38168 &'add recipient'&: A dialog box is displayed into which a recipient address can
38169 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38170 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38171 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38172 causes a call to Exim to be made using the &%-Mar%& option to request that an
38173 additional recipient be added to the message, unless the entry box is empty, in
38174 which case no action is taken.
38175 .next
38176 &'mark delivered'&: A dialog box is displayed into which a recipient address
38177 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38178 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38179 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38180 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
38181 recipient address as already delivered, unless the entry box is empty, in which
38182 case no action is taken.
38183 .next
38184 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
38185 mark all recipient addresses as already delivered.
38186 .next
38187 &'edit sender'&: A dialog box is displayed initialized with the current
38188 sender's address. Pressing RETURN causes a call to Exim to be made using the
38189 &%-Mes%& option to replace the sender address, unless the entry box is empty,
38190 in which case no action is taken. If you want to set an empty sender (as in
38191 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
38192 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
38193 the address is qualified with that domain.
38194 .endlist
38195
38196 When a delivery is forced, a window showing the &%-v%& output is displayed. In
38197 other cases when a call to Exim is made, if there is any output from Exim (in
38198 particular, if the command fails) a window containing the command and the
38199 output is displayed. Otherwise, the results of the action are normally apparent
38200 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
38201 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
38202 if no output is generated.
38203
38204 The queue display is automatically updated for actions such as freezing and
38205 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
38206 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
38207 force an update of the display after one of these actions.
38208
38209 In any text window that is displayed as result of a menu action, the normal
38210 cut-and-paste facility is available, and searching can be carried out using ^R
38211 and ^S, as described above for the log tail window.
38212 .ecindex IIDeximon
38213
38214
38215
38216
38217
38218 . ////////////////////////////////////////////////////////////////////////////
38219 . ////////////////////////////////////////////////////////////////////////////
38220
38221 .chapter "Security considerations" "CHAPsecurity"
38222 .scindex IIDsecurcon "security" "discussion of"
38223 This chapter discusses a number of issues concerned with security, some of
38224 which are also covered in other parts of this manual.
38225
38226 For reasons that this author does not understand, some people have promoted
38227 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
38228 existence of this chapter in the documentation. However, the intent of the
38229 chapter is simply to describe the way Exim works in relation to certain
38230 security concerns, not to make any specific claims about the effectiveness of
38231 its security as compared with other MTAs.
38232
38233 What follows is a description of the way Exim is supposed to be. Best efforts
38234 have been made to try to ensure that the code agrees with the theory, but an
38235 absence of bugs can never be guaranteed. Any that are reported will get fixed
38236 as soon as possible.
38237
38238
38239 .section "Building a more &""hardened""& Exim" "SECID286"
38240 .cindex "security" "build-time features"
38241 There are a number of build-time options that can be set in &_Local/Makefile_&
38242 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
38243 Exim administrator who does not have the root password, or by someone who has
38244 penetrated the Exim (but not the root) account. These options are as follows:
38245
38246 .ilist
38247 ALT_CONFIG_PREFIX can be set to a string that is required to match the
38248 start of any file names used with the &%-C%& option. When it is set, these file
38249 names are also not allowed to contain the sequence &"/../"&. (However, if the
38250 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
38251 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
38252 default setting for &%ALT_CONFIG_PREFIX%&.
38253
38254 If the permitted configuration files are confined to a directory to
38255 which only root has access, this guards against someone who has broken
38256 into the Exim account from running a privileged Exim with an arbitrary
38257 configuration file, and using it to break into other accounts.
38258 .next
38259
38260 If a non-trusted configuration file (i.e. not the default configuration file
38261 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
38262 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
38263 the next item), then root privilege is retained only if the caller of Exim is
38264 root. This locks out the possibility of testing a configuration using &%-C%&
38265 right through message reception and delivery, even if the caller is root. The
38266 reception works, but by that time, Exim is running as the Exim user, so when
38267 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
38268 privilege to be lost. However, root can test reception and delivery using two
38269 separate commands.
38270
38271 .next
38272 The WHITELIST_D_MACROS build option declares some macros to be safe to override
38273 with &%-D%& if the real uid is one of root, the Exim run-time user or the
38274 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
38275 requiring the run-time value supplied to &%-D%& to match a regex that errs on
38276 the restrictive side.  Requiring build-time selection of safe macros is onerous
38277 but this option is intended solely as a transition mechanism to permit
38278 previously-working configurations to continue to work after release 4.73.
38279 .next
38280 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
38281 is disabled.
38282 .next
38283 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
38284 never to be used for any deliveries. This is like the &%never_users%& runtime
38285 option, but it cannot be overridden; the runtime option adds additional users
38286 to the list. The default setting is &"root"&; this prevents a non-root user who
38287 is permitted to modify the runtime file from using Exim as a way to get root.
38288 .endlist
38289
38290
38291
38292 .section "Root privilege" "SECID270"
38293 .cindex "setuid"
38294 .cindex "root privilege"
38295 The Exim binary is normally setuid to root, which means that it gains root
38296 privilege (runs as root) when it starts execution. In some special cases (for
38297 example, when the daemon is not in use and there are no local deliveries), it
38298 may be possible to run Exim setuid to some user other than root. This is
38299 discussed in the next section. However, in most installations, root privilege
38300 is required for two things:
38301
38302 .ilist
38303 To set up a socket connected to the standard SMTP port (25) when initialising
38304 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
38305 not required.
38306 .next
38307 To be able to change uid and gid in order to read users' &_.forward_& files and
38308 perform local deliveries as the receiving user or as specified in the
38309 configuration.
38310 .endlist
38311
38312 It is not necessary to be root to do any of the other things Exim does, such as
38313 receiving messages and delivering them externally over SMTP, and it is
38314 obviously more secure if Exim does not run as root except when necessary.
38315 For this reason, a user and group for Exim to use must be defined in
38316 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
38317 group"&. Their values can be changed by the run time configuration, though this
38318 is not recommended. Often a user called &'exim'& is used, but some sites use
38319 &'mail'& or another user name altogether.
38320
38321 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
38322 abdication; the process cannot regain root afterwards. Prior to release 4.00,
38323 &[seteuid()]& was used in some circumstances, but this is no longer the case.
38324
38325 After a new Exim process has interpreted its command line options, it changes
38326 uid and gid in the following cases:
38327
38328 .ilist
38329 .oindex "&%-C%&"
38330 .oindex "&%-D%&"
38331 If the &%-C%& option is used to specify an alternate configuration file, or if
38332 the &%-D%& option is used to define macro values for the configuration, and the
38333 calling process is not running as root, the uid and gid are changed to those of
38334 the calling process.
38335 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
38336 option may not be used at all.
38337 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
38338 can be supplied if the calling process is running as root, the Exim run-time
38339 user or CONFIGURE_OWNER, if defined.
38340 .next
38341 .oindex "&%-be%&"
38342 .oindex "&%-bf%&"
38343 .oindex "&%-bF%&"
38344 If the expansion test option (&%-be%&) or one of the filter testing options
38345 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
38346 calling process.
38347 .next
38348 If the process is not a daemon process or a queue runner process or a delivery
38349 process or a process for testing address routing (started with &%-bt%&), the
38350 uid and gid are changed to the Exim user and group. This means that Exim always
38351 runs under its own uid and gid when receiving messages. This also applies when
38352 testing address verification
38353 .oindex "&%-bv%&"
38354 .oindex "&%-bh%&"
38355 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
38356 option).
38357 .next
38358 For a daemon, queue runner, delivery, or address testing process, the uid
38359 remains as root at this stage, but the gid is changed to the Exim group.
38360 .endlist
38361
38362 The processes that initially retain root privilege behave as follows:
38363
38364 .ilist
38365 A daemon process changes the gid to the Exim group and the uid to the Exim
38366 user after setting up one or more listening sockets. The &[initgroups()]&
38367 function is called, so that if the Exim user is in any additional groups, they
38368 will be used during message reception.
38369 .next
38370 A queue runner process retains root privilege throughout its execution. Its
38371 job is to fork a controlled sequence of delivery processes.
38372 .next
38373 A delivery process retains root privilege throughout most of its execution,
38374 but any actual deliveries (that is, the transports themselves) are run in
38375 subprocesses which always change to a non-root uid and gid. For local
38376 deliveries this is typically the uid and gid of the owner of the mailbox; for
38377 remote deliveries, the Exim uid and gid are used. Once all the delivery
38378 subprocesses have been run, a delivery process changes to the Exim uid and gid
38379 while doing post-delivery tidying up such as updating the retry database and
38380 generating bounce and warning messages.
38381
38382 While the recipient addresses in a message are being routed, the delivery
38383 process runs as root. However, if a user's filter file has to be processed,
38384 this is done in a subprocess that runs under the individual user's uid and
38385 gid. A system filter is run as root unless &%system_filter_user%& is set.
38386 .next
38387 A process that is testing addresses (the &%-bt%& option) runs as root so that
38388 the routing is done in the same environment as a message delivery.
38389 .endlist
38390
38391
38392
38393
38394 .section "Running Exim without privilege" "SECTrunexiwitpri"
38395 .cindex "privilege, running without"
38396 .cindex "unprivileged running"
38397 .cindex "root privilege" "running without"
38398 Some installations like to run Exim in an unprivileged state for more of its
38399 operation, for added security. Support for this mode of operation is provided
38400 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
38401 gid are changed to the Exim user and group at the start of a delivery process
38402 (and also queue runner and address testing processes). This means that address
38403 routing is no longer run as root, and the deliveries themselves cannot change
38404 to any other uid.
38405
38406 .cindex SIGHUP
38407 .cindex "daemon" "restarting"
38408 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
38409 that the daemon can still be started in the usual way, and it can respond
38410 correctly to SIGHUP because the re-invocation regains root privilege.
38411
38412 An alternative approach is to make Exim setuid to the Exim user and also setgid
38413 to the Exim group. If you do this, the daemon must be started from a root
38414 process. (Calling Exim from a root process makes it behave in the way it does
38415 when it is setuid root.) However, the daemon cannot restart itself after a
38416 SIGHUP signal because it cannot regain privilege.
38417
38418 It is still useful to set &%deliver_drop_privilege%& in this case, because it
38419 stops Exim from trying to re-invoke itself to do a delivery after a message has
38420 been received. Such a re-invocation is a waste of resources because it has no
38421 effect.
38422
38423 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
38424 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
38425 to the Exim user seems a clean approach, but there is one complication:
38426
38427 In this style of operation, Exim is running with the real uid and gid set to
38428 those of the calling process, and the effective uid/gid set to Exim's values.
38429 Ideally, any association with the calling process' uid/gid should be dropped,
38430 that is, the real uid/gid should be reset to the effective values so as to
38431 discard any privileges that the caller may have. While some operating systems
38432 have a function that permits this action for a non-root effective uid, quite a
38433 number of them do not. Because of this lack of standardization, Exim does not
38434 address this problem at this time.
38435
38436 For this reason, the recommended approach for &"mostly unprivileged"& running
38437 is to keep the Exim binary setuid to root, and to set
38438 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
38439 be used in the most straightforward way.
38440
38441 If you configure Exim not to run delivery processes as root, there are a
38442 number of restrictions on what you can do:
38443
38444 .ilist
38445 You can deliver only as the Exim user/group. You should  explicitly use the
38446 &%user%& and &%group%& options to override routers or local transports that
38447 normally deliver as the recipient. This makes sure that configurations that
38448 work in this mode function the same way in normal mode. Any implicit or
38449 explicit specification of another user causes an error.
38450 .next
38451 Use of &_.forward_& files is severely restricted, such that it is usually
38452 not worthwhile to include them in the configuration.
38453 .next
38454 Users who wish to use &_.forward_& would have to make their home directory and
38455 the file itself accessible to the Exim user. Pipe and append-to-file entries,
38456 and their equivalents in Exim filters, cannot be used. While they could be
38457 enabled in the Exim user's name, that would be insecure and not very useful.
38458 .next
38459 Unless the local user mailboxes are all owned by the Exim user (possible in
38460 some POP3 or IMAP-only environments):
38461
38462 .olist
38463 They must be owned by the Exim group and be writeable by that group. This
38464 implies you must set &%mode%& in the appendfile configuration, as well as the
38465 mode of the mailbox files themselves.
38466 .next
38467 You must set &%no_check_owner%&, since most or all of the files will not be
38468 owned by the Exim user.
38469 .next
38470 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
38471 on a newly created mailbox when unprivileged. This also implies that new
38472 mailboxes need to be created manually.
38473 .endlist olist
38474 .endlist ilist
38475
38476
38477 These restrictions severely restrict what can be done in local deliveries.
38478 However, there are no restrictions on remote deliveries. If you are running a
38479 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
38480 gives more security at essentially no cost.
38481
38482 If you are using the &%mua_wrapper%& facility (see chapter
38483 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
38484
38485
38486
38487
38488 .section "Delivering to local files" "SECID271"
38489 Full details of the checks applied by &(appendfile)& before it writes to a file
38490 are given in chapter &<<CHAPappendfile>>&.
38491
38492
38493
38494 .section "Running local commands" "SECTsecconslocalcmds"
38495 .cindex "security" "local commands"
38496 .cindex "security" "command injection attacks"
38497 There are a number of ways in which an administrator can configure Exim to run
38498 commands based upon received, untrustworthy, data. Further, in some
38499 configurations a user who can control a &_.forward_& file can also arrange to
38500 run commands. Configuration to check includes, but is not limited to:
38501
38502 .ilist
38503 Use of &%use_shell%& in the pipe transport: various forms of shell command
38504 injection may be possible with this option present. It is dangerous and should
38505 be used only with considerable caution. Consider constraints which whitelist
38506 allowed characters in a variable which is to be used in a pipe transport that
38507 has &%use_shell%& enabled.
38508 .next
38509 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
38510 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
38511 &_.forward_& files in a redirect router. If Exim is running on a central mail
38512 hub to which ordinary users do not have shell access, but home directories are
38513 NFS mounted (for instance) then administrators should review the list of these
38514 forbid options available, and should bear in mind that the options that may
38515 need forbidding can change as new features are added between releases.
38516 .next
38517 The &%${run...}%& expansion item does not use a shell by default, but
38518 administrators can configure use of &_/bin/sh_& as part of the command.
38519 Such invocations should be viewed with prejudicial suspicion.
38520 .next
38521 Administrators who use embedded Perl are advised to explore how Perl's
38522 taint checking might apply to their usage.
38523 .next
38524 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
38525 administrators are well advised to view its use with suspicion, in case (for
38526 instance) it allows a local-part to contain embedded Exim directives.
38527 .next
38528 Use of &%${match_local_part...}%& and friends becomes more dangerous if
38529 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
38530 each can reference arbitrary lists and files, rather than just being a list
38531 of opaque strings.
38532 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
38533 real-world security vulnerabilities caused by its use with untrustworthy data
38534 injected in, for SQL injection attacks.
38535 Consider the use of the &%inlisti%& expansion condition instead.
38536 .endlist
38537
38538
38539
38540
38541 .section "Trust in configuration data" "SECTsecconfdata"
38542 .cindex "security" "data sources"
38543 .cindex "security" "regular expressions"
38544 .cindex "regular expressions" "security"
38545 .cindex "PCRE" "security"
38546 If configuration data for Exim can come from untrustworthy sources, there
38547 are some issues to be aware of:
38548
38549 .ilist
38550 Use of &%${expand...}%& may provide a path for shell injection attacks.
38551 .next
38552 Letting untrusted data provide a regular expression is unwise.
38553 .next
38554 Using &%${match...}%& to apply a fixed regular expression against untrusted
38555 data may result in pathological behaviour within PCRE.  Be aware of what
38556 "backtracking" means and consider options for being more strict with a regular
38557 expression. Avenues to explore include limiting what can match (avoiding &`.`&
38558 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
38559 possessive quantifiers or just not using regular expressions against untrusted
38560 data.
38561 .next
38562 It can be important to correctly use &%${quote:...}%&,
38563 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
38564 items to ensure that data is correctly constructed.
38565 .next
38566 Some lookups might return multiple results, even though normal usage is only
38567 expected to yield one result.
38568 .endlist
38569
38570
38571
38572
38573 .section "IPv4 source routing" "SECID272"
38574 .cindex "source routing" "in IP packets"
38575 .cindex "IP source routing"
38576 Many operating systems suppress IP source-routed packets in the kernel, but
38577 some cannot be made to do this, so Exim does its own check. It logs incoming
38578 IPv4 source-routed TCP calls, and then drops them. Things are all different in
38579 IPv6. No special checking is currently done.
38580
38581
38582
38583 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
38584 Support for these SMTP commands is disabled by default. If required, they can
38585 be enabled by defining suitable ACLs.
38586
38587
38588
38589
38590 .section "Privileged users" "SECID274"
38591 .cindex "trusted users"
38592 .cindex "admin user"
38593 .cindex "privileged user"
38594 .cindex "user" "trusted"
38595 .cindex "user" "admin"
38596 Exim recognizes two sets of users with special privileges. Trusted users are
38597 able to submit new messages to Exim locally, but supply their own sender
38598 addresses and information about a sending host. For other users submitting
38599 local messages, Exim sets up the sender address from the uid, and doesn't
38600 permit a remote host to be specified.
38601
38602 .oindex "&%-f%&"
38603 However, an untrusted user is permitted to use the &%-f%& command line option
38604 in the special form &%-f <>%& to indicate that a delivery failure for the
38605 message should not cause an error report. This affects the message's envelope,
38606 but it does not affect the &'Sender:'& header. Untrusted users may also be
38607 permitted to use specific forms of address with the &%-f%& option by setting
38608 the &%untrusted_set_sender%& option.
38609
38610 Trusted users are used to run processes that receive mail messages from some
38611 other mail domain and pass them on to Exim for delivery either locally, or over
38612 the Internet. Exim trusts a caller that is running as root, as the Exim user,
38613 as any user listed in the &%trusted_users%& configuration option, or under any
38614 group listed in the &%trusted_groups%& option.
38615
38616 Admin users are permitted to do things to the messages on Exim's queue. They
38617 can freeze or thaw messages, cause them to be returned to their senders, remove
38618 them entirely, or modify them in various ways. In addition, admin users can run
38619 the Exim monitor and see all the information it is capable of providing, which
38620 includes the contents of files on the spool.
38621
38622 .oindex "&%-M%&"
38623 .oindex "&%-q%&"
38624 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
38625 delivery of messages on its queue is restricted to admin users. This
38626 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
38627 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
38628 queue is also restricted to admin users. This restriction can be relaxed by
38629 setting &%no_queue_list_requires_admin%&.
38630
38631 Exim recognizes an admin user if the calling process is running as root or as
38632 the Exim user or if any of the groups associated with the calling process is
38633 the Exim group. It is not necessary actually to be running under the Exim
38634 group. However, if admin users who are not root or the Exim user are to access
38635 the contents of files on the spool via the Exim monitor (which runs
38636 unprivileged), Exim must be built to allow group read access to its spool
38637 files.
38638
38639 By default, regular users are trusted to perform basic testing and
38640 introspection commands, as themselves.  This setting can be tightened by
38641 setting the &%commandline_checks_require_admin%& option.
38642 This affects most of the checking options,
38643 such as &%-be%& and anything else &%-b*%&.
38644
38645
38646 .section "Spool files" "SECID275"
38647 .cindex "spool directory" "files"
38648 Exim's spool directory and everything it contains is owned by the Exim user and
38649 set to the Exim group. The mode for spool files is defined in the
38650 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
38651 any user who is a member of the Exim group can access these files.
38652
38653
38654
38655 .section "Use of argv[0]" "SECID276"
38656 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
38657 of specific strings, Exim assumes certain options. For example, calling Exim
38658 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
38659 to calling it with the option &%-bS%&. There are no security implications in
38660 this.
38661
38662
38663
38664 .section "Use of %f formatting" "SECID277"
38665 The only use made of &"%f"& by Exim is in formatting load average values. These
38666 are actually stored in integer variables as 1000 times the load average.
38667 Consequently, their range is limited and so therefore is the length of the
38668 converted output.
38669
38670
38671
38672 .section "Embedded Exim path" "SECID278"
38673 Exim uses its own path name, which is embedded in the code, only when it needs
38674 to re-exec in order to regain root privilege. Therefore, it is not root when it
38675 does so. If some bug allowed the path to get overwritten, it would lead to an
38676 arbitrary program's being run as exim, not as root.
38677
38678
38679
38680 .section "Dynamic module directory" "SECTdynmoddir"
38681 Any dynamically loadable modules must be installed into the directory
38682 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
38683 loading it.
38684
38685
38686 .section "Use of sprintf()" "SECID279"
38687 .cindex "&[sprintf()]&"
38688 A large number of occurrences of &"sprintf"& in the code are actually calls to
38689 &'string_sprintf()'&, a function that returns the result in malloc'd store.
38690 The intermediate formatting is done into a large fixed buffer by a function
38691 that runs through the format string itself, and checks the length of each
38692 conversion before performing it, thus preventing buffer overruns.
38693
38694 The remaining uses of &[sprintf()]& happen in controlled circumstances where
38695 the output buffer is known to be sufficiently long to contain the converted
38696 string.
38697
38698
38699
38700 .section "Use of debug_printf() and log_write()" "SECID280"
38701 Arbitrary strings are passed to both these functions, but they do their
38702 formatting by calling the function &'string_vformat()'&, which runs through
38703 the format string itself, and checks the length of each conversion.
38704
38705
38706
38707 .section "Use of strcat() and strcpy()" "SECID281"
38708 These are used only in cases where the output buffer is known to be large
38709 enough to hold the result.
38710 .ecindex IIDsecurcon
38711
38712
38713
38714
38715 . ////////////////////////////////////////////////////////////////////////////
38716 . ////////////////////////////////////////////////////////////////////////////
38717
38718 .chapter "Format of spool files" "CHAPspool"
38719 .scindex IIDforspo1 "format" "spool files"
38720 .scindex IIDforspo2 "spool directory" "format of files"
38721 .scindex IIDforspo3 "spool files" "format of"
38722 .cindex "spool files" "editing"
38723 A message on Exim's queue consists of two files, whose names are the message id
38724 followed by -D and -H, respectively. The data portion of the message is kept in
38725 the -D file on its own. The message's envelope, status, and headers are all
38726 kept in the -H file, whose format is described in this chapter. Each of these
38727 two files contains the final component of its own name as its first line. This
38728 is insurance against disk crashes where the directory is lost but the files
38729 themselves are recoverable.
38730
38731 .new
38732 The file formats may be changed, or new formats added, at any release.
38733 Spool files are not intended as an interface to other programs
38734 and should not be used as such.
38735 .wen
38736
38737 Some people are tempted into editing -D files in order to modify messages. You
38738 need to be extremely careful if you do this; it is not recommended and you are
38739 on your own if you do it. Here are some of the pitfalls:
38740
38741 .ilist
38742 You must ensure that Exim does not try to deliver the message while you are
38743 fiddling with it. The safest way is to take out a write lock on the -D file,
38744 which is what Exim itself does, using &[fcntl()]&. If you update the file in
38745 place, the lock will be retained. If you write a new file and rename it, the
38746 lock will be lost at the instant of rename.
38747 .next
38748 .vindex "&$body_linecount$&"
38749 If you change the number of lines in the file, the value of
38750 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
38751 cause incomplete transmission of messages or undeliverable messages.
38752 .next
38753 If the message is in MIME format, you must take care not to break it.
38754 .next
38755 If the message is cryptographically signed, any change will invalidate the
38756 signature.
38757 .endlist
38758 All in all, modifying -D files is fraught with danger.
38759
38760 Files whose names end with -J may also be seen in the &_input_& directory (or
38761 its subdirectories when &%split_spool_directory%& is set). These are journal
38762 files, used to record addresses to which the message has been delivered during
38763 the course of a delivery attempt. If there are still undelivered recipients at
38764 the end, the -H file is updated, and the -J file is deleted. If, however, there
38765 is some kind of crash (for example, a power outage) before this happens, the -J
38766 file remains in existence. When Exim next processes the message, it notices the
38767 -J file and uses it to update the -H file before starting the next delivery
38768 attempt.
38769
38770 Files whose names end with -K or .eml may also be seen in the spool.
38771 These are temporaries used for DKIM or malware processing, when that is used.
38772 They should be tidied up by normal operations; any old ones are probably
38773 relics of crashes and can be removed.
38774
38775 .section "Format of the -H file" "SECID282"
38776 .cindex "uid (user id)" "in spool file"
38777 .cindex "gid (group id)" "in spool file"
38778 The second line of the -H file contains the login name for the uid of the
38779 process that called Exim to read the message, followed by the numerical uid and
38780 gid. For a locally generated message, this is normally the user who sent the
38781 message. For a message received over TCP/IP via the daemon, it is
38782 normally the Exim user.
38783
38784 The third line of the file contains the address of the message's sender as
38785 transmitted in the envelope, contained in angle brackets. The sender address is
38786 empty for bounce messages. For incoming SMTP mail, the sender address is given
38787 in the MAIL command. For locally generated mail, the sender address is
38788 created by Exim from the login name of the current user and the configured
38789 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
38790 leading &"From&~"& line if the caller is trusted, or if the supplied address is
38791 &"<>"& or an address that matches &%untrusted_set_senders%&.
38792
38793 The fourth line contains two numbers. The first is the time that the message
38794 was received, in the conventional Unix form &-- the number of seconds since the
38795 start of the epoch. The second number is a count of the number of messages
38796 warning of delayed delivery that have been sent to the sender.
38797
38798 There follow a number of lines starting with a hyphen. These can appear in any
38799 order, and are omitted when not relevant:
38800
38801 .vlist
38802 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
38803 This item is obsolete, and is not generated from Exim release 4.61 onwards;
38804 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
38805 recognized, to provide backward compatibility. In the old format, a line of
38806 this form is present for every ACL variable that is not empty. The number
38807 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
38808 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
38809 the data string for the variable. The string itself starts at the beginning of
38810 the next line, and is followed by a newline character. It may contain internal
38811 newlines.
38812
38813 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
38814 A line of this form is present for every ACL connection variable that is
38815 defined. Note that there is a space between &%-aclc%& and the rest of the name.
38816 The length is the length of the data string for the variable. The string itself
38817 starts at the beginning of the next line, and is followed by a newline
38818 character. It may contain internal newlines.
38819
38820 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
38821 A line of this form is present for every ACL message variable that is defined.
38822 Note that there is a space between &%-aclm%& and the rest of the name. The
38823 length is the length of the data string for the variable. The string itself
38824 starts at the beginning of the next line, and is followed by a newline
38825 character. It may contain internal newlines.
38826
38827 .vitem "&%-active_hostname%&&~<&'hostname'&>"
38828 This is present if, when the message was received over SMTP, the value of
38829 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
38830
38831 .vitem &%-allow_unqualified_recipient%&
38832 This is present if unqualified recipient addresses are permitted in header
38833 lines (to stop such addresses from being qualified if rewriting occurs at
38834 transport time). Local messages that were input using &%-bnq%& and remote
38835 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
38836
38837 .vitem &%-allow_unqualified_sender%&
38838 This is present if unqualified sender addresses are permitted in header lines
38839 (to stop such addresses from being qualified if rewriting occurs at transport
38840 time). Local messages that were input using &%-bnq%& and remote messages from
38841 hosts that match &%sender_unqualified_hosts%& set this flag.
38842
38843 .vitem "&%-auth_id%&&~<&'text'&>"
38844 The id information for a message received on an authenticated SMTP connection
38845 &-- the value of the &$authenticated_id$& variable.
38846
38847 .vitem "&%-auth_sender%&&~<&'address'&>"
38848 The address of an authenticated sender &-- the value of the
38849 &$authenticated_sender$& variable.
38850
38851 .vitem "&%-body_linecount%&&~<&'number'&>"
38852 This records the number of lines in the body of the message, and is
38853 present unless &%-spool_file_wireformat%& is.
38854
38855 .vitem "&%-body_zerocount%&&~<&'number'&>"
38856 This records the number of binary zero bytes in the body of the message, and is
38857 present if the number is greater than zero.
38858
38859 .vitem &%-deliver_firsttime%&
38860 This is written when a new message is first added to the spool. When the spool
38861 file is updated after a deferral, it is omitted.
38862
38863 .vitem "&%-frozen%&&~<&'time'&>"
38864 .cindex "frozen messages" "spool data"
38865 The message is frozen, and the freezing happened at <&'time'&>.
38866
38867 .vitem "&%-helo_name%&&~<&'text'&>"
38868 This records the host name as specified by a remote host in a HELO or EHLO
38869 command.
38870
38871 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
38872 This records the IP address of the host from which the message was received and
38873 the remote port number that was used. It is omitted for locally generated
38874 messages.
38875
38876 .vitem "&%-host_auth%&&~<&'text'&>"
38877 If the message was received on an authenticated SMTP connection, this records
38878 the name of the authenticator &-- the value of the
38879 &$sender_host_authenticated$& variable.
38880
38881 .vitem &%-host_lookup_failed%&
38882 This is present if an attempt to look up the sending host's name from its IP
38883 address failed. It corresponds to the &$host_lookup_failed$& variable.
38884
38885 .vitem "&%-host_name%&&~<&'text'&>"
38886 .cindex "reverse DNS lookup"
38887 .cindex "DNS" "reverse lookup"
38888 This records the name of the remote host from which the message was received,
38889 if the host name was looked up from the IP address when the message was being
38890 received. It is not present if no reverse lookup was done.
38891
38892 .vitem "&%-ident%&&~<&'text'&>"
38893 For locally submitted messages, this records the login of the originating user,
38894 unless it was a trusted user and the &%-oMt%& option was used to specify an
38895 ident value. For messages received over TCP/IP, this records the ident string
38896 supplied by the remote host, if any.
38897
38898 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
38899 This records the IP address of the local interface and the port number through
38900 which a message was received from a remote host. It is omitted for locally
38901 generated messages.
38902
38903 .vitem &%-local%&
38904 The message is from a local sender.
38905
38906 .vitem &%-localerror%&
38907 The message is a locally-generated bounce message.
38908
38909 .vitem "&%-local_scan%&&~<&'string'&>"
38910 This records the data string that was returned by the &[local_scan()]& function
38911 when the message was received &-- the value of the &$local_scan_data$&
38912 variable. It is omitted if no data was returned.
38913
38914 .vitem &%-manual_thaw%&
38915 The message was frozen but has been thawed manually, that is, by an explicit
38916 Exim command rather than via the auto-thaw process.
38917
38918 .vitem &%-N%&
38919 A testing delivery process was started using the &%-N%& option to suppress any
38920 actual deliveries, but delivery was deferred. At any further delivery attempts,
38921 &%-N%& is assumed.
38922
38923 .vitem &%-received_protocol%&
38924 This records the value of the &$received_protocol$& variable, which contains
38925 the name of the protocol by which the message was received.
38926
38927 .vitem &%-sender_set_untrusted%&
38928 The envelope sender of this message was set by an untrusted local caller (used
38929 to ensure that the caller is displayed in queue listings).
38930
38931 .vitem "&%-spam_score_int%&&~<&'number'&>"
38932 If a message was scanned by SpamAssassin, this is present. It records the value
38933 of &$spam_score_int$&.
38934
38935 .vitem &%-spool_file_wireformat%&
38936 The -D file for this message is in wire-format (for ESMTP CHUNKING)
38937 rather than Unix-format.
38938 The line-ending is CRLF rather than newline.
38939 There is still, however, no leading-dot-stuffing.
38940
38941 .vitem &%-tls_certificate_verified%&
38942 A TLS certificate was received from the client that sent this message, and the
38943 certificate was verified by the server.
38944
38945 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
38946 When the message was received over an encrypted connection, this records the
38947 name of the cipher suite that was used.
38948
38949 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
38950 When the message was received over an encrypted connection, and a certificate
38951 was received from the client, this records the Distinguished Name from that
38952 certificate.
38953 .endlist
38954
38955 Following the options there is a list of those addresses to which the message
38956 is not to be delivered. This set of addresses is initialized from the command
38957 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
38958 is set; otherwise it starts out empty. Whenever a successful delivery is made,
38959 the address is added to this set. The addresses are kept internally as a
38960 balanced binary tree, and it is a representation of that tree which is written
38961 to the spool file. If an address is expanded via an alias or forward file, the
38962 original address is added to the tree when deliveries to all its child
38963 addresses are complete.
38964
38965 If the tree is empty, there is a single line in the spool file containing just
38966 the text &"XX"&. Otherwise, each line consists of two letters, which are either
38967 Y or N, followed by an address. The address is the value for the node of the
38968 tree, and the letters indicate whether the node has a left branch and/or a
38969 right branch attached to it, respectively. If branches exist, they immediately
38970 follow. Here is an example of a three-node tree:
38971 .code
38972 YY darcy@austen.fict.example
38973 NN alice@wonderland.fict.example
38974 NN editor@thesaurus.ref.example
38975 .endd
38976 After the non-recipients tree, there is a list of the message's recipients.
38977 This is a simple list, preceded by a count. It includes all the original
38978 recipients of the message, including those to whom the message has already been
38979 delivered. In the simplest case, the list contains one address per line. For
38980 example:
38981 .code
38982 4
38983 editor@thesaurus.ref.example
38984 darcy@austen.fict.example
38985 rdo@foundation
38986 alice@wonderland.fict.example
38987 .endd
38988 However, when a child address has been added to the top-level addresses as a
38989 result of the use of the &%one_time%& option on a &(redirect)& router, each
38990 line is of the following form:
38991 .display
38992 <&'top-level address'&> <&'errors_to address'&> &&&
38993   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
38994 .endd
38995 The 01 flag bit indicates the presence of the three other fields that follow
38996 the top-level address. Other bits may be used in future to support additional
38997 fields. The <&'parent number'&> is the offset in the recipients list of the
38998 original parent of the &"one time"& address. The first two fields are the
38999 envelope sender that is associated with this address and its length. If the
39000 length is zero, there is no special envelope sender (there are then two space
39001 characters in the line). A non-empty field can arise from a &(redirect)& router
39002 that has an &%errors_to%& setting.
39003
39004
39005 A blank line separates the envelope and status information from the headers
39006 which follow. A header may occupy several lines of the file, and to save effort
39007 when reading it in, each header is preceded by a number and an identifying
39008 character. The number is the number of characters in the header, including any
39009 embedded newlines and the terminating newline. The character is one of the
39010 following:
39011
39012 .table2 50pt
39013 .row <&'blank'&>         "header in which Exim has no special interest"
39014 .row &`B`&               "&'Bcc:'& header"
39015 .row &`C`&               "&'Cc:'& header"
39016 .row &`F`&               "&'From:'& header"
39017 .row &`I`&               "&'Message-id:'& header"
39018 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
39019 .row &`R`&               "&'Reply-To:'& header"
39020 .row &`S`&               "&'Sender:'& header"
39021 .row &`T`&               "&'To:'& header"
39022 .row &`*`&               "replaced or deleted header"
39023 .endtable
39024
39025 Deleted or replaced (rewritten) headers remain in the spool file for debugging
39026 purposes. They are not transmitted when the message is delivered. Here is a
39027 typical set of headers:
39028 .code
39029 111P Received: by hobbit.fict.example with local (Exim 4.00)
39030 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
39031 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
39032 038* X-rewrote-sender: bb@hobbit.fict.example
39033 042* From: Bilbo Baggins <bb@hobbit.fict.example>
39034 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
39035 099* To: alice@wonderland.fict.example, rdo@foundation,
39036 darcy@austen.fict.example, editor@thesaurus.ref.example
39037 104T To: alice@wonderland.fict.example, rdo@foundation.example,
39038 darcy@austen.fict.example, editor@thesaurus.ref.example
39039 038  Date: Fri, 11 May 2001 10:28:59 +0100
39040 .endd
39041 The asterisked headers indicate that the envelope sender, &'From:'& header, and
39042 &'To:'& header have been rewritten, the last one because routing expanded the
39043 unqualified domain &'foundation'&.
39044 .ecindex IIDforspo1
39045 .ecindex IIDforspo2
39046 .ecindex IIDforspo3
39047
39048 .section "Format of the -D file" "SECID282a"
39049 The data file is traditionally in Unix-standard format: lines are ended with
39050 an ASCII newline character.
39051 However, when the &%spool_wireformat%& main option is used some -D files
39052 can have an alternate format.
39053 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
39054 The -D file lines (not including the first name-component line) are
39055 suitable for direct copying to the wire when transmitting using the
39056 ESMTP CHUNKING option, meaning lower processing overhead.
39057 Lines are terminated with an ASCII CRLF pair.
39058 There is no dot-stuffing (and no dot-termination).
39059
39060 . ////////////////////////////////////////////////////////////////////////////
39061 . ////////////////////////////////////////////////////////////////////////////
39062
39063 .chapter "DKIM and SPF" "CHAPdkim" &&&
39064          "DKIM and SPF Support"
39065 .cindex "DKIM"
39066
39067 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
39068
39069 DKIM is a mechanism by which messages sent by some entity can be provably
39070 linked to a domain which that entity controls.  It permits reputation to
39071 be tracked on a per-domain basis, rather than merely upon source IP address.
39072 DKIM is documented in RFC 6376.
39073
39074 As DKIM relies on the message being unchanged in transit, messages handled
39075 by a mailing-list (which traditionally adds to the message) will not match
39076 any original DKIM signature.
39077
39078 DKIM support is compiled into Exim by default if TLS support is present.
39079 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
39080
39081 Exim's DKIM implementation allows for
39082 .olist
39083 Signing outgoing messages: This function is implemented in the SMTP transport.
39084 It can co-exist with all other Exim features
39085 (including transport filters)
39086 except cutthrough delivery.
39087 .next
39088 Verifying signatures in incoming messages: This is implemented by an additional
39089 ACL (acl_smtp_dkim), which can be called several times per message, with
39090 different signature contexts.
39091 .endlist
39092
39093 In typical Exim style, the verification implementation does not include any
39094 default "policy". Instead it enables you to build your own policy using
39095 Exim's standard controls.
39096
39097 Please note that verification of DKIM signatures in incoming mail is turned
39098 on by default for logging (in the <= line) purposes.
39099
39100 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
39101 When set, for each signature in incoming email,
39102 exim will log a line displaying the most important signature details, and the
39103 signature status. Here is an example (with line-breaks added for clarity):
39104 .code
39105 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
39106     d=facebookmail.com s=q1-2009b
39107     c=relaxed/relaxed a=rsa-sha1
39108     i=@facebookmail.com t=1252484542 [verification succeeded]
39109 .endd
39110
39111 You might want to turn off DKIM verification processing entirely for internal
39112 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
39113 control modifier. This should typically be done in the RCPT ACL, at points
39114 where you accept mail from relay sources (internal hosts or authenticated
39115 senders).
39116
39117
39118 .section "Signing outgoing messages" "SECDKIMSIGN"
39119 .cindex "DKIM" "signing"
39120
39121 For signing to be usable you must have published a DKIM record in DNS.
39122 Note that RFC 8301 says:
39123 .code
39124 rsa-sha1 MUST NOT be used for signing or verifying.
39125
39126 Signers MUST use RSA keys of at least 1024 bits for all keys.
39127 Signers SHOULD use RSA keys of at least 2048 bits.
39128 .endd
39129
39130 Note also that the key content (the 'p=' field)
39131 in the DNS record is different between RSA and EC keys;
39132 for the former it is the base64 of the ASN.1 for the RSA public key
39133 (equivalent to the private-key .pem with the header/trailer stripped)
39134 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
39135
39136 Signing is enabled by setting private options on the SMTP transport.
39137 These options take (expandable) strings as arguments.
39138
39139 .option dkim_domain smtp string list&!! unset
39140 The domain(s) you want to sign with.
39141 After expansion, this can be a list.
39142 Each element in turn is put into the &%$dkim_domain%& expansion variable
39143 while expanding the remaining signing options.
39144 If it is empty after expansion, DKIM signing is not done,
39145 and no error will result even if &%dkim_strict%& is set.
39146
39147 .option dkim_selector smtp string list&!! unset
39148 This sets the key selector string.
39149 After expansion, which can use &$dkim_domain$&, this can be a list.
39150 Each element in turn is put in the expansion
39151 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
39152 option along with &%$dkim_domain%&.
39153 If the option is empty after expansion, DKIM signing is not done for this domain,
39154 and no error will result even if &%dkim_strict%& is set.
39155
39156 .option dkim_private_key smtp string&!! unset
39157 This sets the private key to use.
39158 You can use the &%$dkim_domain%& and
39159 &%$dkim_selector%& expansion variables to determine the private key to use.
39160 The result can either
39161 .ilist
39162 be a valid RSA private key in ASCII armor (.pem file), including line breaks
39163 .next
39164 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
39165 be a valid Ed25519 private key (same format as above)
39166 .next
39167 start with a slash, in which case it is treated as a file that contains
39168 the private key
39169 .next
39170 be "0", "false" or the empty string, in which case the message will not
39171 be signed. This case will not result in an error, even if &%dkim_strict%&
39172 is set.
39173 .endlist
39174
39175 To generate keys under OpenSSL:
39176 .code
39177 openssl genrsa -out dkim_rsa.private 2048
39178 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
39179 .endd
39180 Take the base-64 lines from the output of the second command, concatenated,
39181 for the DNS TXT record.
39182 See section 3.6 of RFC6376 for the record specification.
39183
39184 Under GnuTLS:
39185 .code
39186 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
39187 certtool --load-privkey=dkim_rsa.private --pubkey-info
39188 .endd
39189
39190 Note that RFC 8301 says:
39191 .code
39192 Signers MUST use RSA keys of at least 1024 bits for all keys.
39193 Signers SHOULD use RSA keys of at least 2048 bits.
39194 .endd
39195
39196 Support for EC keys is being developed under
39197 &url(https://datatracker.ietf.org/doc/draft-ietf-dcrup-dkim-crypto/).
39198 They are considerably smaller than RSA keys for equivalent protection.
39199 As they are a recent development, users should consider dual-signing
39200 (by setting a list of selectors, and an expansion for this option)
39201 for some transition period.
39202 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
39203 for EC keys.
39204
39205 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
39206 .code
39207 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
39208 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
39209 .endd
39210
39211 To produce the required public key value for a DNS record:
39212 .code
39213 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
39214 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
39215 .endd
39216
39217 Note that the format
39218 of Ed25519 keys in DNS has not yet been decided; this release supports
39219 both of the leading candidates at this time, a future release will
39220 probably drop support for whichever proposal loses.
39221
39222 .option dkim_hash smtp string&!! sha256
39223 Can be set to any one of the supported hash methods, which are:
39224 .ilist
39225 &`sha1`& &-- should not be used, is old and insecure
39226 .next
39227 &`sha256`& &-- the default
39228 .next
39229 &`sha512`& &-- possibly more secure but less well supported
39230 .endlist
39231
39232 Note that RFC 8301 says:
39233 .code
39234 rsa-sha1 MUST NOT be used for signing or verifying.
39235 .endd
39236
39237 .option dkim_identity smtp string&!! unset
39238 If set after expansion, the value is used to set an "i=" tag in
39239 the signing header.  The DKIM standards restrict the permissible
39240 syntax of this optional tag to a mail address, with possibly-empty
39241 local part, an @, and a domain identical to or subdomain of the "d="
39242 tag value.  Note that Exim does not check the value.
39243
39244 .option dkim_canon smtp string&!! unset
39245 This option sets the canonicalization method used when signing a message.
39246 The DKIM RFC currently supports two methods: "simple" and "relaxed".
39247 The option defaults to "relaxed" when unset. Note: the current implementation
39248 only supports signing with the same canonicalization method for both headers and body.
39249
39250 .option dkim_strict smtp string&!! unset
39251 This  option  defines  how  Exim  behaves  when  signing a message that
39252 should be signed fails for some reason.  When the expansion evaluates to
39253 either "1" or "true", Exim will defer. Otherwise Exim will send the message
39254 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
39255 variables here.
39256
39257 .option dkim_sign_headers smtp string&!! "see below"
39258 If set, this option must expand to a colon-separated
39259 list of header names.
39260 Headers with these names, or the absence or such a header, will be included
39261 in the message signature.
39262 When unspecified, the header names listed in RFC4871 will be used,
39263 whether or not each header is present in the message.
39264 The default list is available for the expansion in the macro
39265 "_DKIM_SIGN_HEADERS".
39266
39267 If a name is repeated, multiple headers by that name (or the absence thereof)
39268 will be signed.  The textually later headers in the headers part of the
39269 message are signed first, if there are multiples.
39270
39271 A name can be prefixed with either an '=' or a '+' character.
39272 If an '=' prefix is used, all headers that are present with this name
39273 will be signed.
39274 If a '+' prefix if used, all headers that are present with this name
39275 will be signed, and one signature added for a missing header with the
39276 name will be appended.
39277
39278 .new
39279 .option dkim_timestamps smtp integer&!! unset
39280 This option controls the inclusion of timestamp information in the signature.
39281 If not set, no such information will be included.
39282 Otherwise, must be an unsigned number giving an offset in seconds from the current time
39283 for the expiry tag
39284 (eg. 1209600 for two weeks);
39285 both creation (t=) and expiry (x=) tags will be included.
39286
39287 RFC 6376 lists these tags as RECOMMENDED.
39288 .wen
39289
39290
39291 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
39292 .cindex "DKIM" "verification"
39293
39294 .new
39295 Verification of DKIM signatures in SMTP incoming email is done for all
39296 messages for which an ACL control &%dkim_disable_verify%& has not been set.
39297 .cindex authentication "expansion item"
39298 Performing verification sets up information used by the
39299 &$authresults$& expansion item.
39300 .wen
39301
39302 .new The results of that verification are then made available to the
39303 &%acl_smtp_dkim%& ACL, &new(which can examine and modify them).
39304 By default, this ACL is called once for each
39305 syntactically(!) correct signature in the incoming message.
39306 A missing ACL definition defaults to accept.
39307 If any ACL call does not accept, the message is not accepted.
39308 If a cutthrough delivery was in progress for the message, that is
39309 summarily dropped (having wasted the transmission effort).
39310
39311 To evaluate the &new(verification result) in the ACL
39312 a large number of expansion variables
39313 containing the signature status and its details are set up during the
39314 runtime of the ACL.
39315
39316 Calling the ACL only for existing signatures is not sufficient to build
39317 more advanced policies. For that reason, the global option
39318 &%dkim_verify_signers%&, and a global expansion variable
39319 &%$dkim_signers%& exist.
39320
39321 The global option &%dkim_verify_signers%& can be set to a colon-separated
39322 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
39323 called. It is expanded when the message has been received. At this point,
39324 the expansion variable &%$dkim_signers%& already contains a colon-separated
39325 list of signer domains and identities for the message. When
39326 &%dkim_verify_signers%& is not specified in the main configuration,
39327 it defaults as:
39328 .code
39329 dkim_verify_signers = $dkim_signers
39330 .endd
39331 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
39332 DKIM signature in the message. Current DKIM verifiers may want to explicitly
39333 call the ACL for known domains or identities. This would be achieved as follows:
39334 .code
39335 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
39336 .endd
39337 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
39338 and "ebay.com", plus all domains and identities that have signatures in the message.
39339 You can also be more creative in constructing your policy. For example:
39340 .code
39341 dkim_verify_signers = $sender_address_domain:$dkim_signers
39342 .endd
39343
39344 If a domain or identity is listed several times in the (expanded) value of
39345 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
39346
39347 If multiple signatures match a domain (or identity), the ACL is called once
39348 for each matching signature.
39349
39350
39351 Inside the &%acl_smtp_dkim%&, the following expansion variables are
39352 available (from most to least important):
39353
39354
39355 .vlist
39356 .vitem &%$dkim_cur_signer%&
39357 The signer that is being evaluated in this ACL run. This can be a domain or
39358 an identity. This is one of the list items from the expanded main option
39359 &%dkim_verify_signers%& (see above).
39360
39361 .vitem &%$dkim_verify_status%&
39362 Within the DKIM ACL,
39363 a string describing the general status of the signature. One of
39364 .ilist
39365 &%none%&: There is no signature in the message for the current domain or
39366 identity (as reflected by &%$dkim_cur_signer%&).
39367 .next
39368 &%invalid%&: The signature could not be verified due to a processing error.
39369 More detail is available in &%$dkim_verify_reason%&.
39370 .next
39371 &%fail%&: Verification of the signature failed.  More detail is
39372 available in &%$dkim_verify_reason%&.
39373 .next
39374 &%pass%&: The signature passed verification. It is valid.
39375 .endlist
39376
39377 This variable can be overwritten using an ACL 'set' modifier.
39378 This might, for instance, be done to enforce a policy restriction on
39379 hash-method or key-size:
39380 .code
39381   warn condition       = ${if eq {$dkim_verify_status}{pass}}
39382        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
39383        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
39384                                   {< {$dkim_key_length}{1024}}}}
39385        logwrite        = NOTE: forcing DKIM verify fail (was pass)
39386        set dkim_verify_status = fail
39387        set dkim_verify_reason = hash too weak or key too short
39388 .endd
39389
39390 So long as a DKIM ACL is defined (it need do no more than accept),
39391 after all the DKIM ACL runs have completed, the value becomes a
39392 colon-separated list of the values after each run.
39393 This is maintained for the mime, prdr and data ACLs.
39394
39395 .vitem &%$dkim_verify_reason%&
39396 A string giving a little bit more detail when &%$dkim_verify_status%& is either
39397 "fail" or "invalid". One of
39398 .ilist
39399 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
39400 key for the domain could not be retrieved. This may be a temporary problem.
39401 .next
39402 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
39403 record for the domain is syntactically invalid.
39404 .next
39405 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
39406 body hash does not match the one specified in the signature header. This
39407 means that the message body was modified in transit.
39408 .next
39409 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
39410 could not be verified. This may mean that headers were modified,
39411 re-written or otherwise changed in a way which is incompatible with
39412 DKIM verification. It may of course also mean that the signature is forged.
39413 .endlist
39414
39415 This variable can be overwritten, with any value, using an ACL 'set' modifier.
39416
39417 .vitem &%$dkim_domain%&
39418 The signing domain. IMPORTANT: This variable is only populated if there is
39419 an actual signature in the message for the current domain or identity (as
39420 reflected by &%$dkim_cur_signer%&).
39421
39422 .vitem &%$dkim_identity%&
39423 The signing identity, if present. IMPORTANT: This variable is only populated
39424 if there is an actual signature in the message for the current domain or
39425 identity (as reflected by &%$dkim_cur_signer%&).
39426
39427 .vitem &%$dkim_selector%&
39428 The key record selector string.
39429
39430 .vitem &%$dkim_algo%&
39431 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
39432 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
39433 may also be 'ed25519-sha256'.
39434 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
39435 for EC keys.
39436
39437 Note that RFC 8301 says:
39438 .code
39439 rsa-sha1 MUST NOT be used for signing or verifying.
39440
39441 DKIM signatures identified as having been signed with historic
39442 algorithms (currently, rsa-sha1) have permanently failed evaluation
39443 .endd
39444
39445 To enforce this you must have a DKIM ACL which checks this variable
39446 and overwrites the &$dkim_verify_status$& variable as discussed above.
39447
39448 .vitem &%$dkim_canon_body%&
39449 The body canonicalization method. One of 'relaxed' or 'simple'.
39450
39451 .vitem &%$dkim_canon_headers%&
39452 The header canonicalization method. One of 'relaxed' or 'simple'.
39453
39454 .vitem &%$dkim_copiedheaders%&
39455 A transcript of headers and their values which are included in the signature
39456 (copied from the 'z=' tag of the signature).
39457 Note that RFC6376 requires that verification fail if the From: header is
39458 not included in the signature.  Exim does not enforce this; sites wishing
39459 strict enforcement should code the check explicitly.
39460
39461 .vitem &%$dkim_bodylength%&
39462 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
39463 limit was set by the signer, "9999999999999" is returned. This makes sure
39464 that this variable always expands to an integer value.
39465 .new
39466 &*Note:*& The presence of the signature tag specifying a signing body length
39467 is one possible route to spoofing of valid DKIM signatures.
39468 A paranoid implementation might wish to regard signature where this variable
39469 shows less than the "no limit" return as being invalid.
39470 .wen
39471
39472 .vitem &%$dkim_created%&
39473 UNIX timestamp reflecting the date and time when the signature was created.
39474 When this was not specified by the signer, "0" is returned.
39475
39476 .vitem &%$dkim_expires%&
39477 UNIX timestamp reflecting the date and time when the signer wants the
39478 signature to be treated as "expired". When this was not specified by the
39479 signer, "9999999999999" is returned. This makes it possible to do useful
39480 integer size comparisons against this value.
39481 Note that Exim does not check this value.
39482
39483 .vitem &%$dkim_headernames%&
39484 A colon-separated list of names of headers included in the signature.
39485
39486 .vitem &%$dkim_key_testing%&
39487 "1" if the key record has the "testing" flag set, "0" if not.
39488
39489 .vitem &%$dkim_key_nosubdomains%&
39490 "1" if the key record forbids subdomaining, "0" otherwise.
39491
39492 .vitem &%$dkim_key_srvtype%&
39493 Service type (tag s=) from the key record. Defaults to "*" if not specified
39494 in the key record.
39495
39496 .vitem &%$dkim_key_granularity%&
39497 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
39498 in the key record.
39499
39500 .vitem &%$dkim_key_notes%&
39501 Notes from the key record (tag n=).
39502
39503 .vitem &%$dkim_key_length%&
39504 Number of bits in the key.
39505
39506 Note that RFC 8301 says:
39507 .code
39508 Verifiers MUST NOT consider signatures using RSA keys of
39509 less than 1024 bits as valid signatures.
39510 .endd
39511
39512 To enforce this you must have a DKIM ACL which checks this variable
39513 and overwrites the &$dkim_verify_status$& variable as discussed above.
39514 As EC keys are much smaller, the check should only do this for RSA keys.
39515
39516 .endlist
39517
39518 In addition, two ACL conditions are provided:
39519
39520 .vlist
39521 .vitem &%dkim_signers%&
39522 ACL condition that checks a colon-separated list of domains or identities
39523 for a match against the domain or identity that the ACL is currently verifying
39524 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
39525 verb to a group of domains or identities. For example:
39526
39527 .code
39528 # Warn when Mail purportedly from GMail has no gmail signature
39529 warn log_message = GMail sender without gmail.com DKIM signature
39530      sender_domains = gmail.com
39531      dkim_signers = gmail.com
39532      dkim_status = none
39533 .endd
39534
39535 Note that the above does not check for a total lack of DKIM signing;
39536 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
39537
39538 .vitem &%dkim_status%&
39539 ACL condition that checks a colon-separated list of possible DKIM verification
39540 results against the actual result of verification. This is typically used
39541 to restrict an ACL verb to a list of verification outcomes, for example:
39542
39543 .code
39544 deny message = Mail from Paypal with invalid/missing signature
39545      sender_domains = paypal.com:paypal.de
39546      dkim_signers = paypal.com:paypal.de
39547      dkim_status = none:invalid:fail
39548 .endd
39549
39550 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
39551 see the documentation of the &%$dkim_verify_status%& expansion variable above
39552 for more information of what they mean.
39553 .endlist
39554
39555
39556
39557
39558 .section "SPF (Sender Policy Framework)" SECSPF
39559 .cindex SPF verification
39560
39561 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
39562 messages with its domain in the envelope from, documented by RFC 7208.
39563 For more information on SPF see &url(http://www.openspf.org).
39564 . --- 2018-09-07: still not https
39565
39566 Messages sent by a system not authorised will fail checking of such assertions.
39567 This includes retransmissions done by traditional forwarders.
39568
39569 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
39570 &_Local/Makefile_&.  The support uses the &_libspf2_& library
39571 &url(https://www.libspf2.org/).
39572 There is no Exim involvement in the transmission of messages;
39573 publishing certain DNS records is all that is required.
39574
39575 For verification, an ACL condition and an expansion lookup are provided.
39576 .cindex authentication "expansion item"
39577 Performing verification sets up information used by the
39578 &$authresults$& expansion item.
39579
39580
39581 .cindex SPF "ACL condition"
39582 .cindex ACL "spf condition"
39583 The ACL condition "spf" can be used at or after the MAIL ACL.
39584 It takes as an argument a list of strings giving the outcome of the SPF check,
39585 and will succeed for any matching outcome.
39586 Valid strings are:
39587 .vlist
39588 .vitem &%pass%&
39589 The SPF check passed, the sending host is positively verified by SPF.
39590
39591 .vitem &%fail%&
39592 The SPF check failed, the sending host is NOT allowed to send mail for the
39593 domain in the envelope-from address.
39594
39595 .vitem &%softfail%&
39596 The SPF check failed, but the queried domain can't absolutely confirm that this
39597 is a forgery.
39598
39599 .vitem &%none%&
39600 The queried domain does not publish SPF records.
39601
39602 .vitem &%neutral%&
39603 The SPF check returned a "neutral" state.  This means the queried domain has
39604 published a SPF record, but wants to allow outside servers to send mail under
39605 its domain as well.  This should be treated like "none".
39606
39607 .vitem &%permerror%&
39608 This indicates a syntax error in the SPF record of the queried domain.
39609 You may deny messages when this occurs.
39610
39611 .vitem &%temperror%&
39612 This indicates a temporary error during all processing, including Exim's
39613 SPF processing.  You may defer messages when this occurs.
39614 .endlist
39615
39616 You can prefix each string with an exclamation mark to  invert
39617 its meaning,  for example  "!fail" will  match all  results but
39618 "fail".  The  string  list is  evaluated  left-to-right,  in a
39619 short-circuit fashion.
39620
39621 Example:
39622 .code
39623 deny spf = fail
39624      message = $sender_host_address is not allowed to send mail from \
39625                ${if def:sender_address_domain \
39626                     {$sender_address_domain}{$sender_helo_name}}.  \
39627                Please see http://www.openspf.org/Why?scope=\
39628                ${if def:sender_address_domain {mfrom}{helo}};\
39629                identity=${if def:sender_address_domain \
39630                              {$sender_address}{$sender_helo_name}};\
39631                ip=$sender_host_address
39632 .endd
39633
39634 When the spf condition has run, it sets up several expansion
39635 variables:
39636
39637 .cindex SPF "verification variables"
39638 .vlist
39639 .vitem &$spf_header_comment$&
39640 .vindex &$spf_header_comment$&
39641   This contains a human-readable string describing the outcome
39642   of the SPF check. You can add it to a custom header or use
39643   it for logging purposes.
39644
39645 .vitem &$spf_received$&
39646 .vindex &$spf_received$&
39647   This contains a complete Received-SPF: header that can be
39648   added to the message. Please note that according to the SPF
39649   draft, this header must be added at the top of the header
39650   list. Please see section 10 on how you can do this.
39651
39652   Note: in case of "Best-guess" (see below), the convention is
39653   to put this string in a header called X-SPF-Guess: instead.
39654
39655 .vitem &$spf_result$&
39656 .vindex &$spf_result$&
39657   This contains the outcome of the SPF check in string form,
39658   one of pass, fail, softfail, none, neutral, permerror or
39659   temperror.
39660
39661 .vitem &$spf_result_guessed$&
39662 .vindex &$spf_result_guessed$&
39663   This boolean is true only if a best-guess operation was used
39664   and required in order to obtain a result.
39665
39666 .vitem &$spf_smtp_comment$&
39667 .vindex &$spf_smtp_comment$&
39668   This contains a string that can be used in a SMTP response
39669   to the calling party. Useful for "fail".
39670 .endlist
39671
39672
39673 .cindex SPF "ACL condition"
39674 .cindex ACL "spf_guess condition"
39675 .cindex SPF "best guess"
39676 In addition to SPF, you can also perform checks for so-called
39677 "Best-guess".  Strictly speaking, "Best-guess" is not standard
39678 SPF, but it is supported by the same framework that enables SPF
39679 capability.
39680 Refer to &url(http://www.openspf.org/FAQ/Best_guess_record)
39681 for a description of what it means.
39682 . --- 2018-09-07: still not https:
39683
39684 To access this feature, simply use the spf_guess condition in place
39685 of the spf one.  For example:
39686
39687 .code
39688 deny spf_guess = fail
39689      message = $sender_host_address doesn't look trustworthy to me
39690 .endd
39691
39692 In case you decide to reject messages based on this check, you
39693 should note that although it uses the same framework, "Best-guess"
39694 is not SPF, and therefore you should not mention SPF at all in your
39695 reject message.
39696
39697 When the spf_guess condition has run, it sets up the same expansion
39698 variables as when spf condition is run, described above.
39699
39700 Additionally, since Best-guess is not standardized, you may redefine
39701 what "Best-guess" means to you by redefining the main configuration
39702 &%spf_guess%& option.
39703 For example, the following:
39704
39705 .code
39706 spf_guess = v=spf1 a/16 mx/16 ptr ?all
39707 .endd
39708
39709 would relax host matching rules to a broader network range.
39710
39711
39712 .cindex SPF "lookup expansion"
39713 .cindex lookup spf
39714 A lookup expansion is also available. It takes an email
39715 address as the key and an IP address as the database:
39716
39717 .code
39718   ${lookup {username@domain} spf {ip.ip.ip.ip}}
39719 .endd
39720
39721 The lookup will return the same result strings as can appear in
39722 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
39723 Currently, only IPv4 addresses are supported.
39724
39725
39726
39727
39728 . ////////////////////////////////////////////////////////////////////////////
39729 . ////////////////////////////////////////////////////////////////////////////
39730
39731 .chapter "Proxies" "CHAPproxies" &&&
39732          "Proxy support"
39733 .cindex "proxy support"
39734 .cindex "proxy" "access via"
39735
39736 A proxy is an intermediate system through which communication is passed.
39737 Proxies may provide a security, availability or load-distribution function.
39738
39739
39740 .section "Inbound proxies" SECTproxyInbound
39741 .cindex proxy inbound
39742 .cindex proxy "server side"
39743 .cindex proxy "Proxy protocol"
39744 .cindex "Proxy protocol" proxy
39745
39746 Exim has support for receiving inbound SMTP connections via a proxy
39747 that uses &"Proxy Protocol"& to speak to it.
39748 To include this support, include &"SUPPORT_PROXY=yes"&
39749 in Local/Makefile.
39750
39751 It was built on the HAProxy specification, found at
39752 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
39753
39754 The purpose of this facility is so that an application load balancer,
39755 such as HAProxy, can sit in front of several Exim servers
39756 to distribute load.
39757 Exim uses the local protocol communication with the proxy to obtain
39758 the remote SMTP system IP address and port information.
39759 There is no logging if a host passes or
39760 fails Proxy Protocol negotiation, but it can easily be determined and
39761 recorded in an ACL (example is below).
39762
39763 Use of a proxy is enabled by setting the &%hosts_proxy%&
39764 main configuration option to a hostlist; connections from these
39765 hosts will use Proxy Protocol.
39766 Exim supports both version 1 and version 2 of the Proxy Protocol and
39767 automatically determines which version is in use.
39768
39769 The Proxy Protocol header is the first data received on a TCP connection
39770 and is inserted before any TLS-on-connect handshake from the client; Exim
39771 negotiates TLS between Exim-as-server and the remote client, not between
39772 Exim and the proxy server.
39773
39774 The following expansion variables are usable
39775 (&"internal"& and &"external"& here refer to the interfaces
39776 of the proxy):
39777 .display
39778 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
39779 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
39780 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
39781 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
39782 &'proxy_session            '& boolean: SMTP connection via proxy
39783 .endd
39784 If &$proxy_session$& is set but &$proxy_external_address$& is empty
39785 there was a protocol error.
39786
39787 Since the real connections are all coming from the proxy, and the
39788 per host connection tracking is done before Proxy Protocol is
39789 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
39790 handle all of the parallel volume you expect per inbound proxy.
39791 With the option set so high, you lose the ability
39792 to protect your server from many connections from one IP.
39793 In order to prevent your server from overload, you
39794 need to add a per connection ratelimit to your connect ACL.
39795 A possible solution is:
39796 .display
39797   # Set max number of connections per host
39798   LIMIT   = 5
39799   # Or do some kind of IP lookup in a flat file or database
39800   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
39801
39802   defer   message        = Too many connections from this IP right now
39803           ratelimit      = LIMIT / 5s / per_conn / strict
39804 .endd
39805
39806
39807
39808 .section "Outbound proxies" SECTproxySOCKS
39809 .cindex proxy outbound
39810 .cindex proxy "client side"
39811 .cindex proxy SOCKS
39812 .cindex SOCKS proxy
39813 Exim has support for sending outbound SMTP via a proxy
39814 using a protocol called SOCKS5 (defined by RFC1928).
39815 The support can be optionally included by defining SUPPORT_SOCKS=yes in
39816 Local/Makefile.
39817
39818 Use of a proxy is enabled by setting the &%socks_proxy%& option
39819 on an smtp transport.
39820 The option value is expanded and should then be a list
39821 (colon-separated by default) of proxy specifiers.
39822 Each proxy specifier is a list
39823 (space-separated by default) where the initial element
39824 is an IP address and any subsequent elements are options.
39825
39826 Options are a string <name>=<value>.
39827 The list of options is in the following table:
39828 .display
39829 &'auth   '& authentication method
39830 &'name   '& authentication username
39831 &'pass   '& authentication password
39832 &'port   '& tcp port
39833 &'tmo    '& connection timeout
39834 &'pri    '& priority
39835 &'weight '& selection bias
39836 .endd
39837
39838 More details on each of these options follows:
39839
39840 .ilist
39841 .cindex authentication "to proxy"
39842 .cindex proxy authentication
39843 &%auth%&: Either &"none"& (default) or &"name"&.
39844 Using &"name"& selects username/password authentication per RFC 1929
39845 for access to the proxy.
39846 Default is &"none"&.
39847 .next
39848 &%name%&: sets the username for the &"name"& authentication method.
39849 Default is empty.
39850 .next
39851 &%pass%&: sets the password for the &"name"& authentication method.
39852 Default is empty.
39853 .next
39854 &%port%&: the TCP port number to use for the connection to the proxy.
39855 Default is 1080.
39856 .next
39857 &%tmo%&: sets a connection timeout in seconds for this proxy.
39858 Default is 5.
39859 .next
39860 &%pri%&: specifies a priority for the proxy within the list,
39861 higher values being tried first.
39862 The default priority is 1.
39863 .next
39864 &%weight%&: specifies a selection bias.
39865 Within a priority set servers are queried in a random fashion,
39866 weighted by this value.
39867 The default value for selection bias is 1.
39868 .endlist
39869
39870 Proxies from the list are tried according to their priority
39871 and weight settings until one responds.  The timeout for the
39872 overall connection applies to the set of proxied attempts.
39873
39874 .section Logging SECTproxyLog
39875 To log the (local) IP of a proxy in the incoming or delivery logline,
39876 add &"+proxy"& to the &%log_selector%& option.
39877 This will add a component tagged with &"PRX="& to the line.
39878
39879 . ////////////////////////////////////////////////////////////////////////////
39880 . ////////////////////////////////////////////////////////////////////////////
39881
39882 .chapter "Internationalisation" "CHAPi18n" &&&
39883          "Internationalisation""
39884 .cindex internationalisation "email address"
39885 .cindex EAI
39886 .cindex i18n
39887 .cindex utf8 "mail name handling"
39888
39889 Exim has support for Internationalised mail names.
39890 To include this it must be built with SUPPORT_I18N and the libidn library.
39891 Standards supported are RFCs 2060, 5890, 6530 and 6533.
39892
39893 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
39894 instead of it) then IDNA2008 is supported; this adds an extra library
39895 requirement, upon libidn2.
39896
39897 .section "MTA operations" SECTi18nMTA
39898 .cindex SMTPUTF8 "ESMTP option"
39899 The main configuration option &%smtputf8_advertise_hosts%& specifies
39900 a host list.  If this matches the sending host and
39901 accept_8bitmime is true (the default) then the ESMTP option
39902 SMTPUTF8 will be advertised.
39903
39904 If the sender specifies the SMTPUTF8 option on a MAIL command
39905 international handling for the message is enabled and
39906 the expansion variable &$message_smtputf8$& will have value TRUE.
39907
39908 The option &%allow_utf8_domains%& is set to true for this
39909 message. All DNS lookups are converted to a-label form
39910 whatever the setting of &%allow_utf8_domains%&
39911 when Exim is built with SUPPORT_I18N.
39912
39913 Both localparts and domain are maintained as the original
39914 UTF-8 form internally; any comparison or regular-expression use will
39915 require appropriate care.  Filenames created, eg. by
39916 the appendfile transport, will have UTF-8 names.
39917
39918 HELO names sent by the smtp transport will have any UTF-8
39919 components expanded to a-label form,
39920 and any certificate name checks will be done using the a-label
39921 form of the name.
39922
39923 .cindex log protocol
39924 .cindex SMTPUTF8 logging
39925 .cindex i18n logging
39926 Log lines and Received-by: header lines will acquire a "utf8"
39927 prefix on the protocol element, eg. utf8esmtp.
39928
39929 The following expansion operators can be used:
39930 .code
39931 ${utf8_domain_to_alabel:str}
39932 ${utf8_domain_from_alabel:str}
39933 ${utf8_localpart_to_alabel:str}
39934 ${utf8_localpart_from_alabel:str}
39935 .endd
39936
39937 .cindex utf8 "address downconversion"
39938 .cindex i18n "utf8 address downconversion"
39939 The RCPT ACL
39940 may use the following modifier:
39941 .display
39942 control = utf8_downconvert
39943 control = utf8_downconvert/<value>
39944 .endd
39945 This sets a flag requiring that addresses are converted to
39946 a-label form before smtp delivery, for use in a
39947 Message Submission Agent context.
39948 If a value is appended it may be:
39949 .display
39950 &`1  `& (default) mandatory downconversion
39951 &`0  `& no downconversion
39952 &`-1 `& if SMTPUTF8 not supported by destination host
39953 .endd
39954
39955 If mua_wrapper is set, the utf8_downconvert control
39956 is initially set to -1.
39957
39958 .new
39959 The smtp transport has an option &%utf8_downconvert%&.
39960 If set it must expand to one of the three values described above,
39961 and it overrides any previously set value.
39962 .wen
39963
39964
39965 There is no explicit support for VRFY and EXPN.
39966 Configurations supporting these should inspect
39967 &$smtp_command_argument$& for an SMTPUTF8 argument.
39968
39969 There is no support for LMTP on Unix sockets.
39970 Using the "lmtp" protocol option on an smtp transport,
39971 for LMTP over TCP, should work as expected.
39972
39973 There is no support for DSN unitext handling,
39974 and no provision for converting logging from or to UTF-8.
39975
39976
39977
39978 .section "MDA operations" SECTi18nMDA
39979 To aid in constructing names suitable for IMAP folders
39980 the following expansion operator can be used:
39981 .code
39982 ${imapfolder {<string>} {<sep>} {<specials>}}
39983 .endd
39984
39985 The string is converted from the charset specified by
39986 the "headers charset" command (in a filter file)
39987 or &%headers_charset%& main configuration option (otherwise),
39988 to the
39989 modified UTF-7 encoding specified by RFC 2060,
39990 with the following exception: All occurrences of <sep>
39991 (which has to be a single character)
39992 are replaced with periods ("."), and all periods and slashes that are not
39993 <sep> and are not in the <specials> string are BASE64 encoded.
39994
39995 The third argument can be omitted, defaulting to an empty string.
39996 The second argument can be omitted, defaulting to "/".
39997
39998 This is the encoding used by Courier for Maildir names on disk, and followed
39999 by many other IMAP servers.
40000
40001 Examples:
40002 .display
40003 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
40004 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
40005 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
40006 .endd
40007
40008 Note that the source charset setting is vital, and also that characters
40009 must be representable in UTF-16.
40010
40011
40012 . ////////////////////////////////////////////////////////////////////////////
40013 . ////////////////////////////////////////////////////////////////////////////
40014
40015 .chapter "Events" "CHAPevents" &&&
40016          "Events"
40017 .cindex events
40018
40019 The events mechanism in Exim can be used to intercept processing at a number
40020 of points.  It was originally invented to give a way to do customised logging
40021 actions (for example, to a database) but can also be used to modify some
40022 processing actions.
40023
40024 Most installations will never need to use Events.
40025 The support can be left out of a build by defining DISABLE_EVENT=yes
40026 in &_Local/Makefile_&.
40027
40028 There are two major classes of events: main and transport.
40029 The main configuration option &%event_action%& controls reception events;
40030 a transport option &%event_action%& controls delivery events.
40031
40032 Both options are a string which is expanded when the event fires.
40033 An example might look like:
40034 .cindex logging custom
40035 .code
40036 event_action = ${if eq {msg:delivery}{$event_name} \
40037 {${lookup pgsql {SELECT * FROM record_Delivery( \
40038     '${quote_pgsql:$sender_address_domain}',\
40039     '${quote_pgsql:${lc:$sender_address_local_part}}', \
40040     '${quote_pgsql:$domain}', \
40041     '${quote_pgsql:${lc:$local_part}}', \
40042     '${quote_pgsql:$host_address}', \
40043     '${quote_pgsql:${lc:$host}}', \
40044     '${quote_pgsql:$message_exim_id}')}} \
40045 } {}}
40046 .endd
40047
40048 Events have names which correspond to the point in process at which they fire.
40049 The name is placed in the variable &$event_name$& and the event action
40050 expansion must check this, as it will be called for every possible event type.
40051
40052 The current list of events is:
40053 .display
40054 &`dane:fail              after    transport  `& per connection
40055 &`msg:complete           after    main       `& per message
40056 &`msg:delivery           after    transport  `& per recipient
40057 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
40058 &`msg:rcpt:defer         after    transport  `& per recipient
40059 &`msg:host:defer         after    transport  `& per attempt
40060 &`msg:fail:delivery      after    transport  `& per recipient
40061 &`msg:fail:internal      after    main       `& per recipient
40062 &`tcp:connect            before   transport  `& per connection
40063 &`tcp:close              after    transport  `& per connection
40064 &`tls:cert               before   both       `& per certificate in verification chain
40065 &`smtp:connect           after    transport  `& per connection
40066 .endd
40067 New event types may be added in future.
40068
40069 The event name is a colon-separated list, defining the type of
40070 event in a tree of possibilities.  It may be used as a list
40071 or just matched on as a whole.  There will be no spaces in the name.
40072
40073 The second column in the table above describes whether the event fires
40074 before or after the action is associates with.  Those which fire before
40075 can be used to affect that action (more on this below).
40076
40077 The third column in the table above says what section of the configuration
40078 should define the event action.
40079
40080 An additional variable, &$event_data$&, is filled with information varying
40081 with the event type:
40082 .display
40083 &`dane:fail            `& failure reason
40084 &`msg:delivery         `& smtp confirmation message
40085 &`msg:rcpt:host:defer  `& error string
40086 &`msg:rcpt:defer       `& error string
40087 &`msg:host:defer       `& error string
40088 &`tls:cert             `& verification chain depth
40089 &`smtp:connect         `& smtp banner
40090 .endd
40091
40092 The :defer events populate one extra variable: &$event_defer_errno$&.
40093
40094 For complex operations an ACL expansion can be used in &%event_action%&
40095 however due to the multiple contexts that Exim operates in during
40096 the course of its processing:
40097 .ilist
40098 variables set in transport events will not be visible outside that
40099 transport call
40100 .next
40101 acl_m variables in a server context are lost on a new connection,
40102 and after smtp helo/ehlo/mail/starttls/rset commands
40103 .endlist
40104 Using an ACL expansion with the logwrite modifier can be
40105 a useful way of writing to the main log.
40106
40107 The expansion of the event_action option should normally
40108 return an empty string.  Should it return anything else the
40109 following will be forced:
40110 .display
40111 &`tcp:connect      `&  do not connect
40112 &`tls:cert         `&  refuse verification
40113 &`smtp:connect     `&  close connection
40114 .endd
40115 All other message types ignore the result string, and
40116 no other use is made of it.
40117
40118 For a tcp:connect event, if the connection is being made to a proxy
40119 then the address and port variables will be that of the proxy and not
40120 the target system.
40121
40122 For tls:cert events, if GnuTLS is in use this will trigger only per
40123 chain element received on the connection.
40124 For OpenSSL it will trigger for every chain element including those
40125 loaded locally.
40126
40127 . ////////////////////////////////////////////////////////////////////////////
40128 . ////////////////////////////////////////////////////////////////////////////
40129
40130 .chapter "Adding new drivers or lookup types" "CHID13" &&&
40131          "Adding drivers or lookups"
40132 .cindex "adding drivers"
40133 .cindex "new drivers, adding"
40134 .cindex "drivers" "adding new"
40135 The following actions have to be taken in order to add a new router, transport,
40136 authenticator, or lookup type to Exim:
40137
40138 .olist
40139 Choose a name for the driver or lookup type that does not conflict with any
40140 existing name; I will use &"newdriver"& in what follows.
40141 .next
40142 Add to &_src/EDITME_& the line:
40143 .display
40144 <&'type'&>&`_NEWDRIVER=yes`&
40145 .endd
40146 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
40147 code is not to be included in the binary by default, comment this line out. You
40148 should also add any relevant comments about the driver or lookup type.
40149 .next
40150 Add to &_src/config.h.defaults_& the line:
40151 .code
40152 #define <type>_NEWDRIVER
40153 .endd
40154 .next
40155 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
40156 and create a table entry as is done for all the other drivers and lookup types.
40157 .next
40158 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
40159 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
40160 Add your &`NEWDRIVER`& to that list.
40161 As long as the dynamic module would be named &_newdriver.so_&, you can use the
40162 simple form that most lookups have.
40163 .next
40164 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
40165 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
40166 driver or lookup type and add it to the definition of OBJ.
40167 .next
40168 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
40169 &_src_&.
40170 .next
40171 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
40172 as for other drivers and lookups.
40173 .endlist
40174
40175 Then all you need to do is write the code! A good way to start is to make a
40176 proforma by copying an existing module of the same type, globally changing all
40177 occurrences of the name, and cutting out most of the code. Note that any
40178 options you create must be listed in alphabetical order, because the tables are
40179 searched using a binary chop procedure.
40180
40181 There is a &_README_& file in each of the sub-directories of &_src_& describing
40182 the interface that is expected.
40183
40184
40185
40186
40187 . ////////////////////////////////////////////////////////////////////////////
40188 . ////////////////////////////////////////////////////////////////////////////
40189
40190 . /////////////////////////////////////////////////////////////////////////////
40191 . These lines are processing instructions for the Simple DocBook Processor that
40192 . Philip Hazel has developed as a less cumbersome way of making PostScript and
40193 . PDFs than using xmlto and fop. They will be ignored by all other XML
40194 . processors.
40195 . /////////////////////////////////////////////////////////////////////////////
40196
40197 .literal xml
40198 <?sdop
40199   format="newpage"
40200   foot_right_recto="&chaptertitle;"
40201   foot_right_verso="&chaptertitle;"
40202 ?>
40203 .literal off
40204
40205 .makeindex "Options index"   "option"
40206 .makeindex "Variables index" "variable"
40207 .makeindex "Concept index"   "concept"
40208
40209
40210 . /////////////////////////////////////////////////////////////////////////////
40211 . /////////////////////////////////////////////////////////////////////////////