bb2ce122c9af82d65c0b5ac4025c0c57c0a87e07
[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 printable and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generates the outermost <book> element that wraps the entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.93"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2019
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name.
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be in Roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- a small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for ASCII
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply, or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of Exim,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of this document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, this manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(https://www.uit.co.uk/exim-book/)).
396
397 The book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As Exim develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to Exim (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .row &_openssl.txt_&         "installing a current OpenSSL release"
440 .endtable
441
442 The main specification and the specification of the filtering language are also
443 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
444 &<<SECTavail>>& below tells you how to get hold of these.
445
446
447
448 .section "FTP site and websites" "SECID2"
449 .cindex "website"
450 .cindex "FTP site"
451 The primary site for Exim source distributions is the &%exim.org%& FTP site,
452 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
453 website, are hosted at the University of Cambridge.
454
455 .cindex "wiki"
456 .cindex "FAQ"
457 As well as Exim distribution tar files, the Exim website contains a number of
458 differently formatted versions of the documentation. A recent addition to the
459 online information is the Exim wiki (&url(https://wiki.exim.org)),
460 which contains what used to be a separate FAQ, as well as various other
461 examples, tips, and know-how that have been contributed by Exim users.
462 The wiki site should always redirect to the correct place, which is currently
463 provided by GitHub, and is open to editing by anyone with a GitHub account.
464
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469 Please do not ask for configuration help in the bug-tracker.
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on that list and not on the general Exim
493 lists.
494
495 .section "Bug reports" "SECID5"
496 .cindex "bug reports"
497 .cindex "reporting bugs"
498 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
499 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
500 whether some behaviour is a bug or not, the best thing to do is to post a
501 message to the &'exim-dev'& mailing list and have it discussed.
502
503
504
505 .section "Where to find the Exim distribution" "SECTavail"
506 .cindex "FTP site"
507 .cindex "HTTPS download site"
508 .cindex "distribution" "FTP site"
509 .cindex "distribution" "https site"
510 The master distribution site for the Exim distribution is
511 .display
512 &url(https://downloads.exim.org/)
513 .endd
514 The service is available over HTTPS, HTTP and FTP.
515 We encourage people to migrate to HTTPS.
516
517 The content served at &url(https://downloads.exim.org/) is identical to the
518 content served at &url(https://ftp.exim.org/pub/exim) and
519 &url(ftp://ftp.exim.org/pub/exim).
520
521 If accessing via a hostname containing &'ftp'&, then the file references that
522 follow are relative to the &_exim_& directories at these sites.
523 If accessing via the hostname &'downloads'& then the subdirectories described
524 here are top-level directories.
525
526 There are now quite a number of independent mirror sites around
527 the world. Those that I know about are listed in the file called &_Mirrors_&.
528
529 Within the top exim directory there are subdirectories called &_exim3_& (for
530 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
531 distributions), and &_Testing_& for testing versions. In the &_exim4_&
532 subdirectory, the current release can always be found in files called
533 .display
534 &_exim-n.nn.tar.xz_&
535 &_exim-n.nn.tar.gz_&
536 &_exim-n.nn.tar.bz2_&
537 .endd
538 where &'n.nn'& is the highest such version number in the directory. The three
539 files contain identical data; the only difference is the type of compression.
540 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
541 most portable to old systems.
542
543 .cindex "distribution" "signing details"
544 .cindex "distribution" "public key"
545 .cindex "public key for signed distribution"
546 The distributions will be PGP signed by an individual key of the Release
547 Coordinator.  This key will have a uid containing an email address in the
548 &'exim.org'& domain and will have signatures from other people, including
549 other Exim maintainers.  We expect that the key will be in the "strong set" of
550 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
551 PGP keys, a version of which can be found in the release directory in the file
552 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
553 such as &'pool.sks-keyservers.net'&.
554
555 At the time of the last update, releases were being made by Jeremy Harris and signed
556 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
557 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
558 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.xz.asc_&
563 &_exim-n.nn.tar.gz.asc_&
564 &_exim-n.nn.tar.bz2.asc_&
565 .endd
566 For each released version, the log of changes is made available in a
567 separate file in the directory &_ChangeLogs_& so that it is possible to
568 find out what has changed without having to download the entire distribution.
569
570 .cindex "documentation" "available formats"
571 The main distribution contains ASCII versions of this specification and other
572 documentation; other formats of the documents are available in separate files
573 inside the &_exim4_& directory of the FTP site:
574 .display
575 &_exim-html-n.nn.tar.gz_&
576 &_exim-pdf-n.nn.tar.gz_&
577 &_exim-postscript-n.nn.tar.gz_&
578 &_exim-texinfo-n.nn.tar.gz_&
579 .endd
580 These tar files contain only the &_doc_& directory, not the complete
581 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
582
583
584 .section "Limitations" "SECID6"
585 .ilist
586 .cindex "limitations of Exim"
587 .cindex "bang paths" "not handled by Exim"
588 Exim is designed for use as an Internet MTA, and therefore handles addresses in
589 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
590 simple two-component bang paths can be converted by a straightforward rewriting
591 configuration. This restriction does not prevent Exim from being interfaced to
592 UUCP as a transport mechanism, provided that domain addresses are used.
593 .next
594 .cindex "domainless addresses"
595 .cindex "address" "without domain"
596 Exim insists that every address it handles has a domain attached. For incoming
597 local messages, domainless addresses are automatically qualified with a
598 configured domain value. Configuration options specify from which remote
599 systems unqualified addresses are acceptable. These are then qualified on
600 arrival.
601 .next
602 .cindex "transport" "external"
603 .cindex "external transports"
604 The only external transport mechanisms that are currently implemented are SMTP
605 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
606 transport is available, and there are facilities for writing messages to files
607 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
608 to send messages to other transport mechanisms such as UUCP, provided they can
609 handle domain-style addresses. Batched SMTP input is also catered for.
610 .next
611 Exim is not designed for storing mail for dial-in hosts. When the volumes of
612 such mail are large, it is better to get the messages &"delivered"& into files
613 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
614 other means.
615 .next
616 Although Exim does have basic facilities for scanning incoming messages, these
617 are not comprehensive enough to do full virus or spam scanning. Such operations
618 are best carried out using additional specialized software packages. If you
619 compile Exim with the content-scanning extension, straightforward interfaces to
620 a number of common scanners are provided.
621 .endlist
622
623
624 .section "Runtime configuration" "SECID7"
625 Exim's runtime configuration is held in a single text file that is divided
626 into a number of sections. The entries in this file consist of keywords and
627 values, in the style of Smail 3 configuration files. A default configuration
628 file which is suitable for simple online installations is provided in the
629 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
630
631
632 .section "Calling interface" "SECID8"
633 .cindex "Sendmail compatibility" "command line interface"
634 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
635 can be a straight replacement for &_/usr/lib/sendmail_& or
636 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
637 about Sendmail in order to run Exim. For actions other than sending messages,
638 Sendmail-compatible options also exist, but those that produce output (for
639 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
640 format. There are also some additional options that are compatible with Smail
641 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
642 documents all Exim's command line options. This information is automatically
643 made into the man page that forms part of the Exim distribution.
644
645 Control of messages in the queue can be done via certain privileged command
646 line options. There is also an optional monitor program called &'eximon'&,
647 which displays current information in an X window, and which contains a menu
648 interface to Exim's command line administration options.
649
650
651
652 .section "Terminology" "SECID9"
653 .cindex "terminology definitions"
654 .cindex "body of message" "definition of"
655 The &'body'& of a message is the actual data that the sender wants to transmit.
656 It is the last part of a message and is separated from the &'header'& (see
657 below) by a blank line.
658
659 .cindex "bounce message" "definition of"
660 When a message cannot be delivered, it is normally returned to the sender in a
661 delivery failure message or a &"non-delivery report"& (NDR). The term
662 &'bounce'& is commonly used for this action, and the error reports are often
663 called &'bounce messages'&. This is a convenient shorthand for &"delivery
664 failure error report"&. Such messages have an empty sender address in the
665 message's &'envelope'& (see below) to ensure that they cannot themselves give
666 rise to further bounce messages.
667
668 The term &'default'& appears frequently in this manual. It is used to qualify a
669 value which is used in the absence of any setting in the configuration. It may
670 also qualify an action which is taken unless a configuration setting specifies
671 otherwise.
672
673 The term &'defer'& is used when the delivery of a message to a specific
674 destination cannot immediately take place for some reason (a remote host may be
675 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
676 until a later time.
677
678 The word &'domain'& is sometimes used to mean all but the first component of a
679 host's name. It is &'not'& used in that sense here, where it normally refers to
680 the part of an email address following the @ sign.
681
682 .cindex "envelope, definition of"
683 .cindex "sender" "definition of"
684 A message in transit has an associated &'envelope'&, as well as a header and a
685 body. The envelope contains a sender address (to which bounce messages should
686 be delivered), and any number of recipient addresses. References to the
687 sender or the recipients of a message usually mean the addresses in the
688 envelope. An MTA uses these addresses for delivery, and for returning bounce
689 messages, not the addresses that appear in the header lines.
690
691 .cindex "message" "header, definition of"
692 .cindex "header section" "definition of"
693 The &'header'& of a message is the first part of a message's text, consisting
694 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
695 &'Subject:'&, etc. Long header lines can be split over several text lines by
696 indenting the continuations. The header is separated from the body by a blank
697 line.
698
699 .cindex "local part" "definition of"
700 .cindex "domain" "definition of"
701 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
702 part of an email address that precedes the @ sign. The part that follows the
703 @ sign is called the &'domain'& or &'mail domain'&.
704
705 .cindex "local delivery" "definition of"
706 .cindex "remote delivery, definition of"
707 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
708 delivery to a file or a pipe on the local host from delivery by SMTP over
709 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
710 host it is running on are &'remote'&.
711
712 .cindex "return path" "definition of"
713 &'Return path'& is another name that is used for the sender address in a
714 message's envelope.
715
716 .cindex "queue" "definition of"
717 The term &'queue'& is used to refer to the set of messages awaiting delivery
718 because this term is in widespread use in the context of MTAs. However, in
719 Exim's case, the reality is more like a pool than a queue, because there is
720 normally no ordering of waiting messages.
721
722 .cindex "queue runner" "definition of"
723 The term &'queue runner'& is used to describe a process that scans the queue
724 and attempts to deliver those messages whose retry times have come. This term
725 is used by other MTAs and also relates to the command &%runq%&, but in Exim
726 the waiting messages are normally processed in an unpredictable order.
727
728 .cindex "spool directory" "definition of"
729 The term &'spool directory'& is used for a directory in which Exim keeps the
730 messages in its queue &-- that is, those that it is in the process of
731 delivering. This should not be confused with the directory in which local
732 mailboxes are stored, which is called a &"spool directory"& by some people. In
733 the Exim documentation, &"spool"& is always used in the first sense.
734
735
736
737
738
739
740 . ////////////////////////////////////////////////////////////////////////////
741 . ////////////////////////////////////////////////////////////////////////////
742
743 .chapter "Incorporated code" "CHID2"
744 .cindex "incorporated code"
745 .cindex "regular expressions" "library"
746 .cindex "PCRE"
747 .cindex "OpenDMARC"
748 A number of pieces of external code are included in the Exim distribution.
749
750 .ilist
751 Regular expressions are supported in the main Exim program and in the
752 Exim monitor using the freely-distributable PCRE library, copyright
753 &copy; University of Cambridge. The source to PCRE is no longer shipped with
754 Exim, so you will need to use the version of PCRE shipped with your system,
755 or obtain and install the full version of the library from
756 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
757 .next
758 .cindex "cdb" "acknowledgment"
759 Support for the cdb (Constant DataBase) lookup method is provided by code
760 contributed by Nigel Metheringham of (at the time he contributed it) Planet
761 Online Ltd. The implementation is completely contained within the code of Exim.
762 It does not link against an external cdb library. The code contains the
763 following statements:
764
765 .blockquote
766 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
767
768 This program is free software; you can redistribute it and/or modify it under
769 the terms of the GNU General Public License as published by the Free Software
770 Foundation; either version 2 of the License, or (at your option) any later
771 version.
772 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
773 the spec and sample code for cdb can be obtained from
774 &url(https://cr.yp.to/cdb.html). This implementation borrows
775 some code from Dan Bernstein's implementation (which has no license
776 restrictions applied to it).
777 .endblockquote
778 .next
779 .cindex "SPA authentication"
780 .cindex "Samba project"
781 .cindex "Microsoft Secure Password Authentication"
782 Client support for Microsoft's &'Secure Password Authentication'& is provided
783 by code contributed by Marc Prud'hommeaux. Server support was contributed by
784 Tom Kistner. This includes code taken from the Samba project, which is released
785 under the Gnu GPL.
786 .next
787 .cindex "Cyrus"
788 .cindex "&'pwcheck'& daemon"
789 .cindex "&'pwauthd'& daemon"
790 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
791 by code taken from the Cyrus-SASL library and adapted by Alexander S.
792 Sabourenkov. The permission notice appears below, in accordance with the
793 conditions expressed therein.
794
795 .blockquote
796 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
797
798 Redistribution and use in source and binary forms, with or without
799 modification, are permitted provided that the following conditions
800 are met:
801
802 .olist
803 Redistributions of source code must retain the above copyright
804 notice, this list of conditions and the following disclaimer.
805 .next
806 Redistributions in binary form must reproduce the above copyright
807 notice, this list of conditions and the following disclaimer in
808 the documentation and/or other materials provided with the
809 distribution.
810 .next
811 The name &"Carnegie Mellon University"& must not be used to
812 endorse or promote products derived from this software without
813 prior written permission. For permission or any other legal
814 details, please contact
815 .display
816               Office of Technology Transfer
817               Carnegie Mellon University
818               5000 Forbes Avenue
819               Pittsburgh, PA  15213-3890
820               (412) 268-4387, fax: (412) 268-7395
821               tech-transfer@andrew.cmu.edu
822 .endd
823 .next
824 Redistributions of any form whatsoever must retain the following
825 acknowledgment:
826
827 &"This product includes software developed by Computing Services
828 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
829
830 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
831 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
832 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
833 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
834 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
835 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
836 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
837 .endlist
838 .endblockquote
839
840 .next
841 .cindex "Exim monitor" "acknowledgment"
842 .cindex "X-windows"
843 .cindex "Athena"
844 The Exim Monitor program, which is an X-Window application, includes
845 modified versions of the Athena StripChart and TextPop widgets.
846 This code is copyright by DEC and MIT, and their permission notice appears
847 below, in accordance with the conditions expressed therein.
848
849 .blockquote
850 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
851 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
852
853 All Rights Reserved
854
855 Permission to use, copy, modify, and distribute this software and its
856 documentation for any purpose and without fee is hereby granted,
857 provided that the above copyright notice appear in all copies and that
858 both that copyright notice and this permission notice appear in
859 supporting documentation, and that the names of Digital or MIT not be
860 used in advertising or publicity pertaining to distribution of the
861 software without specific, written prior permission.
862
863 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
864 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
865 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
866 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
867 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
868 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
869 SOFTWARE.
870 .endblockquote
871
872 .next
873 .cindex "opendmarc" "acknowledgment"
874 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
875 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
876 derived code are indicated in the respective source files. The full OpenDMARC
877 license is provided in the LICENSE.opendmarc file contained in the distributed
878 source code.
879
880 .next
881 Many people have contributed code fragments, some large, some small, that were
882 not covered by any specific license requirements. It is assumed that the
883 contributors are happy to see their code incorporated into Exim under the GPL.
884 .endlist
885
886
887
888
889
890 . ////////////////////////////////////////////////////////////////////////////
891 . ////////////////////////////////////////////////////////////////////////////
892
893 .chapter "How Exim receives and delivers mail" "CHID11" &&&
894          "Receiving and delivering mail"
895
896
897 .section "Overall philosophy" "SECID10"
898 .cindex "design philosophy"
899 Exim is designed to work efficiently on systems that are permanently connected
900 to the Internet and are handling a general mix of mail. In such circumstances,
901 most messages can be delivered immediately. Consequently, Exim does not
902 maintain independent queues of messages for specific domains or hosts, though
903 it does try to send several messages in a single SMTP connection after a host
904 has been down, and it also maintains per-host retry information.
905
906
907 .section "Policy control" "SECID11"
908 .cindex "policy control" "overview"
909 Policy controls are now an important feature of MTAs that are connected to the
910 Internet. Perhaps their most important job is to stop MTAs from being abused as
911 &"open relays"& by misguided individuals who send out vast amounts of
912 unsolicited junk and want to disguise its source. Exim provides flexible
913 facilities for specifying policy controls on incoming mail:
914
915 .ilist
916 .cindex "&ACL;" "introduction"
917 Exim 4 (unlike previous versions of Exim) implements policy controls on
918 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
919 series of statements that may either grant or deny access. ACLs can be used at
920 several places in the SMTP dialogue while receiving a message from a remote
921 host. However, the most common places are after each RCPT command, and at the
922 very end of the message. The sysadmin can specify conditions for accepting or
923 rejecting individual recipients or the entire message, respectively, at these
924 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
925 error code.
926 .next
927 An ACL is also available for locally generated, non-SMTP messages. In this
928 case, the only available actions are to accept or deny the entire message.
929 .next
930 When Exim is compiled with the content-scanning extension, facilities are
931 provided in the ACL mechanism for passing the message to external virus and/or
932 spam scanning software. The result of such a scan is passed back to the ACL,
933 which can then use it to decide what to do with the message.
934 .next
935 When a message has been received, either from a remote host or from the local
936 host, but before the final acknowledgment has been sent, a locally supplied C
937 function called &[local_scan()]& can be run to inspect the message and decide
938 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
939 is accepted, the list of recipients can be modified by the function.
940 .next
941 Using the &[local_scan()]& mechanism is another way of calling external scanner
942 software. The &%SA-Exim%& add-on package works this way. It does not require
943 Exim to be compiled with the content-scanning extension.
944 .next
945 After a message has been accepted, a further checking mechanism is available in
946 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
947 runs at the start of every delivery process.
948 .endlist
949
950
951
952 .section "User filters" "SECID12"
953 .cindex "filter" "introduction"
954 .cindex "Sieve filter"
955 In a conventional Exim configuration, users are able to run private filters by
956 setting up appropriate &_.forward_& files in their home directories. See
957 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
958 configuration needed to support this, and the separate document entitled
959 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
960 of filtering are available:
961
962 .ilist
963 Sieve filters are written in the standard filtering language that is defined
964 by RFC 3028.
965 .next
966 Exim filters are written in a syntax that is unique to Exim, but which is more
967 powerful than Sieve, which it pre-dates.
968 .endlist
969
970 User filters are run as part of the routing process, described below.
971
972
973
974 .section "Message identification" "SECTmessiden"
975 .cindex "message ids" "details of format"
976 .cindex "format" "of message id"
977 .cindex "id of message"
978 .cindex "base62"
979 .cindex "base36"
980 .cindex "Darwin"
981 .cindex "Cygwin"
982 Every message handled by Exim is given a &'message id'& which is sixteen
983 characters long. It is divided into three parts, separated by hyphens, for
984 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
985 normally encoding numbers in base 62. However, in the Darwin operating
986 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
987 (avoiding the use of lower case letters) is used instead, because the message
988 id is used to construct filenames, and the names of files in those systems are
989 not always case-sensitive.
990
991 .cindex "pid (process id)" "re-use of"
992 The detail of the contents of the message id have changed as Exim has evolved.
993 Earlier versions relied on the operating system not re-using a process id (pid)
994 within one second. On modern operating systems, this assumption can no longer
995 be made, so the algorithm had to be changed. To retain backward compatibility,
996 the format of the message id was retained, which is why the following rules are
997 somewhat eccentric:
998
999 .ilist
1000 The first six characters of the message id are the time at which the message
1001 started to be received, to a granularity of one second. That is, this field
1002 contains the number of seconds since the start of the epoch (the normal Unix
1003 way of representing the date and time of day).
1004 .next
1005 After the first hyphen, the next six characters are the id of the process that
1006 received the message.
1007 .next
1008 There are two different possibilities for the final two characters:
1009 .olist
1010 .oindex "&%localhost_number%&"
1011 If &%localhost_number%& is not set, this value is the fractional part of the
1012 time of reception, normally in units of 1/2000 of a second, but for systems
1013 that must use base 36 instead of base 62 (because of case-insensitive file
1014 systems), the units are 1/1000 of a second.
1015 .next
1016 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1017 the fractional part of the time, which in this case is in units of 1/200
1018 (1/100) of a second.
1019 .endlist
1020 .endlist
1021
1022 After a message has been received, Exim waits for the clock to tick at the
1023 appropriate resolution before proceeding, so that if another message is
1024 received by the same process, or by another process with the same (re-used)
1025 pid, it is guaranteed that the time will be different. In most cases, the clock
1026 will already have ticked while the message was being received.
1027
1028
1029 .section "Receiving mail" "SECID13"
1030 .cindex "receiving mail"
1031 .cindex "message" "reception"
1032 The only way Exim can receive mail from another host is using SMTP over
1033 TCP/IP, in which case the sender and recipient addresses are transferred using
1034 SMTP commands. However, from a locally running process (such as a user's MUA),
1035 there are several possibilities:
1036
1037 .ilist
1038 If the process runs Exim with the &%-bm%& option, the message is read
1039 non-interactively (usually via a pipe), with the recipients taken from the
1040 command line, or from the body of the message if &%-t%& is also used.
1041 .next
1042 If the process runs Exim with the &%-bS%& option, the message is also read
1043 non-interactively, but in this case the recipients are listed at the start of
1044 the message in a series of SMTP RCPT commands, terminated by a DATA
1045 command. This is called &"batch SMTP"& format,
1046 but it isn't really SMTP. The SMTP commands are just another way of passing
1047 envelope addresses in a non-interactive submission.
1048 .next
1049 If the process runs Exim with the &%-bs%& option, the message is read
1050 interactively, using the SMTP protocol. A two-way pipe is normally used for
1051 passing data between the local process and the Exim process.
1052 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1053 example, the ACLs for SMTP commands are used for this form of submission.
1054 .next
1055 A local process may also make a TCP/IP call to the host's loopback address
1056 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1057 does not treat the loopback address specially. It treats all such connections
1058 in the same way as connections from other hosts.
1059 .endlist
1060
1061
1062 .cindex "message sender, constructed by Exim"
1063 .cindex "sender" "constructed by Exim"
1064 In the three cases that do not involve TCP/IP, the sender address is
1065 constructed from the login name of the user that called Exim and a default
1066 qualification domain (which can be set by the &%qualify_domain%& configuration
1067 option). For local or batch SMTP, a sender address that is passed using the
1068 SMTP MAIL command is ignored. However, the system administrator may allow
1069 certain users (&"trusted users"&) to specify a different sender addresses
1070 unconditionally, or all users to specify certain forms of different sender
1071 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1072 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1073 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1074 users to change sender addresses.
1075
1076 Messages received by either of the non-interactive mechanisms are subject to
1077 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1078 (either over TCP/IP or interacting with a local process) can be checked by a
1079 number of ACLs that operate at different times during the SMTP session. Either
1080 individual recipients or the entire message can be rejected if local policy
1081 requirements are not met. The &[local_scan()]& function (see chapter
1082 &<<CHAPlocalscan>>&) is run for all incoming messages.
1083
1084 Exim can be configured not to start a delivery process when a message is
1085 received; this can be unconditional, or depend on the number of incoming SMTP
1086 connections or the system load. In these situations, new messages wait on the
1087 queue until a queue runner process picks them up. However, in standard
1088 configurations under normal conditions, delivery is started as soon as a
1089 message is received.
1090
1091
1092
1093
1094
1095 .section "Handling an incoming message" "SECID14"
1096 .cindex "spool directory" "files that hold a message"
1097 .cindex "file" "how a message is held"
1098 When Exim accepts a message, it writes two files in its spool directory. The
1099 first contains the envelope information, the current status of the message, and
1100 the header lines, and the second contains the body of the message. The names of
1101 the two spool files consist of the message id, followed by &`-H`& for the
1102 file containing the envelope and header, and &`-D`& for the data file.
1103
1104 .cindex "spool directory" "&_input_& sub-directory"
1105 By default, all these message files are held in a single directory called
1106 &_input_& inside the general Exim spool directory. Some operating systems do
1107 not perform very well if the number of files in a directory gets large; to
1108 improve performance in such cases, the &%split_spool_directory%& option can be
1109 used. This causes Exim to split up the input files into 62 sub-directories
1110 whose names are single letters or digits. When this is done, the queue is
1111 processed one sub-directory at a time instead of all at once, which can improve
1112 overall performance even when there are not enough files in each directory to
1113 affect file system performance.
1114
1115 The envelope information consists of the address of the message's sender and
1116 the addresses of the recipients. This information is entirely separate from
1117 any addresses contained in the header lines. The status of the message includes
1118 a list of recipients who have already received the message. The format of the
1119 first spool file is described in chapter &<<CHAPspool>>&.
1120
1121 .cindex "rewriting" "addresses"
1122 Address rewriting that is specified in the rewrite section of the configuration
1123 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1124 both in the header lines and the envelope, at the time the message is accepted.
1125 If during the course of delivery additional addresses are generated (for
1126 example, via aliasing), these new addresses are rewritten as soon as they are
1127 generated. At the time a message is actually delivered (transported) further
1128 rewriting can take place; because this is a transport option, it can be
1129 different for different forms of delivery. It is also possible to specify the
1130 addition or removal of certain header lines at the time the message is
1131 delivered (see chapters &<<CHAProutergeneric>>& and
1132 &<<CHAPtransportgeneric>>&).
1133
1134
1135
1136 .section "Life of a message" "SECID15"
1137 .cindex "message" "life of"
1138 .cindex "message" "frozen"
1139 A message remains in the spool directory until it is completely delivered to
1140 its recipients or to an error address, or until it is deleted by an
1141 administrator or by the user who originally created it. In cases when delivery
1142 cannot proceed &-- for example when a message can neither be delivered to its
1143 recipients nor returned to its sender, the message is marked &"frozen"& on the
1144 spool, and no more deliveries are attempted.
1145
1146 .cindex "frozen messages" "thawing"
1147 .cindex "message" "thawing frozen"
1148 An administrator can &"thaw"& such messages when the problem has been
1149 corrected, and can also freeze individual messages by hand if necessary. In
1150 addition, an administrator can force a delivery error, causing a bounce message
1151 to be sent.
1152
1153 .oindex "&%timeout_frozen_after%&"
1154 .oindex "&%ignore_bounce_errors_after%&"
1155 There are options called &%ignore_bounce_errors_after%& and
1156 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1157 The first applies only to frozen bounces, the second to all frozen messages.
1158
1159 .cindex "message" "log file for"
1160 .cindex "log" "file for each message"
1161 While Exim is working on a message, it writes information about each delivery
1162 attempt to its main log file. This includes successful, unsuccessful, and
1163 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1164 lines are also written to a separate &'message log'& file for each message.
1165 These logs are solely for the benefit of the administrator and are normally
1166 deleted along with the spool files when processing of a message is complete.
1167 The use of individual message logs can be disabled by setting
1168 &%no_message_logs%&; this might give an improvement in performance on very busy
1169 systems.
1170
1171 .cindex "journal file"
1172 .cindex "file" "journal"
1173 All the information Exim itself needs to set up a delivery is kept in the first
1174 spool file, along with the header lines. When a successful delivery occurs, the
1175 address is immediately written at the end of a journal file, whose name is the
1176 message id followed by &`-J`&. At the end of a delivery run, if there are some
1177 addresses left to be tried again later, the first spool file (the &`-H`& file)
1178 is updated to indicate which these are, and the journal file is then deleted.
1179 Updating the spool file is done by writing a new file and renaming it, to
1180 minimize the possibility of data loss.
1181
1182 Should the system or Exim crash after a successful delivery but before
1183 the spool file has been updated, the journal is left lying around. The next
1184 time Exim attempts to deliver the message, it reads the journal file and
1185 updates the spool file before proceeding. This minimizes the chances of double
1186 deliveries caused by crashes.
1187
1188
1189
1190 .section "Processing an address for delivery" "SECTprocaddress"
1191 .cindex "drivers" "definition of"
1192 .cindex "router" "definition of"
1193 .cindex "transport" "definition of"
1194 The main delivery processing elements of Exim are called &'routers'& and
1195 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1196 number of them is provided in the source distribution, and compile-time options
1197 specify which ones are included in the binary. Runtime options specify which
1198 ones are actually used for delivering messages.
1199
1200 .cindex "drivers" "instance definition"
1201 Each driver that is specified in the runtime configuration is an &'instance'&
1202 of that particular driver type. Multiple instances are allowed; for example,
1203 you can set up several different &(smtp)& transports, each with different
1204 option values that might specify different ports or different timeouts. Each
1205 instance has its own identifying name. In what follows we will normally use the
1206 instance name when discussing one particular instance (that is, one specific
1207 configuration of the driver), and the generic driver name when discussing
1208 the driver's features in general.
1209
1210 A &'router'& is a driver that operates on an address, either determining how
1211 its delivery should happen, by assigning it to a specific transport, or
1212 converting the address into one or more new addresses (for example, via an
1213 alias file). A router may also explicitly choose to fail an address, causing it
1214 to be bounced.
1215
1216 A &'transport'& is a driver that transmits a copy of the message from Exim's
1217 spool to some destination. There are two kinds of transport: for a &'local'&
1218 transport, the destination is a file or a pipe on the local host, whereas for a
1219 &'remote'& transport the destination is some other host. A message is passed
1220 to a specific transport as a result of successful routing. If a message has
1221 several recipients, it may be passed to a number of different transports.
1222
1223 .cindex "preconditions" "definition of"
1224 An address is processed by passing it to each configured router instance in
1225 turn, subject to certain preconditions, until a router accepts the address or
1226 specifies that it should be bounced. We will describe this process in more
1227 detail shortly. First, as a simple example, we consider how each recipient
1228 address in a message is processed in a small configuration of three routers.
1229
1230 To make this a more concrete example, it is described in terms of some actual
1231 routers, but remember, this is only an example. You can configure Exim's
1232 routers in many different ways, and there may be any number of routers in a
1233 configuration.
1234
1235 The first router that is specified in a configuration is often one that handles
1236 addresses in domains that are not recognized specifically by the local host.
1237 Typically these are addresses for arbitrary domains on the Internet. A precondition
1238 is set up which looks for the special domains known to the host (for example,
1239 its own domain name), and the router is run for addresses that do &'not'&
1240 match. Typically, this is a router that looks up domains in the DNS in order to
1241 find the hosts to which this address routes. If it succeeds, the address is
1242 assigned to a suitable SMTP transport; if it does not succeed, the router is
1243 configured to fail the address.
1244
1245 The second router is reached only when the domain is recognized as one that
1246 &"belongs"& to the local host. This router does redirection &-- also known as
1247 aliasing and forwarding. When it generates one or more new addresses from the
1248 original, each of them is routed independently from the start. Otherwise, the
1249 router may cause an address to fail, or it may simply decline to handle the
1250 address, in which case the address is passed to the next router.
1251
1252 The final router in many configurations is one that checks to see if the
1253 address belongs to a local mailbox. The precondition may involve a check to
1254 see if the local part is the name of a login account, or it may look up the
1255 local part in a file or a database. If its preconditions are not met, or if
1256 the router declines, we have reached the end of the routers. When this happens,
1257 the address is bounced.
1258
1259
1260
1261 .section "Processing an address for verification" "SECID16"
1262 .cindex "router" "for verification"
1263 .cindex "verifying address" "overview"
1264 As well as being used to decide how to deliver to an address, Exim's routers
1265 are also used for &'address verification'&. Verification can be requested as
1266 one of the checks to be performed in an ACL for incoming messages, on both
1267 sender and recipient addresses, and it can be tested using the &%-bv%& and
1268 &%-bvs%& command line options.
1269
1270 When an address is being verified, the routers are run in &"verify mode"&. This
1271 does not affect the way the routers work, but it is a state that can be
1272 detected. By this means, a router can be skipped or made to behave differently
1273 when verifying. A common example is a configuration in which the first router
1274 sends all messages to a message-scanning program unless they have been
1275 previously scanned. Thus, the first router accepts all addresses without any
1276 checking, making it useless for verifying. Normally, the &%no_verify%& option
1277 would be set for such a router, causing it to be skipped in verify mode.
1278
1279
1280
1281
1282 .section "Running an individual router" "SECTrunindrou"
1283 .cindex "router" "running details"
1284 .cindex "preconditions" "checking"
1285 .cindex "router" "result of running"
1286 As explained in the example above, a number of preconditions are checked before
1287 running a router. If any are not met, the router is skipped, and the address is
1288 passed to the next router. When all the preconditions on a router &'are'& met,
1289 the router is run. What happens next depends on the outcome, which is one of
1290 the following:
1291
1292 .ilist
1293 &'accept'&: The router accepts the address, and either assigns it to a
1294 transport or generates one or more &"child"& addresses. Processing the
1295 original address ceases
1296 .oindex "&%unseen%&"
1297 unless the &%unseen%& option is set on the router. This option
1298 can be used to set up multiple deliveries with different routing (for example,
1299 for keeping archive copies of messages). When &%unseen%& is set, the address is
1300 passed to the next router. Normally, however, an &'accept'& return marks the
1301 end of routing.
1302
1303 Any child addresses generated by the router are processed independently,
1304 starting with the first router by default. It is possible to change this by
1305 setting the &%redirect_router%& option to specify which router to start at for
1306 child addresses. Unlike &%pass_router%& (see below) the router specified by
1307 &%redirect_router%& may be anywhere in the router configuration.
1308 .next
1309 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1310 requests that the address be passed to another router. By default, the address
1311 is passed to the next router, but this can be changed by setting the
1312 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1313 must be below the current router (to avoid loops).
1314 .next
1315 &'decline'&: The router declines to accept the address because it does not
1316 recognize it at all. By default, the address is passed to the next router, but
1317 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1318 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1319 &'decline'& into &'fail'&.
1320 .next
1321 &'fail'&: The router determines that the address should fail, and queues it for
1322 the generation of a bounce message. There is no further processing of the
1323 original address unless &%unseen%& is set on the router.
1324 .next
1325 &'defer'&: The router cannot handle the address at the present time. (A
1326 database may be offline, or a DNS lookup may have timed out.) No further
1327 processing of the address happens in this delivery attempt. It is tried again
1328 next time the message is considered for delivery.
1329 .next
1330 &'error'&: There is some error in the router (for example, a syntax error in
1331 its configuration). The action is as for defer.
1332 .endlist
1333
1334 If an address reaches the end of the routers without having been accepted by
1335 any of them, it is bounced as unrouteable. The default error message in this
1336 situation is &"unrouteable address"&, but you can set your own message by
1337 making use of the &%cannot_route_message%& option. This can be set for any
1338 router; the value from the last router that &"saw"& the address is used.
1339
1340 Sometimes while routing you want to fail a delivery when some conditions are
1341 met but others are not, instead of passing the address on for further routing.
1342 You can do this by having a second router that explicitly fails the delivery
1343 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1344 facility for this purpose.
1345
1346
1347 .section "Duplicate addresses" "SECID17"
1348 .cindex "case of local parts"
1349 .cindex "address duplicate, discarding"
1350 .cindex "duplicate addresses"
1351 Once routing is complete, Exim scans the addresses that are assigned to local
1352 and remote transports and discards any duplicates that it finds. During this
1353 check, local parts are treated case-sensitively. This happens only when
1354 actually delivering a message; when testing routers with &%-bt%&, all the
1355 routed addresses are shown.
1356
1357
1358
1359 .section "Router preconditions" "SECTrouprecon"
1360 .cindex "router" "preconditions, order of processing"
1361 .cindex "preconditions" "order of processing"
1362 The preconditions that are tested for each router are listed below, in the
1363 order in which they are tested. The individual configuration options are
1364 described in more detail in chapter &<<CHAProutergeneric>>&.
1365
1366 .ilist
1367 .cindex affix "router precondition"
1368 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1369 the local parts handled by the router may or must have certain prefixes and/or
1370 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1371 skipped. These conditions are tested first. When an affix is present, it is
1372 removed from the local part before further processing, including the evaluation
1373 of any other conditions.
1374 .next
1375 Routers can be designated for use only when not verifying an address, that is,
1376 only when routing it for delivery (or testing its delivery routing). If the
1377 &%verify%& option is set false, the router is skipped when Exim is verifying an
1378 address.
1379 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1380 &%verify_recipient%&, which independently control the use of the router for
1381 sender and recipient verification. You can set these options directly if
1382 you want a router to be used for only one type of verification.
1383 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1384 .next
1385 If the &%address_test%& option is set false, the router is skipped when Exim is
1386 run with the &%-bt%& option to test an address routing. This can be helpful
1387 when the first router sends all new messages to a scanner of some sort; it
1388 makes it possible to use &%-bt%& to test subsequent delivery routing without
1389 having to simulate the effect of the scanner.
1390 .next
1391 Routers can be designated for use only when verifying an address, as
1392 opposed to routing it for delivery. The &%verify_only%& option controls this.
1393 Again, cutthrough delivery counts as a verification.
1394 .next
1395 Individual routers can be explicitly skipped when running the routers to
1396 check an address given in the SMTP EXPN command (see the &%expn%& option).
1397 .next
1398 If the &%domains%& option is set, the domain of the address must be in the set
1399 of domains that it defines.
1400 .next
1401 .vindex "&$local_part_prefix$&"
1402 .vindex "&$local_part$&"
1403 .vindex "&$local_part_suffix$&"
1404 .cindex affix "router precondition"
1405 If the &%local_parts%& option is set, the local part of the address must be in
1406 the set of local parts that it defines. If &%local_part_prefix%& or
1407 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1408 part before this check. If you want to do precondition tests on local parts
1409 that include affixes, you can do so by using a &%condition%& option (see below)
1410 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1411 &$local_part_suffix$& as necessary.
1412 .next
1413 .vindex "&$local_user_uid$&"
1414 .vindex "&$local_user_gid$&"
1415 .vindex "&$home$&"
1416 If the &%check_local_user%& option is set, the local part must be the name of
1417 an account on the local host. If this check succeeds, the uid and gid of the
1418 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1419 user's home directory is placed in &$home$&; these values can be used in the
1420 remaining preconditions.
1421 .next
1422 If the &%router_home_directory%& option is set, it is expanded at this point,
1423 because it overrides the value of &$home$&. If this expansion were left till
1424 later, the value of &$home$& as set by &%check_local_user%& would be used in
1425 subsequent tests. Having two different values of &$home$& in the same router
1426 could lead to confusion.
1427 .next
1428 If the &%senders%& option is set, the envelope sender address must be in the
1429 set of addresses that it defines.
1430 .next
1431 If the &%require_files%& option is set, the existence or non-existence of
1432 specified files is tested.
1433 .next
1434 .cindex "customizing" "precondition"
1435 If the &%condition%& option is set, it is evaluated and tested. This option
1436 uses an expanded string to allow you to set up your own custom preconditions.
1437 Expanded strings are described in chapter &<<CHAPexpand>>&.
1438 .endlist
1439
1440
1441 Note that &%require_files%& comes near the end of the list, so you cannot use
1442 it to check for the existence of a file in which to lookup up a domain, local
1443 part, or sender. However, as these options are all expanded, you can use the
1444 &%exists%& expansion condition to make such tests within each condition. The
1445 &%require_files%& option is intended for checking files that the router may be
1446 going to use internally, or which are needed by a specific transport (for
1447 example, &_.procmailrc_&).
1448
1449
1450
1451 .section "Delivery in detail" "SECID18"
1452 .cindex "delivery" "in detail"
1453 When a message is to be delivered, the sequence of events is as follows:
1454
1455 .ilist
1456 If a system-wide filter file is specified, the message is passed to it. The
1457 filter may add recipients to the message, replace the recipients, discard the
1458 message, cause a new message to be generated, or cause the message delivery to
1459 fail. The format of the system filter file is the same as for Exim user filter
1460 files, described in the separate document entitled &'Exim's interfaces to mail
1461 filtering'&.
1462 .cindex "Sieve filter" "not available for system filter"
1463 (&*Note*&: Sieve cannot be used for system filter files.)
1464
1465 Some additional features are available in system filters &-- see chapter
1466 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1467 filter only once per delivery attempt, however many recipients it has. However,
1468 if there are several delivery attempts because one or more addresses could not
1469 be immediately delivered, the system filter is run each time. The filter
1470 condition &%first_delivery%& can be used to detect the first run of the system
1471 filter.
1472 .next
1473 Each recipient address is offered to each configured router, in turn, subject to
1474 its preconditions, until one is able to handle it. If no router can handle the
1475 address, that is, if they all decline, the address is failed. Because routers
1476 can be targeted at particular domains, several locally handled domains can be
1477 processed entirely independently of each other.
1478 .next
1479 .cindex "routing" "loops in"
1480 .cindex "loop" "while routing"
1481 A router that accepts an address may assign it to a local or a remote
1482 transport. However, the transport is not run at this time. Instead, the address
1483 is placed on a list for the particular transport, which will be run later.
1484 Alternatively, the router may generate one or more new addresses (typically
1485 from alias, forward, or filter files). New addresses are fed back into this
1486 process from the top, but in order to avoid loops, a router ignores any address
1487 which has an identically-named ancestor that was processed by itself.
1488 .next
1489 When all the routing has been done, addresses that have been successfully
1490 handled are passed to their assigned transports. When local transports are
1491 doing real local deliveries, they handle only one address at a time, but if a
1492 local transport is being used as a pseudo-remote transport (for example, to
1493 collect batched SMTP messages for transmission by some other means) multiple
1494 addresses can be handled. Remote transports can always handle more than one
1495 address at a time, but can be configured not to do so, or to restrict multiple
1496 addresses to the same domain.
1497 .next
1498 Each local delivery to a file or a pipe runs in a separate process under a
1499 non-privileged uid, and these deliveries are run one at a time. Remote
1500 deliveries also run in separate processes, normally under a uid that is private
1501 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1502 run in parallel. The maximum number of simultaneous remote deliveries for any
1503 one message is set by the &%remote_max_parallel%& option.
1504 The order in which deliveries are done is not defined, except that all local
1505 deliveries happen before any remote deliveries.
1506 .next
1507 .cindex "queue runner"
1508 When it encounters a local delivery during a queue run, Exim checks its retry
1509 database to see if there has been a previous temporary delivery failure for the
1510 address before running the local transport. If there was a previous failure,
1511 Exim does not attempt a new delivery until the retry time for the address is
1512 reached. However, this happens only for delivery attempts that are part of a
1513 queue run. Local deliveries are always attempted when delivery immediately
1514 follows message reception, even if retry times are set for them. This makes for
1515 better behaviour if one particular message is causing problems (for example,
1516 causing quota overflow, or provoking an error in a filter file).
1517 .next
1518 .cindex "delivery" "retry in remote transports"
1519 Remote transports do their own retry handling, since an address may be
1520 deliverable to one of a number of hosts, each of which may have a different
1521 retry time. If there have been previous temporary failures and no host has
1522 reached its retry time, no delivery is attempted, whether in a queue run or
1523 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1524 .next
1525 If there were any permanent errors, a bounce message is returned to an
1526 appropriate address (the sender in the common case), with details of the error
1527 for each failing address. Exim can be configured to send copies of bounce
1528 messages to other addresses.
1529 .next
1530 .cindex "delivery" "deferral"
1531 If one or more addresses suffered a temporary failure, the message is left on
1532 the queue, to be tried again later. Delivery of these addresses is said to be
1533 &'deferred'&.
1534 .next
1535 When all the recipient addresses have either been delivered or bounced,
1536 handling of the message is complete. The spool files and message log are
1537 deleted, though the message log can optionally be preserved if required.
1538 .endlist
1539
1540
1541
1542
1543 .section "Retry mechanism" "SECID19"
1544 .cindex "delivery" "retry mechanism"
1545 .cindex "retry" "description of mechanism"
1546 .cindex "queue runner"
1547 Exim's mechanism for retrying messages that fail to get delivered at the first
1548 attempt is the queue runner process. You must either run an Exim daemon that
1549 uses the &%-q%& option with a time interval to start queue runners at regular
1550 intervals or use some other means (such as &'cron'&) to start them. If you do
1551 not arrange for queue runners to be run, messages that fail temporarily at the
1552 first attempt will remain in your queue forever. A queue runner process works
1553 its way through the queue, one message at a time, trying each delivery that has
1554 passed its retry time.
1555 You can run several queue runners at once.
1556
1557 Exim uses a set of configured rules to determine when next to retry the failing
1558 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1559 should give up trying to deliver to the address, at which point it generates a
1560 bounce message. If no retry rules are set for a particular host, address, and
1561 error combination, no retries are attempted, and temporary errors are treated
1562 as permanent.
1563
1564
1565
1566 .section "Temporary delivery failure" "SECID20"
1567 .cindex "delivery" "temporary failure"
1568 There are many reasons why a message may not be immediately deliverable to a
1569 particular address. Failure to connect to a remote machine (because it, or the
1570 connection to it, is down) is one of the most common. Temporary failures may be
1571 detected during routing as well as during the transport stage of delivery.
1572 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1573 is on a file system where the user is over quota. Exim can be configured to
1574 impose its own quotas on local mailboxes; where system quotas are set they will
1575 also apply.
1576
1577 If a host is unreachable for a period of time, a number of messages may be
1578 waiting for it by the time it recovers, and sending them in a single SMTP
1579 connection is clearly beneficial. Whenever a delivery to a remote host is
1580 deferred,
1581 .cindex "hints database" "deferred deliveries"
1582 Exim makes a note in its hints database, and whenever a successful
1583 SMTP delivery has happened, it looks to see if any other messages are waiting
1584 for the same host. If any are found, they are sent over the same SMTP
1585 connection, subject to a configuration limit as to the maximum number in any
1586 one connection.
1587
1588
1589
1590 .section "Permanent delivery failure" "SECID21"
1591 .cindex "delivery" "permanent failure"
1592 .cindex "bounce message" "when generated"
1593 When a message cannot be delivered to some or all of its intended recipients, a
1594 bounce message is generated. Temporary delivery failures turn into permanent
1595 errors when their timeout expires. All the addresses that fail in a given
1596 delivery attempt are listed in a single message. If the original message has
1597 many recipients, it is possible for some addresses to fail in one delivery
1598 attempt and others to fail subsequently, giving rise to more than one bounce
1599 message. The wording of bounce messages can be customized by the administrator.
1600 See chapter &<<CHAPemsgcust>>& for details.
1601
1602 .cindex "&'X-Failed-Recipients:'& header line"
1603 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1604 failed addresses, for the benefit of programs that try to analyse such messages
1605 automatically.
1606
1607 .cindex "bounce message" "recipient of"
1608 A bounce message is normally sent to the sender of the original message, as
1609 obtained from the message's envelope. For incoming SMTP messages, this is the
1610 address given in the MAIL command. However, when an address is expanded via a
1611 forward or alias file, an alternative address can be specified for delivery
1612 failures of the generated addresses. For a mailing list expansion (see section
1613 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1614 of the list.
1615
1616
1617
1618 .section "Failures to deliver bounce messages" "SECID22"
1619 .cindex "bounce message" "failure to deliver"
1620 If a bounce message (either locally generated or received from a remote host)
1621 itself suffers a permanent delivery failure, the message is left in the queue,
1622 but it is frozen, awaiting the attention of an administrator. There are options
1623 that can be used to make Exim discard such failed messages, or to keep them
1624 for only a short time (see &%timeout_frozen_after%& and
1625 &%ignore_bounce_errors_after%&).
1626
1627
1628
1629
1630
1631 . ////////////////////////////////////////////////////////////////////////////
1632 . ////////////////////////////////////////////////////////////////////////////
1633
1634 .chapter "Building and installing Exim" "CHID3"
1635 .scindex IIDbuex "building Exim"
1636
1637 .section "Unpacking" "SECID23"
1638 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1639 creates a directory with the name of the current release (for example,
1640 &_exim-&version()_&) into which the following files are placed:
1641
1642 .table2 140pt
1643 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1644 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1645   documented"
1646 .irow &_LICENCE_&         "the GNU General Public Licence"
1647 .irow &_Makefile_&        "top-level make file"
1648 .irow &_NOTICE_&          "conditions for the use of Exim"
1649 .irow &_README_&          "list of files, directories and simple build &&&
1650   instructions"
1651 .endtable
1652
1653 Other files whose names begin with &_README_& may also be present. The
1654 following subdirectories are created:
1655
1656 .table2 140pt
1657 .irow &_Local_&           "an empty directory for local configuration files"
1658 .irow &_OS_&              "OS-specific files"
1659 .irow &_doc_&             "documentation files"
1660 .irow &_exim_monitor_&    "source files for the Exim monitor"
1661 .irow &_scripts_&         "scripts used in the build process"
1662 .irow &_src_&             "remaining source files"
1663 .irow &_util_&            "independent utilities"
1664 .endtable
1665
1666 The main utility programs are contained in the &_src_& directory and are built
1667 with the Exim binary. The &_util_& directory contains a few optional scripts
1668 that may be useful to some sites.
1669
1670
1671 .section "Multiple machine architectures and operating systems" "SECID24"
1672 .cindex "building Exim" "multiple OS/architectures"
1673 The building process for Exim is arranged to make it easy to build binaries for
1674 a number of different architectures and operating systems from the same set of
1675 source files. Compilation does not take place in the &_src_& directory.
1676 Instead, a &'build directory'& is created for each architecture and operating
1677 system.
1678 .cindex "symbolic link" "to build directory"
1679 Symbolic links to the sources are installed in this directory, which is where
1680 the actual building takes place. In most cases, Exim can discover the machine
1681 architecture and operating system for itself, but the defaults can be
1682 overridden if necessary.
1683 .cindex compiler requirements
1684 .cindex compiler version
1685 A C99-capable compiler will be required for the build.
1686
1687
1688 .section "PCRE library" "SECTpcre"
1689 .cindex "PCRE library"
1690 Exim no longer has an embedded PCRE library as the vast majority of
1691 modern systems include PCRE as a system library, although you may need to
1692 install the PCRE package or the PCRE development package for your operating
1693 system. If your system has a normal PCRE installation the Exim build
1694 process will need no further configuration. If the library or the
1695 headers are in an unusual location you will need to either set the PCRE_LIBS
1696 and INCLUDE directives appropriately,
1697 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1698 If your operating system has no
1699 PCRE support then you will need to obtain and build the current PCRE
1700 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1701 More information on PCRE is available at &url(https://www.pcre.org/).
1702
1703 .section "DBM libraries" "SECTdb"
1704 .cindex "DBM libraries" "discussion of"
1705 .cindex "hints database" "DBM files used for"
1706 Even if you do not use any DBM files in your configuration, Exim still needs a
1707 DBM library in order to operate, because it uses indexed files for its hints
1708 databases. Unfortunately, there are a number of DBM libraries in existence, and
1709 different operating systems often have different ones installed.
1710
1711 .cindex "Solaris" "DBM library for"
1712 .cindex "IRIX, DBM library for"
1713 .cindex "BSD, DBM library for"
1714 .cindex "Linux, DBM library for"
1715 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1716 Linux distribution, the DBM configuration should happen automatically, and you
1717 may be able to ignore this section. Otherwise, you may have to learn more than
1718 you would like about DBM libraries from what follows.
1719
1720 .cindex "&'ndbm'& DBM library"
1721 Licensed versions of Unix normally contain a library of DBM functions operating
1722 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1723 versions of Unix seem to vary in what they contain as standard. In particular,
1724 some early versions of Linux have no default DBM library, and different
1725 distributors have chosen to bundle different libraries with their packaged
1726 versions. However, the more recent releases seem to have standardized on the
1727 Berkeley DB library.
1728
1729 Different DBM libraries have different conventions for naming the files they
1730 use. When a program opens a file called &_dbmfile_&, there are several
1731 possibilities:
1732
1733 .olist
1734 A traditional &'ndbm'& implementation, such as that supplied as part of
1735 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1736 .next
1737 .cindex "&'gdbm'& DBM library"
1738 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1739 compatibility interface it makes two different hard links to it with names
1740 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1741 filename is used unmodified.
1742 .next
1743 .cindex "Berkeley DB library"
1744 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1745 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1746 programmer exactly the same as the traditional &'ndbm'& implementation.
1747 .next
1748 If the Berkeley package is used in its native mode, it operates on a single
1749 file called &_dbmfile_&; the programmer's interface is somewhat different to
1750 the traditional &'ndbm'& interface.
1751 .next
1752 To complicate things further, there are several very different versions of the
1753 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1754 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1755 Maintenance of some of the earlier releases has ceased. All versions of
1756 Berkeley DB could be obtained from
1757 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1758 page with far newer versions listed.
1759 It is probably wise to plan to move your storage configurations away from
1760 Berkeley DB format, as today there are smaller and simpler alternatives more
1761 suited to Exim's usage model.
1762 .next
1763 .cindex "&'tdb'& DBM library"
1764 Yet another DBM library, called &'tdb'&, is available from
1765 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1766 operates on a single file.
1767 .endlist
1768
1769 .cindex "USE_DB"
1770 .cindex "DBM libraries" "configuration for building"
1771 Exim and its utilities can be compiled to use any of these interfaces. In order
1772 to use any version of the Berkeley DB package in native mode, you must set
1773 USE_DB in an appropriate configuration file (typically
1774 &_Local/Makefile_&). For example:
1775 .code
1776 USE_DB=yes
1777 .endd
1778 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1779 error is diagnosed if you set more than one of these.
1780
1781 At the lowest level, the build-time configuration sets none of these options,
1782 thereby assuming an interface of type (1). However, some operating system
1783 configuration files (for example, those for the BSD operating systems and
1784 Linux) assume type (4) by setting USE_DB as their default, and the
1785 configuration files for Cygwin set USE_GDBM. Anything you set in
1786 &_Local/Makefile_&, however, overrides these system defaults.
1787
1788 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1789 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1790 in one of these lines:
1791 .code
1792 DBMLIB = -ldb
1793 DBMLIB = -ltdb
1794 .endd
1795 Settings like that will work if the DBM library is installed in the standard
1796 place. Sometimes it is not, and the library's header file may also not be in
1797 the default path. You may need to set INCLUDE to specify where the header
1798 file is, and to specify the path to the library more fully in DBMLIB, as in
1799 this example:
1800 .code
1801 INCLUDE=-I/usr/local/include/db-4.1
1802 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1803 .endd
1804 There is further detailed discussion about the various DBM libraries in the
1805 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1806
1807
1808
1809 .section "Pre-building configuration" "SECID25"
1810 .cindex "building Exim" "pre-building configuration"
1811 .cindex "configuration for building Exim"
1812 .cindex "&_Local/Makefile_&"
1813 .cindex "&_src/EDITME_&"
1814 Before building Exim, a local configuration file that specifies options
1815 independent of any operating system has to be created with the name
1816 &_Local/Makefile_&. A template for this file is supplied as the file
1817 &_src/EDITME_&, and it contains full descriptions of all the option settings
1818 therein. These descriptions are therefore not repeated here. If you are
1819 building Exim for the first time, the simplest thing to do is to copy
1820 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1821
1822 There are three settings that you must supply, because Exim will not build
1823 without them. They are the location of the runtime configuration file
1824 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1825 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1826 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1827 a colon-separated list of filenames; Exim uses the first of them that exists.
1828
1829 There are a few other parameters that can be specified either at build time or
1830 at runtime, to enable the same binary to be used on a number of different
1831 machines. However, if the locations of Exim's spool directory and log file
1832 directory (if not within the spool directory) are fixed, it is recommended that
1833 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1834 detected early in Exim's execution (such as a malformed configuration file) can
1835 be logged.
1836
1837 .cindex "content scanning" "specifying at build time"
1838 Exim's interfaces for calling virus and spam scanning software directly from
1839 access control lists are not compiled by default. If you want to include these
1840 facilities, you need to set
1841 .code
1842 WITH_CONTENT_SCAN=yes
1843 .endd
1844 in your &_Local/Makefile_&. For details of the facilities themselves, see
1845 chapter &<<CHAPexiscan>>&.
1846
1847
1848 .cindex "&_Local/eximon.conf_&"
1849 .cindex "&_exim_monitor/EDITME_&"
1850 If you are going to build the Exim monitor, a similar configuration process is
1851 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1852 your installation and saved under the name &_Local/eximon.conf_&. If you are
1853 happy with the default settings described in &_exim_monitor/EDITME_&,
1854 &_Local/eximon.conf_& can be empty, but it must exist.
1855
1856 This is all the configuration that is needed in straightforward cases for known
1857 operating systems. However, the building process is set up so that it is easy
1858 to override options that are set by default or by operating-system-specific
1859 configuration files, for example, to change the C compiler, which
1860 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1861 do this.
1862
1863
1864
1865 .section "Support for iconv()" "SECID26"
1866 .cindex "&[iconv()]& support"
1867 .cindex "RFC 2047"
1868 The contents of header lines in messages may be encoded according to the rules
1869 described RFC 2047. This makes it possible to transmit characters that are not
1870 in the ASCII character set, and to label them as being in a particular
1871 character set. When Exim is inspecting header lines by means of the &%$h_%&
1872 mechanism, it decodes them, and translates them into a specified character set
1873 (default is set at build time). The translation is possible only if the operating system
1874 supports the &[iconv()]& function.
1875
1876 However, some of the operating systems that supply &[iconv()]& do not support
1877 very many conversions. The GNU &%libiconv%& library (available from
1878 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1879 systems to remedy this deficiency, as well as on systems that do not supply
1880 &[iconv()]& at all. After installing &%libiconv%&, you should add
1881 .code
1882 HAVE_ICONV=yes
1883 .endd
1884 to your &_Local/Makefile_& and rebuild Exim.
1885
1886
1887
1888 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1889 .cindex "TLS" "including support for TLS"
1890 .cindex "encryption" "including support for"
1891 .cindex "OpenSSL" "building Exim with"
1892 .cindex "GnuTLS" "building Exim with"
1893 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1894 command as per RFC 2487. It can also support clients that expect to
1895 start a TLS session immediately on connection to a non-standard port (see the
1896 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1897 line option).
1898
1899 If you want to build Exim with TLS support, you must first install either the
1900 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1901 implementing SSL.
1902
1903 If you do not want TLS support you should set
1904 .code
1905 DISABLE_TLS=yes
1906 .endd
1907 in &_Local/Makefile_&.
1908
1909 If OpenSSL is installed, you should set
1910 .code
1911 USE_OPENSL=yes
1912 TLS_LIBS=-lssl -lcrypto
1913 .endd
1914 in &_Local/Makefile_&. You may also need to specify the locations of the
1915 OpenSSL library and include files. For example:
1916 .code
1917 USE_OPENSSL=yes
1918 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1919 TLS_INCLUDE=-I/usr/local/openssl/include/
1920 .endd
1921 .cindex "pkg-config" "OpenSSL"
1922 If you have &'pkg-config'& available, then instead you can just use:
1923 .code
1924 USE_OPENSSL=yes
1925 USE_OPENSSL_PC=openssl
1926 .endd
1927 .cindex "USE_GNUTLS"
1928 If GnuTLS is installed, you should set
1929 .code
1930 USE_GNUTLS=yes
1931 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1932 .endd
1933 in &_Local/Makefile_&, and again you may need to specify the locations of the
1934 library and include files. For example:
1935 .code
1936 USE_GNUTLS=yes
1937 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1938 TLS_INCLUDE=-I/usr/gnu/include
1939 .endd
1940 .cindex "pkg-config" "GnuTLS"
1941 If you have &'pkg-config'& available, then instead you can just use:
1942 .code
1943 USE_GNUTLS=yes
1944 USE_GNUTLS_PC=gnutls
1945 .endd
1946
1947 You do not need to set TLS_INCLUDE if the relevant directory is already
1948 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1949 given in chapter &<<CHAPTLS>>&.
1950
1951
1952
1953
1954 .section "Use of tcpwrappers" "SECID27"
1955
1956 .cindex "tcpwrappers, building Exim to support"
1957 .cindex "USE_TCP_WRAPPERS"
1958 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1959 .cindex "tcp_wrappers_daemon_name"
1960 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1961 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1962 alternative to Exim's own checking facilities for installations that are
1963 already making use of &'tcpwrappers'& for other purposes. To do this, you
1964 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1965 &_tcpd.h_& to be available at compile time, and also ensure that the library
1966 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1967 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1968 you might have
1969 .code
1970 USE_TCP_WRAPPERS=yes
1971 CFLAGS=-O -I/usr/local/include
1972 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1973 .endd
1974 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1975 files is &"exim"&. For example, the line
1976 .code
1977 exim : LOCAL  192.168.1.  .friendly.domain.example
1978 .endd
1979 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1980 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1981 All other connections are denied. The daemon name used by &'tcpwrappers'&
1982 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1983 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1984 configure file. Consult the &'tcpwrappers'& documentation for
1985 further details.
1986
1987
1988 .section "Including support for IPv6" "SECID28"
1989 .cindex "IPv6" "including support for"
1990 Exim contains code for use on systems that have IPv6 support. Setting
1991 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1992 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1993 where the IPv6 support is not fully integrated into the normal include and
1994 library files.
1995
1996 Two different types of DNS record for handling IPv6 addresses have been
1997 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1998 currently seen as the mainstream. Another record type called A6 was proposed
1999 as better than AAAA because it had more flexibility. However, it was felt to be
2000 over-complex, and its status was reduced to &"experimental"&.
2001 Exim used to
2002 have a compile option for including A6 record support but this has now been
2003 withdrawn.
2004
2005
2006
2007 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2008 .cindex "lookup modules"
2009 .cindex "dynamic modules"
2010 .cindex ".so building"
2011 On some platforms, Exim supports not compiling all lookup types directly into
2012 the main binary, instead putting some into external modules which can be loaded
2013 on demand.
2014 This permits packagers to build Exim with support for lookups with extensive
2015 library dependencies without requiring all users to install all of those
2016 dependencies.
2017 Most, but not all, lookup types can be built this way.
2018
2019 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2020 installed; Exim will only load modules from that directory, as a security
2021 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2022 for your OS; see &_OS/Makefile-Linux_& for an example.
2023 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2024 see &_src/EDITME_& for details.
2025
2026 Then, for each module to be loaded dynamically, define the relevant
2027 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2028 For example, this will build in lsearch but load sqlite and mysql support
2029 on demand:
2030 .code
2031 LOOKUP_LSEARCH=yes
2032 LOOKUP_SQLITE=2
2033 LOOKUP_MYSQL=2
2034 .endd
2035
2036
2037 .section "The building process" "SECID29"
2038 .cindex "build directory"
2039 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2040 created, run &'make'& at the top level. It determines the architecture and
2041 operating system types, and creates a build directory if one does not exist.
2042 For example, on a Sun system running Solaris 8, the directory
2043 &_build-SunOS5-5.8-sparc_& is created.
2044 .cindex "symbolic link" "to source files"
2045 Symbolic links to relevant source files are installed in the build directory.
2046
2047 If this is the first time &'make'& has been run, it calls a script that builds
2048 a make file inside the build directory, using the configuration files from the
2049 &_Local_& directory. The new make file is then passed to another instance of
2050 &'make'&. This does the real work, building a number of utility scripts, and
2051 then compiling and linking the binaries for the Exim monitor (if configured), a
2052 number of utility programs, and finally Exim itself. The command &`make
2053 makefile`& can be used to force a rebuild of the make file in the build
2054 directory, should this ever be necessary.
2055
2056 If you have problems building Exim, check for any comments there may be in the
2057 &_README_& file concerning your operating system, and also take a look at the
2058 FAQ, where some common problems are covered.
2059
2060
2061
2062 .section 'Output from &"make"&' "SECID283"
2063 The output produced by the &'make'& process for compile lines is often very
2064 unreadable, because these lines can be very long. For this reason, the normal
2065 output is suppressed by default, and instead output similar to that which
2066 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2067 each module that is being compiled or linked. However, it is still possible to
2068 get the full output, by calling &'make'& like this:
2069 .code
2070 FULLECHO='' make -e
2071 .endd
2072 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2073 command reflection in &'make'&. When you ask for the full output, it is
2074 given in addition to the short output.
2075
2076
2077
2078 .section "Overriding build-time options for Exim" "SECToverride"
2079 .cindex "build-time options, overriding"
2080 The main make file that is created at the beginning of the building process
2081 consists of the concatenation of a number of files which set configuration
2082 values, followed by a fixed set of &'make'& instructions. If a value is set
2083 more than once, the last setting overrides any previous ones. This provides a
2084 convenient way of overriding defaults. The files that are concatenated are, in
2085 order:
2086 .display
2087 &_OS/Makefile-Default_&
2088 &_OS/Makefile-_&<&'ostype'&>
2089 &_Local/Makefile_&
2090 &_Local/Makefile-_&<&'ostype'&>
2091 &_Local/Makefile-_&<&'archtype'&>
2092 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2093 &_OS/Makefile-Base_&
2094 .endd
2095 .cindex "&_Local/Makefile_&"
2096 .cindex "building Exim" "operating system type"
2097 .cindex "building Exim" "architecture type"
2098 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2099 architecture type. &_Local/Makefile_& is required to exist, and the building
2100 process fails if it is absent. The other three &_Local_& files are optional,
2101 and are often not needed.
2102
2103 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2104 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2105 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2106 values are used, thereby providing a means of forcing particular settings.
2107 Otherwise, the scripts try to get values from the &%uname%& command. If this
2108 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2109 of &'ad hoc'& transformations are then applied, to produce the standard names
2110 that Exim expects. You can run these scripts directly from the shell in order
2111 to find out what values are being used on your system.
2112
2113
2114 &_OS/Makefile-Default_& contains comments about the variables that are set
2115 therein. Some (but not all) are mentioned below. If there is something that
2116 needs changing, review the contents of this file and the contents of the make
2117 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2118 default values are.
2119
2120
2121 .cindex "building Exim" "overriding default settings"
2122 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2123 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2124 need to change the original files. Instead, you should make the changes by
2125 putting the new values in an appropriate &_Local_& file. For example,
2126 .cindex "Tru64-Unix build-time settings"
2127 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2128 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2129 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2130 called with the option &%-std1%&, to make it recognize some of the features of
2131 Standard C that Exim uses. (Most other compilers recognize Standard C by
2132 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2133 containing the lines
2134 .code
2135 CC=cc
2136 CFLAGS=-std1
2137 .endd
2138 If you are compiling for just one operating system, it may be easier to put
2139 these lines directly into &_Local/Makefile_&.
2140
2141 Keeping all your local configuration settings separate from the distributed
2142 files makes it easy to transfer them to new versions of Exim simply by copying
2143 the contents of the &_Local_& directory.
2144
2145
2146 .cindex "NIS lookup type" "including support for"
2147 .cindex "NIS+ lookup type" "including support for"
2148 .cindex "LDAP" "including support for"
2149 .cindex "lookup" "inclusion in binary"
2150 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2151 lookup, but not all systems have these components installed, so the default is
2152 not to include the relevant code in the binary. All the different kinds of file
2153 and database lookup that Exim supports are implemented as separate code modules
2154 which are included only if the relevant compile-time options are set. In the
2155 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2156 .code
2157 LOOKUP_LDAP=yes
2158 LOOKUP_NIS=yes
2159 LOOKUP_NISPLUS=yes
2160 .endd
2161 and similar settings apply to the other lookup types. They are all listed in
2162 &_src/EDITME_&. In many cases the relevant include files and interface
2163 libraries need to be installed before compiling Exim.
2164 .cindex "cdb" "including support for"
2165 However, there are some optional lookup types (such as cdb) for which
2166 the code is entirely contained within Exim, and no external include
2167 files or libraries are required. When a lookup type is not included in the
2168 binary, attempts to configure Exim to use it cause runtime configuration
2169 errors.
2170
2171 .cindex "pkg-config" "lookups"
2172 .cindex "pkg-config" "authenticators"
2173 Many systems now use a tool called &'pkg-config'& to encapsulate information
2174 about how to compile against a library; Exim has some initial support for
2175 being able to use pkg-config for lookups and authenticators.  For any given
2176 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2177 variable with the &`_PC`& suffix in the name and assign as the value the
2178 name of the package to be queried.  The results of querying via the
2179 &'pkg-config'& command will be added to the appropriate Makefile variables
2180 with &`+=`& directives, so your version of &'make'& will need to support that
2181 syntax.  For instance:
2182 .code
2183 LOOKUP_SQLITE=yes
2184 LOOKUP_SQLITE_PC=sqlite3
2185 AUTH_GSASL=yes
2186 AUTH_GSASL_PC=libgsasl
2187 AUTH_HEIMDAL_GSSAPI=yes
2188 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2189 .endd
2190
2191 .cindex "Perl" "including support for"
2192 Exim can be linked with an embedded Perl interpreter, allowing Perl
2193 subroutines to be called during string expansion. To enable this facility,
2194 .code
2195 EXIM_PERL=perl.o
2196 .endd
2197 must be defined in &_Local/Makefile_&. Details of this facility are given in
2198 chapter &<<CHAPperl>>&.
2199
2200 .cindex "X11 libraries, location of"
2201 The location of the X11 libraries is something that varies a lot between
2202 operating systems, and there may be different versions of X11 to cope
2203 with. Exim itself makes no use of X11, but if you are compiling the Exim
2204 monitor, the X11 libraries must be available.
2205 The following three variables are set in &_OS/Makefile-Default_&:
2206 .code
2207 X11=/usr/X11R6
2208 XINCLUDE=-I$(X11)/include
2209 XLFLAGS=-L$(X11)/lib
2210 .endd
2211 These are overridden in some of the operating-system configuration files. For
2212 example, in &_OS/Makefile-SunOS5_& there is
2213 .code
2214 X11=/usr/openwin
2215 XINCLUDE=-I$(X11)/include
2216 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2217 .endd
2218 If you need to override the default setting for your operating system, place a
2219 definition of all three of these variables into your
2220 &_Local/Makefile-<ostype>_& file.
2221
2222 .cindex "EXTRALIBS"
2223 If you need to add any extra libraries to the link steps, these can be put in a
2224 variable called EXTRALIBS, which appears in all the link commands, but by
2225 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2226 command for linking the main Exim binary, and not for any associated utilities.
2227
2228 .cindex "DBM libraries" "configuration for building"
2229 There is also DBMLIB, which appears in the link commands for binaries that
2230 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2231 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2232 binary, and which can be used, for example, to include additional X11
2233 libraries.
2234
2235 .cindex "configuration file" "editing"
2236 The make file copes with rebuilding Exim correctly if any of the configuration
2237 files are edited. However, if an optional configuration file is deleted, it is
2238 necessary to touch the associated non-optional file (that is,
2239 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2240
2241
2242 .section "OS-specific header files" "SECID30"
2243 .cindex "&_os.h_&"
2244 .cindex "building Exim" "OS-specific C header files"
2245 The &_OS_& directory contains a number of files with names of the form
2246 &_os.h-<ostype>_&. These are system-specific C header files that should not
2247 normally need to be changed. There is a list of macro settings that are
2248 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2249 are porting Exim to a new operating system.
2250
2251
2252
2253 .section "Overriding build-time options for the monitor" "SECID31"
2254 .cindex "building Eximon"
2255 A similar process is used for overriding things when building the Exim monitor,
2256 where the files that are involved are
2257 .display
2258 &_OS/eximon.conf-Default_&
2259 &_OS/eximon.conf-_&<&'ostype'&>
2260 &_Local/eximon.conf_&
2261 &_Local/eximon.conf-_&<&'ostype'&>
2262 &_Local/eximon.conf-_&<&'archtype'&>
2263 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2264 .endd
2265 .cindex "&_Local/eximon.conf_&"
2266 As with Exim itself, the final three files need not exist, and in this case the
2267 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2268 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2269 variables of the same name, preceded by EXIMON_. For example, setting
2270 EXIMON_LOG_DEPTH in the environment overrides the value of
2271 LOG_DEPTH at runtime.
2272 .ecindex IIDbuex
2273
2274
2275 .section "Installing Exim binaries and scripts" "SECID32"
2276 .cindex "installing Exim"
2277 .cindex "BIN_DIRECTORY"
2278 The command &`make install`& runs the &(exim_install)& script with no
2279 arguments. The script copies binaries and utility scripts into the directory
2280 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2281 .cindex "setuid" "installing Exim with"
2282 The install script copies files only if they are newer than the files they are
2283 going to replace. The Exim binary is required to be owned by root and have the
2284 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2285 install`& as root so that it can set up the Exim binary in this way. However, in
2286 some special situations (for example, if a host is doing no local deliveries)
2287 it may be possible to run Exim without making the binary setuid root (see
2288 chapter &<<CHAPsecurity>>& for details).
2289
2290 .cindex "CONFIGURE_FILE"
2291 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2292 in &_Local/Makefile_&. If this names a single file, and the file does not
2293 exist, the default configuration file &_src/configure.default_& is copied there
2294 by the installation script. If a runtime configuration file already exists, it
2295 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2296 alternative files, no default is installed.
2297
2298 .cindex "system aliases file"
2299 .cindex "&_/etc/aliases_&"
2300 One change is made to the default configuration file when it is installed: the
2301 default configuration contains a router that references a system aliases file.
2302 The path to this file is set to the value specified by
2303 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2304 If the system aliases file does not exist, the installation script creates it,
2305 and outputs a comment to the user.
2306
2307 The created file contains no aliases, but it does contain comments about the
2308 aliases a site should normally have. Mail aliases have traditionally been
2309 kept in &_/etc/aliases_&. However, some operating systems are now using
2310 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2311 Exim's configuration if necessary.
2312
2313 The default configuration uses the local host's name as the only local domain,
2314 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2315 running as the local user. System aliases and &_.forward_& files in users' home
2316 directories are supported, but no NIS or NIS+ support is configured. Domains
2317 other than the name of the local host are routed using the DNS, with delivery
2318 over SMTP.
2319
2320 It is possible to install Exim for special purposes (such as building a binary
2321 distribution) in a private part of the file system. You can do this by a
2322 command such as
2323 .code
2324 make DESTDIR=/some/directory/ install
2325 .endd
2326 This has the effect of pre-pending the specified directory to all the file
2327 paths, except the name of the system aliases file that appears in the default
2328 configuration. (If a default alias file is created, its name &'is'& modified.)
2329 For backwards compatibility, ROOT is used if DESTDIR is not set,
2330 but this usage is deprecated.
2331
2332 .cindex "installing Exim" "what is not installed"
2333 Running &'make install'& does not copy the Exim 4 conversion script
2334 &'convert4r4'&. You will probably run this only once if you are
2335 upgrading from Exim 3. None of the documentation files in the &_doc_&
2336 directory are copied, except for the info files when you have set
2337 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2338
2339 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2340 to their names. The Exim binary itself, however, is handled differently. It is
2341 installed under a name that includes the version number and the compile number,
2342 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2343 called &_exim_& to point to the binary. If you are updating a previous version
2344 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2345 from the directory (as seen by other processes).
2346
2347 .cindex "installing Exim" "testing the script"
2348 If you want to see what the &'make install'& will do before running it for
2349 real, you can pass the &%-n%& option to the installation script by this
2350 command:
2351 .code
2352 make INSTALL_ARG=-n install
2353 .endd
2354 The contents of the variable INSTALL_ARG are passed to the installation
2355 script. You do not need to be root to run this test. Alternatively, you can run
2356 the installation script directly, but this must be from within the build
2357 directory. For example, from the top-level Exim directory you could use this
2358 command:
2359 .code
2360 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2361 .endd
2362 .cindex "installing Exim" "install script options"
2363 There are two other options that can be supplied to the installation script.
2364
2365 .ilist
2366 &%-no_chown%& bypasses the call to change the owner of the installed binary
2367 to root, and the call to make it a setuid binary.
2368 .next
2369 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2370 installed binary.
2371 .endlist
2372
2373 INSTALL_ARG can be used to pass these options to the script. For example:
2374 .code
2375 make INSTALL_ARG=-no_symlink install
2376 .endd
2377 The installation script can also be given arguments specifying which files are
2378 to be copied. For example, to install just the Exim binary, and nothing else,
2379 without creating the symbolic link, you could use:
2380 .code
2381 make INSTALL_ARG='-no_symlink exim' install
2382 .endd
2383
2384
2385
2386 .section "Installing info documentation" "SECTinsinfdoc"
2387 .cindex "installing Exim" "&'info'& documentation"
2388 Not all systems use the GNU &'info'& system for documentation, and for this
2389 reason, the Texinfo source of Exim's documentation is not included in the main
2390 distribution. Instead it is available separately from the FTP site (see section
2391 &<<SECTavail>>&).
2392
2393 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2394 source of the documentation is found in the source tree, running &`make
2395 install`& automatically builds the info files and installs them.
2396
2397
2398
2399 .section "Setting up the spool directory" "SECID33"
2400 .cindex "spool directory" "creating"
2401 When it starts up, Exim tries to create its spool directory if it does not
2402 exist. The Exim uid and gid are used for the owner and group of the spool
2403 directory. Sub-directories are automatically created in the spool directory as
2404 necessary.
2405
2406
2407
2408
2409 .section "Testing" "SECID34"
2410 .cindex "testing" "installation"
2411 Having installed Exim, you can check that the runtime configuration file is
2412 syntactically valid by running the following command, which assumes that the
2413 Exim binary directory is within your PATH environment variable:
2414 .code
2415 exim -bV
2416 .endd
2417 If there are any errors in the configuration file, Exim outputs error messages.
2418 Otherwise it outputs the version number and build date,
2419 the DBM library that is being used, and information about which drivers and
2420 other optional code modules are included in the binary.
2421 Some simple routing tests can be done by using the address testing option. For
2422 example,
2423 .display
2424 &`exim -bt`& <&'local username'&>
2425 .endd
2426 should verify that it recognizes a local mailbox, and
2427 .display
2428 &`exim -bt`& <&'remote address'&>
2429 .endd
2430 a remote one. Then try getting it to deliver mail, both locally and remotely.
2431 This can be done by passing messages directly to Exim, without going through a
2432 user agent. For example:
2433 .code
2434 exim -v postmaster@your.domain.example
2435 From: user@your.domain.example
2436 To: postmaster@your.domain.example
2437 Subject: Testing Exim
2438
2439 This is a test message.
2440 ^D
2441 .endd
2442 The &%-v%& option causes Exim to output some verification of what it is doing.
2443 In this case you should see copies of three log lines, one for the message's
2444 arrival, one for its delivery, and one containing &"Completed"&.
2445
2446 .cindex "delivery" "problems with"
2447 If you encounter problems, look at Exim's log files (&'mainlog'& and
2448 &'paniclog'&) to see if there is any relevant information there. Another source
2449 of information is running Exim with debugging turned on, by specifying the
2450 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2451 with debugging turned on by a command of the form
2452 .display
2453 &`exim -d -M`& <&'exim-message-id'&>
2454 .endd
2455 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2456 produces rather a lot of output, but you can cut this down to specific areas.
2457 For example, if you use &%-d-all+route%& only the debugging information
2458 relevant to routing is included. (See the &%-d%& option in chapter
2459 &<<CHAPcommandline>>& for more details.)
2460
2461 .cindex '&"sticky"& bit'
2462 .cindex "lock files"
2463 One specific problem that has shown up on some sites is the inability to do
2464 local deliveries into a shared mailbox directory, because it does not have the
2465 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2466 writing to a mailbox file, and if it cannot create the lock file, the delivery
2467 is deferred. You can get round this either by setting the &"sticky bit"& on the
2468 directory, or by setting a specific group for local deliveries and allowing
2469 that group to create files in the directory (see the comments above the
2470 &(local_delivery)& transport in the default configuration file). Another
2471 approach is to configure Exim not to use lock files, but just to rely on
2472 &[fcntl()]& locking instead. However, you should do this only if all user
2473 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2474 see chapter &<<CHAPappendfile>>&.
2475
2476 One thing that cannot be tested on a system that is already running an MTA is
2477 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2478 &%-oX%& option can be used to run an Exim daemon that listens on some other
2479 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2480 &'exim_checkaccess'& utility can be used to check out policy controls on
2481 incoming SMTP mail.
2482
2483 Testing a new version on a system that is already running Exim can most easily
2484 be done by building a binary with a different CONFIGURE_FILE setting. From
2485 within the runtime configuration, all other file and directory names
2486 that Exim uses can be altered, in order to keep it entirely clear of the
2487 production version.
2488
2489
2490 .section "Replacing another MTA with Exim" "SECID35"
2491 .cindex "replacing another MTA"
2492 Building and installing Exim for the first time does not of itself put it in
2493 general use. The name by which the system's MTA is called by mail user agents
2494 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2495 operating system), and it is necessary to make this name point to the &'exim'&
2496 binary in order to get the user agents to pass messages to Exim. This is
2497 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2498 or &_/usr/lib/sendmail_&
2499 .cindex "symbolic link" "to &'exim'& binary"
2500 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2501 privilege and executable status from the old MTA. It is then necessary to stop
2502 and restart the mailer daemon, if one is running.
2503
2504 .cindex "FreeBSD, MTA indirection"
2505 .cindex "&_/etc/mail/mailer.conf_&"
2506 Some operating systems have introduced alternative ways of switching MTAs. For
2507 example, if you are running FreeBSD, you need to edit the file
2508 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2509 described. A typical example of the contents of this file for running Exim is
2510 as follows:
2511 .code
2512 sendmail            /usr/exim/bin/exim
2513 send-mail           /usr/exim/bin/exim
2514 mailq               /usr/exim/bin/exim -bp
2515 newaliases          /usr/bin/true
2516 .endd
2517 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2518 your Exim installation is &"live"&. Check it by sending a message from your
2519 favourite user agent.
2520
2521 You should consider what to tell your users about the change of MTA. Exim may
2522 have different capabilities to what was previously running, and there are
2523 various operational differences such as the text of messages produced by
2524 command line options and in bounce messages. If you allow your users to make
2525 use of Exim's filtering capabilities, you should make the document entitled
2526 &'Exim's interface to mail filtering'& available to them.
2527
2528
2529
2530 .section "Upgrading Exim" "SECID36"
2531 .cindex "upgrading Exim"
2532 If you are already running Exim on your host, building and installing a new
2533 version automatically makes it available to MUAs, or any other programs that
2534 call the MTA directly. However, if you are running an Exim daemon, you do need
2535 .cindex restart "on HUP signal"
2536 .cindex signal "HUP, to restart"
2537 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2538 new binary. You do not need to stop processing mail in order to install a new
2539 version of Exim. The install script does not modify an existing runtime
2540 configuration file.
2541
2542
2543
2544
2545 .section "Stopping the Exim daemon on Solaris" "SECID37"
2546 .cindex "Solaris" "stopping Exim on"
2547 The standard command for stopping the mailer daemon on Solaris is
2548 .code
2549 /etc/init.d/sendmail stop
2550 .endd
2551 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2552 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2553 for the text &"sendmail"&; this is not present because the actual program name
2554 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2555 solution is to replace the line that finds the process id with something like
2556 .code
2557 pid=`cat /var/spool/exim/exim-daemon.pid`
2558 .endd
2559 to obtain the daemon's pid directly from the file that Exim saves it in.
2560
2561 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2562 still be received from local processes, and if automatic delivery is configured
2563 (the normal case), deliveries will still occur.
2564
2565
2566
2567
2568 . ////////////////////////////////////////////////////////////////////////////
2569 . ////////////////////////////////////////////////////////////////////////////
2570
2571 .chapter "The Exim command line" "CHAPcommandline"
2572 .scindex IIDclo1 "command line" "options"
2573 .scindex IIDclo2 "options" "command line"
2574 Exim's command line takes the standard Unix form of a sequence of options,
2575 each starting with a hyphen character, followed by a number of arguments. The
2576 options are compatible with the main options of Sendmail, and there are also
2577 some additional options, some of which are compatible with Smail 3. Certain
2578 combinations of options do not make sense, and provoke an error if used.
2579 The form of the arguments depends on which options are set.
2580
2581
2582 .section "Setting options by program name" "SECID38"
2583 .cindex "&'mailq'&"
2584 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2585 were present before any other options.
2586 The &%-bp%& option requests a listing of the contents of the mail queue on the
2587 standard output.
2588 This feature is for compatibility with some systems that contain a command of
2589 that name in one of the standard libraries, symbolically linked to
2590 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2591
2592 .cindex "&'rsmtp'&"
2593 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2594 were present before any other options, for compatibility with Smail. The
2595 &%-bS%& option is used for reading in a number of messages in batched SMTP
2596 format.
2597
2598 .cindex "&'rmail'&"
2599 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2600 &%-oee%& options were present before any other options, for compatibility with
2601 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2602
2603 .cindex "&'runq'&"
2604 .cindex "queue runner"
2605 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2606 were present before any other options, for compatibility with Smail. The &%-q%&
2607 option causes a single queue runner process to be started.
2608
2609 .cindex "&'newaliases'&"
2610 .cindex "alias file" "building"
2611 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2612 If Exim is called under the name &'newaliases'& it behaves as if the option
2613 &%-bi%& were present before any other options, for compatibility with Sendmail.
2614 This option is used for rebuilding Sendmail's alias file. Exim does not have
2615 the concept of a single alias file, but can be configured to run a given
2616 command if called with the &%-bi%& option.
2617
2618
2619 .section "Trusted and admin users" "SECTtrustedadmin"
2620 Some Exim options are available only to &'trusted users'& and others are
2621 available only to &'admin users'&. In the description below, the phrases &"Exim
2622 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2623 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2624 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2625
2626 .ilist
2627 .cindex "trusted users" "definition of"
2628 .cindex "user" "trusted definition of"
2629 The trusted users are root, the Exim user, any user listed in the
2630 &%trusted_users%& configuration option, and any user whose current group or any
2631 supplementary group is one of those listed in the &%trusted_groups%&
2632 configuration option. Note that the Exim group is not automatically trusted.
2633
2634 .cindex '&"From"& line'
2635 .cindex "envelope from"
2636 .cindex "envelope sender"
2637 Trusted users are always permitted to use the &%-f%& option or a leading
2638 &"From&~"& line to specify the envelope sender of a message that is passed to
2639 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2640 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2641 users to set envelope senders.
2642
2643 .cindex "&'From:'& header line"
2644 .cindex "&'Sender:'& header line"
2645 .cindex "header lines" "From:"
2646 .cindex "header lines" "Sender:"
2647 For a trusted user, there is never any check on the contents of the &'From:'&
2648 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2649 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2650
2651 Trusted users may also specify a host name, host address, interface address,
2652 protocol name, ident value, and authentication data when submitting a message
2653 locally. Thus, they are able to insert messages into Exim's queue locally that
2654 have the characteristics of messages received from a remote host. Untrusted
2655 users may in some circumstances use &%-f%&, but can never set the other values
2656 that are available to trusted users.
2657 .next
2658 .cindex "user" "admin definition of"
2659 .cindex "admin user" "definition of"
2660 The admin users are root, the Exim user, and any user that is a member of the
2661 Exim group or of any group listed in the &%admin_groups%& configuration option.
2662 The current group does not have to be one of these groups.
2663
2664 Admin users are permitted to list the queue, and to carry out certain
2665 operations on messages, for example, to force delivery failures. It is also
2666 necessary to be an admin user in order to see the full information provided by
2667 the Exim monitor, and full debugging output.
2668
2669 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2670 Exim to attempt delivery of messages on its queue is restricted to admin users.
2671 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2672 option false (that is, specifying &%no_prod_requires_admin%&).
2673
2674 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2675 is restricted to admin users unless &%queue_list_requires_admin%& is set
2676 false.
2677 .endlist
2678
2679
2680 &*Warning*&: If you configure your system so that admin users are able to
2681 edit Exim's configuration file, you are giving those users an easy way of
2682 getting root. There is further discussion of this issue at the start of chapter
2683 &<<CHAPconf>>&.
2684
2685
2686
2687
2688 .section "Command line options" "SECID39"
2689 Exim's command line options are described in alphabetical order below. If none
2690 of the options that specifies a specific action (such as starting the daemon or
2691 a queue runner, or testing an address, or receiving a message in a specific
2692 format, or listing the queue) are present, and there is at least one argument
2693 on the command line, &%-bm%& (accept a local message on the standard input,
2694 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2695 outputs a brief message about itself and exits.
2696
2697 . ////////////////////////////////////////////////////////////////////////////
2698 . Insert a stylized XML comment here, to identify the start of the command line
2699 . options. This is for the benefit of the Perl script that automatically
2700 . creates a man page for the options.
2701 . ////////////////////////////////////////////////////////////////////////////
2702
2703 .literal xml
2704 <!-- === Start of command line options === -->
2705 .literal off
2706
2707
2708 .vlist
2709 .vitem &%--%&
2710 .oindex "--"
2711 .cindex "options" "command line; terminating"
2712 This is a pseudo-option whose only purpose is to terminate the options and
2713 therefore to cause subsequent command line items to be treated as arguments
2714 rather than options, even if they begin with hyphens.
2715
2716 .vitem &%--help%&
2717 .oindex "&%--help%&"
2718 This option causes Exim to output a few sentences stating what it is.
2719 The same output is generated if the Exim binary is called with no options and
2720 no arguments.
2721
2722 .vitem &%--version%&
2723 .oindex "&%--version%&"
2724 This option is an alias for &%-bV%& and causes version information to be
2725 displayed.
2726
2727 .vitem &%-Ac%& &&&
2728        &%-Am%&
2729 .oindex "&%-Ac%&"
2730 .oindex "&%-Am%&"
2731 These options are used by Sendmail for selecting configuration files and are
2732 ignored by Exim.
2733
2734 .vitem &%-B%&<&'type'&>
2735 .oindex "&%-B%&"
2736 .cindex "8-bit characters"
2737 .cindex "Sendmail compatibility" "8-bit characters"
2738 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2739 clean; it ignores this option.
2740
2741 .vitem &%-bd%&
2742 .oindex "&%-bd%&"
2743 .cindex "daemon"
2744 .cindex "SMTP" "listener"
2745 .cindex "queue runner"
2746 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2747 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2748 that the daemon should also initiate periodic queue runs.
2749
2750 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2751 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2752 disconnect from the controlling terminal. When running this way, it can be
2753 stopped by pressing ctrl-C.
2754
2755 By default, Exim listens for incoming connections to the standard SMTP port on
2756 all the host's running interfaces. However, it is possible to listen on other
2757 ports, on multiple ports, and only on specific interfaces. Chapter
2758 &<<CHAPinterfaces>>& contains a description of the options that control this.
2759
2760 When a listening daemon
2761 .cindex "daemon" "process id (pid)"
2762 .cindex "pid (process id)" "of daemon"
2763 is started without the use of &%-oX%& (that is, without overriding the normal
2764 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2765 in Exim's spool directory. This location can be overridden by setting
2766 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2767 running as root.
2768
2769 When &%-oX%& is used on the command line to start a listening daemon, the
2770 process id is not written to the normal pid file path. However, &%-oP%& can be
2771 used to specify a path on the command line if a pid file is required.
2772
2773 The SIGHUP signal
2774 .cindex "SIGHUP"
2775 .cindex restart "on HUP signal"
2776 .cindex signal "HUP, to restart"
2777 .cindex "daemon" "restarting"
2778 .cindex signal "to reload configuration"
2779 .cindex daemon "reload configuration"
2780 .cindex reload configuration
2781 can be used to cause the daemon to re-execute itself. This should be done
2782 whenever Exim's configuration file, or any file that is incorporated into it by
2783 means of the &%.include%& facility, is changed, and also whenever a new version
2784 of Exim is installed. It is not necessary to do this when other files that are
2785 referenced from the configuration (for example, alias files) are changed,
2786 because these are reread each time they are used.
2787
2788 .vitem &%-bdf%&
2789 .oindex "&%-bdf%&"
2790 This option has the same effect as &%-bd%& except that it never disconnects
2791 from the controlling terminal, even when no debugging is specified.
2792
2793 .vitem &%-be%&
2794 .oindex "&%-be%&"
2795 .cindex "testing" "string expansion"
2796 .cindex "expansion" "testing"
2797 Run Exim in expansion testing mode. Exim discards its root privilege, to
2798 prevent ordinary users from using this mode to read otherwise inaccessible
2799 files. If no arguments are given, Exim runs interactively, prompting for lines
2800 of data. Otherwise, it processes each argument in turn.
2801
2802 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2803 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2804 used without command line arguments. If successful, it uses the &[readline()]&
2805 function, which provides extensive line-editing facilities, for reading the
2806 test data. A line history is supported.
2807
2808 Long expansion expressions can be split over several lines by using backslash
2809 continuations. As in Exim's runtime configuration, white space at the start of
2810 continuation lines is ignored. Each argument or data line is passed through the
2811 string expansion mechanism, and the result is output. Variable values from the
2812 configuration file (for example, &$qualify_domain$&) are available, but no
2813 message-specific values (such as &$message_exim_id$&) are set, because no message
2814 is being processed (but see &%-bem%& and &%-Mset%&).
2815
2816 &*Note*&: If you use this mechanism to test lookups, and you change the data
2817 files or databases you are using, you must exit and restart Exim before trying
2818 the same lookup again. Otherwise, because each Exim process caches the results
2819 of lookups, you will just get the same result as before.
2820
2821 Macro processing is done on lines before string-expansion: new macros can be
2822 defined and macros will be expanded.
2823 Because macros in the config file are often used for secrets, those are only
2824 available to admin users.
2825
2826 .vitem &%-bem%&&~<&'filename'&>
2827 .oindex "&%-bem%&"
2828 .cindex "testing" "string expansion"
2829 .cindex "expansion" "testing"
2830 This option operates like &%-be%& except that it must be followed by the name
2831 of a file. For example:
2832 .code
2833 exim -bem /tmp/testmessage
2834 .endd
2835 The file is read as a message (as if receiving a locally-submitted non-SMTP
2836 message) before any of the test expansions are done. Thus, message-specific
2837 variables such as &$message_size$& and &$header_from:$& are available. However,
2838 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2839 recipients are read from the headers in the normal way, and are shown in the
2840 &$recipients$& variable. Note that recipients cannot be given on the command
2841 line, because further arguments are taken as strings to expand (just like
2842 &%-be%&).
2843
2844 .vitem &%-bF%&&~<&'filename'&>
2845 .oindex "&%-bF%&"
2846 .cindex "system filter" "testing"
2847 .cindex "testing" "system filter"
2848 This option is the same as &%-bf%& except that it assumes that the filter being
2849 tested is a system filter. The additional commands that are available only in
2850 system filters are recognized.
2851
2852 .vitem &%-bf%&&~<&'filename'&>
2853 .oindex "&%-bf%&"
2854 .cindex "filter" "testing"
2855 .cindex "testing" "filter file"
2856 .cindex "forward file" "testing"
2857 .cindex "testing" "forward file"
2858 .cindex "Sieve filter" "testing"
2859 This option runs Exim in user filter testing mode; the file is the filter file
2860 to be tested, and a test message must be supplied on the standard input. If
2861 there are no message-dependent tests in the filter, an empty file can be
2862 supplied.
2863
2864 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2865 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2866 filter and a user filter in the same run. For example:
2867 .code
2868 exim -bF /system/filter -bf /user/filter </test/message
2869 .endd
2870 This is helpful when the system filter adds header lines or sets filter
2871 variables that are used by the user filter.
2872
2873 If the test filter file does not begin with one of the special lines
2874 .code
2875 # Exim filter
2876 # Sieve filter
2877 .endd
2878 it is taken to be a normal &_.forward_& file, and is tested for validity under
2879 that interpretation. See sections &<<SECTitenonfilred>>& to
2880 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2881 redirection lists.
2882
2883 The result of an Exim command that uses &%-bf%&, provided no errors are
2884 detected, is a list of the actions that Exim would try to take if presented
2885 with the message for real. More details of filter testing are given in the
2886 separate document entitled &'Exim's interfaces to mail filtering'&.
2887
2888 When testing a filter file,
2889 .cindex "&""From""& line"
2890 .cindex "envelope from"
2891 .cindex "envelope sender"
2892 .oindex "&%-f%&" "for filter testing"
2893 the envelope sender can be set by the &%-f%& option,
2894 or by a &"From&~"& line at the start of the test message. Various parameters
2895 that would normally be taken from the envelope recipient address of the message
2896 can be set by means of additional command line options (see the next four
2897 options).
2898
2899 .vitem &%-bfd%&&~<&'domain'&>
2900 .oindex "&%-bfd%&"
2901 .vindex "&$qualify_domain$&"
2902 This sets the domain of the recipient address when a filter file is being
2903 tested by means of the &%-bf%& option. The default is the value of
2904 &$qualify_domain$&.
2905
2906 .vitem &%-bfl%&&~<&'local&~part'&>
2907 .oindex "&%-bfl%&"
2908 This sets the local part of the recipient address when a filter file is being
2909 tested by means of the &%-bf%& option. The default is the username of the
2910 process that calls Exim. A local part should be specified with any prefix or
2911 suffix stripped, because that is how it appears to the filter when a message is
2912 actually being delivered.
2913
2914 .vitem &%-bfp%&&~<&'prefix'&>
2915 .oindex "&%-bfp%&"
2916 .cindex affix "filter testing"
2917 This sets the prefix of the local part of the recipient address when a filter
2918 file is being tested by means of the &%-bf%& option. The default is an empty
2919 prefix.
2920
2921 .vitem &%-bfs%&&~<&'suffix'&>
2922 .oindex "&%-bfs%&"
2923 .cindex affix "filter testing"
2924 This sets the suffix of the local part of the recipient address when a filter
2925 file is being tested by means of the &%-bf%& option. The default is an empty
2926 suffix.
2927
2928 .vitem &%-bh%&&~<&'IP&~address'&>
2929 .oindex "&%-bh%&"
2930 .cindex "testing" "incoming SMTP"
2931 .cindex "SMTP" "testing incoming"
2932 .cindex "testing" "relay control"
2933 .cindex "relaying" "testing configuration"
2934 .cindex "policy control" "testing"
2935 .cindex "debugging" "&%-bh%& option"
2936 This option runs a fake SMTP session as if from the given IP address, using the
2937 standard input and output. The IP address may include a port number at the end,
2938 after a full stop. For example:
2939 .code
2940 exim -bh 10.9.8.7.1234
2941 exim -bh fe80::a00:20ff:fe86:a061.5678
2942 .endd
2943 When an IPv6 address is given, it is converted into canonical form. In the case
2944 of the second example above, the value of &$sender_host_address$& after
2945 conversion to the canonical form is
2946 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2947
2948 Comments as to what is going on are written to the standard error file. These
2949 include lines beginning with &"LOG"& for anything that would have been logged.
2950 This facility is provided for testing configuration options for incoming
2951 messages, to make sure they implement the required policy. For example, you can
2952 test your relay controls using &%-bh%&.
2953
2954 &*Warning 1*&:
2955 .cindex "RFC 1413"
2956 You can test features of the configuration that rely on ident (RFC 1413)
2957 information by using the &%-oMt%& option. However, Exim cannot actually perform
2958 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2959 connection.
2960
2961 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2962 are also skipped when testing using &%-bh%&. If you want these callouts to
2963 occur, use &%-bhc%& instead.
2964
2965 Messages supplied during the testing session are discarded, and nothing is
2966 written to any of the real log files. There may be pauses when DNS (and other)
2967 lookups are taking place, and of course these may time out. The &%-oMi%& option
2968 can be used to specify a specific IP interface and port if this is important,
2969 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2970 session were authenticated.
2971
2972 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2973 output just states whether a given recipient address from a given host is
2974 acceptable or not. See section &<<SECTcheckaccess>>&.
2975
2976 Features such as authentication and encryption, where the client input is not
2977 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2978 specialized SMTP test program such as
2979 &url(https://www.jetmore.org/john/code/swaks/,swaks).
2980
2981 .vitem &%-bhc%&&~<&'IP&~address'&>
2982 .oindex "&%-bhc%&"
2983 This option operates in the same way as &%-bh%&, except that address
2984 verification callouts are performed if required. This includes consulting and
2985 updating the callout cache database.
2986
2987 .vitem &%-bi%&
2988 .oindex "&%-bi%&"
2989 .cindex "alias file" "building"
2990 .cindex "building alias file"
2991 .cindex "Sendmail compatibility" "&%-bi%& option"
2992 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2993 Exim does not have the concept of a single alias file, and so it cannot mimic
2994 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2995 tend to appear in various scripts such as NIS make files, so the option must be
2996 recognized.
2997
2998 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2999 configuration option is run, under the uid and gid of the caller of Exim. If
3000 the &%-oA%& option is used, its value is passed to the command as an argument.
3001 The command set by &%bi_command%& may not contain arguments. The command can
3002 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3003 if this is required. If the &%bi_command%& option is not set, calling Exim with
3004 &%-bi%& is a no-op.
3005
3006 . // Keep :help first, then the rest in alphabetical order
3007 .vitem &%-bI:help%&
3008 .oindex "&%-bI:help%&"
3009 .cindex "querying exim information"
3010 We shall provide various options starting &`-bI:`& for querying Exim for
3011 information.  The output of many of these will be intended for machine
3012 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3013 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3014 options shall cause Exim to exit after producing the requested output.
3015
3016 .vitem &%-bI:dscp%&
3017 .oindex "&%-bI:dscp%&"
3018 .cindex "DSCP" "values"
3019 This option causes Exim to emit an alphabetically sorted list of all
3020 recognised DSCP names.
3021
3022 .vitem &%-bI:sieve%&
3023 .oindex "&%-bI:sieve%&"
3024 .cindex "Sieve filter" "capabilities"
3025 This option causes Exim to emit an alphabetically sorted list of all supported
3026 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3027 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3028 &`SIEVE`& capability response line.  As the precise list may depend upon
3029 compile-time build options, which this option will adapt to, this is the only
3030 way to guarantee a correct response.
3031
3032 .vitem &%-bm%&
3033 .oindex "&%-bm%&"
3034 .cindex "local message reception"
3035 This option runs an Exim receiving process that accepts an incoming,
3036 locally-generated message on the standard input. The recipients are given as the
3037 command arguments (except when &%-t%& is also present &-- see below). Each
3038 argument can be a comma-separated list of RFC 2822 addresses. This is the
3039 default option for selecting the overall action of an Exim call; it is assumed
3040 if no other conflicting option is present.
3041
3042 If any addresses in the message are unqualified (have no domain), they are
3043 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3044 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3045 suppressing this for special cases.
3046
3047 Policy checks on the contents of local messages can be enforced by means of
3048 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3049
3050 .cindex "return code" "for &%-bm%&"
3051 The return code is zero if the message is successfully accepted. Otherwise, the
3052 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3053
3054 The format
3055 .cindex "message" "format"
3056 .cindex "format" "message"
3057 .cindex "&""From""& line"
3058 .cindex "UUCP" "&""From""& line"
3059 .cindex "Sendmail compatibility" "&""From""& line"
3060 of the message must be as defined in RFC 2822, except that, for
3061 compatibility with Sendmail and Smail, a line in one of the forms
3062 .code
3063 From sender Fri Jan  5 12:55 GMT 1997
3064 From sender Fri, 5 Jan 97 12:55:01
3065 .endd
3066 (with the weekday optional, and possibly with additional text after the date)
3067 is permitted to appear at the start of the message. There appears to be no
3068 authoritative specification of the format of this line. Exim recognizes it by
3069 matching against the regular expression defined by the &%uucp_from_pattern%&
3070 option, which can be changed if necessary.
3071
3072 .oindex "&%-f%&" "overriding &""From""& line"
3073 The specified sender is treated as if it were given as the argument to the
3074 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3075 preference to the address taken from the message. The caller of Exim must be a
3076 trusted user for the sender of a message to be set in this way.
3077
3078 .vitem &%-bmalware%&&~<&'filename'&>
3079 .oindex "&%-bmalware%&"
3080 .cindex "testing", "malware"
3081 .cindex "malware scan test"
3082 This debugging option causes Exim to scan the given file or directory
3083 (depending on the used scanner interface),
3084 using the malware scanning framework.  The option of &%av_scanner%& influences
3085 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3086 the expansion should have defaults which apply to this invocation.  ACLs are
3087 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3088 will never be populated and &%-bmalware%& will fail.
3089
3090 Exim will have changed working directory before resolving the filename, so
3091 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3092 user when it tries to open the file, rather than as the invoking user.
3093 This option requires admin privileges.
3094
3095 The &%-bmalware%& option will not be extended to be more generally useful,
3096 there are better tools for file-scanning.  This option exists to help
3097 administrators verify their Exim and AV scanner configuration.
3098
3099 .vitem &%-bnq%&
3100 .oindex "&%-bnq%&"
3101 .cindex "address qualification, suppressing"
3102 By default, Exim automatically qualifies unqualified addresses (those
3103 without domains) that appear in messages that are submitted locally (that
3104 is, not over TCP/IP). This qualification applies both to addresses in
3105 envelopes, and addresses in header lines. Sender addresses are qualified using
3106 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3107 defaults to the value of &%qualify_domain%&).
3108
3109 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3110 being used to re-submit messages that originally came from remote hosts after
3111 content scanning, you probably do not want to qualify unqualified addresses in
3112 header lines. (Such lines will be present only if you have not enabled a header
3113 syntax check in the appropriate ACL.)
3114
3115 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3116 messages that originate on the local host. When this is used, unqualified
3117 addresses in the envelope provoke errors (causing message rejection) and
3118 unqualified addresses in header lines are left alone.
3119
3120
3121 .vitem &%-bP%&
3122 .oindex "&%-bP%&"
3123 .cindex "configuration options" "extracting"
3124 .cindex "options" "configuration &-- extracting"
3125 If this option is given with no arguments, it causes the values of all Exim's
3126 main configuration options to be written to the standard output. The values
3127 of one or more specific options can be requested by giving their names as
3128 arguments, for example:
3129 .code
3130 exim -bP qualify_domain hold_domains
3131 .endd
3132 .cindex "hiding configuration option values"
3133 .cindex "configuration options" "hiding value of"
3134 .cindex "options" "hiding value of"
3135 However, any option setting that is preceded by the word &"hide"& in the
3136 configuration file is not shown in full, except to an admin user. For other
3137 users, the output is as in this example:
3138 .code
3139 mysql_servers = <value not displayable>
3140 .endd
3141 If &%config%& is given as an argument, the config is
3142 output, as it was parsed, any include file resolved, any comment removed.
3143
3144 If &%config_file%& is given as an argument, the name of the runtime
3145 configuration file is output. (&%configure_file%& works too, for
3146 backward compatibility.)
3147 If a list of configuration files was supplied, the value that is output here
3148 is the name of the file that was actually used.
3149
3150 .cindex "options" "hiding name of"
3151 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3152 name will not be output.
3153
3154 .cindex "daemon" "process id (pid)"
3155 .cindex "pid (process id)" "of daemon"
3156 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3157 directories where log files and daemon pid files are written are output,
3158 respectively. If these values are unset, log files are written in a
3159 sub-directory of the spool directory called &%log%&, and the pid file is
3160 written directly into the spool directory.
3161
3162 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3163 .code
3164 exim -bP +local_domains
3165 .endd
3166 it searches for a matching named list of any type (domain, host, address, or
3167 local part) and outputs what it finds.
3168
3169 .cindex "options" "router &-- extracting"
3170 .cindex "options" "transport &-- extracting"
3171 .cindex "options" "authenticator &-- extracting"
3172 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3173 followed by the name of an appropriate driver instance, the option settings for
3174 that driver are output. For example:
3175 .code
3176 exim -bP transport local_delivery
3177 .endd
3178 The generic driver options are output first, followed by the driver's private
3179 options. A list of the names of drivers of a particular type can be obtained by
3180 using one of the words &%router_list%&, &%transport_list%&, or
3181 &%authenticator_list%&, and a complete list of all drivers with their option
3182 settings can be obtained by using &%routers%&, &%transports%&, or
3183 &%authenticators%&.
3184
3185 .cindex "environment"
3186 If &%environment%& is given as an argument, the set of environment
3187 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3188 variables.
3189
3190 .cindex "options" "macro &-- extracting"
3191 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3192 are available, similarly to the drivers.  Because macros are sometimes used
3193 for storing passwords, this option is restricted.
3194 The output format is one item per line.
3195 For the "-bP macro <name>" form, if no such macro is found
3196 the exit status will be nonzero.
3197
3198 .vitem &%-bp%&
3199 .oindex "&%-bp%&"
3200 .cindex "queue" "listing messages in"
3201 .cindex "listing" "messages in the queue"
3202 This option requests a listing of the contents of the mail queue on the
3203 standard output. If the &%-bp%& option is followed by a list of message ids,
3204 just those messages are listed. By default, this option can be used only by an
3205 admin user. However, the &%queue_list_requires_admin%& option can be set false
3206 to allow any user to see the queue.
3207
3208 Each message in the queue is displayed as in the following example:
3209 .code
3210 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3211           red.king@looking-glass.fict.example
3212           <other addresses>
3213 .endd
3214 .cindex "message" "size in queue listing"
3215 .cindex "size" "of message"
3216 The first line contains the length of time the message has been in the queue
3217 (in this case 25 minutes), the size of the message (2.9K), the unique local
3218 identifier for the message, and the message sender, as contained in the
3219 envelope. For bounce messages, the sender address is empty, and appears as
3220 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3221 the default sender address, the user's login name is shown in parentheses
3222 before the sender address.
3223
3224 .cindex "frozen messages" "in queue listing"
3225 If the message is frozen (attempts to deliver it are suspended) then the text
3226 &"*** frozen ***"& is displayed at the end of this line.
3227
3228 The recipients of the message (taken from the envelope, not the headers) are
3229 displayed on subsequent lines. Those addresses to which the message has already
3230 been delivered are marked with the letter D. If an original address gets
3231 expanded into several addresses via an alias or forward file, the original is
3232 displayed with a D only when deliveries for all of its child addresses are
3233 complete.
3234
3235
3236 .vitem &%-bpa%&
3237 .oindex "&%-bpa%&"
3238 This option operates like &%-bp%&, but in addition it shows delivered addresses
3239 that were generated from the original top level address(es) in each message by
3240 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3241 of just &"D"&.
3242
3243
3244 .vitem &%-bpc%&
3245 .oindex "&%-bpc%&"
3246 .cindex "queue" "count of messages on"
3247 This option counts the number of messages in the queue, and writes the total
3248 to the standard output. It is restricted to admin users, unless
3249 &%queue_list_requires_admin%& is set false.
3250
3251
3252 .vitem &%-bpr%&
3253 .oindex "&%-bpr%&"
3254 This option operates like &%-bp%&, but the output is not sorted into
3255 chronological order of message arrival. This can speed it up when there are
3256 lots of messages in the queue, and is particularly useful if the output is
3257 going to be post-processed in a way that doesn't need the sorting.
3258
3259 .vitem &%-bpra%&
3260 .oindex "&%-bpra%&"
3261 This option is a combination of &%-bpr%& and &%-bpa%&.
3262
3263 .vitem &%-bpru%&
3264 .oindex "&%-bpru%&"
3265 This option is a combination of &%-bpr%& and &%-bpu%&.
3266
3267
3268 .vitem &%-bpu%&
3269 .oindex "&%-bpu%&"
3270 This option operates like &%-bp%& but shows only undelivered top-level
3271 addresses for each message displayed. Addresses generated by aliasing or
3272 forwarding are not shown, unless the message was deferred after processing by a
3273 router with the &%one_time%& option set.
3274
3275
3276 .vitem &%-brt%&
3277 .oindex "&%-brt%&"
3278 .cindex "testing" "retry configuration"
3279 .cindex "retry" "configuration testing"
3280 This option is for testing retry rules, and it must be followed by up to three
3281 arguments. It causes Exim to look for a retry rule that matches the values
3282 and to write it to the standard output. For example:
3283 .code
3284 exim -brt bach.comp.mus.example
3285 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3286 .endd
3287 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3288 argument, which is required, can be a complete address in the form
3289 &'local_part@domain'&, or it can be just a domain name. If the second argument
3290 contains a dot, it is interpreted as an optional second domain name; if no
3291 retry rule is found for the first argument, the second is tried. This ties in
3292 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3293 rule is found that matches the host, one that matches the mail domain is
3294 sought. Finally, an argument that is the name of a specific delivery error, as
3295 used in setting up retry rules, can be given. For example:
3296 .code
3297 exim -brt haydn.comp.mus.example quota_3d
3298 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3299 .endd
3300
3301 .vitem &%-brw%&
3302 .oindex "&%-brw%&"
3303 .cindex "testing" "rewriting"
3304 .cindex "rewriting" "testing"
3305 This option is for testing address rewriting rules, and it must be followed by
3306 a single argument, consisting of either a local part without a domain, or a
3307 complete address with a fully qualified domain. Exim outputs how this address
3308 would be rewritten for each possible place it might appear. See chapter
3309 &<<CHAPrewrite>>& for further details.
3310
3311 .vitem &%-bS%&
3312 .oindex "&%-bS%&"
3313 .cindex "SMTP" "batched incoming"
3314 .cindex "batched SMTP input"
3315 This option is used for batched SMTP input, which is an alternative interface
3316 for non-interactive local message submission. A number of messages can be
3317 submitted in a single run. However, despite its name, this is not really SMTP
3318 input. Exim reads each message's envelope from SMTP commands on the standard
3319 input, but generates no responses. If the caller is trusted, or
3320 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3321 believed; otherwise the sender is always the caller of Exim.
3322
3323 The message itself is read from the standard input, in SMTP format (leading
3324 dots doubled), terminated by a line containing just a single dot. An error is
3325 provoked if the terminating dot is missing. A further message may then follow.
3326
3327 As for other local message submissions, the contents of incoming batch SMTP
3328 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3329 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3330 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3331
3332 Some other SMTP commands are recognized in the input. HELO and EHLO act
3333 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3334 QUIT quits, ignoring the rest of the standard input.
3335
3336 .cindex "return code" "for &%-bS%&"
3337 If any error is encountered, reports are written to the standard output and
3338 error streams, and Exim gives up immediately. The return code is 0 if no error
3339 was detected; it is 1 if one or more messages were accepted before the error
3340 was detected; otherwise it is 2.
3341
3342 More details of input using batched SMTP are given in section
3343 &<<SECTincomingbatchedSMTP>>&.
3344
3345 .vitem &%-bs%&
3346 .oindex "&%-bs%&"
3347 .cindex "SMTP" "local input"
3348 .cindex "local SMTP input"
3349 This option causes Exim to accept one or more messages by reading SMTP commands
3350 on the standard input, and producing SMTP replies on the standard output. SMTP
3351 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3352 Some user agents use this interface as a way of passing locally-generated
3353 messages to the MTA.
3354
3355 In
3356 .cindex "sender" "source of"
3357 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3358 set, the senders of messages are taken from the SMTP MAIL commands.
3359 Otherwise the content of these commands is ignored and the sender is set up as
3360 the calling user. Unqualified addresses are automatically qualified using
3361 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3362 &%-bnq%& option is used.
3363
3364 .cindex "inetd"
3365 The
3366 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3367 using a listening daemon. Exim can distinguish the two cases by checking
3368 whether the standard input is a TCP/IP socket. When Exim is called from
3369 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3370 above concerning senders and qualification do not apply. In this situation,
3371 Exim behaves in exactly the same way as it does when receiving a message via
3372 the listening daemon.
3373
3374 .vitem &%-bt%&
3375 .oindex "&%-bt%&"
3376 .cindex "testing" "addresses"
3377 .cindex "address" "testing"
3378 This option runs Exim in address testing mode, in which each argument is taken
3379 as a recipient address to be tested for deliverability. The results are
3380 written to the standard output. If a test fails, and the caller is not an admin
3381 user, no details of the failure are output, because these might contain
3382 sensitive information such as usernames and passwords for database lookups.
3383
3384 If no arguments are given, Exim runs in an interactive manner, prompting with a
3385 right angle bracket for addresses to be tested.
3386
3387 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3388 &[readline()]& function, because it is running as &'root'& and there are
3389 security issues.
3390
3391 Each address is handled as if it were the recipient address of a message
3392 (compare the &%-bv%& option). It is passed to the routers and the result is
3393 written to the standard output. However, any router that has
3394 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3395 genuine routing tests if your first router passes everything to a scanner
3396 program.
3397
3398 .cindex "return code" "for &%-bt%&"
3399 The return code is 2 if any address failed outright; it is 1 if no address
3400 failed outright but at least one could not be resolved for some reason. Return
3401 code 0 is given only when all addresses succeed.
3402
3403 .cindex "duplicate addresses"
3404 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3405 addresses after routing is complete, so that only one delivery takes place.
3406 This does not happen when testing with &%-bt%&; the full results of routing are
3407 always shown.
3408
3409 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3410 routers in the configuration makes any tests on the sender address of a
3411 message,
3412 .oindex "&%-f%&" "for address testing"
3413 you can use the &%-f%& option to set an appropriate sender when running
3414 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3415 default qualifying domain. However, if you have set up (for example) routers
3416 whose behaviour depends on the contents of an incoming message, you cannot test
3417 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3418 doing such tests.
3419
3420 .vitem &%-bV%&
3421 .oindex "&%-bV%&"
3422 .cindex "version number of Exim"
3423 This option causes Exim to write the current version number, compilation
3424 number, and compilation date of the &'exim'& binary to the standard output.
3425 It also lists the DBM library that is being used, the optional modules (such as
3426 specific lookup types), the drivers that are included in the binary, and the
3427 name of the runtime configuration file that is in use.
3428
3429 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3430 configuration file. However, this is a static check only. It cannot check
3431 values that are to be expanded. For example, although a misspelt ACL verb is
3432 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3433 alone to discover (for example) all the typos in the configuration; some
3434 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3435 dynamic testing facilities.
3436
3437 .vitem &%-bv%&
3438 .oindex "&%-bv%&"
3439 .cindex "verifying address" "using &%-bv%&"
3440 .cindex "address" "verification"
3441 This option runs Exim in address verification mode, in which each argument is
3442 taken as a recipient address to be verified by the routers. (This does
3443 not involve any verification callouts). During normal operation, verification
3444 happens mostly as a consequence processing a &%verify%& condition in an ACL
3445 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3446 including callouts, see the &%-bh%& and &%-bhc%& options.
3447
3448 If verification fails, and the caller is not an admin user, no details of the
3449 failure are output, because these might contain sensitive information such as
3450 usernames and passwords for database lookups.
3451
3452 If no arguments are given, Exim runs in an interactive manner, prompting with a
3453 right angle bracket for addresses to be verified.
3454
3455 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3456 &[readline()]& function, because it is running as &'exim'& and there are
3457 security issues.
3458
3459 Verification differs from address testing (the &%-bt%& option) in that routers
3460 that have &%no_verify%& set are skipped, and if the address is accepted by a
3461 router that has &%fail_verify%& set, verification fails. The address is
3462 verified as a recipient if &%-bv%& is used; to test verification for a sender
3463 address, &%-bvs%& should be used.
3464
3465 If the &%-v%& option is not set, the output consists of a single line for each
3466 address, stating whether it was verified or not, and giving a reason in the
3467 latter case. Without &%-v%&, generating more than one address by redirection
3468 causes verification to end successfully, without considering the generated
3469 addresses. However, if just one address is generated, processing continues,
3470 and the generated address must verify successfully for the overall verification
3471 to succeed.
3472
3473 When &%-v%& is set, more details are given of how the address has been handled,
3474 and in the case of address redirection, all the generated addresses are also
3475 considered. Verification may succeed for some and fail for others.
3476
3477 The
3478 .cindex "return code" "for &%-bv%&"
3479 return code is 2 if any address failed outright; it is 1 if no address
3480 failed outright but at least one could not be resolved for some reason. Return
3481 code 0 is given only when all addresses succeed.
3482
3483 If any of the routers in the configuration makes any tests on the sender
3484 address of a message, you should use the &%-f%& option to set an appropriate
3485 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3486 calling user at the default qualifying domain.
3487
3488 .vitem &%-bvs%&
3489 .oindex "&%-bvs%&"
3490 This option acts like &%-bv%&, but verifies the address as a sender rather
3491 than a recipient address. This affects any rewriting and qualification that
3492 might happen.
3493
3494 .vitem &%-bw%&
3495 .oindex "&%-bw%&"
3496 .cindex "daemon"
3497 .cindex "inetd"
3498 .cindex "inetd" "wait mode"
3499 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3500 similarly to the &%-bd%& option.  All port specifications on the command-line
3501 and in the configuration file are ignored.  Queue-running may not be specified.
3502
3503 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3504 listening for connections.  This permits the system to start up and have
3505 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3506 each port only when the first connection is received.
3507
3508 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3509 which the daemon will exit, which should cause inetd to listen once more.
3510
3511 .vitem &%-C%&&~<&'filelist'&>
3512 .oindex "&%-C%&"
3513 .cindex "configuration file" "alternate"
3514 .cindex "CONFIGURE_FILE"
3515 .cindex "alternate configuration file"
3516 This option causes Exim to find the runtime configuration file from the given
3517 list instead of from the list specified by the CONFIGURE_FILE
3518 compile-time setting. Usually, the list will consist of just a single filename,
3519 but it can be a colon-separated list of names. In this case, the first
3520 file that exists is used. Failure to open an existing file stops Exim from
3521 proceeding any further along the list, and an error is generated.
3522
3523 When this option is used by a caller other than root, and the list is different
3524 from the compiled-in list, Exim gives up its root privilege immediately, and
3525 runs with the real and effective uid and gid set to those of the caller.
3526 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3527 file contains a list of full pathnames, one per line, for configuration files
3528 which are trusted. Root privilege is retained for any configuration file so
3529 listed, as long as the caller is the Exim user (or the user specified in the
3530 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3531 not writeable by inappropriate users or groups.
3532
3533 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3534 configuration using &%-C%& right through message reception and delivery,
3535 even if the caller is root. The reception works, but by that time, Exim is
3536 running as the Exim user, so when it re-executes to regain privilege for the
3537 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3538 test reception and delivery using two separate commands (one to put a message
3539 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3540
3541 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3542 prefix string with which any file named in a &%-C%& command line option
3543 must start. In addition, the filename must not contain the sequence &`/../`&.
3544 However, if the value of the &%-C%& option is identical to the value of
3545 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3546 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3547 unset, any filename can be used with &%-C%&.
3548
3549 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3550 to a directory to which only root has access. This prevents someone who has
3551 broken into the Exim account from running a privileged Exim with an arbitrary
3552 configuration file.
3553
3554 The &%-C%& facility is useful for ensuring that configuration files are
3555 syntactically correct, but cannot be used for test deliveries, unless the
3556 caller is privileged, or unless it is an exotic configuration that does not
3557 require privilege. No check is made on the owner or group of the files
3558 specified by this option.
3559
3560
3561 .vitem &%-D%&<&'macro'&>=<&'value'&>
3562 .oindex "&%-D%&"
3563 .cindex "macro" "setting on command line"
3564 This option can be used to override macro definitions in the configuration file
3565 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3566 unprivileged caller, it causes Exim to give up its root privilege.
3567 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3568 completely disabled, and its use causes an immediate error exit.
3569
3570 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3571 colon-separated list of macros which are considered safe and, if &%-D%& only
3572 supplies macros from this list, and the values are acceptable, then Exim will
3573 not give up root privilege if the caller is root, the Exim run-time user, or
3574 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3575 to be removed in the future.  Acceptable values for the macros satisfy the
3576 regexp: &`^[A-Za-z0-9_/.-]*$`&
3577
3578 The entire option (including equals sign if present) must all be within one
3579 command line item. &%-D%& can be used to set the value of a macro to the empty
3580 string, in which case the equals sign is optional. These two commands are
3581 synonymous:
3582 .code
3583 exim -DABC  ...
3584 exim -DABC= ...
3585 .endd
3586 To include spaces in a macro definition item, quotes must be used. If you use
3587 quotes, spaces are permitted around the macro name and the equals sign. For
3588 example:
3589 .code
3590 exim '-D ABC = something' ...
3591 .endd
3592 &%-D%& may be repeated up to 10 times on a command line.
3593 Only macro names up to 22 letters long can be set.
3594
3595
3596 .vitem &%-d%&<&'debug&~options'&>
3597 .oindex "&%-d%&"
3598 .cindex "debugging" "list of selectors"
3599 .cindex "debugging" "&%-d%& option"
3600 This option causes debugging information to be written to the standard
3601 error stream. It is restricted to admin users because debugging output may show
3602 database queries that contain password information. Also, the details of users'
3603 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3604 writes an error message to the standard error stream and exits with a non-zero
3605 return code.
3606
3607 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3608 standard debugging data is output. This can be reduced, or increased to include
3609 some more rarely needed information, by directly following &%-d%& with a string
3610 made up of names preceded by plus or minus characters. These add or remove sets
3611 of debugging data, respectively. For example, &%-d+filter%& adds filter
3612 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3613 no spaces are allowed in the debug setting. The available debugging categories
3614 are:
3615 .display
3616 &`acl            `& ACL interpretation
3617 &`auth           `& authenticators
3618 &`deliver        `& general delivery logic
3619 &`dns            `& DNS lookups (see also resolver)
3620 &`dnsbl          `& DNS black list (aka RBL) code
3621 &`exec           `& arguments for &[execv()]& calls
3622 &`expand         `& detailed debugging for string expansions
3623 &`filter         `& filter handling
3624 &`hints_lookup   `& hints data lookups
3625 &`host_lookup    `& all types of name-to-IP address handling
3626 &`ident          `& ident lookup
3627 &`interface      `& lists of local interfaces
3628 &`lists          `& matching things in lists
3629 &`load           `& system load checks
3630 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3631                     &<<CHAPlocalscan>>&)
3632 &`lookup         `& general lookup code and all lookups
3633 &`memory         `& memory handling
3634 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3635 &`pid            `& modifier: add pid to debug output lines
3636 &`process_info   `& setting info for the process log
3637 &`queue_run      `& queue runs
3638 &`receive        `& general message reception logic
3639 &`resolver       `& turn on the DNS resolver's debugging output
3640 &`retry          `& retry handling
3641 &`rewrite        `& address rewriting
3642 &`route          `& address routing
3643 &`timestamp      `& modifier: add timestamp to debug output lines
3644 &`tls            `& TLS logic
3645 &`transport      `& transports
3646 &`uid            `& changes of uid/gid and looking up uid/gid
3647 &`verify         `& address verification logic
3648 &`all            `& almost all of the above (see below), and also &%-v%&
3649 .endd
3650 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3651 for &`-all`&. The reason for this is that &`+all`& is something that people
3652 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3653 is included, an awful lot of output that is very rarely of interest is
3654 generated, so it now has to be explicitly requested. However, &`-all`& does
3655 turn everything off.
3656
3657 .cindex "resolver, debugging output"
3658 .cindex "DNS resolver, debugging output"
3659 The &`resolver`& option produces output only if the DNS resolver was compiled
3660 with DEBUG enabled. This is not the case in some operating systems. Also,
3661 unfortunately, debugging output from the DNS resolver is written to stdout
3662 rather than stderr.
3663
3664 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3665 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3666 However, the &`pid`& selector is forced when debugging is turned on for a
3667 daemon, which then passes it on to any re-executed Exims. Exim also
3668 automatically adds the pid to debug lines when several remote deliveries are
3669 run in parallel.
3670
3671 The &`timestamp`& selector causes the current time to be inserted at the start
3672 of all debug output lines. This can be useful when trying to track down delays
3673 in processing.
3674
3675 .cindex debugging "UTF-8 in"
3676 .cindex UTF-8 "in debug output"
3677 The &`noutf8`& selector disables the use of
3678 UTF-8 line-drawing characters to group related information.
3679 When disabled. ascii-art is used instead.
3680 Using the &`+all`& option does not set this modifier,
3681
3682 If the &%debug_print%& option is set in any driver, it produces output whenever
3683 any debugging is selected, or if &%-v%& is used.
3684
3685 .vitem &%-dd%&<&'debug&~options'&>
3686 .oindex "&%-dd%&"
3687 This option behaves exactly like &%-d%& except when used on a command that
3688 starts a daemon process. In that case, debugging is turned off for the
3689 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3690 behaviour of the daemon without creating as much output as full debugging does.
3691
3692 .vitem &%-dropcr%&
3693 .oindex "&%-dropcr%&"
3694 This is an obsolete option that is now a no-op. It used to affect the way Exim
3695 handled CR and LF characters in incoming messages. What happens now is
3696 described in section &<<SECTlineendings>>&.
3697
3698 .vitem &%-E%&
3699 .oindex "&%-E%&"
3700 .cindex "bounce message" "generating"
3701 This option specifies that an incoming message is a locally-generated delivery
3702 failure report. It is used internally by Exim when handling delivery failures
3703 and is not intended for external use. Its only effect is to stop Exim
3704 generating certain messages to the postmaster, as otherwise message cascades
3705 could occur in some situations. As part of the same option, a message id may
3706 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3707 new message contains the id, following &"R="&, as a cross-reference.
3708
3709 .vitem &%-e%&&'x'&
3710 .oindex "&%-e%&&'x'&"
3711 There are a number of Sendmail options starting with &%-oe%& which seem to be
3712 called by various programs without the leading &%o%& in the option. For
3713 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3714 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3715
3716 .vitem &%-F%&&~<&'string'&>
3717 .oindex "&%-F%&"
3718 .cindex "sender" "name"
3719 .cindex "name" "of sender"
3720 This option sets the sender's full name for use when a locally-generated
3721 message is being accepted. In the absence of this option, the user's &'gecos'&
3722 entry from the password data is used. As users are generally permitted to alter
3723 their &'gecos'& entries, no security considerations are involved. White space
3724 between &%-F%& and the <&'string'&> is optional.
3725
3726 .vitem &%-f%&&~<&'address'&>
3727 .oindex "&%-f%&"
3728 .cindex "sender" "address"
3729 .cindex "address" "sender"
3730 .cindex "trusted users"
3731 .cindex "envelope from"
3732 .cindex "envelope sender"
3733 .cindex "user" "trusted"
3734 This option sets the address of the envelope sender of a locally-generated
3735 message (also known as the return path). The option can normally be used only
3736 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3737 users to use it.
3738
3739 Processes running as root or the Exim user are always trusted. Other
3740 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3741 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3742 of a local message is set to the caller's login name at the default qualify
3743 domain.
3744
3745 There is one exception to the restriction on the use of &%-f%&: an empty sender
3746 can be specified by any user, trusted or not, to create a message that can
3747 never provoke a bounce. An empty sender can be specified either as an empty
3748 string, or as a pair of angle brackets with nothing between them, as in these
3749 examples of shell commands:
3750 .code
3751 exim -f '<>' user@domain
3752 exim -f "" user@domain
3753 .endd
3754 In addition, the use of &%-f%& is not restricted when testing a filter file
3755 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3756 &%-bv%& options.
3757
3758 Allowing untrusted users to change the sender address does not of itself make
3759 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3760 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3761 though this can be overridden by setting &%no_local_from_check%&.
3762
3763 White
3764 .cindex "&""From""& line"
3765 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3766 given as two arguments or one combined argument). The sender of a
3767 locally-generated message can also be set (when permitted) by an initial
3768 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3769 if &%-f%& is also present, it overrides &"From&~"&.
3770
3771 .vitem &%-G%&
3772 .oindex "&%-G%&"
3773 .cindex "submission fixups, suppressing (command-line)"
3774 This option is equivalent to an ACL applying:
3775 .code
3776 control = suppress_local_fixups
3777 .endd
3778 for every message received.  Note that Sendmail will complain about such
3779 bad formatting, where Exim silently just does not fix it up.  This may change
3780 in future.
3781
3782 As this affects audit information, the caller must be a trusted user to use
3783 this option.
3784
3785 .vitem &%-h%&&~<&'number'&>
3786 .oindex "&%-h%&"
3787 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3788 This option is accepted for compatibility with Sendmail, but has no effect. (In
3789 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3790 headers.)
3791
3792 .vitem &%-i%&
3793 .oindex "&%-i%&"
3794 .cindex "Solaris" "&'mail'& command"
3795 .cindex "dot" "in incoming non-SMTP message"
3796 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3797 line by itself should not terminate an incoming, non-SMTP message. I can find
3798 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3799 command in Solaris 2.4 uses it. See also &%-ti%&.
3800
3801 .vitem &%-L%&&~<&'tag'&>
3802 .oindex "&%-L%&"
3803 .cindex "syslog" "process name; set with flag"
3804 This option is equivalent to setting &%syslog_processname%& in the config
3805 file and setting &%log_file_path%& to &`syslog`&.
3806 Its use is restricted to administrators.  The configuration file has to be
3807 read and parsed, to determine access rights, before this is set and takes
3808 effect, so early configuration file errors will not honour this flag.
3809
3810 The tag should not be longer than 32 characters.
3811
3812 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3813 .oindex "&%-M%&"
3814 .cindex "forcing delivery"
3815 .cindex "delivery" "forcing attempt"
3816 .cindex "frozen messages" "forcing delivery"
3817 This option requests Exim to run a delivery attempt on each message in turn. If
3818 any of the messages are frozen, they are automatically thawed before the
3819 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3820 and &%hold_domains%& are ignored.
3821
3822 Retry
3823 .cindex "hints database" "overriding retry hints"
3824 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3825 the normal retry time has not yet been reached. This option requires the caller
3826 to be an admin user. However, there is an option called &%prod_requires_admin%&
3827 which can be set false to relax this restriction (and also the same requirement
3828 for the &%-q%&, &%-R%&, and &%-S%& options).
3829
3830 The deliveries happen synchronously, that is, the original Exim process does
3831 not terminate until all the delivery attempts have finished. No output is
3832 produced unless there is a serious error. If you want to see what is happening,
3833 use the &%-v%& option as well, or inspect Exim's main log.
3834
3835 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3836 .oindex "&%-Mar%&"
3837 .cindex "message" "adding recipients"
3838 .cindex "recipient" "adding"
3839 This option requests Exim to add the addresses to the list of recipients of the
3840 message (&"ar"& for &"add recipients"&). The first argument must be a message
3841 id, and the remaining ones must be email addresses. However, if the message is
3842 active (in the middle of a delivery attempt), it is not altered. This option
3843 can be used only by an admin user.
3844
3845 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3846         &~<&'message&~id'&>"
3847 .oindex "&%-MC%&"
3848 .cindex "SMTP" "passed connection"
3849 .cindex "SMTP" "multiple deliveries"
3850 .cindex "multiple SMTP deliveries"
3851 This option is not intended for use by external callers. It is used internally
3852 by Exim to invoke another instance of itself to deliver a waiting message using
3853 an existing SMTP connection, which is passed as the standard input. Details are
3854 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3855 must be root or the Exim user in order to use it.
3856
3857 .vitem &%-MCA%&
3858 .oindex "&%-MCA%&"
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
3861 connection to the remote host has been authenticated.
3862
3863 .vitem &%-MCD%&
3864 .oindex "&%-MCD%&"
3865 This option is not intended for use by external callers. It is used internally
3866 by Exim in conjunction with the &%-MC%& option. It signifies that the
3867 remote host supports the ESMTP &_DSN_& extension.
3868
3869 .vitem &%-MCG%&&~<&'queue&~name'&>
3870 .oindex "&%-MCG%&"
3871 This option is not intended for use by external callers. It is used internally
3872 by Exim in conjunction with the &%-MC%& option. It signifies that an
3873 alternate queue is used, named by the following argument.
3874
3875 .vitem &%-MCK%&
3876 .oindex "&%-MCK%&"
3877 This option is not intended for use by external callers. It is used internally
3878 by Exim in conjunction with the &%-MC%& option. It signifies that a
3879 remote host supports the ESMTP &_CHUNKING_& extension.
3880
3881 .vitem &%-MCP%&
3882 .oindex "&%-MCP%&"
3883 This option is not intended for use by external callers. It is used internally
3884 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3885 which Exim is connected supports pipelining.
3886
3887 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3888 .oindex "&%-MCQ%&"
3889 This option is not intended for use by external callers. It is used internally
3890 by Exim in conjunction with the &%-MC%& option when the original delivery was
3891 started by a queue runner. It passes on the process id of the queue runner,
3892 together with the file descriptor number of an open pipe. Closure of the pipe
3893 signals the final completion of the sequence of processes that are passing
3894 messages through the same SMTP connection.
3895
3896 .vitem &%-MCS%&
3897 .oindex "&%-MCS%&"
3898 This option is not intended for use by external callers. It is used internally
3899 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3900 SMTP SIZE option should be used on messages delivered down the existing
3901 connection.
3902
3903 .vitem &%-MCT%&
3904 .oindex "&%-MCT%&"
3905 This option is not intended for use by external callers. It is used internally
3906 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3907 host to which Exim is connected supports TLS encryption.
3908
3909 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3910 .oindex "&%-MCt%&"
3911 This option is not intended for use by external callers. It is used internally
3912 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3913 connection is being proxied by a parent process for handling TLS encryption.
3914 The arguments give the local address and port being proxied, and the TLS cipher.
3915
3916 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3917 .oindex "&%-Mc%&"
3918 .cindex "hints database" "not overridden by &%-Mc%&"
3919 .cindex "delivery" "manually started &-- not forced"
3920 This option requests Exim to run a delivery attempt on each message, in turn,
3921 but unlike the &%-M%& option, it does check for retry hints, and respects any
3922 that are found. This option is not very useful to external callers. It is
3923 provided mainly for internal use by Exim when it needs to re-invoke itself in
3924 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3925 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3926 respects retry times and other options such as &%hold_domains%& that are
3927 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3928 If you want to run a specific delivery as if in a queue run, you should use
3929 &%-q%& with a message id argument. A distinction between queue run deliveries
3930 and other deliveries is made in one or two places.
3931
3932 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3933 .oindex "&%-Mes%&"
3934 .cindex "message" "changing sender"
3935 .cindex "sender" "changing"
3936 This option requests Exim to change the sender address in the message to the
3937 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3938 &"edit sender"&). There must be exactly two arguments. The first argument must
3939 be a message id, and the second one an email address. However, if the message
3940 is active (in the middle of a delivery attempt), its status is not altered.
3941 This option can be used only by an admin user.
3942
3943 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3944 .oindex "&%-Mf%&"
3945 .cindex "freezing messages"
3946 .cindex "message" "manually freezing"
3947 This option requests Exim to mark each listed message as &"frozen"&. This
3948 prevents any delivery attempts taking place until the message is &"thawed"&,
3949 either manually or as a result of the &%auto_thaw%& configuration option.
3950 However, if any of the messages are active (in the middle of a delivery
3951 attempt), their status is not altered. This option can be used only by an admin
3952 user.
3953
3954 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3955 .oindex "&%-Mg%&"
3956 .cindex "giving up on messages"
3957 .cindex "message" "abandoning delivery attempts"
3958 .cindex "delivery" "abandoning further attempts"
3959 This option requests Exim to give up trying to deliver the listed messages,
3960 including any that are frozen. However, if any of the messages are active,
3961 their status is not altered. For non-bounce messages, a delivery error message
3962 is sent to the sender, containing the text &"cancelled by administrator"&.
3963 Bounce messages are just discarded. This option can be used only by an admin
3964 user.
3965
3966 .vitem &%-MG%&&~<&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
3967 .oindex "&%-MG%&"
3968 .cindex queue named
3969 .cindex "named queues"
3970 .cindex "queue" "moving messages"
3971 This option requests that each listed message be moved from its current
3972 queue to the given named queue.
3973 The destination queue name argument is required, but can be an empty
3974 string to define the default queue.
3975 If the messages are not currently located in the default queue,
3976 a &%-qG<name>%& option will be required to define the source queue.
3977
3978 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3979 .oindex "&%-Mmad%&"
3980 .cindex "delivery" "cancelling all"
3981 This option requests Exim to mark all the recipient addresses in the messages
3982 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3983 message is active (in the middle of a delivery attempt), its status is not
3984 altered. This option can be used only by an admin user.
3985
3986 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3987 .oindex "&%-Mmd%&"
3988 .cindex "delivery" "cancelling by address"
3989 .cindex "recipient" "removing"
3990 .cindex "removing recipients"
3991 This option requests Exim to mark the given addresses as already delivered
3992 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3993 the remaining ones must be email addresses. These are matched to recipient
3994 addresses in the message in a case-sensitive manner. If the message is active
3995 (in the middle of a delivery attempt), its status is not altered. This option
3996 can be used only by an admin user.
3997
3998 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3999 .oindex "&%-Mrm%&"
4000 .cindex "removing messages"
4001 .cindex "abandoning mail"
4002 .cindex "message" "manually discarding"
4003 This option requests Exim to remove the given messages from the queue. No
4004 bounce messages are sent; each message is simply forgotten. However, if any of
4005 the messages are active, their status is not altered. This option can be used
4006 only by an admin user or by the user who originally caused the message to be
4007 placed in the queue.
4008
4009 . .new
4010 . .vitem &%-MS%&
4011 . .oindex "&%-MS%&"
4012 . .cindex REQUIRETLS
4013 . This option is used to request REQUIRETLS processing on the message.
4014 . It is used internally by Exim in conjunction with -E when generating
4015 . a bounce message.
4016 . .wen
4017
4018 .vitem &%-Mset%&&~<&'message&~id'&>
4019 .oindex "&%-Mset%&"
4020 .cindex "testing" "string expansion"
4021 .cindex "expansion" "testing"
4022 This option is useful only in conjunction with &%-be%& (that is, when testing
4023 string expansions). Exim loads the given message from its spool before doing
4024 the test expansions, thus setting message-specific variables such as
4025 &$message_size$& and the header variables. The &$recipients$& variable is made
4026 available. This feature is provided to make it easier to test expansions that
4027 make use of these variables. However, this option can be used only by an admin
4028 user. See also &%-bem%&.
4029
4030 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4031 .oindex "&%-Mt%&"
4032 .cindex "thawing messages"
4033 .cindex "unfreezing messages"
4034 .cindex "frozen messages" "thawing"
4035 .cindex "message" "thawing frozen"
4036 This option requests Exim to &"thaw"& any of the listed messages that are
4037 &"frozen"&, so that delivery attempts can resume. However, if any of the
4038 messages are active, their status is not altered. This option can be used only
4039 by an admin user.
4040
4041 .vitem &%-Mvb%&&~<&'message&~id'&>
4042 .oindex "&%-Mvb%&"
4043 .cindex "listing" "message body"
4044 .cindex "message" "listing body of"
4045 This option causes the contents of the message body (-D) spool file to be
4046 written to the standard output. This option can be used only by an admin user.
4047
4048 .vitem &%-Mvc%&&~<&'message&~id'&>
4049 .oindex "&%-Mvc%&"
4050 .cindex "message" "listing in RFC 2822 format"
4051 .cindex "listing" "message in RFC 2822 format"
4052 This option causes a copy of the complete message (header lines plus body) to
4053 be written to the standard output in RFC 2822 format. This option can be used
4054 only by an admin user.
4055
4056 .vitem &%-Mvh%&&~<&'message&~id'&>
4057 .oindex "&%-Mvh%&"
4058 .cindex "listing" "message headers"
4059 .cindex "header lines" "listing"
4060 .cindex "message" "listing header lines"
4061 This option causes the contents of the message headers (-H) spool file to be
4062 written to the standard output. This option can be used only by an admin user.
4063
4064 .vitem &%-Mvl%&&~<&'message&~id'&>
4065 .oindex "&%-Mvl%&"
4066 .cindex "listing" "message log"
4067 .cindex "message" "listing message log"
4068 This option causes the contents of the message log spool file to be written to
4069 the standard output. This option can be used only by an admin user.
4070
4071 .vitem &%-m%&
4072 .oindex "&%-m%&"
4073 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4074 treats it that way too.
4075
4076 .vitem &%-N%&
4077 .oindex "&%-N%&"
4078 .cindex "debugging" "&%-N%& option"
4079 .cindex "debugging" "suppressing delivery"
4080 This is a debugging option that inhibits delivery of a message at the transport
4081 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4082 it just doesn't actually transport the message, but instead behaves as if it
4083 had successfully done so. However, it does not make any updates to the retry
4084 database, and the log entries for deliveries are flagged with &"*>"& rather
4085 than &"=>"&.
4086
4087 Because &%-N%& discards any message to which it applies, only root or the Exim
4088 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4089 words, an ordinary user can use it only when supplying an incoming message to
4090 which it will apply. Although transportation never fails when &%-N%& is set, an
4091 address may be deferred because of a configuration problem on a transport, or a
4092 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4093 the message, and applies to any subsequent delivery attempts that may happen
4094 for that message.
4095
4096 .vitem &%-n%&
4097 .oindex "&%-n%&"
4098 This option is interpreted by Sendmail to mean &"no aliasing"&.
4099 For normal modes of operation, it is ignored by Exim.
4100 When combined with &%-bP%& it makes the output more terse (suppresses
4101 option names, environment values and config pretty printing).
4102
4103 .vitem &%-O%&&~<&'data'&>
4104 .oindex "&%-O%&"
4105 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4106 Exim.
4107
4108 .vitem &%-oA%&&~<&'file&~name'&>
4109 .oindex "&%-oA%&"
4110 .cindex "Sendmail compatibility" "&%-oA%& option"
4111 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4112 alternative alias filename. Exim handles &%-bi%& differently; see the
4113 description above.
4114
4115 .vitem &%-oB%&&~<&'n'&>
4116 .oindex "&%-oB%&"
4117 .cindex "SMTP" "passed connection"
4118 .cindex "SMTP" "multiple deliveries"
4119 .cindex "multiple SMTP deliveries"
4120 This is a debugging option which limits the maximum number of messages that can
4121 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4122 transport. If <&'n'&> is omitted, the limit is set to 1.
4123
4124 .vitem &%-odb%&
4125 .oindex "&%-odb%&"
4126 .cindex "background delivery"
4127 .cindex "delivery" "in the background"
4128 This option applies to all modes in which Exim accepts incoming messages,
4129 including the listening daemon. It requests &"background"& delivery of such
4130 messages, which means that the accepting process automatically starts a
4131 delivery process for each message received, but does not wait for the delivery
4132 processes to finish.
4133
4134 When all the messages have been received, the reception process exits,
4135 leaving the delivery processes to finish in their own time. The standard output
4136 and error streams are closed at the start of each delivery process.
4137 This is the default action if none of the &%-od%& options are present.
4138
4139 If one of the queueing options in the configuration file
4140 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4141 overrides it if &%queue_only_override%& is set true, which is the default
4142 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4143
4144 .vitem &%-odf%&
4145 .oindex "&%-odf%&"
4146 .cindex "foreground delivery"
4147 .cindex "delivery" "in the foreground"
4148 This option requests &"foreground"& (synchronous) delivery when Exim has
4149 accepted a locally-generated message. (For the daemon it is exactly the same as
4150 &%-odb%&.) A delivery process is automatically started to deliver the message,
4151 and Exim waits for it to complete before proceeding.
4152
4153 The original Exim reception process does not finish until the delivery
4154 process for the final message has ended. The standard error stream is left open
4155 during deliveries.
4156
4157 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4158 false and one of the queueing options in the configuration file is in effect.
4159
4160 If there is a temporary delivery error during foreground delivery, the
4161 message is left in the queue for later delivery, and the original reception
4162 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4163 restricted configuration that never queues messages.
4164
4165
4166 .vitem &%-odi%&
4167 .oindex "&%-odi%&"
4168 This option is synonymous with &%-odf%&. It is provided for compatibility with
4169 Sendmail.
4170
4171 .vitem &%-odq%&
4172 .oindex "&%-odq%&"
4173 .cindex "non-immediate delivery"
4174 .cindex "delivery" "suppressing immediate"
4175 .cindex "queueing incoming messages"
4176 This option applies to all modes in which Exim accepts incoming messages,
4177 including the listening daemon. It specifies that the accepting process should
4178 not automatically start a delivery process for each message received. Messages
4179 are placed in the queue, and remain there until a subsequent queue runner
4180 process encounters them. There are several configuration options (such as
4181 &%queue_only%&) that can be used to queue incoming messages under certain
4182 conditions. This option overrides all of them and also &%-odqs%&. It always
4183 forces queueing.
4184
4185 .vitem &%-odqs%&
4186 .oindex "&%-odqs%&"
4187 .cindex "SMTP" "delaying delivery"
4188 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4189 However, like &%-odb%& and &%-odi%&, this option has no effect if
4190 &%queue_only_override%& is false and one of the queueing options in the
4191 configuration file is in effect.
4192
4193 When &%-odqs%& does operate, a delivery process is started for each incoming
4194 message, in the background by default, but in the foreground if &%-odi%& is
4195 also present. The recipient addresses are routed, and local deliveries are done
4196 in the normal way. However, if any SMTP deliveries are required, they are not
4197 done at this time, so the message remains in the queue until a subsequent queue
4198 runner process encounters it. Because routing was done, Exim knows which
4199 messages are waiting for which hosts, and so a number of messages for the same
4200 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4201 configuration option has the same effect for specific domains. See also the
4202 &%-qq%& option.
4203
4204 .vitem &%-oee%&
4205 .oindex "&%-oee%&"
4206 .cindex "error" "reporting"
4207 If an error is detected while a non-SMTP message is being received (for
4208 example, a malformed address), the error is reported to the sender in a mail
4209 message.
4210
4211 .cindex "return code" "for &%-oee%&"
4212 Provided
4213 this error message is successfully sent, the Exim receiving process
4214 exits with a return code of zero. If not, the return code is 2 if the problem
4215 is that the original message has no recipients, or 1 for any other error.
4216 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4217
4218 .vitem &%-oem%&
4219 .oindex "&%-oem%&"
4220 .cindex "error" "reporting"
4221 .cindex "return code" "for &%-oem%&"
4222 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4223 return code, whether or not the error message was successfully sent.
4224 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4225
4226 .vitem &%-oep%&
4227 .oindex "&%-oep%&"
4228 .cindex "error" "reporting"
4229 If an error is detected while a non-SMTP message is being received, the
4230 error is reported by writing a message to the standard error file (stderr).
4231 .cindex "return code" "for &%-oep%&"
4232 The return code is 1 for all errors.
4233
4234 .vitem &%-oeq%&
4235 .oindex "&%-oeq%&"
4236 .cindex "error" "reporting"
4237 This option is supported for compatibility with Sendmail, but has the same
4238 effect as &%-oep%&.
4239
4240 .vitem &%-oew%&
4241 .oindex "&%-oew%&"
4242 .cindex "error" "reporting"
4243 This option is supported for compatibility with Sendmail, but has the same
4244 effect as &%-oem%&.
4245
4246 .vitem &%-oi%&
4247 .oindex "&%-oi%&"
4248 .cindex "dot" "in incoming non-SMTP message"
4249 This option, which has the same effect as &%-i%&, specifies that a dot on a
4250 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4251 single dot does terminate, though Exim does no special processing for other
4252 lines that start with a dot. This option is set by default if Exim is called as
4253 &'rmail'&. See also &%-ti%&.
4254
4255 .vitem &%-oitrue%&
4256 .oindex "&%-oitrue%&"
4257 This option is treated as synonymous with &%-oi%&.
4258
4259 .vitem &%-oMa%&&~<&'host&~address'&>
4260 .oindex "&%-oMa%&"
4261 .cindex "sender" "host address, specifying for local message"
4262 A number of options starting with &%-oM%& can be used to set values associated
4263 with remote hosts on locally-submitted messages (that is, messages not received
4264 over TCP/IP). These options can be used by any caller in conjunction with the
4265 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4266 other circumstances, they are ignored unless the caller is trusted.
4267
4268 The &%-oMa%& option sets the sender host address. This may include a port
4269 number at the end, after a full stop (period). For example:
4270 .code
4271 exim -bs -oMa 10.9.8.7.1234
4272 .endd
4273 An alternative syntax is to enclose the IP address in square brackets,
4274 followed by a colon and the port number:
4275 .code
4276 exim -bs -oMa [10.9.8.7]:1234
4277 .endd
4278 The IP address is placed in the &$sender_host_address$& variable, and the
4279 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4280 are present on the command line, the sender host IP address is taken from
4281 whichever one is last.
4282
4283 .vitem &%-oMaa%&&~<&'name'&>
4284 .oindex "&%-oMaa%&"
4285 .cindex "authentication" "name, specifying for local message"
4286 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4287 option sets the value of &$sender_host_authenticated$& (the authenticator
4288 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4289 This option can be used with &%-bh%& and &%-bs%& to set up an
4290 authenticated SMTP session without actually using the SMTP AUTH command.
4291
4292 .vitem &%-oMai%&&~<&'string'&>
4293 .oindex "&%-oMai%&"
4294 .cindex "authentication" "id, specifying for local message"
4295 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4296 option sets the value of &$authenticated_id$& (the id that was authenticated).
4297 This overrides the default value (the caller's login id, except with &%-bh%&,
4298 where there is no default) for messages from local sources. See chapter
4299 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4300
4301 .vitem &%-oMas%&&~<&'address'&>
4302 .oindex "&%-oMas%&"
4303 .cindex "authentication" "sender, specifying for local message"
4304 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4305 option sets the authenticated sender value in &$authenticated_sender$&. It
4306 overrides the sender address that is created from the caller's login id for
4307 messages from local sources, except when &%-bh%& is used, when there is no
4308 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4309 specified on a MAIL command overrides this value. See chapter
4310 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4311
4312 .vitem &%-oMi%&&~<&'interface&~address'&>
4313 .oindex "&%-oMi%&"
4314 .cindex "interface" "address, specifying for local message"
4315 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4316 option sets the IP interface address value. A port number may be included,
4317 using the same syntax as for &%-oMa%&. The interface address is placed in
4318 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4319
4320 .vitem &%-oMm%&&~<&'message&~reference'&>
4321 .oindex "&%-oMm%&"
4322 .cindex "message reference" "message reference, specifying for local message"
4323 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4324 option sets the message reference, e.g. message-id, and is logged during
4325 delivery. This is useful when some kind of audit trail is required to tie
4326 messages together. The format of the message reference is checked and will
4327 abort if the format is invalid. The option will only be accepted if exim is
4328 running in trusted mode, not as any regular user.
4329
4330 The best example of a message reference is when Exim sends a bounce message.
4331 The message reference is the message-id of the original message for which Exim
4332 is sending the bounce.
4333
4334 .vitem &%-oMr%&&~<&'protocol&~name'&>
4335 .oindex "&%-oMr%&"
4336 .cindex "protocol, specifying for local message"
4337 .vindex "&$received_protocol$&"
4338 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4339 option sets the received protocol value that is stored in
4340 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4341 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4342 SMTP protocol names (see the description of &$received_protocol$& in section
4343 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4344 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4345 be set by &%-oMr%&. Repeated use of this option is not supported.
4346
4347 .vitem &%-oMs%&&~<&'host&~name'&>
4348 .oindex "&%-oMs%&"
4349 .cindex "sender" "host name, specifying for local message"
4350 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4351 option sets the sender host name in &$sender_host_name$&. When this option is
4352 present, Exim does not attempt to look up a host name from an IP address; it
4353 uses the name it is given.
4354
4355 .vitem &%-oMt%&&~<&'ident&~string'&>
4356 .oindex "&%-oMt%&"
4357 .cindex "sender" "ident string, specifying for local message"
4358 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4359 option sets the sender ident value in &$sender_ident$&. The default setting for
4360 local callers is the login id of the calling process, except when &%-bh%& is
4361 used, when there is no default.
4362
4363 .vitem &%-om%&
4364 .oindex "&%-om%&"
4365 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4366 In Sendmail, this option means &"me too"&, indicating that the sender of a
4367 message should receive a copy of the message if the sender appears in an alias
4368 expansion. Exim always does this, so the option does nothing.
4369
4370 .vitem &%-oo%&
4371 .oindex "&%-oo%&"
4372 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4373 This option is ignored. In Sendmail it specifies &"old style headers"&,
4374 whatever that means.
4375
4376 .vitem &%-oP%&&~<&'path'&>
4377 .oindex "&%-oP%&"
4378 .cindex "pid (process id)" "of daemon"
4379 .cindex "daemon" "process id (pid)"
4380 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4381 value. The option specifies the file to which the process id of the daemon is
4382 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4383 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4384 because in those cases, the normal pid file is not used.
4385
4386 .new
4387 .vitem &%-oPX%&
4388 .oindex "&%-oPX%&"
4389 .cindex "pid (process id)" "of daemon"
4390 .cindex "daemon" "process id (pid)"
4391 This option is not intended for general use.
4392 The daemon uses it when terminating due to a SIGTEM, possibly in
4393 combination with &%-oP%&&~<&'path'&>.
4394 It causes the pid file to be removed.
4395 .wen
4396
4397 .vitem &%-or%&&~<&'time'&>
4398 .oindex "&%-or%&"
4399 .cindex "timeout" "for non-SMTP input"
4400 This option sets a timeout value for incoming non-SMTP messages. If it is not
4401 set, Exim will wait forever for the standard input. The value can also be set
4402 by the &%receive_timeout%& option. The format used for specifying times is
4403 described in section &<<SECTtimeformat>>&.
4404
4405 .vitem &%-os%&&~<&'time'&>
4406 .oindex "&%-os%&"
4407 .cindex "timeout" "for SMTP input"
4408 .cindex "SMTP" "input timeout"
4409 This option sets a timeout value for incoming SMTP messages. The timeout
4410 applies to each SMTP command and block of data. The value can also be set by
4411 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4412 for specifying times is described in section &<<SECTtimeformat>>&.
4413
4414 .vitem &%-ov%&
4415 .oindex "&%-ov%&"
4416 This option has exactly the same effect as &%-v%&.
4417
4418 .vitem &%-oX%&&~<&'number&~or&~string'&>
4419 .oindex "&%-oX%&"
4420 .cindex "TCP/IP" "setting listening ports"
4421 .cindex "TCP/IP" "setting listening interfaces"
4422 .cindex "port" "receiving TCP/IP"
4423 This option is relevant only when the &%-bd%& (start listening daemon) option
4424 is also given. It controls which ports and interfaces the daemon uses. Details
4425 of the syntax, and how it interacts with configuration file options, are given
4426 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4427 file is written unless &%-oP%& is also present to specify a pid filename.
4428
4429 .vitem &%-pd%&
4430 .oindex "&%-pd%&"
4431 .cindex "Perl" "starting the interpreter"
4432 This option applies when an embedded Perl interpreter is linked with Exim (see
4433 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4434 option, forcing the starting of the interpreter to be delayed until it is
4435 needed.
4436
4437 .vitem &%-ps%&
4438 .oindex "&%-ps%&"
4439 .cindex "Perl" "starting the interpreter"
4440 This option applies when an embedded Perl interpreter is linked with Exim (see
4441 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4442 option, forcing the starting of the interpreter to occur as soon as Exim is
4443 started.
4444
4445 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4446 .oindex "&%-p%&"
4447 For compatibility with Sendmail, this option is equivalent to
4448 .display
4449 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4450 .endd
4451 It sets the incoming protocol and host name (for trusted callers). The
4452 host name and its colon can be omitted when only the protocol is to be set.
4453 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4454 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4455 or &`s`& using this option (but that does not seem a real limitation).
4456 Repeated use of this option is not supported.
4457
4458 .vitem &%-q%&
4459 .oindex "&%-q%&"
4460 .cindex "queue runner" "starting manually"
4461 This option is normally restricted to admin users. However, there is a
4462 configuration option called &%prod_requires_admin%& which can be set false to
4463 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4464 and &%-S%& options).
4465
4466 .cindex "queue runner" "description of operation"
4467 If other commandline options do not specify an action,
4468 the &%-q%& option starts one queue runner process. This scans the queue of
4469 waiting messages, and runs a delivery process for each one in turn. It waits
4470 for each delivery process to finish before starting the next one. A delivery
4471 process may not actually do any deliveries if the retry times for the addresses
4472 have not been reached. Use &%-qf%& (see below) if you want to override this.
4473
4474 If
4475 .cindex "SMTP" "passed connection"
4476 .cindex "SMTP" "multiple deliveries"
4477 .cindex "multiple SMTP deliveries"
4478 the delivery process spawns other processes to deliver other messages down
4479 passed SMTP connections, the queue runner waits for these to finish before
4480 proceeding.
4481
4482 When all the queued messages have been considered, the original queue runner
4483 process terminates. In other words, a single pass is made over the waiting
4484 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4485 this to be repeated periodically.
4486
4487 Exim processes the waiting messages in an unpredictable order. It isn't very
4488 random, but it is likely to be different each time, which is all that matters.
4489 If one particular message screws up a remote MTA, other messages to the same
4490 MTA have a chance of getting through if they get tried first.
4491
4492 It is possible to cause the messages to be processed in lexical message id
4493 order, which is essentially the order in which they arrived, by setting the
4494 &%queue_run_in_order%& option, but this is not recommended for normal use.
4495
4496 .vitem &%-q%&<&'qflags'&>
4497 The &%-q%& option may be followed by one or more flag letters that change its
4498 behaviour. They are all optional, but if more than one is present, they must
4499 appear in the correct order. Each flag is described in a separate item below.
4500
4501 .vitem &%-qq...%&
4502 .oindex "&%-qq%&"
4503 .cindex "queue" "double scanning"
4504 .cindex "queue" "routing"
4505 .cindex "routing" "whole queue before delivery"
4506 An option starting with &%-qq%& requests a two-stage queue run. In the first
4507 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4508 every domain. Addresses are routed, local deliveries happen, but no remote
4509 transports are run.
4510
4511 .cindex "hints database" "remembering routing"
4512 The hints database that remembers which messages are waiting for specific hosts
4513 is updated, as if delivery to those hosts had been deferred. After this is
4514 complete, a second, normal queue scan happens, with routing and delivery taking
4515 place as normal. Messages that are routed to the same host should mostly be
4516 delivered down a single SMTP
4517 .cindex "SMTP" "passed connection"
4518 .cindex "SMTP" "multiple deliveries"
4519 .cindex "multiple SMTP deliveries"
4520 connection because of the hints that were set up during the first queue scan.
4521 This option may be useful for hosts that are connected to the Internet
4522 intermittently.
4523
4524 .vitem &%-q[q]i...%&
4525 .oindex "&%-qi%&"
4526 .cindex "queue" "initial delivery"
4527 If the &'i'& flag is present, the queue runner runs delivery processes only for
4528 those messages that haven't previously been tried. (&'i'& stands for &"initial
4529 delivery"&.) This can be helpful if you are putting messages in the queue using
4530 &%-odq%& and want a queue runner just to process the new messages.
4531
4532 .vitem &%-q[q][i]f...%&
4533 .oindex "&%-qf%&"
4534 .cindex "queue" "forcing delivery"
4535 .cindex "delivery" "forcing in queue run"
4536 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4537 message, whereas without &'f'& only those non-frozen addresses that have passed
4538 their retry times are tried.
4539
4540 .vitem &%-q[q][i]ff...%&
4541 .oindex "&%-qff%&"
4542 .cindex "frozen messages" "forcing delivery"
4543 If &'ff'& is present, a delivery attempt is forced for every message, whether
4544 frozen or not.
4545
4546 .vitem &%-q[q][i][f[f]]l%&
4547 .oindex "&%-ql%&"
4548 .cindex "queue" "local deliveries only"
4549 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4550 be done. If a message requires any remote deliveries, it remains in the queue
4551 for later delivery.
4552
4553 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4554 .oindex "&%-qG%&"
4555 .cindex queue named
4556 .cindex "named queues"
4557 .cindex "queue" "delivering specific messages"
4558 If the &'G'& flag and a name is present, the queue runner operates on the
4559 queue with the given name rather than the default queue.
4560 The name should not contain a &'/'& character.
4561 For a periodic queue run (see below)
4562 append to the name a slash and a time value.
4563
4564 If other commandline options specify an action, a &'-qG<name>'& option
4565 will specify a queue to operate on.
4566 For example:
4567 .code
4568 exim -bp -qGquarantine
4569 mailq -qGquarantine
4570 exim -qGoffpeak -Rf @special.domain.example
4571 .endd
4572
4573 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4574 When scanning the queue, Exim can be made to skip over messages whose ids are
4575 lexically less than a given value by following the &%-q%& option with a
4576 starting message id. For example:
4577 .code
4578 exim -q 0t5C6f-0000c8-00
4579 .endd
4580 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4581 second message id is given, messages whose ids are lexically greater than it
4582 are also skipped. If the same id is given twice, for example,
4583 .code
4584 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4585 .endd
4586 just one delivery process is started, for that message. This differs from
4587 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4588 that it counts as a delivery from a queue run. Note that the selection
4589 mechanism does not affect the order in which the messages are scanned. There
4590 are also other ways of selecting specific sets of messages for delivery in a
4591 queue run &-- see &%-R%& and &%-S%&.
4592
4593 .vitem &%-q%&<&'qflags'&><&'time'&>
4594 .cindex "queue runner" "starting periodically"
4595 .cindex "periodic queue running"
4596 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4597 starting a queue runner process at intervals specified by the given time value
4598 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4599 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4600 single daemon process handles both functions. A common way of starting up a
4601 combined daemon at system boot time is to use a command such as
4602 .code
4603 /usr/exim/bin/exim -bd -q30m
4604 .endd
4605 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4606 process every 30 minutes.
4607
4608 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4609 pid file is written unless one is explicitly requested by the &%-oP%& option.
4610
4611 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4612 .oindex "&%-qR%&"
4613 This option is synonymous with &%-R%&. It is provided for Sendmail
4614 compatibility.
4615
4616 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4617 .oindex "&%-qS%&"
4618 This option is synonymous with &%-S%&.
4619
4620 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4621 .oindex "&%-R%&"
4622 .cindex "queue runner" "for specific recipients"
4623 .cindex "delivery" "to given domain"
4624 .cindex "domain" "delivery to"
4625 The <&'rsflags'&> may be empty, in which case the white space before the string
4626 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4627 which are the possible values for <&'rsflags'&>. White space is required if
4628 <&'rsflags'&> is not empty.
4629
4630 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4631 perform a single queue run, except that, when scanning the messages on the
4632 queue, Exim processes only those that have at least one undelivered recipient
4633 address containing the given string, which is checked in a case-independent
4634 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4635 regular expression; otherwise it is a literal string.
4636
4637 If you want to do periodic queue runs for messages with specific recipients,
4638 you can combine &%-R%& with &%-q%& and a time value. For example:
4639 .code
4640 exim -q25m -R @special.domain.example
4641 .endd
4642 This example does a queue run for messages with recipients in the given domain
4643 every 25 minutes. Any additional flags that are specified with &%-q%& are
4644 applied to each queue run.
4645
4646 Once a message is selected for delivery by this mechanism, all its addresses
4647 are processed. For the first selected message, Exim overrides any retry
4648 information and forces a delivery attempt for each undelivered address. This
4649 means that if delivery of any address in the first message is successful, any
4650 existing retry information is deleted, and so delivery attempts for that
4651 address in subsequently selected messages (which are processed without forcing)
4652 will run. However, if delivery of any address does not succeed, the retry
4653 information is updated, and in subsequently selected messages, the failing
4654 address will be skipped.
4655
4656 .cindex "frozen messages" "forcing delivery"
4657 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4658 all selected messages, not just the first; frozen messages are included when
4659 &'ff'& is present.
4660
4661 The &%-R%& option makes it straightforward to initiate delivery of all messages
4662 to a given domain after a host has been down for some time. When the SMTP
4663 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4664 effect is to run Exim with the &%-R%& option, but it can be configured to run
4665 an arbitrary command instead.
4666
4667 .vitem &%-r%&
4668 .oindex "&%-r%&"
4669 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4670
4671 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4672 .oindex "&%-S%&"
4673 .cindex "delivery" "from given sender"
4674 .cindex "queue runner" "for specific senders"
4675 This option acts like &%-R%& except that it checks the string against each
4676 message's sender instead of against the recipients. If &%-R%& is also set, both
4677 conditions must be met for a message to be selected. If either of the options
4678 has &'f'& or &'ff'& in its flags, the associated action is taken.
4679
4680 .vitem &%-Tqt%&&~<&'times'&>
4681 .oindex "&%-Tqt%&"
4682 This is an option that is exclusively for use by the Exim testing suite. It is not
4683 recognized when Exim is run normally. It allows for the setting up of explicit
4684 &"queue times"& so that various warning/retry features can be tested.
4685
4686 .vitem &%-t%&
4687 .oindex "&%-t%&"
4688 .cindex "recipient" "extracting from header lines"
4689 .cindex "&'Bcc:'& header line"
4690 .cindex "&'Cc:'& header line"
4691 .cindex "&'To:'& header line"
4692 When Exim is receiving a locally-generated, non-SMTP message on its standard
4693 input, the &%-t%& option causes the recipients of the message to be obtained
4694 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4695 from the command arguments. The addresses are extracted before any rewriting
4696 takes place and the &'Bcc:'& header line, if present, is then removed.
4697
4698 .cindex "Sendmail compatibility" "&%-t%& option"
4699 If the command has any arguments, they specify addresses to which the message
4700 is &'not'& to be delivered. That is, the argument addresses are removed from
4701 the recipients list obtained from the headers. This is compatible with Smail 3
4702 and in accordance with the documented behaviour of several versions of
4703 Sendmail, as described in man pages on a number of operating systems (e.g.
4704 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4705 argument addresses to those obtained from the headers, and the O'Reilly
4706 Sendmail book documents it that way. Exim can be made to add argument addresses
4707 instead of subtracting them by setting the option
4708 &%extract_addresses_remove_arguments%& false.
4709
4710 .cindex "&%Resent-%& header lines" "with &%-t%&"
4711 If there are any &%Resent-%& header lines in the message, Exim extracts
4712 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4713 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4714 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4715 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4716
4717 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4718 message is resent several times). The RFC also specifies that they should be
4719 added at the front of the message, and separated by &'Received:'& lines. It is
4720 not at all clear how &%-t%& should operate in the present of multiple sets,
4721 nor indeed exactly what constitutes a &"set"&.
4722 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4723 are often added at the end of the header, and if a message is resent more than
4724 once, it is common for the original set of &%Resent-%& headers to be renamed as
4725 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4726
4727 .vitem &%-ti%&
4728 .oindex "&%-ti%&"
4729 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4730 compatibility with Sendmail.
4731
4732 .vitem &%-tls-on-connect%&
4733 .oindex "&%-tls-on-connect%&"
4734 .cindex "TLS" "use without STARTTLS"
4735 .cindex "TLS" "automatic start"
4736 This option is available when Exim is compiled with TLS support. It forces all
4737 incoming SMTP connections to behave as if the incoming port is listed in the
4738 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4739 &<<CHAPTLS>>& for further details.
4740
4741
4742 .vitem &%-U%&
4743 .oindex "&%-U%&"
4744 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4745 Sendmail uses this option for &"initial message submission"&, and its
4746 documentation states that in future releases, it may complain about
4747 syntactically invalid messages rather than fixing them when this flag is not
4748 set. Exim ignores this option.
4749
4750 .vitem &%-v%&
4751 .oindex "&%-v%&"
4752 This option causes Exim to write information to the standard error stream,
4753 describing what it is doing. In particular, it shows the log lines for
4754 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4755 dialogue is shown. Some of the log lines shown may not actually be written to
4756 the log if the setting of &%log_selector%& discards them. Any relevant
4757 selectors are shown with each log line. If none are shown, the logging is
4758 unconditional.
4759
4760 .vitem &%-x%&
4761 .oindex "&%-x%&"
4762 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4763 National Language Support extended characters in the body of the mail item"&).
4764 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4765 this option.
4766
4767 .vitem &%-X%&&~<&'logfile'&>
4768 .oindex "&%-X%&"
4769 This option is interpreted by Sendmail to cause debug information to be sent
4770 to the named file.  It is ignored by Exim.
4771
4772 .vitem &%-z%&&~<&'log-line'&>
4773 .oindex "&%-z%&"
4774 This option writes its argument to Exim's logfile.
4775 Use is restricted to administrators; the intent is for operational notes.
4776 Quotes should be used to maintain a multi-word item as a single argument,
4777 under most shells.
4778 .endlist
4779
4780 .ecindex IIDclo1
4781 .ecindex IIDclo2
4782
4783
4784 . ////////////////////////////////////////////////////////////////////////////
4785 . Insert a stylized DocBook comment here, to identify the end of the command
4786 . line options. This is for the benefit of the Perl script that automatically
4787 . creates a man page for the options.
4788 . ////////////////////////////////////////////////////////////////////////////
4789
4790 .literal xml
4791 <!-- === End of command line options === -->
4792 .literal off
4793
4794
4795
4796
4797
4798 . ////////////////////////////////////////////////////////////////////////////
4799 . ////////////////////////////////////////////////////////////////////////////
4800
4801
4802 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4803          "The runtime configuration file"
4804
4805 .cindex "runtime configuration"
4806 .cindex "configuration file" "general description"
4807 .cindex "CONFIGURE_FILE"
4808 .cindex "configuration file" "errors in"
4809 .cindex "error" "in configuration file"
4810 .cindex "return code" "for bad configuration"
4811 Exim uses a single runtime configuration file that is read whenever an Exim
4812 binary is executed. Note that in normal operation, this happens frequently,
4813 because Exim is designed to operate in a distributed manner, without central
4814 control.
4815
4816 If a syntax error is detected while reading the configuration file, Exim
4817 writes a message on the standard error, and exits with a non-zero return code.
4818 The message is also written to the panic log. &*Note*&: Only simple syntax
4819 errors can be detected at this time. The values of any expanded options are
4820 not checked until the expansion happens, even when the expansion does not
4821 actually alter the string.
4822
4823 The name of the configuration file is compiled into the binary for security
4824 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4825 most configurations, this specifies a single file. However, it is permitted to
4826 give a colon-separated list of filenames, in which case Exim uses the first
4827 existing file in the list.
4828
4829 .cindex "EXIM_USER"
4830 .cindex "EXIM_GROUP"
4831 .cindex "CONFIGURE_OWNER"
4832 .cindex "CONFIGURE_GROUP"
4833 .cindex "configuration file" "ownership"
4834 .cindex "ownership" "configuration file"
4835 The runtime configuration file must be owned by root or by the user that is
4836 specified at compile time by the CONFIGURE_OWNER option (if set). The
4837 configuration file must not be world-writeable, or group-writeable unless its
4838 group is the root group or the one specified at compile time by the
4839 CONFIGURE_GROUP option.
4840
4841 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4842 to root, anybody who is able to edit the runtime configuration file has an
4843 easy way to run commands as root. If you specify a user or group in the
4844 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4845 who are members of that group will trivially be able to obtain root privileges.
4846
4847 Up to Exim version 4.72, the runtime configuration file was also permitted to
4848 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4849 since it offered a simple privilege escalation for any attacker who managed to
4850 compromise the Exim user account.
4851
4852 A default configuration file, which will work correctly in simple situations,
4853 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4854 defines just one filename, the installation process copies the default
4855 configuration to a new file of that name if it did not previously exist. If
4856 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4857 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4858 configuration.
4859
4860
4861
4862 .section "Using a different configuration file" "SECID40"
4863 .cindex "configuration file" "alternate"
4864 A one-off alternate configuration can be specified by the &%-C%& command line
4865 option, which may specify a single file or a list of files. However, when
4866 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4867 unless the argument for &%-C%& is identical to the built-in value from
4868 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4869 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4870 is useful mainly for checking the syntax of configuration files before
4871 installing them. No owner or group checks are done on a configuration file
4872 specified by &%-C%&, if root privilege has been dropped.
4873
4874 Even the Exim user is not trusted to specify an arbitrary configuration file
4875 with the &%-C%& option to be used with root privileges, unless that file is
4876 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4877 testing a configuration using &%-C%& right through message reception and
4878 delivery, even if the caller is root. The reception works, but by that time,
4879 Exim is running as the Exim user, so when it re-execs to regain privilege for
4880 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4881 can test reception and delivery using two separate commands (one to put a
4882 message in the queue, using &%-odq%&, and another to do the delivery, using
4883 &%-M%&).
4884
4885 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4886 prefix string with which any file named in a &%-C%& command line option must
4887 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4888 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4889 filename can be used with &%-C%&.
4890
4891 One-off changes to a configuration can be specified by the &%-D%& command line
4892 option, which defines and overrides values for macros used inside the
4893 configuration file. However, like &%-C%&, the use of this option by a
4894 non-privileged user causes Exim to discard its root privilege.
4895 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4896 completely disabled, and its use causes an immediate error exit.
4897
4898 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4899 to declare certain macro names trusted, such that root privilege will not
4900 necessarily be discarded.
4901 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4902 considered safe and, if &%-D%& only supplies macros from this list, and the
4903 values are acceptable, then Exim will not give up root privilege if the caller
4904 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4905 transition mechanism and is expected to be removed in the future.  Acceptable
4906 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4907
4908 Some sites may wish to use the same Exim binary on different machines that
4909 share a file system, but to use different configuration files on each machine.
4910 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4911 looks for a file whose name is the configuration filename followed by a dot
4912 and the machine's node name, as obtained from the &[uname()]& function. If this
4913 file does not exist, the standard name is tried. This processing occurs for
4914 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4915
4916 In some esoteric situations different versions of Exim may be run under
4917 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4918 help with this. See the comments in &_src/EDITME_& for details.
4919
4920
4921
4922 .section "Configuration file format" "SECTconffilfor"
4923 .cindex "configuration file" "format of"
4924 .cindex "format" "configuration file"
4925 Exim's configuration file is divided into a number of different parts. General
4926 option settings must always appear at the start of the file. The other parts
4927 are all optional, and may appear in any order. Each part other than the first
4928 is introduced by the word &"begin"& followed by at least one literal
4929 space, and the name of the part. The optional parts are:
4930
4931 .ilist
4932 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4933 &<<CHAPACL>>&).
4934 .next
4935 .cindex "AUTH" "configuration"
4936 &'authenticators'&: Configuration settings for the authenticator drivers. These
4937 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4938 .next
4939 &'routers'&: Configuration settings for the router drivers. Routers process
4940 addresses and determine how the message is to be delivered (see chapters
4941 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4942 .next
4943 &'transports'&: Configuration settings for the transport drivers. Transports
4944 define mechanisms for copying messages to destinations (see chapters
4945 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4946 .next
4947 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4948 If there is no retry section, or if it is empty (that is, no retry rules are
4949 defined), Exim will not retry deliveries. In this situation, temporary errors
4950 are treated the same as permanent errors. Retry rules are discussed in chapter
4951 &<<CHAPretry>>&.
4952 .next
4953 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4954 when new addresses are generated during delivery. Rewriting is discussed in
4955 chapter &<<CHAPrewrite>>&.
4956 .next
4957 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4958 want to use this feature, you must set
4959 .code
4960 LOCAL_SCAN_HAS_OPTIONS=yes
4961 .endd
4962 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4963 facility are given in chapter &<<CHAPlocalscan>>&.
4964 .endlist
4965
4966 .cindex "configuration file" "leading white space in"
4967 .cindex "configuration file" "trailing white space in"
4968 .cindex "white space" "in configuration file"
4969 Leading and trailing white space in configuration lines is always ignored.
4970
4971 Blank lines in the file, and lines starting with a # character (ignoring
4972 leading white space) are treated as comments and are ignored. &*Note*&: A
4973 # character other than at the beginning of a line is not treated specially,
4974 and does not introduce a comment.
4975
4976 Any non-comment line can be continued by ending it with a backslash. Note that
4977 the general rule for white space means that trailing white space after the
4978 backslash and leading white space at the start of continuation
4979 lines is ignored. Comment lines beginning with # (but not empty lines) may
4980 appear in the middle of a sequence of continuation lines.
4981
4982 A convenient way to create a configuration file is to start from the
4983 default, which is supplied in &_src/configure.default_&, and add, delete, or
4984 change settings as required.
4985
4986 The ACLs, retry rules, and rewriting rules have their own syntax which is
4987 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4988 respectively. The other parts of the configuration file have some syntactic
4989 items in common, and these are described below, from section &<<SECTcos>>&
4990 onwards. Before that, the inclusion, macro, and conditional facilities are
4991 described.
4992
4993
4994
4995 .section "File inclusions in the configuration file" "SECID41"
4996 .cindex "inclusions in configuration file"
4997 .cindex "configuration file" "including other files"
4998 .cindex "&`.include`& in configuration file"
4999 .cindex "&`.include_if_exists`& in configuration file"
5000 You can include other files inside Exim's runtime configuration file by
5001 using this syntax:
5002 .display
5003 &`.include`& <&'filename'&>
5004 &`.include_if_exists`& <&'filename'&>
5005 .endd
5006 on a line by itself. Double quotes round the filename are optional. If you use
5007 the first form, a configuration error occurs if the file does not exist; the
5008 second form does nothing for non-existent files.
5009 The first form allows a relative name. It is resolved relative to
5010 the directory of the including file. For the second form an absolute filename
5011 is required.
5012
5013 Includes may be nested to any depth, but remember that Exim reads its
5014 configuration file often, so it is a good idea to keep them to a minimum.
5015 If you change the contents of an included file, you must HUP the daemon,
5016 because an included file is read only when the configuration itself is read.
5017
5018 The processing of inclusions happens early, at a physical line level, so, like
5019 comment lines, an inclusion can be used in the middle of an option setting,
5020 for example:
5021 .code
5022 hosts_lookup = a.b.c \
5023                .include /some/file
5024 .endd
5025 Include processing happens after macro processing (see below). Its effect is to
5026 process the lines of the included file as if they occurred inline where the
5027 inclusion appears.
5028
5029
5030
5031 .section "Macros in the configuration file" "SECTmacrodefs"
5032 .cindex "macro" "description of"
5033 .cindex "configuration file" "macros"
5034 If a line in the main part of the configuration (that is, before the first
5035 &"begin"& line) begins with an upper case letter, it is taken as a macro
5036 definition, and must be of the form
5037 .display
5038 <&'name'&> = <&'rest of line'&>
5039 .endd
5040 The name must consist of letters, digits, and underscores, and need not all be
5041 in upper case, though that is recommended. The rest of the line, including any
5042 continuations, is the replacement text, and has leading and trailing white
5043 space removed. Quotes are not removed. The replacement text can never end with
5044 a backslash character, but this doesn't seem to be a serious limitation.
5045
5046 Macros may also be defined between router, transport, authenticator, or ACL
5047 definitions. They may not, however, be defined within an individual driver or
5048 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5049
5050 .section "Macro substitution" "SECID42"
5051 Once a macro is defined, all subsequent lines in the file (and any included
5052 files) are scanned for the macro name; if there are several macros, the line is
5053 scanned for each, in turn, in the order in which the macros are defined. The
5054 replacement text is not re-scanned for the current macro, though it is scanned
5055 for subsequently defined macros. For this reason, a macro name may not contain
5056 the name of a previously defined macro as a substring. You could, for example,
5057 define
5058 .display
5059 &`ABCD_XYZ = `&<&'something'&>
5060 &`ABCD = `&<&'something else'&>
5061 .endd
5062 but putting the definitions in the opposite order would provoke a configuration
5063 error. Macro expansion is applied to individual physical lines from the file,
5064 before checking for line continuation or file inclusion (see above). If a line
5065 consists solely of a macro name, and the expansion of the macro is empty, the
5066 line is ignored. A macro at the start of a line may turn the line into a
5067 comment line or a &`.include`& line.
5068
5069
5070 .section "Redefining macros" "SECID43"
5071 Once defined, the value of a macro can be redefined later in the configuration
5072 (or in an included file). Redefinition is specified by using &'=='& instead of
5073 &'='&. For example:
5074 .code
5075 MAC =  initial value
5076 ...
5077 MAC == updated value
5078 .endd
5079 Redefinition does not alter the order in which the macros are applied to the
5080 subsequent lines of the configuration file. It is still the same order in which
5081 the macros were originally defined. All that changes is the macro's value.
5082 Redefinition makes it possible to accumulate values. For example:
5083 .code
5084 MAC =  initial value
5085 ...
5086 MAC == MAC and something added
5087 .endd
5088 This can be helpful in situations where the configuration file is built
5089 from a number of other files.
5090
5091 .section "Overriding macro values" "SECID44"
5092 The values set for macros in the configuration file can be overridden by the
5093 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5094 used, unless called by root or the Exim user. A definition on the command line
5095 using the &%-D%& option causes all definitions and redefinitions within the
5096 file to be ignored.
5097
5098
5099
5100 .section "Example of macro usage" "SECID45"
5101 As an example of macro usage, consider a configuration where aliases are looked
5102 up in a MySQL database. It helps to keep the file less cluttered if long
5103 strings such as SQL statements are defined separately as macros, for example:
5104 .code
5105 ALIAS_QUERY = select mailbox from user where \
5106               login='${quote_mysql:$local_part}';
5107 .endd
5108 This can then be used in a &(redirect)& router setting like this:
5109 .code
5110 data = ${lookup mysql{ALIAS_QUERY}}
5111 .endd
5112 In earlier versions of Exim macros were sometimes used for domain, host, or
5113 address lists. In Exim 4 these are handled better by named lists &-- see
5114 section &<<SECTnamedlists>>&.
5115
5116
5117 .section "Builtin macros" "SECTbuiltinmacros"
5118 Exim defines some macros depending on facilities available, which may
5119 differ due to build-time definitions and from one release to another.
5120 All of these macros start with an underscore.
5121 They can be used to conditionally include parts of a configuration
5122 (see below).
5123
5124 The following classes of macros are defined:
5125 .display
5126 &` _HAVE_*                    `&  build-time defines
5127 &` _DRIVER_ROUTER_*           `&  router drivers
5128 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5129 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5130 &` _LOG_*                     `&  log_selector values
5131 &` _OPT_MAIN_*                `&  main config options
5132 &` _OPT_ROUTERS_*             `&  generic router options
5133 &` _OPT_TRANSPORTS_*          `&  generic transport options
5134 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5135 &` _OPT_ROUTER_*_*            `&  private router options
5136 &` _OPT_TRANSPORT_*_*         `&  private transport options
5137 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5138 .endd
5139
5140 Use an &"exim -bP macros"& command to get the list of macros.
5141
5142
5143 .section "Conditional skips in the configuration file" "SECID46"
5144 .cindex "configuration file" "conditional skips"
5145 .cindex "&`.ifdef`&"
5146 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5147 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5148 portions of the configuration file. The processing happens whenever the file is
5149 read (that is, when an Exim binary starts to run).
5150
5151 The implementation is very simple. Instances of the first four directives must
5152 be followed by text that includes the names of one or macros. The condition
5153 that is tested is whether or not any macro substitution has taken place in the
5154 line. Thus:
5155 .code
5156 .ifdef AAA
5157 message_size_limit = 50M
5158 .else
5159 message_size_limit = 100M
5160 .endif
5161 .endd
5162 sets a message size limit of 50M if the macro &`AAA`& is defined
5163 (or &`A`& or &`AA`&), and 100M
5164 otherwise. If there is more than one macro named on the line, the condition
5165 is true if any of them are defined. That is, it is an &"or"& condition. To
5166 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5167
5168 Although you can use a macro expansion to generate one of these directives,
5169 it is not very useful, because the condition &"there was a macro substitution
5170 in this line"& will always be true.
5171
5172 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5173 to clarify complicated nestings.
5174
5175
5176
5177 .section "Common option syntax" "SECTcos"
5178 .cindex "common option syntax"
5179 .cindex "syntax of common options"
5180 .cindex "configuration file" "common option syntax"
5181 For the main set of options, driver options, and &[local_scan()]& options,
5182 each setting is on a line by itself, and starts with a name consisting of
5183 lower-case letters and underscores. Many options require a data value, and in
5184 these cases the name must be followed by an equals sign (with optional white
5185 space) and then the value. For example:
5186 .code
5187 qualify_domain = mydomain.example.com
5188 .endd
5189 .cindex "hiding configuration option values"
5190 .cindex "configuration options" "hiding value of"
5191 .cindex "options" "hiding value of"
5192 Some option settings may contain sensitive data, for example, passwords for
5193 accessing databases. To stop non-admin users from using the &%-bP%& command
5194 line option to read these values, you can precede the option settings with the
5195 word &"hide"&. For example:
5196 .code
5197 hide mysql_servers = localhost/users/admin/secret-password
5198 .endd
5199 For non-admin users, such options are displayed like this:
5200 .code
5201 mysql_servers = <value not displayable>
5202 .endd
5203 If &"hide"& is used on a driver option, it hides the value of that option on
5204 all instances of the same driver.
5205
5206 The following sections describe the syntax used for the different data types
5207 that are found in option settings.
5208
5209
5210 .section "Boolean options" "SECID47"
5211 .cindex "format" "boolean"
5212 .cindex "boolean configuration values"
5213 .oindex "&%no_%&&'xxx'&"
5214 .oindex "&%not_%&&'xxx'&"
5215 Options whose type is given as boolean are on/off switches. There are two
5216 different ways of specifying such options: with and without a data value. If
5217 the option name is specified on its own without data, the switch is turned on;
5218 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5219 boolean options may be followed by an equals sign and one of the words
5220 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5221 the following two settings have exactly the same effect:
5222 .code
5223 queue_only
5224 queue_only = true
5225 .endd
5226 The following two lines also have the same (opposite) effect:
5227 .code
5228 no_queue_only
5229 queue_only = false
5230 .endd
5231 You can use whichever syntax you prefer.
5232
5233
5234
5235
5236 .section "Integer values" "SECID48"
5237 .cindex "integer configuration values"
5238 .cindex "format" "integer"
5239 If an option's type is given as &"integer"&, the value can be given in decimal,
5240 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5241 number is assumed. Otherwise, it is treated as an octal number unless it starts
5242 with the characters &"0x"&, in which case the remainder is interpreted as a
5243 hexadecimal number.
5244
5245 If an integer value is followed by the letter K, it is multiplied by 1024; if
5246 it is followed by the letter M, it is multiplied by 1024x1024;
5247 if by the letter G, 1024x1024x1024.
5248 When the values
5249 of integer option settings are output, values which are an exact multiple of
5250 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5251 and M. The printing style is independent of the actual input format that was
5252 used.
5253
5254
5255 .section "Octal integer values" "SECID49"
5256 .cindex "integer format"
5257 .cindex "format" "octal integer"
5258 If an option's type is given as &"octal integer"&, its value is always
5259 interpreted as an octal number, whether or not it starts with the digit zero.
5260 Such options are always output in octal.
5261
5262
5263 .section "Fixed point numbers" "SECID50"
5264 .cindex "fixed point configuration values"
5265 .cindex "format" "fixed point"
5266 If an option's type is given as &"fixed-point"&, its value must be a decimal
5267 integer, optionally followed by a decimal point and up to three further digits.
5268
5269
5270
5271 .section "Time intervals" "SECTtimeformat"
5272 .cindex "time interval" "specifying in configuration"
5273 .cindex "format" "time interval"
5274 A time interval is specified as a sequence of numbers, each followed by one of
5275 the following letters, with no intervening white space:
5276
5277 .table2 30pt
5278 .irow &%s%& seconds
5279 .irow &%m%& minutes
5280 .irow &%h%& hours
5281 .irow &%d%& days
5282 .irow &%w%& weeks
5283 .endtable
5284
5285 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5286 intervals are output in the same format. Exim does not restrict the values; it
5287 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5288
5289
5290
5291 .section "String values" "SECTstrings"
5292 .cindex "string" "format of configuration values"
5293 .cindex "format" "string"
5294 If an option's type is specified as &"string"&, the value can be specified with
5295 or without double-quotes. If it does not start with a double-quote, the value
5296 consists of the remainder of the line plus any continuation lines, starting at
5297 the first character after any leading white space, with trailing white space
5298 removed, and with no interpretation of the characters in the string. Because
5299 Exim removes comment lines (those beginning with #) at an early stage, they can
5300 appear in the middle of a multi-line string. The following two settings are
5301 therefore equivalent:
5302 .code
5303 trusted_users = uucp:mail
5304 trusted_users = uucp:\
5305                 # This comment line is ignored
5306                 mail
5307 .endd
5308 .cindex "string" "quoted"
5309 .cindex "escape characters in quoted strings"
5310 If a string does start with a double-quote, it must end with a closing
5311 double-quote, and any backslash characters other than those used for line
5312 continuation are interpreted as escape characters, as follows:
5313
5314 .table2 100pt
5315 .irow &`\\`&                     "single backslash"
5316 .irow &`\n`&                     "newline"
5317 .irow &`\r`&                     "carriage return"
5318 .irow &`\t`&                     "tab"
5319 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5320 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5321                                    character"
5322 .endtable
5323
5324 If a backslash is followed by some other character, including a double-quote
5325 character, that character replaces the pair.
5326
5327 Quoting is necessary only if you want to make use of the backslash escapes to
5328 insert special characters, or if you need to specify a value with leading or
5329 trailing spaces. These cases are rare, so quoting is almost never needed in
5330 current versions of Exim. In versions of Exim before 3.14, quoting was required
5331 in order to continue lines, so you may come across older configuration files
5332 and examples that apparently quote unnecessarily.
5333
5334
5335 .section "Expanded strings" "SECID51"
5336 .cindex "expansion" "definition of"
5337 Some strings in the configuration file are subjected to &'string expansion'&,
5338 by which means various parts of the string may be changed according to the
5339 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5340 is as just described; in particular, the handling of backslashes in quoted
5341 strings is done as part of the input process, before expansion takes place.
5342 However, backslash is also an escape character for the expander, so any
5343 backslashes that are required for that reason must be doubled if they are
5344 within a quoted configuration string.
5345
5346
5347 .section "User and group names" "SECID52"
5348 .cindex "user name" "format of"
5349 .cindex "format" "user name"
5350 .cindex "groups" "name format"
5351 .cindex "format" "group name"
5352 User and group names are specified as strings, using the syntax described
5353 above, but the strings are interpreted specially. A user or group name must
5354 either consist entirely of digits, or be a name that can be looked up using the
5355 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5356
5357
5358 .section "List construction" "SECTlistconstruct"
5359 .cindex "list" "syntax of in configuration"
5360 .cindex "format" "list item in configuration"
5361 .cindex "string" "list, definition of"
5362 The data for some configuration options is a list of items, with colon as the
5363 default separator. Many of these options are shown with type &"string list"& in
5364 the descriptions later in this document. Others are listed as &"domain list"&,
5365 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5366 are all the same; however, those other than &"string list"& are subject to
5367 particular kinds of interpretation, as described in chapter
5368 &<<CHAPdomhosaddlists>>&.
5369
5370 In all these cases, the entire list is treated as a single string as far as the
5371 input syntax is concerned. The &%trusted_users%& setting in section
5372 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5373 in a list, it must be entered as two colons. Leading and trailing white space
5374 on each item in a list is ignored. This makes it possible to include items that
5375 start with a colon, and in particular, certain forms of IPv6 address. For
5376 example, the list
5377 .code
5378 local_interfaces = 127.0.0.1 : ::::1
5379 .endd
5380 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5381
5382 &*Note*&: Although leading and trailing white space is ignored in individual
5383 list items, it is not ignored when parsing the list. The space after the first
5384 colon in the example above is necessary. If it were not there, the list would
5385 be interpreted as the two items 127.0.0.1:: and 1.
5386
5387 .section "Changing list separators" "SECTlistsepchange"
5388 .cindex "list separator" "changing"
5389 .cindex "IPv6" "addresses in lists"
5390 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5391 introduced to allow the separator character to be changed. If a list begins
5392 with a left angle bracket, followed by any punctuation character, that
5393 character is used instead of colon as the list separator. For example, the list
5394 above can be rewritten to use a semicolon separator like this:
5395 .code
5396 local_interfaces = <; 127.0.0.1 ; ::1
5397 .endd
5398 This facility applies to all lists, with the exception of the list in
5399 &%log_file_path%&. It is recommended that the use of non-colon separators be
5400 confined to circumstances where they really are needed.
5401
5402 .cindex "list separator" "newline as"
5403 .cindex "newline" "as list separator"
5404 It is also possible to use newline and other control characters (those with
5405 code values less than 32, plus DEL) as separators in lists. Such separators
5406 must be provided literally at the time the list is processed. For options that
5407 are string-expanded, you can write the separator using a normal escape
5408 sequence. This will be processed by the expander before the string is
5409 interpreted as a list. For example, if a newline-separated list of domains is
5410 generated by a lookup, you can process it directly by a line such as this:
5411 .code
5412 domains = <\n ${lookup mysql{.....}}
5413 .endd
5414 This avoids having to change the list separator in such data. You are unlikely
5415 to want to use a control character as a separator in an option that is not
5416 expanded, because the value is literal text. However, it can be done by giving
5417 the value in quotes. For example:
5418 .code
5419 local_interfaces = "<\n 127.0.0.1 \n ::1"
5420 .endd
5421 Unlike printing character separators, which can be included in list items by
5422 doubling, it is not possible to include a control character as data when it is
5423 set as the separator. Two such characters in succession are interpreted as
5424 enclosing an empty list item.
5425
5426
5427
5428 .section "Empty items in lists" "SECTempitelis"
5429 .cindex "list" "empty item in"
5430 An empty item at the end of a list is always ignored. In other words, trailing
5431 separator characters are ignored. Thus, the list in
5432 .code
5433 senders = user@domain :
5434 .endd
5435 contains only a single item. If you want to include an empty string as one item
5436 in a list, it must not be the last item. For example, this list contains three
5437 items, the second of which is empty:
5438 .code
5439 senders = user1@domain : : user2@domain
5440 .endd
5441 &*Note*&: There must be white space between the two colons, as otherwise they
5442 are interpreted as representing a single colon data character (and the list
5443 would then contain just one item). If you want to specify a list that contains
5444 just one, empty item, you can do it as in this example:
5445 .code
5446 senders = :
5447 .endd
5448 In this case, the first item is empty, and the second is discarded because it
5449 is at the end of the list.
5450
5451
5452
5453
5454 .section "Format of driver configurations" "SECTfordricon"
5455 .cindex "drivers" "configuration format"
5456 There are separate parts in the configuration for defining routers, transports,
5457 and authenticators. In each part, you are defining a number of driver
5458 instances, each with its own set of options. Each driver instance is defined by
5459 a sequence of lines like this:
5460 .display
5461 <&'instance name'&>:
5462   <&'option'&>
5463   ...
5464   <&'option'&>
5465 .endd
5466 In the following example, the instance name is &(localuser)&, and it is
5467 followed by three options settings:
5468 .code
5469 localuser:
5470   driver = accept
5471   check_local_user
5472   transport = local_delivery
5473 .endd
5474 For each driver instance, you specify which Exim code module it uses &-- by the
5475 setting of the &%driver%& option &-- and (optionally) some configuration
5476 settings. For example, in the case of transports, if you want a transport to
5477 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5478 a local file you would use the &(appendfile)& driver. Each of the drivers is
5479 described in detail in its own separate chapter later in this manual.
5480
5481 You can have several routers, transports, or authenticators that are based on
5482 the same underlying driver (each must have a different instance name).
5483
5484 The order in which routers are defined is important, because addresses are
5485 passed to individual routers one by one, in order. The order in which
5486 transports are defined does not matter at all. The order in which
5487 authenticators are defined is used only when Exim, as a client, is searching
5488 them to find one that matches an authentication mechanism offered by the
5489 server.
5490
5491 .cindex "generic options"
5492 .cindex "options" "generic &-- definition of"
5493 Within a driver instance definition, there are two kinds of option: &'generic'&
5494 and &'private'&. The generic options are those that apply to all drivers of the
5495 same type (that is, all routers, all transports or all authenticators). The
5496 &%driver%& option is a generic option that must appear in every definition.
5497 .cindex "private options"
5498 The private options are special for each driver, and none need appear, because
5499 they all have default values.
5500
5501 The options may appear in any order, except that the &%driver%& option must
5502 precede any private options, since these depend on the particular driver. For
5503 this reason, it is recommended that &%driver%& always be the first option.
5504
5505 Driver instance names, which are used for reference in log entries and
5506 elsewhere, can be any sequence of letters, digits, and underscores (starting
5507 with a letter) and must be unique among drivers of the same type. A router and
5508 a transport (for example) can each have the same name, but no two router
5509 instances can have the same name. The name of a driver instance should not be
5510 confused with the name of the underlying driver module. For example, the
5511 configuration lines:
5512 .code
5513 remote_smtp:
5514   driver = smtp
5515 .endd
5516 create an instance of the &(smtp)& transport driver whose name is
5517 &(remote_smtp)&. The same driver code can be used more than once, with
5518 different instance names and different option settings each time. A second
5519 instance of the &(smtp)& transport, with different options, might be defined
5520 thus:
5521 .code
5522 special_smtp:
5523   driver = smtp
5524   port = 1234
5525   command_timeout = 10s
5526 .endd
5527 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5528 these transport instances from routers, and these names would appear in log
5529 lines.
5530
5531 Comment lines may be present in the middle of driver specifications. The full
5532 list of option settings for any particular driver instance, including all the
5533 defaulted values, can be extracted by making use of the &%-bP%& command line
5534 option.
5535
5536
5537
5538
5539
5540
5541 . ////////////////////////////////////////////////////////////////////////////
5542 . ////////////////////////////////////////////////////////////////////////////
5543
5544 .chapter "The default configuration file" "CHAPdefconfil"
5545 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5546 .cindex "default" "configuration file &""walk through""&"
5547 The default configuration file supplied with Exim as &_src/configure.default_&
5548 is sufficient for a host with simple mail requirements. As an introduction to
5549 the way Exim is configured, this chapter &"walks through"& the default
5550 configuration, giving brief explanations of the settings. Detailed descriptions
5551 of the options are given in subsequent chapters. The default configuration file
5552 itself contains extensive comments about ways you might want to modify the
5553 initial settings. However, note that there are many options that are not
5554 mentioned at all in the default configuration.
5555
5556
5557
5558 .section "Macros" "SECTdefconfmacros"
5559 All macros should be defined before any options.
5560
5561 One macro is specified, but commented out, in the default configuration:
5562 .code
5563 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5564 .endd
5565 If all off-site mail is expected to be delivered to a "smarthost", then set the
5566 hostname here and uncomment the macro.  This will affect which router is used
5567 later on.  If this is left commented out, then Exim will perform direct-to-MX
5568 deliveries using a &(dnslookup)& router.
5569
5570 In addition to macros defined here, Exim includes a number of built-in macros
5571 to enable configuration to be guarded by a binary built with support for a
5572 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5573
5574
5575 .section "Main configuration settings" "SECTdefconfmain"
5576 The main (global) configuration option settings section must always come first
5577 in the file, after the macros.
5578 The first thing you'll see in the file, after some initial comments, is the line
5579 .code
5580 # primary_hostname =
5581 .endd
5582 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5583 to know the official, fully qualified name of your host, and this is where you
5584 can specify it. However, in most cases you do not need to set this option. When
5585 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5586
5587 The first three non-comment configuration lines are as follows:
5588 .code
5589 domainlist local_domains    = @
5590 domainlist relay_to_domains =
5591 hostlist   relay_from_hosts = 127.0.0.1
5592 .endd
5593 These are not, in fact, option settings. They are definitions of two named
5594 domain lists and one named host list. Exim allows you to give names to lists of
5595 domains, hosts, and email addresses, in order to make it easier to manage the
5596 configuration file (see section &<<SECTnamedlists>>&).
5597
5598 The first line defines a domain list called &'local_domains'&; this is used
5599 later in the configuration to identify domains that are to be delivered
5600 on the local host.
5601
5602 .cindex "@ in a domain list"
5603 There is just one item in this list, the string &"@"&. This is a special form
5604 of entry which means &"the name of the local host"&. Thus, if the local host is
5605 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5606 be delivered locally. Because the local host's name is referenced indirectly,
5607 the same configuration file can be used on different hosts.
5608
5609 The second line defines a domain list called &'relay_to_domains'&, but the
5610 list itself is empty. Later in the configuration we will come to the part that
5611 controls mail relaying through the local host; it allows relaying to any
5612 domains in this list. By default, therefore, no relaying on the basis of a mail
5613 domain is permitted.
5614
5615 The third line defines a host list called &'relay_from_hosts'&. This list is
5616 used later in the configuration to permit relaying from any host or IP address
5617 that matches the list. The default contains just the IP address of the IPv4
5618 loopback interface, which means that processes on the local host are able to
5619 submit mail for relaying by sending it over TCP/IP to that interface. No other
5620 hosts are permitted to submit messages for relaying.
5621
5622 Just to be sure there's no misunderstanding: at this point in the configuration
5623 we aren't actually setting up any controls. We are just defining some domains
5624 and hosts that will be used in the controls that are specified later.
5625
5626 The next two configuration lines are genuine option settings:
5627 .code
5628 acl_smtp_rcpt = acl_check_rcpt
5629 acl_smtp_data = acl_check_data
5630 .endd
5631 These options specify &'Access Control Lists'& (ACLs) that are to be used
5632 during an incoming SMTP session for every recipient of a message (every RCPT
5633 command), and after the contents of the message have been received,
5634 respectively. The names of the lists are &'acl_check_rcpt'& and
5635 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5636 section of the configuration. The RCPT ACL controls which recipients are
5637 accepted for an incoming message &-- if a configuration does not provide an ACL
5638 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5639 contents of a message to be checked.
5640
5641 Two commented-out option settings are next:
5642 .code
5643 # av_scanner = clamd:/tmp/clamd
5644 # spamd_address = 127.0.0.1 783
5645 .endd
5646 These are example settings that can be used when Exim is compiled with the
5647 content-scanning extension. The first specifies the interface to the virus
5648 scanner, and the second specifies the interface to SpamAssassin. Further
5649 details are given in chapter &<<CHAPexiscan>>&.
5650
5651 Three more commented-out option settings follow:
5652 .code
5653 # tls_advertise_hosts = *
5654 # tls_certificate = /etc/ssl/exim.crt
5655 # tls_privatekey = /etc/ssl/exim.pem
5656 .endd
5657 These are example settings that can be used when Exim is compiled with
5658 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5659 first one specifies the list of clients that are allowed to use TLS when
5660 connecting to this server; in this case, the wildcard means all clients. The
5661 other options specify where Exim should find its TLS certificate and private
5662 key, which together prove the server's identity to any clients that connect.
5663 More details are given in chapter &<<CHAPTLS>>&.
5664
5665 Another two commented-out option settings follow:
5666 .code
5667 # daemon_smtp_ports = 25 : 465 : 587
5668 # tls_on_connect_ports = 465
5669 .endd
5670 .cindex "port" "465 and 587"
5671 .cindex "port" "for message submission"
5672 .cindex "message" "submission, ports for"
5673 .cindex "submissions protocol"
5674 .cindex "smtps protocol"
5675 .cindex "ssmtp protocol"
5676 .cindex "SMTP" "submissions protocol"
5677 .cindex "SMTP" "ssmtp protocol"
5678 .cindex "SMTP" "smtps protocol"
5679 These options provide better support for roaming users who wish to use this
5680 server for message submission. They are not much use unless you have turned on
5681 TLS (as described in the previous paragraph) and authentication (about which
5682 more in section &<<SECTdefconfauth>>&).
5683 Mail submission from mail clients (MUAs) should be separate from inbound mail
5684 to your domain (MX delivery) for various good reasons (eg, ability to impose
5685 much saner TLS protocol and ciphersuite requirements without unintended
5686 consequences).
5687 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5688 which uses STARTTLS, so this is the &"submission"& port.
5689 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5690 which should be used in preference to 587.
5691 You should also consider deploying SRV records to help clients find
5692 these ports.
5693 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5694
5695 Two more commented-out options settings follow:
5696 .code
5697 # qualify_domain =
5698 # qualify_recipient =
5699 .endd
5700 The first of these specifies a domain that Exim uses when it constructs a
5701 complete email address from a local login name. This is often needed when Exim
5702 receives a message from a local process. If you do not set &%qualify_domain%&,
5703 the value of &%primary_hostname%& is used. If you set both of these options,
5704 you can have different qualification domains for sender and recipient
5705 addresses. If you set only the first one, its value is used in both cases.
5706
5707 .cindex "domain literal" "recognizing format"
5708 The following line must be uncommented if you want Exim to recognize
5709 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5710 (an IP address within square brackets) instead of a named domain.
5711 .code
5712 # allow_domain_literals
5713 .endd
5714 The RFCs still require this form, but many people think that in the modern
5715 Internet it makes little sense to permit mail to be sent to specific hosts by
5716 quoting their IP addresses. This ancient format has been used by people who
5717 try to abuse hosts by using them for unwanted relaying. However, some
5718 people believe there are circumstances (for example, messages addressed to
5719 &'postmaster'&) where domain literals are still useful.
5720
5721 The next configuration line is a kind of trigger guard:
5722 .code
5723 never_users = root
5724 .endd
5725 It specifies that no delivery must ever be run as the root user. The normal
5726 convention is to set up &'root'& as an alias for the system administrator. This
5727 setting is a guard against slips in the configuration.
5728 The list of users specified by &%never_users%& is not, however, the complete
5729 list; the build-time configuration in &_Local/Makefile_& has an option called
5730 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5731 contents of &%never_users%& are added to this list. By default
5732 FIXED_NEVER_USERS also specifies root.
5733
5734 When a remote host connects to Exim in order to send mail, the only information
5735 Exim has about the host's identity is its IP address. The next configuration
5736 line,
5737 .code
5738 host_lookup = *
5739 .endd
5740 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5741 in order to get a host name. This improves the quality of the logging
5742 information, but if you feel it is too expensive, you can remove it entirely,
5743 or restrict the lookup to hosts on &"nearby"& networks.
5744 Note that it is not always possible to find a host name from an IP address,
5745 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5746 unreachable.
5747
5748 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5749 1413 (hence their names):
5750 .code
5751 rfc1413_hosts = *
5752 rfc1413_query_timeout = 0s
5753 .endd
5754 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5755 Few hosts offer RFC1413 service these days; calls have to be
5756 terminated by a timeout and this needlessly delays the startup
5757 of an incoming SMTP connection.
5758 If you have hosts for which you trust RFC1413 and need this
5759 information, you can change this.
5760
5761 This line enables an efficiency SMTP option.  It is negotiated by clients
5762 and not expected to cause problems but can be disabled if needed.
5763 .code
5764 prdr_enable = true
5765 .endd
5766
5767 When Exim receives messages over SMTP connections, it expects all addresses to
5768 be fully qualified with a domain, as required by the SMTP definition. However,
5769 if you are running a server to which simple clients submit messages, you may
5770 find that they send unqualified addresses. The two commented-out options:
5771 .code
5772 # sender_unqualified_hosts =
5773 # recipient_unqualified_hosts =
5774 .endd
5775 show how you can specify hosts that are permitted to send unqualified sender
5776 and recipient addresses, respectively.
5777
5778 The &%log_selector%& option is used to increase the detail of logging
5779 over the default:
5780 .code
5781 log_selector = +smtp_protocol_error +smtp_syntax_error \
5782                +tls_certificate_verified
5783 .endd
5784
5785 The &%percent_hack_domains%& option is also commented out:
5786 .code
5787 # percent_hack_domains =
5788 .endd
5789 It provides a list of domains for which the &"percent hack"& is to operate.
5790 This is an almost obsolete form of explicit email routing. If you do not know
5791 anything about it, you can safely ignore this topic.
5792
5793 The next two settings in the main part of the default configuration are
5794 concerned with messages that have been &"frozen"& on Exim's queue. When a
5795 message is frozen, Exim no longer continues to try to deliver it. Freezing
5796 occurs when a bounce message encounters a permanent failure because the sender
5797 address of the original message that caused the bounce is invalid, so the
5798 bounce cannot be delivered. This is probably the most common case, but there
5799 are also other conditions that cause freezing, and frozen messages are not
5800 always bounce messages.
5801 .code
5802 ignore_bounce_errors_after = 2d
5803 timeout_frozen_after = 7d
5804 .endd
5805 The first of these options specifies that failing bounce messages are to be
5806 discarded after 2 days in the queue. The second specifies that any frozen
5807 message (whether a bounce message or not) is to be timed out (and discarded)
5808 after a week. In this configuration, the first setting ensures that no failing
5809 bounce message ever lasts a week.
5810
5811 Exim queues it's messages in a spool directory. If you expect to have
5812 large queues, you may consider using this option. It splits the spool
5813 directory into subdirectories to avoid file system degradation from
5814 many files in a single directory, resulting in better performance.
5815 Manual manipulation of queued messages becomes more complex (though fortunately
5816 not often needed).
5817 .code
5818 # split_spool_directory = true
5819 .endd
5820
5821 In an ideal world everybody follows the standards. For non-ASCII
5822 messages RFC 2047 is a standard, allowing a maximum line length of 76
5823 characters. Exim adheres that standard and won't process messages which
5824 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5825 In particular, the Exim maintainers have had multiple reports of
5826 problems from Russian administrators of issues until they disable this
5827 check, because of some popular, yet buggy, mail composition software.
5828 .code
5829 # check_rfc2047_length = false
5830 .endd
5831
5832 If you need to be strictly RFC compliant you may wish to disable the
5833 8BITMIME advertisement. Use this, if you exchange mails with systems
5834 that are not 8-bit clean.
5835 .code
5836 # accept_8bitmime = false
5837 .endd
5838
5839 Libraries you use may depend on specific environment settings.  This
5840 imposes a security risk (e.g. PATH). There are two lists:
5841 &%keep_environment%& for the variables to import as they are, and
5842 &%add_environment%& for variables we want to set to a fixed value.
5843 Note that TZ is handled separately, by the $%timezone%$ runtime
5844 option and by the TIMEZONE_DEFAULT buildtime option.
5845 .code
5846 # keep_environment = ^LDAP
5847 # add_environment = PATH=/usr/bin::/bin
5848 .endd
5849
5850
5851 .section "ACL configuration" "SECID54"
5852 .cindex "default" "ACLs"
5853 .cindex "&ACL;" "default configuration"
5854 In the default configuration, the ACL section follows the main configuration.
5855 It starts with the line
5856 .code
5857 begin acl
5858 .endd
5859 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5860 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5861 and &%acl_smtp_data%& above.
5862
5863 .cindex "RCPT" "ACL for"
5864 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5865 RCPT command specifies one of the message's recipients. The ACL statements
5866 are considered in order, until the recipient address is either accepted or
5867 rejected. The RCPT command is then accepted or rejected, according to the
5868 result of the ACL processing.
5869 .code
5870 acl_check_rcpt:
5871 .endd
5872 This line, consisting of a name terminated by a colon, marks the start of the
5873 ACL, and names it.
5874 .code
5875 accept  hosts = :
5876 .endd
5877 This ACL statement accepts the recipient if the sending host matches the list.
5878 But what does that strange list mean? It doesn't actually contain any host
5879 names or IP addresses. The presence of the colon puts an empty item in the
5880 list; Exim matches this only if the incoming message did not come from a remote
5881 host, because in that case, the remote hostname is empty. The colon is
5882 important. Without it, the list itself is empty, and can never match anything.
5883
5884 What this statement is doing is to accept unconditionally all recipients in
5885 messages that are submitted by SMTP from local processes using the standard
5886 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5887 manner.
5888 .code
5889 deny    message       = Restricted characters in address
5890         domains       = +local_domains
5891         local_parts   = ^[.] : ^.*[@%!/|]
5892
5893 deny    message       = Restricted characters in address
5894         domains       = !+local_domains
5895         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5896 .endd
5897 These statements are concerned with local parts that contain any of the
5898 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5899 Although these characters are entirely legal in local parts (in the case of
5900 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5901 in Internet mail addresses.
5902
5903 The first three have in the past been associated with explicitly routed
5904 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5905 option). Addresses containing these characters are regularly tried by spammers
5906 in an attempt to bypass relaying restrictions, and also by open relay testing
5907 programs. Unless you really need them it is safest to reject these characters
5908 at this early stage. This configuration is heavy-handed in rejecting these
5909 characters for all messages it accepts from remote hosts. This is a deliberate
5910 policy of being as safe as possible.
5911
5912 The first rule above is stricter, and is applied to messages that are addressed
5913 to one of the local domains handled by this host. This is implemented by the
5914 first condition, which restricts it to domains that are listed in the
5915 &'local_domains'& domain list. The &"+"& character is used to indicate a
5916 reference to a named list. In this configuration, there is just one domain in
5917 &'local_domains'&, but in general there may be many.
5918
5919 The second condition on the first statement uses two regular expressions to
5920 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5921 or &"|"&. If you have local accounts that include these characters, you will
5922 have to modify this rule.
5923
5924 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5925 allows them because they have been encountered in practice. (Consider the
5926 common convention of local parts constructed as
5927 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5928 the author of Exim, who has no second initial.) However, a local part starting
5929 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5930 filename (for example, for a mailing list). This is also true for local parts
5931 that contain slashes. A pipe symbol can also be troublesome if the local part
5932 is incorporated unthinkingly into a shell command line.
5933
5934 The second rule above applies to all other domains, and is less strict. This
5935 allows your own users to send outgoing messages to sites that use slashes
5936 and vertical bars in their local parts. It blocks local parts that begin
5937 with a dot, slash, or vertical bar, but allows these characters within the
5938 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5939 and &"!"& is blocked, as before. The motivation here is to prevent your users
5940 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5941 .code
5942 accept  local_parts   = postmaster
5943         domains       = +local_domains
5944 .endd
5945 This statement, which has two conditions, accepts an incoming address if the
5946 local part is &'postmaster'& and the domain is one of those listed in the
5947 &'local_domains'& domain list. The &"+"& character is used to indicate a
5948 reference to a named list. In this configuration, there is just one domain in
5949 &'local_domains'&, but in general there may be many.
5950
5951 The presence of this statement means that mail to postmaster is never blocked
5952 by any of the subsequent tests. This can be helpful while sorting out problems
5953 in cases where the subsequent tests are incorrectly denying access.
5954 .code
5955 require verify        = sender
5956 .endd
5957 This statement requires the sender address to be verified before any subsequent
5958 ACL statement can be used. If verification fails, the incoming recipient
5959 address is refused. Verification consists of trying to route the address, to
5960 see if a bounce message could be delivered to it. In the case of remote
5961 addresses, basic verification checks only the domain, but &'callouts'& can be
5962 used for more verification if required. Section &<<SECTaddressverification>>&
5963 discusses the details of address verification.
5964 .code
5965 accept  hosts         = +relay_from_hosts
5966         control       = submission
5967 .endd
5968 This statement accepts the address if the message is coming from one of the
5969 hosts that are defined as being allowed to relay through this host. Recipient
5970 verification is omitted here, because in many cases the clients are dumb MUAs
5971 that do not cope well with SMTP error responses. For the same reason, the
5972 second line specifies &"submission mode"& for messages that are accepted. This
5973 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5974 messages that are deficient in some way, for example, because they lack a
5975 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5976 probably add recipient verification here, and disable submission mode.
5977 .code
5978 accept  authenticated = *
5979         control       = submission
5980 .endd
5981 This statement accepts the address if the client host has authenticated itself.
5982 Submission mode is again specified, on the grounds that such messages are most
5983 likely to come from MUAs. The default configuration does not define any
5984 authenticators, though it does include some nearly complete commented-out
5985 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5986 fact authenticate until you complete the authenticator definitions.
5987 .code
5988 require message = relay not permitted
5989         domains = +local_domains : +relay_to_domains
5990 .endd
5991 This statement rejects the address if its domain is neither a local domain nor
5992 one of the domains for which this host is a relay.
5993 .code
5994 require verify = recipient
5995 .endd
5996 This statement requires the recipient address to be verified; if verification
5997 fails, the address is rejected.
5998 .code
5999 # deny    message     = rejected because $sender_host_address \
6000 #                       is in a black list at $dnslist_domain\n\
6001 #                       $dnslist_text
6002 #         dnslists    = black.list.example
6003 #
6004 # warn    dnslists    = black.list.example
6005 #         add_header  = X-Warning: $sender_host_address is in \
6006 #                       a black list at $dnslist_domain
6007 #         log_message = found in $dnslist_domain
6008 .endd
6009 These commented-out lines are examples of how you could configure Exim to check
6010 sending hosts against a DNS black list. The first statement rejects messages
6011 from blacklisted hosts, whereas the second just inserts a warning header
6012 line.
6013 .code
6014 # require verify = csa
6015 .endd
6016 This commented-out line is an example of how you could turn on client SMTP
6017 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6018 records.
6019 .code
6020 accept
6021 .endd
6022 The final statement in the first ACL unconditionally accepts any recipient
6023 address that has successfully passed all the previous tests.
6024 .code
6025 acl_check_data:
6026 .endd
6027 This line marks the start of the second ACL, and names it. Most of the contents
6028 of this ACL are commented out:
6029 .code
6030 # deny    malware   = *
6031 #         message   = This message contains a virus \
6032 #                     ($malware_name).
6033 .endd
6034 These lines are examples of how to arrange for messages to be scanned for
6035 viruses when Exim has been compiled with the content-scanning extension, and a
6036 suitable virus scanner is installed. If the message is found to contain a
6037 virus, it is rejected with the given custom error message.
6038 .code
6039 # warn    spam      = nobody
6040 #         message   = X-Spam_score: $spam_score\n\
6041 #                     X-Spam_score_int: $spam_score_int\n\
6042 #                     X-Spam_bar: $spam_bar\n\
6043 #                     X-Spam_report: $spam_report
6044 .endd
6045 These lines are an example of how to arrange for messages to be scanned by
6046 SpamAssassin when Exim has been compiled with the content-scanning extension,
6047 and SpamAssassin has been installed. The SpamAssassin check is run with
6048 &`nobody`& as its user parameter, and the results are added to the message as a
6049 series of extra header line. In this case, the message is not rejected,
6050 whatever the spam score.
6051 .code
6052 accept
6053 .endd
6054 This final line in the DATA ACL accepts the message unconditionally.
6055
6056
6057 .section "Router configuration" "SECID55"
6058 .cindex "default" "routers"
6059 .cindex "routers" "default"
6060 The router configuration comes next in the default configuration, introduced
6061 by the line
6062 .code
6063 begin routers
6064 .endd
6065 Routers are the modules in Exim that make decisions about where to send
6066 messages. An address is passed to each router, in turn, until it is either
6067 accepted, or failed. This means that the order in which you define the routers
6068 matters. Each router is fully described in its own chapter later in this
6069 manual. Here we give only brief overviews.
6070 .code
6071 # domain_literal:
6072 #   driver = ipliteral
6073 #   domains = !+local_domains
6074 #   transport = remote_smtp
6075 .endd
6076 .cindex "domain literal" "default router"
6077 This router is commented out because the majority of sites do not want to
6078 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6079 you uncomment this router, you also need to uncomment the setting of
6080 &%allow_domain_literals%& in the main part of the configuration.
6081
6082 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6083 macro has been defined, per
6084 .code
6085 .ifdef ROUTER_SMARTHOST
6086 smarthost:
6087 #...
6088 .else
6089 dnslookup:
6090 #...
6091 .endif
6092 .endd
6093
6094 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6095 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6096 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6097 skip these routers because of the &%domains%& option.
6098
6099 .code
6100 smarthost:
6101   driver = manualroute
6102   domains = ! +local_domains
6103   transport = smarthost_smtp
6104   route_data = ROUTER_SMARTHOST
6105   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6106   no_more
6107 .endd
6108 This router only handles mail which is not to any local domains; this is
6109 specified by the line
6110 .code
6111 domains = ! +local_domains
6112 .endd
6113 The &%domains%& option lists the domains to which this router applies, but the
6114 exclamation mark is a negation sign, so the router is used only for domains
6115 that are not in the domain list called &'local_domains'& (which was defined at
6116 the start of the configuration). The plus sign before &'local_domains'&
6117 indicates that it is referring to a named list. Addresses in other domains are
6118 passed on to the following routers.
6119
6120 The name of the router driver is &(manualroute)& because we are manually
6121 specifying how mail should be routed onwards, instead of using DNS MX.
6122 While the name of this router instance is arbitrary, the &%driver%& option must
6123 be one of the driver modules that is in the Exim binary.
6124
6125 With no pre-conditions other than &%domains%&, all mail for non-local domains
6126 will be handled by this router, and the &%no_more%& setting will ensure that no
6127 other routers will be used for messages matching the pre-conditions.  See
6128 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6129 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6130 and the macro supplies the value; the address is then queued for the
6131 &(smarthost_smtp)& transport.
6132
6133 .code
6134 dnslookup:
6135   driver = dnslookup
6136   domains = ! +local_domains
6137   transport = remote_smtp
6138   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6139   no_more
6140 .endd
6141 The &%domains%& option behaves as per smarthost, above.
6142
6143 The name of the router driver is &(dnslookup)&,
6144 and is specified by the &%driver%& option. Do not be confused by the fact that
6145 the name of this router instance is the same as the name of the driver. The
6146 instance name is arbitrary, but the name set in the &%driver%& option must be
6147 one of the driver modules that is in the Exim binary.
6148
6149 The &(dnslookup)& router routes addresses by looking up their domains in the
6150 DNS in order to obtain a list of hosts to which the address is routed. If the
6151 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6152 specified by the &%transport%& option. If the router does not find the domain
6153 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6154 the address fails and is bounced.
6155
6156 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6157 be entirely ignored. This option is present because a number of cases have been
6158 encountered where MX records in the DNS point to host names
6159 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6160 Completely ignoring these IP addresses causes Exim to fail to route the
6161 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6162 continue to try to deliver the message periodically until the address timed
6163 out.
6164 .code
6165 system_aliases:
6166   driver = redirect
6167   allow_fail
6168   allow_defer
6169   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6170 # user = exim
6171   file_transport = address_file
6172   pipe_transport = address_pipe
6173 .endd
6174 Control reaches this and subsequent routers only for addresses in the local
6175 domains. This router checks to see whether the local part is defined as an
6176 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6177 data that it looks up from that file. If no data is found for the local part,
6178 the value of the &%data%& option is empty, causing the address to be passed to
6179 the next router.
6180
6181 &_/etc/aliases_& is a conventional name for the system aliases file that is
6182 often used. That is why it is referenced by from the default configuration
6183 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6184 &_Local/Makefile_& before building Exim.
6185 .code
6186 userforward:
6187   driver = redirect
6188   check_local_user
6189 # local_part_suffix = +* : -*
6190 # local_part_suffix_optional
6191   file = $home/.forward
6192 # allow_filter
6193   no_verify
6194   no_expn
6195   check_ancestor
6196   file_transport = address_file
6197   pipe_transport = address_pipe
6198   reply_transport = address_reply
6199 .endd
6200 This is the most complicated router in the default configuration. It is another
6201 redirection router, but this time it is looking for forwarding data set up by
6202 individual users. The &%check_local_user%& setting specifies a check that the
6203 local part of the address is the login name of a local user. If it is not, the
6204 router is skipped. The two commented options that follow &%check_local_user%&,
6205 namely:
6206 .code
6207 # local_part_suffix = +* : -*
6208 # local_part_suffix_optional
6209 .endd
6210 .vindex "&$local_part_suffix$&"
6211 show how you can specify the recognition of local part suffixes. If the first
6212 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6213 by any sequence of characters, is removed from the local part and placed in the
6214 variable &$local_part_suffix$&. The second suffix option specifies that the
6215 presence of a suffix in the local part is optional. When a suffix is present,
6216 the check for a local login uses the local part with the suffix removed.
6217
6218 When a local user account is found, the file called &_.forward_& in the user's
6219 home directory is consulted. If it does not exist, or is empty, the router
6220 declines. Otherwise, the contents of &_.forward_& are interpreted as
6221 redirection data (see chapter &<<CHAPredirect>>& for more details).
6222
6223 .cindex "Sieve filter" "enabling in default router"
6224 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6225 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6226 is commented out by default), the contents of the file are interpreted as a set
6227 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6228 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6229 separate document entitled &'Exim's interfaces to mail filtering'&.
6230
6231 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6232 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6233 There are two reasons for doing this:
6234
6235 .olist
6236 Whether or not a local user has a &_.forward_& file is not really relevant when
6237 checking an address for validity; it makes sense not to waste resources doing
6238 unnecessary work.
6239 .next
6240 More importantly, when Exim is verifying addresses or handling an EXPN
6241 command during an SMTP session, it is running as the Exim user, not as root.
6242 The group is the Exim group, and no additional groups are set up.
6243 It may therefore not be possible for Exim to read users' &_.forward_& files at
6244 this time.
6245 .endlist
6246
6247 The setting of &%check_ancestor%& prevents the router from generating a new
6248 address that is the same as any previous address that was redirected. (This
6249 works round a problem concerning a bad interaction between aliasing and
6250 forwarding &-- see section &<<SECTredlocmai>>&).
6251
6252 The final three option settings specify the transports that are to be used when
6253 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6254 auto-reply, respectively. For example, if a &_.forward_& file contains
6255 .code
6256 a.nother@elsewhere.example, /home/spqr/archive
6257 .endd
6258 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6259 transport.
6260 .code
6261 localuser:
6262   driver = accept
6263   check_local_user
6264 # local_part_suffix = +* : -*
6265 # local_part_suffix_optional
6266   transport = local_delivery
6267 .endd
6268 The final router sets up delivery into local mailboxes, provided that the local
6269 part is the name of a local login, by accepting the address and assigning it to
6270 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6271 routers, so the address is bounced. The commented suffix settings fulfil the
6272 same purpose as they do for the &(userforward)& router.
6273
6274
6275 .section "Transport configuration" "SECID56"
6276 .cindex "default" "transports"
6277 .cindex "transports" "default"
6278 Transports define mechanisms for actually delivering messages. They operate
6279 only when referenced from routers, so the order in which they are defined does
6280 not matter. The transports section of the configuration starts with
6281 .code
6282 begin transports
6283 .endd
6284 Two remote transports and four local transports are defined.
6285 .code
6286 remote_smtp:
6287   driver = smtp
6288   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6289 .ifdef _HAVE_PRDR
6290   hosts_try_prdr = *
6291 .endif
6292 .endd
6293 This transport is used for delivering messages over SMTP connections.
6294 The list of remote hosts comes from the router.
6295 The &%message_size_limit%& usage is a hack to avoid sending on messages
6296 with over-long lines.
6297
6298 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6299 negotiated between client and server and not expected to cause problems
6300 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6301 use of the &%hosts_try_prdr%& configuration option.
6302
6303 The other remote transport is used when delivering to a specific smarthost
6304 with whom there must be some kind of existing relationship, instead of the
6305 usual federated system.
6306
6307 .code
6308 smarthost_smtp:
6309   driver = smtp
6310   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6311   multi_domain
6312   #
6313 .ifdef _HAVE_TLS
6314   # Comment out any of these which you have to, then file a Support
6315   # request with your smarthost provider to get things fixed:
6316   hosts_require_tls = *
6317   tls_verify_hosts = *
6318   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6319   # have to comment it out then this will at least log whether you succeed
6320   # or not:
6321   tls_try_verify_hosts = *
6322   #
6323   # The SNI name should match the name which we'll expect to verify;
6324   # many mail systems don't use SNI and this doesn't matter, but if it does,
6325   # we need to send a name which the remote site will recognize.
6326   # This _should_ be the name which the smarthost operators specified as
6327   # the hostname for sending your mail to.
6328   tls_sni = ROUTER_SMARTHOST
6329   #
6330 .ifdef _HAVE_OPENSSL
6331   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6332 .endif
6333 .ifdef _HAVE_GNUTLS
6334   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6335 .endif
6336 .endif
6337 .ifdef _HAVE_PRDR
6338   hosts_try_prdr = *
6339 .endif
6340 .endd
6341 After the same &%message_size_limit%& hack, we then specify that this Transport
6342 can handle messages to multiple domains in one run.  The assumption here is
6343 that you're routing all non-local mail to the same place and that place is
6344 happy to take all messages from you as quickly as possible.
6345 All other options depend upon built-in macros; if Exim was built without TLS support
6346 then no other options are defined.
6347 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6348 and versions using the &%tls_require_ciphers%& option, where the value to be
6349 used depends upon the library providing TLS.
6350 Beyond that, the options adopt the stance that you should have TLS support available
6351 from your smarthost on today's Internet, so we turn on requiring TLS for the
6352 mail to be delivered, and requiring that the certificate be valid, and match
6353 the expected hostname.  The &%tls_sni%& option can be used by service providers
6354 to select an appropriate certificate to present to you and here we re-use the
6355 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6356 You want to specify the hostname which you'll expect to validate for, and that
6357 should not be subject to insecure tampering via DNS results.
6358
6359 For the &%hosts_try_prdr%& option see the previous transport.
6360
6361 All other options are defaulted.
6362 .code
6363 local_delivery:
6364   driver = appendfile
6365   file = /var/mail/$local_part_verified
6366   delivery_date_add
6367   envelope_to_add
6368   return_path_add
6369 # group = mail
6370 # mode = 0660
6371 .endd
6372 This &(appendfile)& transport is used for local delivery to user mailboxes in
6373 traditional BSD mailbox format.
6374
6375 .new
6376 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6377 as it is provided by a potential bad actor.
6378 Instead we use &$local_part_verified$&,
6379 the result of looking up &$local_part$& in the user database
6380 (done by using &%check_local_user%& in the the router).
6381 .wen
6382
6383 By default &(appendfile)& runs under the uid and gid of the
6384 local user, which requires the sticky bit to be set on the &_/var/mail_&
6385 directory. Some systems use the alternative approach of running mail deliveries
6386 under a particular group instead of using the sticky bit. The commented options
6387 show how this can be done.
6388
6389 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6390 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6391 similarly-named options above.
6392 .code
6393 address_pipe:
6394   driver = pipe
6395   return_output
6396 .endd
6397 This transport is used for handling deliveries to pipes that are generated by
6398 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6399 option specifies that any output on stdout or stderr generated by the pipe is to
6400 be returned to the sender.
6401 .code
6402 address_file:
6403   driver = appendfile
6404   delivery_date_add
6405   envelope_to_add
6406   return_path_add
6407 .endd
6408 This transport is used for handling deliveries to files that are generated by
6409 redirection. The name of the file is not specified in this instance of
6410 &(appendfile)&, because it comes from the &(redirect)& router.
6411 .code
6412 address_reply:
6413   driver = autoreply
6414 .endd
6415 This transport is used for handling automatic replies generated by users'
6416 filter files.
6417
6418
6419
6420 .section "Default retry rule" "SECID57"
6421 .cindex "retry" "default rule"
6422 .cindex "default" "retry rule"
6423 The retry section of the configuration file contains rules which affect the way
6424 Exim retries deliveries that cannot be completed at the first attempt. It is
6425 introduced by the line
6426 .code
6427 begin retry
6428 .endd
6429 In the default configuration, there is just one rule, which applies to all
6430 errors:
6431 .code
6432 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6433 .endd
6434 This causes any temporarily failing address to be retried every 15 minutes for
6435 2 hours, then at intervals starting at one hour and increasing by a factor of
6436 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6437 is not delivered after 4 days of temporary failure, it is bounced. The time is
6438 measured from first failure, not from the time the message was received.
6439
6440 If the retry section is removed from the configuration, or is empty (that is,
6441 if no retry rules are defined), Exim will not retry deliveries. This turns
6442 temporary errors into permanent errors.
6443
6444
6445 .section "Rewriting configuration" "SECID58"
6446 The rewriting section of the configuration, introduced by
6447 .code
6448 begin rewrite
6449 .endd
6450 contains rules for rewriting addresses in messages as they arrive. There are no
6451 rewriting rules in the default configuration file.
6452
6453
6454
6455 .section "Authenticators configuration" "SECTdefconfauth"
6456 .cindex "AUTH" "configuration"
6457 The authenticators section of the configuration, introduced by
6458 .code
6459 begin authenticators
6460 .endd
6461 defines mechanisms for the use of the SMTP AUTH command. The default
6462 configuration file contains two commented-out example authenticators
6463 which support plaintext username/password authentication using the
6464 standard PLAIN mechanism and the traditional but non-standard LOGIN
6465 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6466 to support most MUA software.
6467
6468 The example PLAIN authenticator looks like this:
6469 .code
6470 #PLAIN:
6471 #  driver                  = plaintext
6472 #  server_set_id           = $auth2
6473 #  server_prompts          = :
6474 #  server_condition        = Authentication is not yet configured
6475 #  server_advertise_condition = ${if def:tls_in_cipher }
6476 .endd
6477 And the example LOGIN authenticator looks like this:
6478 .code
6479 #LOGIN:
6480 #  driver                  = plaintext
6481 #  server_set_id           = $auth1
6482 #  server_prompts          = <| Username: | Password:
6483 #  server_condition        = Authentication is not yet configured
6484 #  server_advertise_condition = ${if def:tls_in_cipher }
6485 .endd
6486
6487 The &%server_set_id%& option makes Exim remember the authenticated username
6488 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6489 &%server_prompts%& option configures the &(plaintext)& authenticator so
6490 that it implements the details of the specific authentication mechanism,
6491 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6492 when Exim offers authentication to clients; in the examples, this is only
6493 when TLS or SSL has been started, so to enable the authenticators you also
6494 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6495
6496 The &%server_condition%& setting defines how to verify that the username and
6497 password are correct. In the examples it just produces an error message.
6498 To make the authenticators work, you can use a string expansion
6499 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6500
6501 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6502 usercode and password are in different positions.
6503 Chapter &<<CHAPplaintext>>& covers both.
6504
6505 .ecindex IIDconfiwal
6506
6507
6508
6509 . ////////////////////////////////////////////////////////////////////////////
6510 . ////////////////////////////////////////////////////////////////////////////
6511
6512 .chapter "Regular expressions" "CHAPregexp"
6513
6514 .cindex "regular expressions" "library"
6515 .cindex "PCRE"
6516 Exim supports the use of regular expressions in many of its options. It
6517 uses the PCRE regular expression library; this provides regular expression
6518 matching that is compatible with Perl 5. The syntax and semantics of
6519 regular expressions is discussed in
6520 online Perl manpages, in
6521 many Perl reference books, and also in
6522 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6523 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6524 . --- the http: URL here redirects to another page with the ISBN in the URL
6525 . --- where trying to use https: just redirects back to http:, so sticking
6526 . --- to the old URL for now.  2018-09-07.
6527
6528 The documentation for the syntax and semantics of the regular expressions that
6529 are supported by PCRE is included in the PCRE distribution, and no further
6530 description is included here. The PCRE functions are called from Exim using
6531 the default option settings (that is, with no PCRE options set), except that
6532 the PCRE_CASELESS option is set when the matching is required to be
6533 case-insensitive.
6534
6535 In most cases, when a regular expression is required in an Exim configuration,
6536 it has to start with a circumflex, in order to distinguish it from plain text
6537 or an &"ends with"& wildcard. In this example of a configuration setting, the
6538 second item in the colon-separated list is a regular expression.
6539 .code
6540 domains = a.b.c : ^\\d{3} : *.y.z : ...
6541 .endd
6542 The doubling of the backslash is required because of string expansion that
6543 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6544 of this issue, and a way of avoiding the need for doubling backslashes. The
6545 regular expression that is eventually used in this example contains just one
6546 backslash. The circumflex is included in the regular expression, and has the
6547 normal effect of &"anchoring"& it to the start of the string that is being
6548 matched.
6549
6550 There are, however, two cases where a circumflex is not required for the
6551 recognition of a regular expression: these are the &%match%& condition in a
6552 string expansion, and the &%matches%& condition in an Exim filter file. In
6553 these cases, the relevant string is always treated as a regular expression; if
6554 it does not start with a circumflex, the expression is not anchored, and can
6555 match anywhere in the subject string.
6556
6557 In all cases, if you want a regular expression to match at the end of a string,
6558 you must code the $ metacharacter to indicate this. For example:
6559 .code
6560 domains = ^\\d{3}\\.example
6561 .endd
6562 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6563 You need to use:
6564 .code
6565 domains = ^\\d{3}\\.example\$
6566 .endd
6567 if you want &'example'& to be the top-level domain. The backslash before the
6568 $ is needed because string expansion also interprets dollar characters.
6569
6570
6571
6572 . ////////////////////////////////////////////////////////////////////////////
6573 . ////////////////////////////////////////////////////////////////////////////
6574
6575 .chapter "File and database lookups" "CHAPfdlookup"
6576 .scindex IIDfidalo1 "file" "lookups"
6577 .scindex IIDfidalo2 "database" "lookups"
6578 .cindex "lookup" "description of"
6579 Exim can be configured to look up data in files or databases as it processes
6580 messages. Two different kinds of syntax are used:
6581
6582 .olist
6583 A string that is to be expanded may contain explicit lookup requests. These
6584 cause parts of the string to be replaced by data that is obtained from the
6585 lookup. Lookups of this type are conditional expansion items. Different results
6586 can be defined for the cases of lookup success and failure. See chapter
6587 &<<CHAPexpand>>&, where string expansions are described in detail.
6588 The key for the lookup is specified as part of the string expansion.
6589 .next
6590 Lists of domains, hosts, and email addresses can contain lookup requests as a
6591 way of avoiding excessively long linear lists. In this case, the data that is
6592 returned by the lookup is often (but not always) discarded; whether the lookup
6593 succeeds or fails is what really counts. These kinds of list are described in
6594 chapter &<<CHAPdomhosaddlists>>&.
6595 The key for the lookup is given by the context in which the list is expanded.
6596 .endlist
6597
6598 String expansions, lists, and lookups interact with each other in such a way
6599 that there is no order in which to describe any one of them that does not
6600 involve references to the others. Each of these three chapters makes more sense
6601 if you have read the other two first. If you are reading this for the first
6602 time, be aware that some of it will make a lot more sense after you have read
6603 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6604
6605 .section "Examples of different lookup syntax" "SECID60"
6606 It is easy to confuse the two different kinds of lookup, especially as the
6607 lists that may contain the second kind are always expanded before being
6608 processed as lists. Therefore, they may also contain lookups of the first kind.
6609 Be careful to distinguish between the following two examples:
6610 .code
6611 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6612 domains = lsearch;/some/file
6613 .endd
6614 The first uses a string expansion, the result of which must be a domain list.
6615 No strings have been specified for a successful or a failing lookup; the
6616 defaults in this case are the looked-up data and an empty string, respectively.
6617 The expansion takes place before the string is processed as a list, and the
6618 file that is searched could contain lines like this:
6619 .code
6620 192.168.3.4: domain1:domain2:...
6621 192.168.1.9: domain3:domain4:...
6622 .endd
6623 When the lookup succeeds, the result of the expansion is a list of domains (and
6624 possibly other types of item that are allowed in domain lists).
6625
6626 In the second example, the lookup is a single item in a domain list. It causes
6627 Exim to use a lookup to see if the domain that is being processed can be found
6628 in the file. The file could contains lines like this:
6629 .code
6630 domain1:
6631 domain2:
6632 .endd
6633 Any data that follows the keys is not relevant when checking that the domain
6634 matches the list item.
6635
6636 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6637 Consider a file containing lines like this:
6638 .code
6639 192.168.5.6: lsearch;/another/file
6640 .endd
6641 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6642 first &%domains%& setting above generates the second setting, which therefore
6643 causes a second lookup to occur.
6644
6645 The rest of this chapter describes the different lookup types that are
6646 available. Any of them can be used in any part of the configuration where a
6647 lookup is permitted.
6648
6649
6650 .section "Lookup types" "SECID61"
6651 .cindex "lookup" "types of"
6652 .cindex "single-key lookup" "definition of"
6653 Two different types of data lookup are implemented:
6654
6655 .ilist
6656 The &'single-key'& type requires the specification of a file in which to look,
6657 and a single key to search for. The key must be a non-empty string for the
6658 lookup to succeed. The lookup type determines how the file is searched.
6659 .next
6660 .cindex "query-style lookup" "definition of"
6661 The &'query-style'& type accepts a generalized database query. No particular
6662 key value is assumed by Exim for query-style lookups. You can use whichever
6663 Exim variables you need to construct the database query.
6664 .endlist
6665
6666 The code for each lookup type is in a separate source file that is included in
6667 the binary of Exim only if the corresponding compile-time option is set. The
6668 default settings in &_src/EDITME_& are:
6669 .code
6670 LOOKUP_DBM=yes
6671 LOOKUP_LSEARCH=yes
6672 .endd
6673 which means that only linear searching and DBM lookups are included by default.
6674 For some types of lookup (e.g. SQL databases), you need to install appropriate
6675 libraries and header files before building Exim.
6676
6677
6678
6679
6680 .section "Single-key lookup types" "SECTsinglekeylookups"
6681 .cindex "lookup" "single-key types"
6682 .cindex "single-key lookup" "list of types"
6683 The following single-key lookup types are implemented:
6684
6685 .ilist
6686 .cindex "cdb" "description of"
6687 .cindex "lookup" "cdb"
6688 .cindex "binary zero" "in lookup key"
6689 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6690 string without a terminating binary zero. The cdb format is designed for
6691 indexed files that are read frequently and never updated, except by total
6692 re-creation. As such, it is particularly suitable for large files containing
6693 aliases or other indexed data referenced by an MTA. Information about cdb and
6694 tools for building the files can be found in several places:
6695 .display
6696 &url(https://cr.yp.to/cdb.html)
6697 &url(https://www.corpit.ru/mjt/tinycdb.html)
6698 &url(https://packages.debian.org/stable/utils/freecdb)
6699 &url(https://github.com/philpennock/cdbtools) (in Go)
6700 .endd
6701 A cdb distribution is not needed in order to build Exim with cdb support,
6702 because the code for reading cdb files is included directly in Exim itself.
6703 However, no means of building or testing cdb files is provided with Exim, so
6704 you need to obtain a cdb distribution in order to do this.
6705 .next
6706 .cindex "DBM" "lookup type"
6707 .cindex "lookup" "dbm"
6708 .cindex "binary zero" "in lookup key"
6709 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6710 DBM file by looking up the record with the given key. A terminating binary
6711 zero is included in the key that is passed to the DBM library. See section
6712 &<<SECTdb>>& for a discussion of DBM libraries.
6713
6714 .cindex "Berkeley DB library" "file format"
6715 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6716 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6717 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6718 the DB_UNKNOWN option. This enables it to handle any of the types of database
6719 that the library supports, and can be useful for accessing DBM files created by
6720 other applications. (For earlier DB versions, DB_HASH is always used.)
6721 .next
6722 .cindex "lookup" "dbmjz"
6723 .cindex "lookup" "dbm &-- embedded NULs"
6724 .cindex "sasldb2"
6725 .cindex "dbmjz lookup type"
6726 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6727 interpreted as an Exim list; the elements of the list are joined together with
6728 ASCII NUL characters to form the lookup key.  An example usage would be to
6729 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6730 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6731 &(cram_md5)& authenticator.
6732 .next
6733 .cindex "lookup" "dbmnz"
6734 .cindex "lookup" "dbm &-- terminating zero"
6735 .cindex "binary zero" "in lookup key"
6736 .cindex "Courier"
6737 .cindex "&_/etc/userdbshadow.dat_&"
6738 .cindex "dbmnz lookup type"
6739 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6740 is not included in the key that is passed to the DBM library. You may need this
6741 if you want to look up data in files that are created by or shared with some
6742 other application that does not use terminating zeros. For example, you need to
6743 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6744 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6745 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6746 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6747 .next
6748 .cindex "lookup" "dsearch"
6749 .cindex "dsearch lookup type"
6750 &(dsearch)&: The given file must be a directory; this is searched for an entry
6751 whose name is the key by calling the &[lstat()]& function. The key may not
6752 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6753 the lookup is the name of the entry, which may be a file, directory,
6754 symbolic link, or any other kind of directory entry. An example of how this
6755 lookup can be used to support virtual domains is given in section
6756 &<<SECTvirtualdomains>>&.
6757 .next
6758 .cindex "lookup" "iplsearch"
6759 .cindex "iplsearch lookup type"
6760 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6761 terminated by a colon or white space or the end of the line. The keys in the
6762 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6763 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6764 being interpreted as a key terminator. For example:
6765 .code
6766 1.2.3.4:           data for 1.2.3.4
6767 192.168.0.0/16:    data for 192.168.0.0/16
6768 "abcd::cdab":      data for abcd::cdab
6769 "abcd:abcd::/32"   data for abcd:abcd::/32
6770 .endd
6771 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6772 file is searched linearly, using the CIDR masks where present, until a matching
6773 key is found. The first key that matches is used; there is no attempt to find a
6774 &"best"& match. Apart from the way the keys are matched, the processing for
6775 &(iplsearch)& is the same as for &(lsearch)&.
6776
6777 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6778 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6779 lookup types support only literal keys.
6780
6781 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6782 the implicit key is the host's IP address rather than its name (see section
6783 &<<SECThoslispatsikey>>&).
6784
6785 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6786 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6787 notation before executing the lookup.)
6788 .next
6789 .cindex lookup json
6790 .cindex json "lookup type"
6791 .cindex JSON expansions
6792 &(json)&: The given file is a text file with a JSON structure.
6793 An element of the structure is extracted, defined by the search key.
6794 The key is a list of subelement selectors
6795 (colon-separated by default but changeable in the usual way)
6796 which are applied in turn to select smaller and smaller portions
6797 of the JSON structure.
6798 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6799 nunbered array element is selected.
6800 Otherwise it must apply to a JSON object; the named element is selected.
6801 The final resulting element can be a simple JSON type or a JSON object
6802 or array; for the latter two a string-representation os the JSON
6803 is returned.
6804 For elements of type string, the returned value is de-quoted.
6805 .next
6806 .cindex "linear search"
6807 .cindex "lookup" "lsearch"
6808 .cindex "lsearch lookup type"
6809 .cindex "case sensitivity" "in lsearch lookup"
6810 &(lsearch)&: The given file is a text file that is searched linearly for a
6811 line beginning with the search key, terminated by a colon or white space or the
6812 end of the line. The search is case-insensitive; that is, upper and lower case
6813 letters are treated as the same. The first occurrence of the key that is found
6814 in the file is used.
6815
6816 White space between the key and the colon is permitted. The remainder of the
6817 line, with leading and trailing white space removed, is the data. This can be
6818 continued onto subsequent lines by starting them with any amount of white
6819 space, but only a single space character is included in the data at such a
6820 junction. If the data begins with a colon, the key must be terminated by a
6821 colon, for example:
6822 .code
6823 baduser:  :fail:
6824 .endd
6825 Empty lines and lines beginning with # are ignored, even if they occur in the
6826 middle of an item. This is the traditional textual format of alias files. Note
6827 that the keys in an &(lsearch)& file are literal strings. There is no
6828 wildcarding of any kind.
6829
6830 .cindex "lookup" "lsearch &-- colons in keys"
6831 .cindex "white space" "in lsearch key"
6832 In most &(lsearch)& files, keys are not required to contain colons or #
6833 characters, or white space. However, if you need this feature, it is available.
6834 If a key begins with a doublequote character, it is terminated only by a
6835 matching quote (or end of line), and the normal escaping rules apply to its
6836 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6837 quoted keys (exactly as for unquoted keys). There is no special handling of
6838 quotes for the data part of an &(lsearch)& line.
6839
6840 .next
6841 .cindex "NIS lookup type"
6842 .cindex "lookup" "NIS"
6843 .cindex "binary zero" "in lookup key"
6844 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6845 the given key, without a terminating binary zero. There is a variant called
6846 &(nis0)& which does include the terminating binary zero in the key. This is
6847 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6848 aliases; the full map names must be used.
6849
6850 .next
6851 .cindex "wildlsearch lookup type"
6852 .cindex "lookup" "wildlsearch"
6853 .cindex "nwildlsearch lookup type"
6854 .cindex "lookup" "nwildlsearch"
6855 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6856 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6857 the file may be wildcarded. The difference between these two lookup types is
6858 that for &(wildlsearch)&, each key in the file is string-expanded before being
6859 used, whereas for &(nwildlsearch)&, no expansion takes place.
6860
6861 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6862 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6863 file that are regular expressions can be made case-sensitive by the use of
6864 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6865
6866 . ==== As this is a nested list, any displays it contains must be indented
6867 . ==== as otherwise they are too far to the left.
6868
6869 .olist
6870 The string may begin with an asterisk to mean &"ends with"&. For example:
6871 .code
6872     *.a.b.c       data for anything.a.b.c
6873     *fish         data for anythingfish
6874 .endd
6875 .next
6876 The string may begin with a circumflex to indicate a regular expression. For
6877 example, for &(wildlsearch)&:
6878 .code
6879     ^\N\d+\.a\.b\N    data for <digits>.a.b
6880 .endd
6881 Note the use of &`\N`& to disable expansion of the contents of the regular
6882 expression. If you are using &(nwildlsearch)&, where the keys are not
6883 string-expanded, the equivalent entry is:
6884 .code
6885     ^\d+\.a\.b        data for <digits>.a.b
6886 .endd
6887 The case-insensitive flag is set at the start of compiling the regular
6888 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6889 For example, to make the entire pattern case-sensitive:
6890 .code
6891     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6892 .endd
6893
6894 If the regular expression contains white space or colon characters, you must
6895 either quote it (see &(lsearch)& above), or represent these characters in other
6896 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6897 colon. This may be easier than quoting, because if you quote, you have to
6898 escape all the backslashes inside the quotes.
6899
6900 &*Note*&: It is not possible to capture substrings in a regular expression
6901 match for later use, because the results of all lookups are cached. If a lookup
6902 is repeated, the result is taken from the cache, and no actual pattern matching
6903 takes place. The values of all the numeric variables are unset after a
6904 &((n)wildlsearch)& match.
6905
6906 .next
6907 Although I cannot see it being of much use, the general matching function that
6908 is used to implement &((n)wildlsearch)& means that the string may begin with a
6909 lookup name terminated by a semicolon, and followed by lookup data. For
6910 example:
6911 .code
6912     cdb;/some/file  data for keys that match the file
6913 .endd
6914 The data that is obtained from the nested lookup is discarded.
6915 .endlist olist
6916
6917 Keys that do not match any of these patterns are interpreted literally. The
6918 continuation rules for the data are the same as for &(lsearch)&, and keys may
6919 be followed by optional colons.
6920
6921 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6922 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6923 lookup types support only literal keys.
6924
6925 .next
6926 .cindex "lookup" "spf"
6927 If Exim is built with SPF support, manual lookups can be done
6928 (as opposed to the standard ACL condition method.
6929 For details see section &<<SECSPF>>&.
6930 .endlist ilist
6931
6932
6933 .section "Query-style lookup types" "SECTquerystylelookups"
6934 .cindex "lookup" "query-style types"
6935 .cindex "query-style lookup" "list of types"
6936 The supported query-style lookup types are listed below. Further details about
6937 many of them are given in later sections.
6938
6939 .ilist
6940 .cindex "DNS" "as a lookup type"
6941 .cindex "lookup" "DNS"
6942 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6943 are given in the supplied query. The resulting data is the contents of the
6944 records. See section &<<SECTdnsdb>>&.
6945 .next
6946 .cindex "InterBase lookup type"
6947 .cindex "lookup" "InterBase"
6948 &(ibase)&: This does a lookup in an InterBase database.
6949 .next
6950 .cindex "LDAP" "lookup type"
6951 .cindex "lookup" "LDAP"
6952 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6953 returns attributes from a single entry. There is a variant called &(ldapm)&
6954 that permits values from multiple entries to be returned. A third variant
6955 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6956 any attribute values. See section &<<SECTldap>>&.
6957 .next
6958 .cindex "MySQL" "lookup type"
6959 .cindex "lookup" "MySQL"
6960 &(mysql)&: The format of the query is an SQL statement that is passed to a
6961 MySQL database. See section &<<SECTsql>>&.
6962 .next
6963 .cindex "NIS+ lookup type"
6964 .cindex "lookup" "NIS+"
6965 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6966 the field to be returned. See section &<<SECTnisplus>>&.
6967 .next
6968 .cindex "Oracle" "lookup type"
6969 .cindex "lookup" "Oracle"
6970 &(oracle)&: The format of the query is an SQL statement that is passed to an
6971 Oracle database. See section &<<SECTsql>>&.
6972 .next
6973 .cindex "lookup" "passwd"
6974 .cindex "passwd lookup type"
6975 .cindex "&_/etc/passwd_&"
6976 &(passwd)& is a query-style lookup with queries that are just user names. The
6977 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6978 success, the result string is the same as you would get from an &(lsearch)&
6979 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6980 password value. For example:
6981 .code
6982 *:42:42:King Rat:/home/kr:/bin/bash
6983 .endd
6984 .next
6985 .cindex "PostgreSQL lookup type"
6986 .cindex "lookup" "PostgreSQL"
6987 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6988 PostgreSQL database. See section &<<SECTsql>>&.
6989
6990 .next
6991 .cindex "Redis lookup type"
6992 .cindex lookup Redis
6993 &(redis)&: The format of the query is either a simple get or simple set,
6994 passed to a Redis database. See section &<<SECTsql>>&.
6995
6996 .next
6997 .cindex "sqlite lookup type"
6998 .cindex "lookup" "sqlite"
6999 &(sqlite)&: The format of the query is a filename followed by an SQL statement
7000 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7001
7002 .next
7003 &(testdb)&: This is a lookup type that is used for testing Exim. It is
7004 not likely to be useful in normal operation.
7005 .next
7006 .cindex "whoson lookup type"
7007 .cindex "lookup" "whoson"
7008 . --- still http:-only, 2018-09-07
7009 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7010 allows a server to check whether a particular (dynamically allocated) IP
7011 address is currently allocated to a known (trusted) user and, optionally, to
7012 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7013 at one time for &"POP before SMTP"& authentication, but that approach has been
7014 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7015 &"POP before SMTP"& checking using ACL statements such as
7016 .code
7017 require condition = \
7018   ${lookup whoson {$sender_host_address}{yes}{no}}
7019 .endd
7020 The query consists of a single IP address. The value returned is the name of
7021 the authenticated user, which is stored in the variable &$value$&. However, in
7022 this example, the data in &$value$& is not used; the result of the lookup is
7023 one of the fixed strings &"yes"& or &"no"&.
7024 .endlist
7025
7026
7027
7028 .section "Temporary errors in lookups" "SECID63"
7029 .cindex "lookup" "temporary error in"
7030 Lookup functions can return temporary error codes if the lookup cannot be
7031 completed. For example, an SQL or LDAP database might be unavailable. For this
7032 reason, it is not advisable to use a lookup that might do this for critical
7033 options such as a list of local domains.
7034
7035 When a lookup cannot be completed in a router or transport, delivery
7036 of the message (to the relevant address) is deferred, as for any other
7037 temporary error. In other circumstances Exim may assume the lookup has failed,
7038 or may give up altogether.
7039
7040
7041
7042 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7043 .cindex "wildcard lookups"
7044 .cindex "lookup" "default values"
7045 .cindex "lookup" "wildcard"
7046 .cindex "lookup" "* added to type"
7047 .cindex "default" "in single-key lookups"
7048 In this context, a &"default value"& is a value specified by the administrator
7049 that is to be used if a lookup fails.
7050
7051 &*Note:*& This section applies only to single-key lookups. For query-style
7052 lookups, the facilities of the query language must be used. An attempt to
7053 specify a default for a query-style lookup provokes an error.
7054
7055 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7056 and the initial lookup fails, the key &"*"& is looked up in the file to
7057 provide a default value. See also the section on partial matching below.
7058
7059 .cindex "*@ with single-key lookup"
7060 .cindex "lookup" "*@ added to type"
7061 .cindex "alias file" "per-domain default"
7062 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7063 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7064 character, a second lookup is done with everything before the last @ replaced
7065 by *. This makes it possible to provide per-domain defaults in alias files
7066 that include the domains in the keys. If the second lookup fails (or doesn't
7067 take place because there is no @ in the key), &"*"& is looked up.
7068 For example, a &(redirect)& router might contain:
7069 .code
7070 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7071 .endd
7072 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7073 looks up these keys, in this order:
7074 .code
7075 jane@eyre.example
7076 *@eyre.example
7077 *
7078 .endd
7079 The data is taken from whichever key it finds first. &*Note*&: In an
7080 &(lsearch)& file, this does not mean the first of these keys in the file. A
7081 complete scan is done for each key, and only if it is not found at all does
7082 Exim move on to try the next key.
7083
7084
7085
7086 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7087 .cindex "partial matching"
7088 .cindex "wildcard lookups"
7089 .cindex "lookup" "partial matching"
7090 .cindex "lookup" "wildcard"
7091 .cindex "asterisk" "in search type"
7092 The normal operation of a single-key lookup is to search the file for an exact
7093 match with the given key. However, in a number of situations where domains are
7094 being looked up, it is useful to be able to do partial matching. In this case,
7095 information in the file that has a key starting with &"*."& is matched by any
7096 domain that ends with the components that follow the full stop. For example, if
7097 a key in a DBM file is
7098 .code
7099 *.dates.fict.example
7100 .endd
7101 then when partial matching is enabled this is matched by (amongst others)
7102 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7103 by &'dates.fict.example'&, if that does not appear as a separate key in the
7104 file.
7105
7106 &*Note*&: Partial matching is not available for query-style lookups. It is
7107 also not available for any lookup items in address lists (see section
7108 &<<SECTaddresslist>>&).
7109
7110 Partial matching is implemented by doing a series of separate lookups using
7111 keys constructed by modifying the original subject key. This means that it can
7112 be used with any of the single-key lookup types, provided that
7113 partial matching keys
7114 beginning with a special prefix (default &"*."&) are included in the data file.
7115 Keys in the file that do not begin with the prefix are matched only by
7116 unmodified subject keys when partial matching is in use.
7117
7118 Partial matching is requested by adding the string &"partial-"& to the front of
7119 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7120 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7121 is added at the start of the subject key, and it is looked up again. If that
7122 fails, further lookups are tried with dot-separated components removed from the
7123 start of the subject key, one-by-one, and &"*."& added on the front of what
7124 remains.
7125
7126 A minimum number of two non-* components are required. This can be adjusted
7127 by including a number before the hyphen in the search type. For example,
7128 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7129 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7130 subject key is &'2250.dates.fict.example'& then the following keys are looked
7131 up when the minimum number of non-* components is two:
7132 .code
7133 2250.dates.fict.example
7134 *.2250.dates.fict.example
7135 *.dates.fict.example
7136 *.fict.example
7137 .endd
7138 As soon as one key in the sequence is successfully looked up, the lookup
7139 finishes.
7140
7141 .cindex "lookup" "partial matching &-- changing prefix"
7142 .cindex "prefix" "for partial matching"
7143 The use of &"*."& as the partial matching prefix is a default that can be
7144 changed. The motivation for this feature is to allow Exim to operate with file
7145 formats that are used by other MTAs. A different prefix can be supplied in
7146 parentheses instead of the hyphen after &"partial"&. For example:
7147 .code
7148 domains = partial(.)lsearch;/some/file
7149 .endd
7150 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7151 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7152 components is unchanged). The prefix may consist of any punctuation characters
7153 other than a closing parenthesis. It may be empty, for example:
7154 .code
7155 domains = partial1()cdb;/some/file
7156 .endd
7157 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7158 &`a.b.c`&, &`b.c`&, and &`c`&.
7159
7160 If &"partial0"& is specified, what happens at the end (when the lookup with
7161 just one non-wild component has failed, and the original key is shortened right
7162 down to the null string) depends on the prefix:
7163
7164 .ilist
7165 If the prefix has zero length, the whole lookup fails.
7166 .next
7167 If the prefix has length 1, a lookup for just the prefix is done. For
7168 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7169 .next
7170 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7171 remainder is looked up. With the default prefix, therefore, the final lookup is
7172 for &"*"& on its own.
7173 .next
7174 Otherwise, the whole prefix is looked up.
7175 .endlist
7176
7177
7178 If the search type ends in &"*"& or &"*@"& (see section
7179 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7180 this implies happens after all partial lookups have failed. If &"partial0"& is
7181 specified, adding &"*"& to the search type has no effect with the default
7182 prefix, because the &"*"& key is already included in the sequence of partial
7183 lookups. However, there might be a use for lookup types such as
7184 &"partial0(.)lsearch*"&.
7185
7186 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7187 in domain lists and the like. Partial matching works only in terms of
7188 dot-separated components; a key such as &`*fict.example`&
7189 in a database file is useless, because the asterisk in a partial matching
7190 subject key is always followed by a dot.
7191
7192
7193
7194
7195 .section "Lookup caching" "SECID64"
7196 .cindex "lookup" "caching"
7197 .cindex "caching" "lookup data"
7198 Exim caches all lookup results in order to avoid needless repetition of
7199 lookups. However, because (apart from the daemon) Exim operates as a collection
7200 of independent, short-lived processes, this caching applies only within a
7201 single Exim process. There is no inter-process lookup caching facility.
7202
7203 For single-key lookups, Exim keeps the relevant files open in case there is
7204 another lookup that needs them. In some types of configuration this can lead to
7205 many files being kept open for messages with many recipients. To avoid hitting
7206 the operating system limit on the number of simultaneously open files, Exim
7207 closes the least recently used file when it needs to open more files than its
7208 own internal limit, which can be changed via the &%lookup_open_max%& option.
7209
7210 The single-key lookup files are closed and the lookup caches are flushed at
7211 strategic points during delivery &-- for example, after all routing is
7212 complete.
7213
7214
7215
7216
7217 .section "Quoting lookup data" "SECID65"
7218 .cindex "lookup" "quoting"
7219 .cindex "quoting" "in lookups"
7220 When data from an incoming message is included in a query-style lookup, there
7221 is the possibility of special characters in the data messing up the syntax of
7222 the query. For example, a NIS+ query that contains
7223 .code
7224 [name=$local_part]
7225 .endd
7226 will be broken if the local part happens to contain a closing square bracket.
7227 For NIS+, data can be enclosed in double quotes like this:
7228 .code
7229 [name="$local_part"]
7230 .endd
7231 but this still leaves the problem of a double quote in the data. The rule for
7232 NIS+ is that double quotes must be doubled. Other lookup types have different
7233 rules, and to cope with the differing requirements, an expansion operator
7234 of the following form is provided:
7235 .code
7236 ${quote_<lookup-type>:<string>}
7237 .endd
7238 For example, the safest way to write the NIS+ query is
7239 .code
7240 [name="${quote_nisplus:$local_part}"]
7241 .endd
7242 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7243 operator can be used for all lookup types, but has no effect for single-key
7244 lookups, since no quoting is ever needed in their key strings.
7245
7246
7247
7248
7249 .section "More about dnsdb" "SECTdnsdb"
7250 .cindex "dnsdb lookup"
7251 .cindex "lookup" "dnsdb"
7252 .cindex "DNS" "as a lookup type"
7253 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7254 of a record type and a domain name, separated by an equals sign. For example,
7255 an expansion string could contain:
7256 .code
7257 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7258 .endd
7259 If the lookup succeeds, the result is placed in &$value$&, which in this case
7260 is used on its own as the result. If the lookup does not succeed, the
7261 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7262 &<<SECTforexpfai>>& for an explanation of what this means.
7263
7264 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7265 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7266 If no type is given, TXT is assumed.
7267
7268 For any record type, if multiple records are found, the data is returned as a
7269 concatenation, with newline as the default separator. The order, of course,
7270 depends on the DNS resolver. You can specify a different separator character
7271 between multiple records by putting a right angle-bracket followed immediately
7272 by the new separator at the start of the query. For example:
7273 .code
7274 ${lookup dnsdb{>: a=host1.example}}
7275 .endd
7276 It is permitted to specify a space as the separator character. Further
7277 white space is ignored.
7278 For lookup types that return multiple fields per record,
7279 an alternate field separator can be specified using a comma after the main
7280 separator character, followed immediately by the field separator.
7281
7282 .cindex "PTR record" "in &(dnsdb)& lookup"
7283 When the type is PTR,
7284 the data can be an IP address, written as normal; inversion and the addition of
7285 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7286 .code
7287 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7288 .endd
7289 If the data for a PTR record is not a syntactically valid IP address, it is not
7290 altered and nothing is added.
7291
7292 .cindex "MX record" "in &(dnsdb)& lookup"
7293 .cindex "SRV record" "in &(dnsdb)& lookup"
7294 For an MX lookup, both the preference value and the host name are returned for
7295 each record, separated by a space. For an SRV lookup, the priority, weight,
7296 port, and host name are returned for each record, separated by spaces.
7297 The field separator can be modified as above.
7298
7299 .cindex "TXT record" "in &(dnsdb)& lookup"
7300 .cindex "SPF record" "in &(dnsdb)& lookup"
7301 For TXT records with multiple items of data, only the first item is returned,
7302 unless a field separator is specified.
7303 To concatenate items without a separator, use a semicolon instead.
7304 For SPF records the
7305 default behaviour is to concatenate multiple items without using a separator.
7306 .code
7307 ${lookup dnsdb{>\n,: txt=a.b.example}}
7308 ${lookup dnsdb{>\n; txt=a.b.example}}
7309 ${lookup dnsdb{spf=example.org}}
7310 .endd
7311 It is permitted to specify a space as the separator character. Further
7312 white space is ignored.
7313
7314 .cindex "SOA record" "in &(dnsdb)& lookup"
7315 For an SOA lookup, while no result is obtained the lookup is redone with
7316 successively more leading components dropped from the given domain.
7317 Only the primary-nameserver field is returned unless a field separator is
7318 specified.
7319 .code
7320 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7321 .endd
7322
7323 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7324 .cindex "dnsdb modifiers"
7325 .cindex "modifiers" "dnsdb"
7326 .cindex "options" "dnsdb"
7327 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7328 each followed by a comma,
7329 that may appear before the record type.
7330
7331 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7332 temporary DNS error for any of them, the behaviour is controlled by
7333 a defer-option modifier.
7334 The possible keywords are
7335 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7336 With &"strict"& behaviour, any temporary DNS error causes the
7337 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7338 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7339 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7340 error causes the whole lookup to defer only if none of the other lookups
7341 succeed. The default is &"lax"&, so the following lookups are equivalent:
7342 .code
7343 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7344 ${lookup dnsdb{a=one.host.com:two.host.com}}
7345 .endd
7346 Thus, in the default case, as long as at least one of the DNS lookups
7347 yields some data, the lookup succeeds.
7348
7349 .cindex "DNSSEC" "dns lookup"
7350 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7351 The possible keywords are
7352 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7353 With &"strict"& or &"lax"& DNSSEC information is requested
7354 with the lookup.
7355 With &"strict"& a response from the DNS resolver that
7356 is not labelled as authenticated data
7357 is treated as equivalent to a temporary DNS error.
7358 The default is &"lax"&.
7359
7360 See also the &$lookup_dnssec_authenticated$& variable.
7361
7362 .cindex timeout "dns lookup"
7363 .cindex "DNS" timeout
7364 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7365 The form is &"retrans_VAL"& where VAL is an Exim time specification
7366 (e.g. &"5s"&).
7367 The default value is set by the main configuration option &%dns_retrans%&.
7368
7369 Retries for the dnsdb lookup can be controlled by a retry modifier.
7370 The form if &"retry_VAL"& where VAL is an integer.
7371 The default count is set by the main configuration option &%dns_retry%&.
7372
7373 .cindex caching "of dns lookup"
7374 .cindex TTL "of dns lookup"
7375 .cindex DNS TTL
7376 Dnsdb lookup results are cached within a single process (and its children).
7377 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7378 value of the set of returned DNS records.
7379
7380
7381 .section "Pseudo dnsdb record types" "SECID66"
7382 .cindex "MX record" "in &(dnsdb)& lookup"
7383 By default, both the preference value and the host name are returned for
7384 each MX record, separated by a space. If you want only host names, you can use
7385 the pseudo-type MXH:
7386 .code
7387 ${lookup dnsdb{mxh=a.b.example}}
7388 .endd
7389 In this case, the preference values are omitted, and just the host names are
7390 returned.
7391
7392 .cindex "name server for enclosing domain"
7393 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7394 records on the given domain, but if none are found, it removes the first
7395 component of the domain name, and tries again. This process continues until NS
7396 records are found or there are no more components left (or there is a DNS
7397 error). In other words, it may return the name servers for a top-level domain,
7398 but it never returns the root name servers. If there are no NS records for the
7399 top-level domain, the lookup fails. Consider these examples:
7400 .code
7401 ${lookup dnsdb{zns=xxx.quercite.com}}
7402 ${lookup dnsdb{zns=xxx.edu}}
7403 .endd
7404 Assuming that in each case there are no NS records for the full domain name,
7405 the first returns the name servers for &%quercite.com%&, and the second returns
7406 the name servers for &%edu%&.
7407
7408 You should be careful about how you use this lookup because, unless the
7409 top-level domain does not exist, the lookup always returns some host names. The
7410 sort of use to which this might be put is for seeing if the name servers for a
7411 given domain are on a blacklist. You can probably assume that the name servers
7412 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7413 such a list.
7414
7415 .cindex "CSA" "in &(dnsdb)& lookup"
7416 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7417 records according to the CSA rules, which are described in section
7418 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7419 not sufficient because of the extra parent domain search behaviour of CSA. The
7420 result of a successful lookup such as:
7421 .code
7422 ${lookup dnsdb {csa=$sender_helo_name}}
7423 .endd
7424 has two space-separated fields: an authorization code and a target host name.
7425 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7426 authorization required but absent, or &"?"& for unknown.
7427
7428 .cindex "A+" "in &(dnsdb)& lookup"
7429 The pseudo-type A+ performs an AAAA
7430 and then an A lookup.  All results are returned; defer processing
7431 (see below) is handled separately for each lookup.  Example:
7432 .code
7433 ${lookup dnsdb {>; a+=$sender_helo_name}}
7434 .endd
7435
7436
7437 .section "Multiple dnsdb lookups" "SECID67"
7438 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7439 However, you can specify a list of domains or IP addresses in a single
7440 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7441 the default separator, but with the ability to change this. For example:
7442 .code
7443 ${lookup dnsdb{one.domain.com:two.domain.com}}
7444 ${lookup dnsdb{a=one.host.com:two.host.com}}
7445 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7446 .endd
7447 In order to retain backwards compatibility, there is one special case: if
7448 the lookup type is PTR and no change of separator is specified, Exim looks
7449 to see if the rest of the string is precisely one IPv6 address. In this
7450 case, it does not treat it as a list.
7451
7452 The data from each lookup is concatenated, with newline separators by default,
7453 in the same way that multiple DNS records for a single item are handled. A
7454 different separator can be specified, as described above.
7455
7456
7457
7458
7459 .section "More about LDAP" "SECTldap"
7460 .cindex "LDAP" "lookup, more about"
7461 .cindex "lookup" "LDAP"
7462 .cindex "Solaris" "LDAP"
7463 The original LDAP implementation came from the University of Michigan; this has
7464 become &"Open LDAP"&, and there are now two different releases. Another
7465 implementation comes from Netscape, and Solaris 7 and subsequent releases
7466 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7467 the lookup function level, their error handling is different. For this reason
7468 it is necessary to set a compile-time variable when building Exim with LDAP, to
7469 indicate which LDAP library is in use. One of the following should appear in
7470 your &_Local/Makefile_&:
7471 .code
7472 LDAP_LIB_TYPE=UMICHIGAN
7473 LDAP_LIB_TYPE=OPENLDAP1
7474 LDAP_LIB_TYPE=OPENLDAP2
7475 LDAP_LIB_TYPE=NETSCAPE
7476 LDAP_LIB_TYPE=SOLARIS
7477 .endd
7478 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7479 same interface as the University of Michigan version.
7480
7481 There are three LDAP lookup types in Exim. These behave slightly differently in
7482 the way they handle the results of a query:
7483
7484 .ilist
7485 &(ldap)& requires the result to contain just one entry; if there are more, it
7486 gives an error.
7487 .next
7488 &(ldapdn)& also requires the result to contain just one entry, but it is the
7489 Distinguished Name that is returned rather than any attribute values.
7490 .next
7491 &(ldapm)& permits the result to contain more than one entry; the attributes
7492 from all of them are returned.
7493 .endlist
7494
7495
7496 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7497 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7498 the data returned by a successful lookup is described in the next section.
7499 First we explain how LDAP queries are coded.
7500
7501
7502 .section "Format of LDAP queries" "SECTforldaque"
7503 .cindex "LDAP" "query format"
7504 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7505 the configuration of a &(redirect)& router one might have this setting:
7506 .code
7507 data = ${lookup ldap \
7508   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7509   c=UK?mailbox?base?}}
7510 .endd
7511 .cindex "LDAP" "with TLS"
7512 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7513 secure (encrypted) LDAP connections. The second of these ensures that an
7514 encrypted TLS connection is used.
7515
7516 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7517 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7518 See the &%ldap_start_tls%& option.
7519
7520 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7521 controlled. Every part of the TLS configuration can be configured by settings in
7522 &_exim.conf_&. Depending on the version of the client libraries installed on
7523 your system, some of the initialization may have required setting options in
7524 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7525 certificates. This revealed a nuance where the current UID that exim was
7526 running as could affect which config files it read. With Exim 4.83, these
7527 methods become optional, only taking effect if not specifically set in
7528 &_exim.conf_&.
7529
7530
7531 .section "LDAP quoting" "SECID68"
7532 .cindex "LDAP" "quoting"
7533 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7534 and the second because the LDAP query is represented as a URL. Furthermore,
7535 within an LDAP query, two different kinds of quoting are required. For this
7536 reason, there are two different LDAP-specific quoting operators.
7537
7538 The &%quote_ldap%& operator is designed for use on strings that are part of
7539 filter specifications. Conceptually, it first does the following conversions on
7540 the string:
7541 .code
7542 *   =>   \2A
7543 (   =>   \28
7544 )   =>   \29
7545 \   =>   \5C
7546 .endd
7547 in accordance with RFC 2254. The resulting string is then quoted according
7548 to the rules for URLs, that is, all non-alphanumeric characters except
7549 .code
7550 ! $ ' - . _ ( ) * +
7551 .endd
7552 are converted to their hex values, preceded by a percent sign. For example:
7553 .code
7554 ${quote_ldap: a(bc)*, a<yz>; }
7555 .endd
7556 yields
7557 .code
7558 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7559 .endd
7560 Removing the URL quoting, this is (with a leading and a trailing space):
7561 .code
7562 a\28bc\29\2A, a<yz>;
7563 .endd
7564 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7565 base DN specifications in queries. Conceptually, it first converts the string
7566 by inserting a backslash in front of any of the following characters:
7567 .code
7568 , + " \ < > ;
7569 .endd
7570 It also inserts a backslash before any leading spaces or # characters, and
7571 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7572 is then quoted according to the rules for URLs. For example:
7573 .code
7574 ${quote_ldap_dn: a(bc)*, a<yz>; }
7575 .endd
7576 yields
7577 .code
7578 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7579 .endd
7580 Removing the URL quoting, this is (with a trailing space):
7581 .code
7582 \ a(bc)*\, a\<yz\>\;\
7583 .endd
7584 There are some further comments about quoting in the section on LDAP
7585 authentication below.
7586
7587
7588 .section "LDAP connections" "SECID69"
7589 .cindex "LDAP" "connections"
7590 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7591 is in use, via a Unix domain socket. The example given above does not specify
7592 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7593 by starting it with
7594 .code
7595 ldap://<hostname>:<port>/...
7596 .endd
7597 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7598 used. When no server is specified in a query, a list of default servers is
7599 taken from the &%ldap_default_servers%& configuration option. This supplies a
7600 colon-separated list of servers which are tried in turn until one successfully
7601 handles a query, or there is a serious error. Successful handling either
7602 returns the requested data, or indicates that it does not exist. Serious errors
7603 are syntactical, or multiple values when only a single value is expected.
7604 Errors which cause the next server to be tried are connection failures, bind
7605 failures, and timeouts.
7606
7607 For each server name in the list, a port number can be given. The standard way
7608 of specifying a host and port is to use a colon separator (RFC 1738). Because
7609 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7610 doubled. For example
7611 .code
7612 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7613 .endd
7614 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7615 to the LDAP library with no server name, and the library's default (normally
7616 the local host) is used.
7617
7618 If you are using the OpenLDAP library, you can connect to an LDAP server using
7619 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7620 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7621 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7622 not available.
7623
7624 For this type of connection, instead of a host name for the server, a pathname
7625 for the socket is required, and the port number is not relevant. The pathname
7626 can be specified either as an item in &%ldap_default_servers%&, or inline in
7627 the query. In the former case, you can have settings such as
7628 .code
7629 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7630 .endd
7631 When the pathname is given in the query, you have to escape the slashes as
7632 &`%2F`& to fit in with the LDAP URL syntax. For example:
7633 .code
7634 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7635 .endd
7636 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7637 a pathname, it uses the Unix domain socket code, even if the query actually
7638 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7639 socket connection. This behaviour means that you can use a setting of
7640 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7641 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7642 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7643 backup host.
7644
7645 If an explicit &`ldapi`& type is given in a query when a host name is
7646 specified, an error is diagnosed. However, if there are more items in
7647 &%ldap_default_servers%&, they are tried. In other words:
7648
7649 .ilist
7650 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7651 interface.
7652 .next
7653 Using &`ldapi`& with a host name causes an error.
7654 .endlist
7655
7656
7657 Using &`ldapi`& with no host or path in the query, and no setting of
7658 &%ldap_default_servers%&, does whatever the library does by default.
7659
7660
7661
7662 .section "LDAP authentication and control information" "SECID70"
7663 .cindex "LDAP" "authentication"
7664 The LDAP URL syntax provides no way of passing authentication and other control
7665 information to the server. To make this possible, the URL in an LDAP query may
7666 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7667 spaces. If a value contains spaces it must be enclosed in double quotes, and
7668 when double quotes are used, backslash is interpreted in the usual way inside
7669 them. The following names are recognized:
7670 .display
7671 &`DEREFERENCE`&  set the dereferencing parameter
7672 &`NETTIME    `&  set a timeout for a network operation
7673 &`USER       `&  set the DN, for authenticating the LDAP bind
7674 &`PASS       `&  set the password, likewise
7675 &`REFERRALS  `&  set the referrals parameter
7676 &`SERVERS    `&  set alternate server list for this query only
7677 &`SIZE       `&  set the limit for the number of entries returned
7678 &`TIME       `&  set the maximum waiting time for a query
7679 .endd
7680 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7681 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7682 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7683 library from trying to follow referrals issued by the LDAP server.
7684
7685 .cindex LDAP timeout
7686 .cindex timeout "LDAP lookup"
7687 The name CONNECT is an obsolete name for NETTIME, retained for
7688 backwards compatibility. This timeout (specified as a number of seconds) is
7689 enforced from the client end for operations that can be carried out over a
7690 network. Specifically, it applies to network connections and calls to the
7691 &'ldap_result()'& function. If the value is greater than zero, it is used if
7692 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7693 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7694 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7695 Netscape SDK; for OpenLDAP no action is taken.
7696
7697 The TIME parameter (also a number of seconds) is passed to the server to
7698 set a server-side limit on the time taken to complete a search.
7699
7700 The SERVERS parameter allows you to specify an alternate list of ldap servers
7701 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7702 default list of ldap servers, and a single lookup can specify a single ldap
7703 server to use.  But when you need to do a lookup with a list of servers that is
7704 different than the default list (maybe different order, maybe a completely
7705 different set of servers), the SERVERS parameter allows you to specify this
7706 alternate list (colon-separated).
7707
7708 Here is an example of an LDAP query in an Exim lookup that uses some of these
7709 values. This is a single line, folded to fit on the page:
7710 .code
7711 ${lookup ldap
7712   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7713   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7714   {$value}fail}
7715 .endd
7716 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7717 any of the auxiliary data. Exim configuration settings that include lookups
7718 which contain password information should be preceded by &"hide"& to prevent
7719 non-admin users from using the &%-bP%& option to see their values.
7720
7721 The auxiliary data items may be given in any order. The default is no
7722 connection timeout (the system timeout is used), no user or password, no limit
7723 on the number of entries returned, and no time limit on queries.
7724
7725 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7726 removes any URL quoting that it may contain before passing it LDAP. Apparently
7727 some libraries do this for themselves, but some do not. Removing the URL
7728 quoting has two advantages:
7729
7730 .ilist
7731 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7732 DNs as with DNs inside actual queries.
7733 .next
7734 It permits spaces inside USER= DNs.
7735 .endlist
7736
7737 For example, a setting such as
7738 .code
7739 USER=cn=${quote_ldap_dn:$1}
7740 .endd
7741 should work even if &$1$& contains spaces.
7742
7743 Expanded data for the PASS= value should be quoted using the &%quote%&
7744 expansion operator, rather than the LDAP quote operators. The only reason this
7745 field needs quoting is to ensure that it conforms to the Exim syntax, which
7746 does not allow unquoted spaces. For example:
7747 .code
7748 PASS=${quote:$3}
7749 .endd
7750 The LDAP authentication mechanism can be used to check passwords as part of
7751 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7752 &<<CHAPexpand>>&.
7753
7754
7755
7756 .section "Format of data returned by LDAP" "SECID71"
7757 .cindex "LDAP" "returned data formats"
7758 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7759 as a sequence of values, for example
7760 .code
7761 cn=manager,o=University of Cambridge,c=UK
7762 .endd
7763 The &(ldap)& lookup type generates an error if more than one entry matches the
7764 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7765 the result between the data from different entries. It is possible for multiple
7766 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7767 you know that whatever values are returned all came from a single entry in the
7768 directory.
7769
7770 In the common case where you specify a single attribute in your LDAP query, the
7771 result is not quoted, and does not contain the attribute name. If the attribute
7772 has multiple values, they are separated by commas. Any comma that is
7773 part of an attribute's value is doubled.
7774
7775 If you specify multiple attributes, the result contains space-separated, quoted
7776 strings, each preceded by the attribute name and an equals sign. Within the
7777 quotes, the quote character, backslash, and newline are escaped with
7778 backslashes, and commas are used to separate multiple values for the attribute.
7779 Any commas in attribute values are doubled
7780 (permitting treatment of the values as a comma-separated list).
7781 Apart from the escaping, the string within quotes takes the same form as the
7782 output when a single attribute is requested. Specifying no attributes is the
7783 same as specifying all of an entry's attributes.
7784
7785 Here are some examples of the output format. The first line of each pair is an
7786 LDAP query, and the second is the data that is returned. The attribute called
7787 &%attr1%& has two values, one of them with an embedded comma, whereas
7788 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7789 (they have SUP &%attr%& in their schema definitions).
7790
7791 .code
7792 ldap:///o=base?attr1?sub?(uid=fred)
7793 value1.1,value1,,2
7794
7795 ldap:///o=base?attr2?sub?(uid=fred)
7796 value two
7797
7798 ldap:///o=base?attr?sub?(uid=fred)
7799 value1.1,value1,,2,value two
7800
7801 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7802 attr1="value1.1,value1,,2" attr2="value two"
7803
7804 ldap:///o=base??sub?(uid=fred)
7805 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7806 .endd
7807 You can
7808 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7809 results of LDAP lookups.
7810 The &%extract%& operator in string expansions can be used to pick out
7811 individual fields from data that consists of &'key'&=&'value'& pairs.
7812 The &%listextract%& operator should be used to pick out individual values
7813 of attributes, even when only a single value is expected.
7814 The doubling of embedded commas allows you to use the returned data as a
7815 comma separated list (using the "<," syntax for changing the input list separator).
7816
7817
7818
7819
7820 .section "More about NIS+" "SECTnisplus"
7821 .cindex "NIS+ lookup type"
7822 .cindex "lookup" "NIS+"
7823 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7824 and field name. If this is given, the result of a successful query is the
7825 contents of the named field; otherwise the result consists of a concatenation
7826 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7827 values containing spaces are quoted. For example, the query
7828 .code
7829 [name=mg1456],passwd.org_dir
7830 .endd
7831 might return the string
7832 .code
7833 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7834 home=/home/mg1456 shell=/bin/bash shadow=""
7835 .endd
7836 (split over two lines here to fit on the page), whereas
7837 .code
7838 [name=mg1456],passwd.org_dir:gcos
7839 .endd
7840 would just return
7841 .code
7842 Martin Guerre
7843 .endd
7844 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7845 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7846 operator is to double any quote characters within the text.
7847
7848
7849
7850 .section "SQL lookups" "SECTsql"
7851 .cindex "SQL lookup types"
7852 .cindex "MySQL" "lookup type"
7853 .cindex "PostgreSQL lookup type"
7854 .cindex "lookup" "MySQL"
7855 .cindex "lookup" "PostgreSQL"
7856 .cindex "Oracle" "lookup type"
7857 .cindex "lookup" "Oracle"
7858 .cindex "InterBase lookup type"
7859 .cindex "lookup" "InterBase"
7860 .cindex "Redis lookup type"
7861 .cindex lookup Redis
7862 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7863 and SQLite
7864 databases. Queries for these databases contain SQL statements, so an example
7865 might be
7866 .code
7867 ${lookup mysql{select mailbox from users where id='userx'}\
7868   {$value}fail}
7869 .endd
7870 If the result of the query contains more than one field, the data for each
7871 field in the row is returned, preceded by its name, so the result of
7872 .code
7873 ${lookup pgsql{select home,name from users where id='userx'}\
7874   {$value}}
7875 .endd
7876 might be
7877 .code
7878 home=/home/userx name="Mister X"
7879 .endd
7880 Empty values and values containing spaces are double quoted, with embedded
7881 quotes escaped by a backslash. If the result of the query contains just one
7882 field, the value is passed back verbatim, without a field name, for example:
7883 .code
7884 Mister X
7885 .endd
7886 If the result of the query yields more than one row, it is all concatenated,
7887 with a newline between the data for each row.
7888
7889
7890 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7891 .cindex "MySQL" "lookup type"
7892 .cindex "PostgreSQL lookup type"
7893 .cindex "lookup" "MySQL"
7894 .cindex "lookup" "PostgreSQL"
7895 .cindex "Oracle" "lookup type"
7896 .cindex "lookup" "Oracle"
7897 .cindex "InterBase lookup type"
7898 .cindex "lookup" "InterBase"
7899 .cindex "Redis lookup type"
7900 .cindex lookup Redis
7901 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7902 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7903 or &%redis_servers%&
7904 option (as appropriate) must be set to a colon-separated list of server
7905 information.
7906 (For MySQL and PostgreSQL, the global option need not be set if all
7907 queries contain their own server information &-- see section
7908 &<<SECTspeserque>>&.)
7909 For all but Redis
7910 each item in the list is a slash-separated list of four
7911 items: host name, database name, user name, and password. In the case of
7912 Oracle, the host name field is used for the &"service name"&, and the database
7913 name field is not used and should be empty. For example:
7914 .code
7915 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7916 .endd
7917 Because password data is sensitive, you should always precede the setting with
7918 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7919 option. Here is an example where two MySQL servers are listed:
7920 .code
7921 hide mysql_servers = localhost/users/root/secret:\
7922                      otherhost/users/root/othersecret
7923 .endd
7924 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7925 because this is a colon-separated list, the colon has to be doubled. For each
7926 query, these parameter groups are tried in order until a connection is made and
7927 a query is successfully processed. The result of a query may be that no data is
7928 found, but that is still a successful query. In other words, the list of
7929 servers provides a backup facility, not a list of different places to look.
7930
7931 For Redis the global option need not be specified if all queries contain their
7932 own server information &-- see section &<<SECTspeserque>>&.
7933 If specified, the option must be set to a colon-separated list of server
7934 information.
7935 Each item in the list is a slash-separated list of three items:
7936 host, database number, and password.
7937 .olist
7938 The host is required and may be either an IPv4 address and optional
7939 port number (separated by a colon, which needs doubling due to the
7940 higher-level list), or a Unix socket pathname enclosed in parentheses
7941 .next
7942 The database number is optional; if present that number is selected in the backend
7943 .next
7944 The password is optional; if present it is used to authenticate to the backend
7945 .endlist
7946
7947 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7948 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7949 respectively, and the characters single-quote, double-quote, and backslash
7950 itself are escaped with backslashes.
7951
7952 The &%quote_redis%& expansion operator
7953 escapes whitespace and backslash characters with a backslash.
7954
7955 .section "Specifying the server in the query" "SECTspeserque"
7956 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7957 it is possible to specify a list of servers with an individual query. This is
7958 done by starting the query with
7959 .display
7960 &`servers=`&&'server1:server2:server3:...'&&`;`&
7961 .endd
7962 Each item in the list may take one of two forms:
7963 .olist
7964 If it contains no slashes it is assumed to be just a host name. The appropriate
7965 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7966 of the same name, and the remaining parameters (database, user, password) are
7967 taken from there.
7968 .next
7969 If it contains any slashes, it is taken as a complete parameter set.
7970 .endlist
7971 The list of servers is used in exactly the same way as the global list.
7972 Once a connection to a server has happened and a query has been
7973 successfully executed, processing of the lookup ceases.
7974
7975 This feature is intended for use in master/slave situations where updates
7976 are occurring and you want to update the master rather than a slave. If the
7977 master is in the list as a backup for reading, you might have a global setting
7978 like this:
7979 .code
7980 mysql_servers = slave1/db/name/pw:\
7981                 slave2/db/name/pw:\
7982                 master/db/name/pw
7983 .endd
7984 In an updating lookup, you could then write:
7985 .code
7986 ${lookup mysql{servers=master; UPDATE ...} }
7987 .endd
7988 That query would then be sent only to the master server. If, on the other hand,
7989 the master is not to be used for reading, and so is not present in the global
7990 option, you can still update it by a query of this form:
7991 .code
7992 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7993 .endd
7994
7995
7996 .section "Special MySQL features" "SECID73"
7997 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7998 causes a connection to the server on the local host by means of a Unix domain
7999 socket. An alternate socket can be specified in parentheses.
8000 An option group name for MySQL option files can be specified in square brackets;
8001 the default value is &"exim"&.
8002 The full syntax of each item in &%mysql_servers%& is:
8003 .display
8004 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8005   <&'database'&>/<&'user'&>/<&'password'&>
8006 .endd
8007 Any of the four sub-parts of the first field can be omitted. For normal use on
8008 the local host it can be left blank or set to just &"localhost"&.
8009
8010 No database need be supplied &-- but if it is absent here, it must be given in
8011 the queries.
8012
8013 If a MySQL query is issued that does not request any data (an insert, update,
8014 or delete command), the result of the lookup is the number of rows affected.
8015
8016 &*Warning*&: This can be misleading. If an update does not actually change
8017 anything (for example, setting a field to the value it already has), the result
8018 is zero because no rows are affected.
8019
8020
8021 .section "Special PostgreSQL features" "SECID74"
8022 PostgreSQL lookups can also use Unix domain socket connections to the database.
8023 This is usually faster and costs less CPU time than a TCP/IP connection.
8024 However it can be used only if the mail server runs on the same machine as the
8025 database server. A configuration line for PostgreSQL via Unix domain sockets
8026 looks like this:
8027 .code
8028 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8029 .endd
8030 In other words, instead of supplying a host name, a path to the socket is
8031 given. The path name is enclosed in parentheses so that its slashes aren't
8032 visually confused with the delimiters for the other server parameters.
8033
8034 If a PostgreSQL query is issued that does not request any data (an insert,
8035 update, or delete command), the result of the lookup is the number of rows
8036 affected.
8037
8038 .section "More about SQLite" "SECTsqlite"
8039 .cindex "lookup" "SQLite"
8040 .cindex "sqlite lookup type"
8041 SQLite is different to the other SQL lookups because a filename is required in
8042 addition to the SQL query. An SQLite database is a single file, and there is no
8043 daemon as in the other SQL databases. The interface to Exim requires the name
8044 of the file, as an absolute path, to be given at the start of the query. It is
8045 separated from the query by white space. This means that the path name cannot
8046 contain white space. Here is a lookup expansion example:
8047 .code
8048 ${lookup sqlite {/some/thing/sqlitedb \
8049   select name from aliases where id='userx';}}
8050 .endd
8051 In a list, the syntax is similar. For example:
8052 .code
8053 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
8054    select * from relays where ip='$sender_host_address';
8055 .endd
8056 The only character affected by the &%quote_sqlite%& operator is a single
8057 quote, which it doubles.
8058
8059 .cindex timeout SQLite
8060 .cindex sqlite "lookup timeout"
8061 The SQLite library handles multiple simultaneous accesses to the database
8062 internally. Multiple readers are permitted, but only one process can
8063 update at once. Attempts to access the database while it is being updated
8064 are rejected after a timeout period, during which the SQLite library
8065 waits for the lock to be released. In Exim, the default timeout is set
8066 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8067 option.
8068
8069 .section "More about Redis" "SECTredis"
8070 .cindex "lookup" "Redis"
8071 .cindex "redis lookup type"
8072 Redis is a non-SQL database. Commands are simple get and set.
8073 Examples:
8074 .code
8075 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8076 ${lookup redis{get keyname}}
8077 .endd
8078
8079 As of release 4.91, "lightweight" support for Redis Cluster is available.
8080 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8081 of which must be reachable from the running exim instance. If the cluster has
8082 master/slave replication, the list must contain all the master and slave
8083 servers.
8084
8085 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8086 immediately follow the redirection but treats the response as a DEFER, moving on
8087 to the next server in the &%redis_servers%& list until the correct server is
8088 reached.
8089
8090 .ecindex IIDfidalo1
8091 .ecindex IIDfidalo2
8092
8093
8094 . ////////////////////////////////////////////////////////////////////////////
8095 . ////////////////////////////////////////////////////////////////////////////
8096
8097 .chapter "Domain, host, address, and local part lists" &&&
8098          "CHAPdomhosaddlists" &&&
8099          "Domain, host, and address lists"
8100 .scindex IIDdohoadli "lists of domains; hosts; etc."
8101 A number of Exim configuration options contain lists of domains, hosts,
8102 email addresses, or local parts. For example, the &%hold_domains%& option
8103 contains a list of domains whose delivery is currently suspended. These lists
8104 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8105 arguments to expansion conditions such as &%match_domain%&.
8106
8107 Each item in one of these lists is a pattern to be matched against a domain,
8108 host, email address, or local part, respectively. In the sections below, the
8109 different types of pattern for each case are described, but first we cover some
8110 general facilities that apply to all four kinds of list.
8111
8112 Note that other parts of Exim use a &'string list'& which does not
8113 support all the complexity available in
8114 domain, host, address and local part lists.
8115
8116
8117
8118 .section "Expansion of lists" "SECTlistexpand"
8119 .cindex "expansion" "of lists"
8120 Each list is expanded as a single string before it is used.
8121
8122 &'Exception: the router headers_remove option, where list-item
8123 splitting is done before string-expansion.'&
8124
8125 The result of
8126 expansion must be a list, possibly containing empty items, which is split up
8127 into separate items for matching. By default, colon is the separator character,
8128 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8129 &<<SECTempitelis>>& for details of the list syntax; the second of these
8130 discusses the way to specify empty list items.
8131
8132
8133 If the string expansion is forced to fail, Exim behaves as if the item it is
8134 testing (domain, host, address, or local part) is not in the list. Other
8135 expansion failures cause temporary errors.
8136
8137 If an item in a list is a regular expression, backslashes, dollars and possibly
8138 other special characters in the expression must be protected against
8139 misinterpretation by the string expander. The easiest way to do this is to use
8140 the &`\N`& expansion feature to indicate that the contents of the regular
8141 expression should not be expanded. For example, in an ACL you might have:
8142 .code
8143 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8144                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8145 .endd
8146 The first item is a regular expression that is protected from expansion by
8147 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8148 senders based on the receiving domain.
8149
8150
8151
8152
8153 .section "Negated items in lists" "SECID76"
8154 .cindex "list" "negation"
8155 .cindex "negation" "in lists"
8156 Items in a list may be positive or negative. Negative items are indicated by a
8157 leading exclamation mark, which may be followed by optional white space. A list
8158 defines a set of items (domains, etc). When Exim processes one of these lists,
8159 it is trying to find out whether a domain, host, address, or local part
8160 (respectively) is in the set that is defined by the list. It works like this:
8161
8162 The list is scanned from left to right. If a positive item is matched, the
8163 subject that is being checked is in the set; if a negative item is matched, the
8164 subject is not in the set. If the end of the list is reached without the
8165 subject having matched any of the patterns, it is in the set if the last item
8166 was a negative one, but not if it was a positive one. For example, the list in
8167 .code
8168 domainlist relay_to_domains = !a.b.c : *.b.c
8169 .endd
8170 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8171 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8172 list is positive. However, if the setting were
8173 .code
8174 domainlist relay_to_domains = !a.b.c
8175 .endd
8176 then all domains other than &'a.b.c'& would match because the last item in the
8177 list is negative. In other words, a list that ends with a negative item behaves
8178 as if it had an extra item &`:*`& on the end.
8179
8180 Another way of thinking about positive and negative items in lists is to read
8181 the connector as &"or"& after a positive item and as &"and"& after a negative
8182 item.
8183
8184
8185
8186 .section "File names in lists" "SECTfilnamlis"
8187 .cindex "list" "filename in"
8188 If an item in a domain, host, address, or local part list is an absolute
8189 filename (beginning with a slash character), each line of the file is read and
8190 processed as if it were an independent item in the list, except that further
8191 filenames are not allowed,
8192 and no expansion of the data from the file takes place.
8193 Empty lines in the file are ignored, and the file may also contain comment
8194 lines:
8195
8196 .ilist
8197 For domain and host lists, if a # character appears anywhere in a line of the
8198 file, it and all following characters are ignored.
8199 .next
8200 Because local parts may legitimately contain # characters, a comment in an
8201 address list or local part list file is recognized only if # is preceded by
8202 white space or the start of the line. For example:
8203 .code
8204 not#comment@x.y.z   # but this is a comment
8205 .endd
8206 .endlist
8207
8208 Putting a filename in a list has the same effect as inserting each line of the
8209 file as an item in the list (blank lines and comments excepted). However, there
8210 is one important difference: the file is read each time the list is processed,
8211 so if its contents vary over time, Exim's behaviour changes.
8212
8213 If a filename is preceded by an exclamation mark, the sense of any match
8214 within the file is inverted. For example, if
8215 .code
8216 hold_domains = !/etc/nohold-domains
8217 .endd
8218 and the file contains the lines
8219 .code
8220 !a.b.c
8221 *.b.c
8222 .endd
8223 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8224 any domain matching &`*.b.c`& is not.
8225
8226
8227
8228 .section "An lsearch file is not an out-of-line list" "SECID77"
8229 As will be described in the sections that follow, lookups can be used in lists
8230 to provide indexed methods of checking list membership. There has been some
8231 confusion about the way &(lsearch)& lookups work in lists. Because
8232 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8233 sometimes thought that it is allowed to contain wild cards and other kinds of
8234 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8235 always fixed strings, just as for any other single-key lookup type.
8236
8237 If you want to use a file to contain wild-card patterns that form part of a
8238 list, just give the filename on its own, without a search type, as described
8239 in the previous section. You could also use the &(wildlsearch)& or
8240 &(nwildlsearch)&, but there is no advantage in doing this.
8241
8242
8243
8244
8245 .section "Named lists" "SECTnamedlists"
8246 .cindex "named lists"
8247 .cindex "list" "named"
8248 A list of domains, hosts, email addresses, or local parts can be given a name
8249 which is then used to refer to the list elsewhere in the configuration. This is
8250 particularly convenient if the same list is required in several different
8251 places. It also allows lists to be given meaningful names, which can improve
8252 the readability of the configuration. For example, it is conventional to define
8253 a domain list called &'local_domains'& for all the domains that are handled
8254 locally on a host, using a configuration line such as
8255 .code
8256 domainlist local_domains = localhost:my.dom.example
8257 .endd
8258 Named lists are referenced by giving their name preceded by a plus sign, so,
8259 for example, a router that is intended to handle local domains would be
8260 configured with the line
8261 .code
8262 domains = +local_domains
8263 .endd
8264 The first router in a configuration is often one that handles all domains
8265 except the local ones, using a configuration with a negated item like this:
8266 .code
8267 dnslookup:
8268   driver = dnslookup
8269   domains = ! +local_domains
8270   transport = remote_smtp
8271   no_more
8272 .endd
8273 The four kinds of named list are created by configuration lines starting with
8274 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8275 respectively. Then there follows the name that you are defining, followed by an
8276 equals sign and the list itself. For example:
8277 .code
8278 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8279 addresslist bad_senders = cdb;/etc/badsenders
8280 .endd
8281 A named list may refer to other named lists:
8282 .code
8283 domainlist  dom1 = first.example : second.example
8284 domainlist  dom2 = +dom1 : third.example
8285 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8286 .endd
8287 &*Warning*&: If the last item in a referenced list is a negative one, the
8288 effect may not be what you intended, because the negation does not propagate
8289 out to the higher level. For example, consider:
8290 .code
8291 domainlist  dom1 = !a.b
8292 domainlist  dom2 = +dom1 : *.b
8293 .endd
8294 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8295 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8296 means it matches the second list as well. The effect is not the same as
8297 .code
8298 domainlist  dom2 = !a.b : *.b
8299 .endd
8300 where &'x.y'& does not match. It's best to avoid negation altogether in
8301 referenced lists if you can.
8302
8303 Named lists may have a performance advantage. When Exim is routing an
8304 address or checking an incoming message, it caches the result of tests on named
8305 lists. So, if you have a setting such as
8306 .code
8307 domains = +local_domains
8308 .endd
8309 on several of your routers
8310 or in several ACL statements,
8311 the actual test is done only for the first one. However, the caching works only
8312 if there are no expansions within the list itself or any sublists that it
8313 references. In other words, caching happens only for lists that are known to be
8314 the same each time they are referenced.
8315
8316 By default, there may be up to 16 named lists of each type. This limit can be
8317 extended by changing a compile-time variable. The use of domain and host lists
8318 is recommended for concepts such as local domains, relay domains, and relay
8319 hosts. The default configuration is set up like this.
8320
8321
8322
8323 .section "Named lists compared with macros" "SECID78"
8324 .cindex "list" "named compared with macro"
8325 .cindex "macro" "compared with named list"
8326 At first sight, named lists might seem to be no different from macros in the
8327 configuration file. However, macros are just textual substitutions. If you
8328 write
8329 .code
8330 ALIST = host1 : host2
8331 auth_advertise_hosts = !ALIST
8332 .endd
8333 it probably won't do what you want, because that is exactly the same as
8334 .code
8335 auth_advertise_hosts = !host1 : host2
8336 .endd
8337 Notice that the second host name is not negated. However, if you use a host
8338 list, and write
8339 .code
8340 hostlist alist = host1 : host2
8341 auth_advertise_hosts = ! +alist
8342 .endd
8343 the negation applies to the whole list, and so that is equivalent to
8344 .code
8345 auth_advertise_hosts = !host1 : !host2
8346 .endd
8347
8348
8349 .section "Named list caching" "SECID79"
8350 .cindex "list" "caching of named"
8351 .cindex "caching" "named lists"
8352 While processing a message, Exim caches the result of checking a named list if
8353 it is sure that the list is the same each time. In practice, this means that
8354 the cache operates only if the list contains no $ characters, which guarantees
8355 that it will not change when it is expanded. Sometimes, however, you may have
8356 an expanded list that you know will be the same each time within a given
8357 message. For example:
8358 .code
8359 domainlist special_domains = \
8360            ${lookup{$sender_host_address}cdb{/some/file}}
8361 .endd
8362 This provides a list of domains that depends only on the sending host's IP
8363 address. If this domain list is referenced a number of times (for example,
8364 in several ACL lines, or in several routers) the result of the check is not
8365 cached by default, because Exim does not know that it is going to be the
8366 same list each time.
8367
8368 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8369 cache the result anyway. For example:
8370 .code
8371 domainlist_cache special_domains = ${lookup{...
8372 .endd
8373 If you do this, you should be absolutely sure that caching is going to do
8374 the right thing in all cases. When in doubt, leave it out.
8375
8376
8377
8378 .section "Domain lists" "SECTdomainlist"
8379 .cindex "domain list" "patterns for"
8380 .cindex "list" "domain list"
8381 Domain lists contain patterns that are to be matched against a mail domain.
8382 The following types of item may appear in domain lists:
8383
8384 .ilist
8385 .cindex "primary host name"
8386 .cindex "host name" "matched in domain list"
8387 .oindex "&%primary_hostname%&"
8388 .cindex "domain list" "matching primary host name"
8389 .cindex "@ in a domain list"
8390 If a pattern consists of a single @ character, it matches the local host name,
8391 as set by the &%primary_hostname%& option (or defaulted). This makes it
8392 possible to use the same configuration file on several different hosts that
8393 differ only in their names.
8394 .next
8395 .cindex "@[] in a domain list"
8396 .cindex "domain list" "matching local IP interfaces"
8397 .cindex "domain literal"
8398 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8399 in square brackets (as in an email address that contains a domain literal), but
8400 only if that IP address is recognized as local for email routing purposes. The
8401 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8402 control which of a host's several IP addresses are treated as local.
8403 In today's Internet, the use of domain literals is controversial.
8404 .next
8405 .cindex "@mx_any"
8406 .cindex "@mx_primary"
8407 .cindex "@mx_secondary"
8408 .cindex "domain list" "matching MX pointers to local host"
8409 If a pattern consists of the string &`@mx_any`& it matches any domain that
8410 has an MX record pointing to the local host or to any host that is listed in
8411 .oindex "&%hosts_treat_as_local%&"
8412 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8413 are similar, except that the first matches only when a primary MX target is the
8414 local host, and the second only when no primary MX target is the local host,
8415 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8416 preference value &-- there may of course be more than one of them.
8417
8418 The MX lookup that takes place when matching a pattern of this type is
8419 performed with the resolver options for widening names turned off. Thus, for
8420 example, a single-component domain will &'not'& be expanded by adding the
8421 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8422 options of the &(dnslookup)& router for a discussion of domain widening.
8423
8424 Sometimes you may want to ignore certain IP addresses when using one of these
8425 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8426 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8427 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8428 on a router). For example:
8429 .code
8430 domains = @mx_any/ignore=127.0.0.1
8431 .endd
8432 This example matches any domain that has an MX record pointing to one of
8433 the local host's IP addresses other than 127.0.0.1.
8434
8435 The list of IP addresses is in fact processed by the same code that processes
8436 host lists, so it may contain CIDR-coded network specifications and it may also
8437 contain negative items.
8438
8439 Because the list of IP addresses is a sublist within a domain list, you have to
8440 be careful about delimiters if there is more than one address. Like any other
8441 list, the default delimiter can be changed. Thus, you might have:
8442 .code
8443 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8444           an.other.domain : ...
8445 .endd
8446 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8447 involved, it is easiest to change the delimiter for the main list as well:
8448 .code
8449 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8450           an.other.domain ? ...
8451 .endd
8452 .next
8453 .cindex "asterisk" "in domain list"
8454 .cindex "domain list" "asterisk in"
8455 .cindex "domain list" "matching &""ends with""&"
8456 If a pattern starts with an asterisk, the remaining characters of the pattern
8457 are compared with the terminating characters of the domain. The use of &"*"& in
8458 domain lists differs from its use in partial matching lookups. In a domain
8459 list, the character following the asterisk need not be a dot, whereas partial
8460 matching works only in terms of dot-separated components. For example, a domain
8461 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8462 &'cipher.key.ex'&.
8463
8464 .next
8465 .cindex "regular expressions" "in domain list"
8466 .cindex "domain list" "matching regular expression"
8467 If a pattern starts with a circumflex character, it is treated as a regular
8468 expression, and matched against the domain using a regular expression matching
8469 function. The circumflex is treated as part of the regular expression.
8470 Email domains are case-independent, so this regular expression match is by
8471 default case-independent, but you can make it case-dependent by starting it
8472 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8473 are given in chapter &<<CHAPregexp>>&.
8474
8475 &*Warning*&: Because domain lists are expanded before being processed, you
8476 must escape any backslash and dollar characters in the regular expression, or
8477 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8478 it is not to be expanded (unless you really do want to build a regular
8479 expression by expansion, of course).
8480 .next
8481 .cindex "lookup" "in domain list"
8482 .cindex "domain list" "matching by lookup"
8483 If a pattern starts with the name of a single-key lookup type followed by a
8484 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8485 must be a filename in a suitable format for the lookup type. For example, for
8486 &"cdb;"& it must be an absolute path:
8487 .code
8488 domains = cdb;/etc/mail/local_domains.cdb
8489 .endd
8490 The appropriate type of lookup is done on the file using the domain name as the
8491 key. In most cases, the data that is looked up is not used; Exim is interested
8492 only in whether or not the key is present in the file. However, when a lookup
8493 is used for the &%domains%& option on a router
8494 or a &%domains%& condition in an ACL statement, the data is preserved in the
8495 &$domain_data$& variable and can be referred to in other router options or
8496 other statements in the same ACL.
8497
8498 .next
8499 Any of the single-key lookup type names may be preceded by
8500 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8501 .code
8502 domains = partial-dbm;/partial/domains
8503 .endd
8504 This causes partial matching logic to be invoked; a description of how this
8505 works is given in section &<<SECTpartiallookup>>&.
8506
8507 .next
8508 .cindex "asterisk" "in lookup type"
8509 Any of the single-key lookup types may be followed by an asterisk. This causes
8510 a default lookup for a key consisting of a single asterisk to be done if the
8511 original lookup fails. This is not a useful feature when using a domain list to
8512 select particular domains (because any domain would match), but it might have
8513 value if the result of the lookup is being used via the &$domain_data$&
8514 expansion variable.
8515 .next
8516 If the pattern starts with the name of a query-style lookup type followed by a
8517 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8518 pattern must be an appropriate query for the lookup type, as described in
8519 chapter &<<CHAPfdlookup>>&. For example:
8520 .code
8521 hold_domains = mysql;select domain from holdlist \
8522   where domain = '${quote_mysql:$domain}';
8523 .endd
8524 In most cases, the data that is looked up is not used (so for an SQL query, for
8525 example, it doesn't matter what field you select). Exim is interested only in
8526 whether or not the query succeeds. However, when a lookup is used for the
8527 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8528 variable and can be referred to in other options.
8529 .next
8530 .cindex "domain list" "matching literal domain name"
8531 If none of the above cases apply, a caseless textual comparison is made
8532 between the pattern and the domain.
8533 .endlist
8534
8535 Here is an example that uses several different kinds of pattern:
8536 .code
8537 domainlist funny_domains = \
8538   @ : \
8539   lib.unseen.edu : \
8540   *.foundation.fict.example : \
8541   \N^[1-2]\d{3}\.fict\.example$\N : \
8542   partial-dbm;/opt/data/penguin/book : \
8543   nis;domains.byname : \
8544   nisplus;[name=$domain,status=local],domains.org_dir
8545 .endd
8546 There are obvious processing trade-offs among the various matching modes. Using
8547 an asterisk is faster than a regular expression, and listing a few names
8548 explicitly probably is too. The use of a file or database lookup is expensive,
8549 but may be the only option if hundreds of names are required. Because the
8550 patterns are tested in order, it makes sense to put the most commonly matched
8551 patterns earlier.
8552
8553
8554
8555 .section "Host lists" "SECThostlist"
8556 .cindex "host list" "patterns in"
8557 .cindex "list" "host list"
8558 Host lists are used to control what remote hosts are allowed to do. For
8559 example, some hosts may be allowed to use the local host as a relay, and some
8560 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8561 two different ways, by name or by IP address. In a host list, some types of
8562 pattern are matched to a host name, and some are matched to an IP address.
8563 You need to be particularly careful with this when single-key lookups are
8564 involved, to ensure that the right value is being used as the key.
8565
8566
8567 .section "Special host list patterns" "SECID80"
8568 .cindex "empty item in hosts list"
8569 .cindex "host list" "empty string in"
8570 If a host list item is the empty string, it matches only when no remote host is
8571 involved. This is the case when a message is being received from a local
8572 process using SMTP on the standard input, that is, when a TCP/IP connection is
8573 not used.
8574
8575 .cindex "asterisk" "in host list"
8576 The special pattern &"*"& in a host list matches any host or no host. Neither
8577 the IP address nor the name is actually inspected.
8578
8579
8580
8581 .section "Host list patterns that match by IP address" "SECThoslispatip"
8582 .cindex "host list" "matching IP addresses"
8583 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8584 the incoming address actually appears in the IPv6 host as
8585 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8586 list, it is converted into a traditional IPv4 address first. (Not all operating
8587 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8588 concerns.)
8589
8590 The following types of pattern in a host list check the remote host by
8591 inspecting its IP address:
8592
8593 .ilist
8594 If the pattern is a plain domain name (not a regular expression, not starting
8595 with *, not a lookup of any kind), Exim calls the operating system function
8596 to find the associated IP address(es). Exim uses the newer
8597 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8598 This typically causes a forward DNS lookup of the name. The result is compared
8599 with the IP address of the subject host.
8600
8601 If there is a temporary problem (such as a DNS timeout) with the host name
8602 lookup, a temporary error occurs. For example, if the list is being used in an
8603 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8604 temporary SMTP error code. If no IP address can be found for the host name,
8605 what happens is described in section &<<SECTbehipnot>>& below.
8606
8607 .next
8608 .cindex "@ in a host list"
8609 If the pattern is &"@"&, the primary host name is substituted and used as a
8610 domain name, as just described.
8611
8612 .next
8613 If the pattern is an IP address, it is matched against the IP address of the
8614 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8615 IPv6 addresses can be given in colon-separated format, but the colons have to
8616 be doubled so as not to be taken as item separators when the default list
8617 separator is used. IPv6 addresses are recognized even when Exim is compiled
8618 without IPv6 support. This means that if they appear in a host list on an
8619 IPv4-only host, Exim will not treat them as host names. They are just addresses
8620 that can never match a client host.
8621
8622 .next
8623 .cindex "@[] in a host list"
8624 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8625 the local host. For example, if the local host is an IPv4 host with one
8626 interface address 10.45.23.56, these two ACL statements have the same effect:
8627 .code
8628 accept hosts = 127.0.0.1 : 10.45.23.56
8629 accept hosts = @[]
8630 .endd
8631 .next
8632 .cindex "CIDR notation"
8633 If the pattern is an IP address followed by a slash and a mask length (for
8634 example 10.11.42.0/24), it is matched against the IP address of the subject
8635 host under the given mask. This allows, an entire network of hosts to be
8636 included (or excluded) by a single item. The mask uses CIDR notation; it
8637 specifies the number of address bits that must match, starting from the most
8638 significant end of the address.
8639
8640 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8641 of a range of addresses. It is the number of bits in the network portion of the
8642 address. The above example specifies a 24-bit netmask, so it matches all 256
8643 addresses in the 10.11.42.0 network. An item such as
8644 .code
8645 192.168.23.236/31
8646 .endd
8647 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8648 32 for an IPv4 address is the same as no mask at all; just a single address
8649 matches.
8650
8651 Here is another example which shows an IPv4 and an IPv6 network:
8652 .code
8653 recipient_unqualified_hosts = 192.168.0.0/16: \
8654                               3ffe::ffff::836f::::/48
8655 .endd
8656 The doubling of list separator characters applies only when these items
8657 appear inline in a host list. It is not required when indirecting via a file.
8658 For example:
8659 .code
8660 recipient_unqualified_hosts = /opt/exim/unqualnets
8661 .endd
8662 could make use of a file containing
8663 .code
8664 172.16.0.0/12
8665 3ffe:ffff:836f::/48
8666 .endd
8667 to have exactly the same effect as the previous example. When listing IPv6
8668 addresses inline, it is usually more convenient to use the facility for
8669 changing separator characters. This list contains the same two networks:
8670 .code
8671 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8672                                  3ffe:ffff:836f::/48
8673 .endd
8674 The separator is changed to semicolon by the leading &"<;"& at the start of the
8675 list.
8676 .endlist
8677
8678
8679
8680 .section "Host list patterns for single-key lookups by host address" &&&
8681          "SECThoslispatsikey"
8682 .cindex "host list" "lookup of IP address"
8683 When a host is to be identified by a single-key lookup of its complete IP
8684 address, the pattern takes this form:
8685 .display
8686 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8687 .endd
8688 For example:
8689 .code
8690 hosts_lookup = net-cdb;/hosts-by-ip.db
8691 .endd
8692 The text form of the IP address of the subject host is used as the lookup key.
8693 IPv6 addresses are converted to an unabbreviated form, using lower case
8694 letters, with dots as separators because colon is the key terminator in
8695 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8696 quoting the keys, but this is a facility that was added later.] The data
8697 returned by the lookup is not used.
8698
8699 .cindex "IP address" "masking"
8700 .cindex "host list" "masked IP address"
8701 Single-key lookups can also be performed using masked IP addresses, using
8702 patterns of this form:
8703 .display
8704 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8705 .endd
8706 For example:
8707 .code
8708 net24-dbm;/networks.db
8709 .endd
8710 The IP address of the subject host is masked using <&'number'&> as the mask
8711 length. A textual string is constructed from the masked value, followed by the
8712 mask, and this is used as the lookup key. For example, if the host's IP address
8713 is 192.168.34.6, the key that is looked up for the above example is
8714 &"192.168.34.0/24"&.
8715
8716 When an IPv6 address is converted to a string, dots are normally used instead
8717 of colons, so that keys in &(lsearch)& files need not contain colons (which
8718 terminate &(lsearch)& keys). This was implemented some time before the ability
8719 to quote keys was made available in &(lsearch)& files. However, the more
8720 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8721 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8722 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8723 converted using colons and not dots.
8724 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8725 addresses are always used.
8726 The latter are converted to IPv4 addresses, in dotted-quad form.
8727
8728 Ideally, it would be nice to tidy up this anomalous situation by changing to
8729 colons in all cases, given that quoting is now available for &(lsearch)&.
8730 However, this would be an incompatible change that might break some existing
8731 configurations.
8732
8733 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8734 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8735 the former case the key strings include the mask value, whereas in the latter
8736 case the IP address is used on its own.
8737
8738
8739
8740 .section "Host list patterns that match by host name" "SECThoslispatnam"
8741 .cindex "host" "lookup failures"
8742 .cindex "unknown host name"
8743 .cindex "host list" "matching host name"
8744 There are several types of pattern that require Exim to know the name of the
8745 remote host. These are either wildcard patterns or lookups by name. (If a
8746 complete hostname is given without any wildcarding, it is used to find an IP
8747 address to match against, as described in section &<<SECThoslispatip>>&
8748 above.)
8749
8750 If the remote host name is not already known when Exim encounters one of these
8751 patterns, it has to be found from the IP address.
8752 Although many sites on the Internet are conscientious about maintaining reverse
8753 DNS data for their hosts, there are also many that do not do this.
8754 Consequently, a name cannot always be found, and this may lead to unwanted
8755 effects. Take care when configuring host lists with wildcarded name patterns.
8756 Consider what will happen if a name cannot be found.
8757
8758 Because of the problems of determining host names from IP addresses, matching
8759 against host names is not as common as matching against IP addresses.
8760
8761 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8762 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8763 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8764 are done can be changed by setting the &%host_lookup_order%& option. For
8765 security, once Exim has found one or more names, it looks up the IP addresses
8766 for these names and compares them with the IP address that it started with.
8767 Only those names whose IP addresses match are accepted. Any other names are
8768 discarded. If no names are left, Exim behaves as if the host name cannot be
8769 found. In the most common case there is only one name and one IP address.
8770
8771 There are some options that control what happens if a host name cannot be
8772 found. These are described in section &<<SECTbehipnot>>& below.
8773
8774 .cindex "host" "alias for"
8775 .cindex "alias for host"
8776 As a result of aliasing, hosts may have more than one name. When processing any
8777 of the following types of pattern, all the host's names are checked:
8778
8779 .ilist
8780 .cindex "asterisk" "in host list"
8781 If a pattern starts with &"*"& the remainder of the item must match the end of
8782 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8783 &'.b.c'&. This special simple form is provided because this is a very common
8784 requirement. Other kinds of wildcarding require the use of a regular
8785 expression.
8786 .next
8787 .cindex "regular expressions" "in host list"
8788 .cindex "host list" "regular expression in"
8789 If the item starts with &"^"& it is taken to be a regular expression which is
8790 matched against the host name. Host names are case-independent, so this regular
8791 expression match is by default case-independent, but you can make it
8792 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8793 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8794 example,
8795 .code
8796 ^(a|b)\.c\.d$
8797 .endd
8798 is a regular expression that matches either of the two hosts &'a.c.d'& or
8799 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8800 that backslash and dollar characters are not misinterpreted as part of the
8801 string expansion. The simplest way to do this is to use &`\N`& to mark that
8802 part of the string as non-expandable. For example:
8803 .code
8804 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8805 .endd
8806 &*Warning*&: If you want to match a complete host name, you must include the
8807 &`$`& terminating metacharacter in the regular expression, as in the above
8808 example. Without it, a match at the start of the host name is all that is
8809 required.
8810 .endlist
8811
8812
8813
8814
8815 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8816 .cindex "host" "lookup failures, permanent"
8817 While processing a host list, Exim may need to look up an IP address from a
8818 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8819 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8820 behaviour when it fails to find the information it is seeking is the same.
8821
8822 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8823 apply to temporary DNS errors, whose handling is described in the next section.
8824
8825 .cindex "&`+include_unknown`&"
8826 .cindex "&`+ignore_unknown`&"
8827 Exim parses a host list from left to right. If it encounters a permanent
8828 lookup failure in any item in the host list before it has found a match,
8829 Exim treats it as a failure and the default behavior is as if the host
8830 does not match the list. This may not always be what you want to happen.
8831 To change Exim's behaviour, the special items &`+include_unknown`& or
8832 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8833 not recognized in an indirected file).
8834
8835 .ilist
8836 If any item that follows &`+include_unknown`& requires information that
8837 cannot found, Exim behaves as if the host does match the list. For example,
8838 .code
8839 host_reject_connection = +include_unknown:*.enemy.ex
8840 .endd
8841 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8842 any hosts whose name it cannot find.
8843
8844 .next
8845 If any item that follows &`+ignore_unknown`& requires information that cannot
8846 be found, Exim ignores that item and proceeds to the rest of the list. For
8847 example:
8848 .code
8849 accept hosts = +ignore_unknown : friend.example : \
8850                192.168.4.5
8851 .endd
8852 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8853 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8854 name can be found for 192.168.4.5, it is rejected.
8855 .endlist
8856
8857 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8858 list. The effect of each one lasts until the next, or until the end of the
8859 list.
8860
8861 .section "Mixing wildcarded host names and addresses in host lists" &&&
8862          "SECTmixwilhos"
8863 .cindex "host list" "mixing names and addresses in"
8864
8865 This section explains the host/ip processing logic with the same concepts
8866 as the previous section, but specifically addresses what happens when a
8867 wildcarded hostname is one of the items in the hostlist.
8868
8869 .ilist
8870 If you have name lookups or wildcarded host names and
8871 IP addresses in the same host list, you should normally put the IP
8872 addresses first. For example, in an ACL you could have:
8873 .code
8874 accept hosts = 10.9.8.7 : *.friend.example
8875 .endd
8876 The reason you normally would order it this way lies in the
8877 left-to-right way that Exim processes lists.  It can test IP addresses
8878 without doing any DNS lookups, but when it reaches an item that requires
8879 a host name, it fails if it cannot find a host name to compare with the
8880 pattern. If the above list is given in the opposite order, the
8881 &%accept%& statement fails for a host whose name cannot be found, even
8882 if its IP address is 10.9.8.7.
8883
8884 .next
8885 If you really do want to do the name check first, and still recognize the IP
8886 address, you can rewrite the ACL like this:
8887 .code
8888 accept hosts = *.friend.example
8889 accept hosts = 10.9.8.7
8890 .endd
8891 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8892 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8893 &`+ignore_unknown`&, which was discussed in depth in the first example in
8894 this section.
8895 .endlist
8896
8897
8898 .section "Temporary DNS errors when looking up host information" &&&
8899          "SECTtemdnserr"
8900 .cindex "host" "lookup failures, temporary"
8901 .cindex "&`+include_defer`&"
8902 .cindex "&`+ignore_defer`&"
8903 A temporary DNS lookup failure normally causes a defer action (except when
8904 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8905 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8906 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8907 section. These options should be used with care, probably only in non-critical
8908 host lists such as whitelists.
8909
8910
8911
8912 .section "Host list patterns for single-key lookups by host name" &&&
8913          "SECThoslispatnamsk"
8914 .cindex "unknown host name"
8915 .cindex "host list" "matching host name"
8916 If a pattern is of the form
8917 .display
8918 <&'single-key-search-type'&>;<&'search-data'&>
8919 .endd
8920 for example
8921 .code
8922 dbm;/host/accept/list
8923 .endd
8924 a single-key lookup is performed, using the host name as its key. If the
8925 lookup succeeds, the host matches the item. The actual data that is looked up
8926 is not used.
8927
8928 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8929 keys in the file, not IP addresses. If you want to do lookups based on IP
8930 addresses, you must precede the search type with &"net-"& (see section
8931 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8932 two items in the same list, one doing an address lookup and one doing a name
8933 lookup, both using the same file.
8934
8935
8936
8937 .section "Host list patterns for query-style lookups" "SECID81"
8938 If a pattern is of the form
8939 .display
8940 <&'query-style-search-type'&>;<&'query'&>
8941 .endd
8942 the query is obeyed, and if it succeeds, the host matches the item. The actual
8943 data that is looked up is not used. The variables &$sender_host_address$& and
8944 &$sender_host_name$& can be used in the query. For example:
8945 .code
8946 hosts_lookup = pgsql;\
8947   select ip from hostlist where ip='$sender_host_address'
8948 .endd
8949 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8950 can use the &%sg%& expansion item to change this if you need to. If you want to
8951 use masked IP addresses in database queries, you can use the &%mask%& expansion
8952 operator.
8953
8954 If the query contains a reference to &$sender_host_name$&, Exim automatically
8955 looks up the host name if it has not already done so. (See section
8956 &<<SECThoslispatnam>>& for comments on finding host names.)
8957
8958 Historical note: prior to release 4.30, Exim would always attempt to find a
8959 host name before running the query, unless the search type was preceded by
8960 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8961 still recognized for query-style lookups, but its presence or absence has no
8962 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8963 See section &<<SECThoslispatsikey>>&.)
8964
8965
8966
8967
8968
8969 .section "Address lists" "SECTaddresslist"
8970 .cindex "list" "address list"
8971 .cindex "address list" "empty item"
8972 .cindex "address list" "patterns"
8973 Address lists contain patterns that are matched against mail addresses. There
8974 is one special case to be considered: the sender address of a bounce message is
8975 always empty. You can test for this by providing an empty item in an address
8976 list. For example, you can set up a router to process bounce messages by
8977 using this option setting:
8978 .code
8979 senders = :
8980 .endd
8981 The presence of the colon creates an empty item. If you do not provide any
8982 data, the list is empty and matches nothing. The empty sender can also be
8983 detected by a regular expression that matches an empty string,
8984 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8985
8986 Non-empty items in an address list can be straightforward email addresses. For
8987 example:
8988 .code
8989 senders = jbc@askone.example : hs@anacreon.example
8990 .endd
8991 A certain amount of wildcarding is permitted. If a pattern contains an @
8992 character, but is not a regular expression and does not begin with a
8993 semicolon-terminated lookup type (described below), the local part of the
8994 subject address is compared with the local part of the pattern, which may start
8995 with an asterisk. If the local parts match, the domain is checked in exactly
8996 the same way as for a pattern in a domain list. For example, the domain can be
8997 wildcarded, refer to a named list, or be a lookup:
8998 .code
8999 deny senders = *@*.spamming.site:\
9000                *@+hostile_domains:\
9001                bozo@partial-lsearch;/list/of/dodgy/sites:\
9002                *@dbm;/bad/domains.db
9003 .endd
9004 .cindex "local part" "starting with !"
9005 .cindex "address list" "local part starting with !"
9006 If a local part that begins with an exclamation mark is required, it has to be
9007 specified using a regular expression, because otherwise the exclamation mark is
9008 treated as a sign of negation, as is standard in lists.
9009
9010 If a non-empty pattern that is not a regular expression or a lookup does not
9011 contain an @ character, it is matched against the domain part of the subject
9012 address. The only two formats that are recognized this way are a literal
9013 domain, or a domain pattern that starts with *. In both these cases, the effect
9014 is the same as if &`*@`& preceded the pattern. For example:
9015 .code
9016 deny senders = enemy.domain : *.enemy.domain
9017 .endd
9018
9019 The following kinds of more complicated address list pattern can match any
9020 address, including the empty address that is characteristic of bounce message
9021 senders:
9022
9023 .ilist
9024 .cindex "regular expressions" "in address list"
9025 .cindex "address list" "regular expression in"
9026 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9027 done against the complete address, with the pattern as the regular expression.
9028 You must take care that backslash and dollar characters are not misinterpreted
9029 as part of the string expansion. The simplest way to do this is to use &`\N`&
9030 to mark that part of the string as non-expandable. For example:
9031 .code
9032 deny senders = \N^.*this.*@example\.com$\N : \
9033                \N^\d{8}.+@spamhaus.example$\N : ...
9034 .endd
9035 The &`\N`& sequences are removed by the expansion, so these items do indeed
9036 start with &"^"& by the time they are being interpreted as address patterns.
9037
9038 .next
9039 .cindex "address list" "lookup for complete address"
9040 Complete addresses can be looked up by using a pattern that starts with a
9041 lookup type terminated by a semicolon, followed by the data for the lookup. For
9042 example:
9043 .code
9044 deny senders = cdb;/etc/blocked.senders : \
9045   mysql;select address from blocked where \
9046   address='${quote_mysql:$sender_address}'
9047 .endd
9048 Both query-style and single-key lookup types can be used. For a single-key
9049 lookup type, Exim uses the complete address as the key. However, empty keys are
9050 not supported for single-key lookups, so a match against the empty address
9051 always fails. This restriction does not apply to query-style lookups.
9052
9053 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9054 cannot be used, and is ignored if specified, with an entry being written to the
9055 panic log.
9056 .cindex "*@ with single-key lookup"
9057 However, you can configure lookup defaults, as described in section
9058 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9059 default. For example, with this lookup:
9060 .code
9061 accept senders = lsearch*@;/some/file
9062 .endd
9063 the file could contains lines like this:
9064 .code
9065 user1@domain1.example
9066 *@domain2.example
9067 .endd
9068 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9069 that are tried is:
9070 .code
9071 nimrod@jaeger.example
9072 *@jaeger.example
9073 *
9074 .endd
9075 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9076 would mean that every address matches, thus rendering the test useless.
9077
9078 &*Warning 2*&: Do not confuse these two kinds of item:
9079 .code
9080 deny recipients = dbm*@;/some/file
9081 deny recipients = *@dbm;/some/file
9082 .endd
9083 The first does a whole address lookup, with defaulting, as just described,
9084 because it starts with a lookup type. The second matches the local part and
9085 domain independently, as described in a bullet point below.
9086 .endlist
9087
9088
9089 The following kinds of address list pattern can match only non-empty addresses.
9090 If the subject address is empty, a match against any of these pattern types
9091 always fails.
9092
9093
9094 .ilist
9095 .cindex "@@ with single-key lookup"
9096 .cindex "address list" "@@ lookup type"
9097 .cindex "address list" "split local part and domain"
9098 If a pattern starts with &"@@"& followed by a single-key lookup item
9099 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9100 split into a local part and a domain. The domain is looked up in the file. If
9101 it is not found, there is no match. If it is found, the data that is looked up
9102 from the file is treated as a colon-separated list of local part patterns, each
9103 of which is matched against the subject local part in turn.
9104
9105 .cindex "asterisk" "in address list"
9106 The lookup may be a partial one, and/or one involving a search for a default
9107 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9108 patterns that are looked up can be regular expressions or begin with &"*"&, or
9109 even be further lookups. They may also be independently negated. For example,
9110 with
9111 .code
9112 deny senders = @@dbm;/etc/reject-by-domain
9113 .endd
9114 the data from which the DBM file is built could contain lines like
9115 .code
9116 baddomain.com:  !postmaster : *
9117 .endd
9118 to reject all senders except &%postmaster%& from that domain.
9119
9120 .cindex "local part" "starting with !"
9121 If a local part that actually begins with an exclamation mark is required, it
9122 has to be specified using a regular expression. In &(lsearch)& files, an entry
9123 may be split over several lines by indenting the second and subsequent lines,
9124 but the separating colon must still be included at line breaks. White space
9125 surrounding the colons is ignored. For example:
9126 .code
9127 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9128   spammer3 : spammer4
9129 .endd
9130 As in all colon-separated lists in Exim, a colon can be included in an item by
9131 doubling.
9132
9133 If the last item in the list starts with a right angle-bracket, the remainder
9134 of the item is taken as a new key to look up in order to obtain a continuation
9135 list of local parts. The new key can be any sequence of characters. Thus one
9136 might have entries like
9137 .code
9138 aol.com: spammer1 : spammer 2 : >*
9139 xyz.com: spammer3 : >*
9140 *:       ^\d{8}$
9141 .endd
9142 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9143 local parts for all domains, in addition to the specific local parts listed for
9144 each domain. Of course, using this feature costs another lookup each time a
9145 chain is followed, but the effort needed to maintain the data is reduced.
9146
9147 .cindex "loop" "in lookups"
9148 It is possible to construct loops using this facility, and in order to catch
9149 them, the chains may be no more than fifty items long.
9150
9151 .next
9152 The @@<&'lookup'&> style of item can also be used with a query-style
9153 lookup, but in this case, the chaining facility is not available. The lookup
9154 can only return a single list of local parts.
9155 .endlist
9156
9157 &*Warning*&: There is an important difference between the address list items
9158 in these two examples:
9159 .code
9160 senders = +my_list
9161 senders = *@+my_list
9162 .endd
9163 In the first one, &`my_list`& is a named address list, whereas in the second
9164 example it is a named domain list.
9165
9166
9167
9168
9169 .section "Case of letters in address lists" "SECTcasletadd"
9170 .cindex "case of local parts"
9171 .cindex "address list" "case forcing"
9172 .cindex "case forcing in address lists"
9173 Domains in email addresses are always handled caselessly, but for local parts
9174 case may be significant on some systems (see &%caseful_local_part%& for how
9175 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9176 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9177 blocking lists should be done in a case-independent manner. Since most address
9178 lists in Exim are used for this kind of control, Exim attempts to do this by
9179 default.
9180
9181 The domain portion of an address is always lowercased before matching it to an
9182 address list. The local part is lowercased by default, and any string
9183 comparisons that take place are done caselessly. This means that the data in
9184 the address list itself, in files included as plain filenames, and in any file
9185 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9186 keys in files that are looked up by a search type other than &(lsearch)& (which
9187 works caselessly) must be in lower case, because these lookups are not
9188 case-independent.
9189
9190 .cindex "&`+caseful`&"
9191 To allow for the possibility of caseful address list matching, if an item in
9192 an address list is the string &"+caseful"&, the original case of the local
9193 part is restored for any comparisons that follow, and string comparisons are no
9194 longer case-independent. This does not affect the domain, which remains in
9195 lower case. However, although independent matches on the domain alone are still
9196 performed caselessly, regular expressions that match against an entire address
9197 become case-sensitive after &"+caseful"& has been seen.
9198
9199
9200
9201 .section "Local part lists" "SECTlocparlis"
9202 .cindex "list" "local part list"
9203 .cindex "local part" "list"
9204 Case-sensitivity in local part lists is handled in the same way as for address
9205 lists, as just described. The &"+caseful"& item can be used if required. In a
9206 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9207 set false, the subject is lowercased and the matching is initially
9208 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9209 matching in the local part list, but not elsewhere in the router. If
9210 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9211 option is case-sensitive from the start.
9212
9213 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9214 comments are handled in the same way as address lists &-- they are recognized
9215 only if the # is preceded by white space or the start of the line.
9216 Otherwise, local part lists are matched in the same way as domain lists, except
9217 that the special items that refer to the local host (&`@`&, &`@[]`&,
9218 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9219 Refer to section &<<SECTdomainlist>>& for details of the other available item
9220 types.
9221 .ecindex IIDdohoadli
9222
9223
9224
9225
9226 . ////////////////////////////////////////////////////////////////////////////
9227 . ////////////////////////////////////////////////////////////////////////////
9228
9229 .chapter "String expansions" "CHAPexpand"
9230 .scindex IIDstrexp "expansion" "of strings"
9231 Many strings in Exim's runtime configuration are expanded before use. Some of
9232 them are expanded every time they are used; others are expanded only once.
9233
9234 When a string is being expanded it is copied verbatim from left to right except
9235 .cindex expansion "string concatenation"
9236 when a dollar or backslash character is encountered. A dollar specifies the
9237 start of a portion of the string that is interpreted and replaced as described
9238 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9239 escape character, as described in the following section.
9240
9241 Whether a string is expanded depends upon the context.  Usually this is solely
9242 dependent upon the option for which a value is sought; in this documentation,
9243 options for which string expansion is performed are marked with &dagger; after
9244 the data type.  ACL rules always expand strings.  A couple of expansion
9245 conditions do not expand some of the brace-delimited branches, for security
9246 reasons,
9247 .cindex "tainted data" expansion
9248 .cindex expansion "tainted data"
9249 and expansion of data deriving from the sender (&"tainted data"&)
9250 is not permitted.
9251
9252
9253
9254 .section "Literal text in expanded strings" "SECTlittext"
9255 .cindex "expansion" "including literal text"
9256 An uninterpreted dollar can be included in an expanded string by putting a
9257 backslash in front of it. A backslash can be used to prevent any special
9258 character being treated specially in an expansion, including backslash itself.
9259 If the string appears in quotes in the configuration file, two backslashes are
9260 required because the quotes themselves cause interpretation of backslashes when
9261 the string is read in (see section &<<SECTstrings>>&).
9262
9263 .cindex "expansion" "non-expandable substrings"
9264 A portion of the string can specified as non-expandable by placing it between
9265 two occurrences of &`\N`&. This is particularly useful for protecting regular
9266 expressions, which often contain backslashes and dollar signs. For example:
9267 .code
9268 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9269 .endd
9270 On encountering the first &`\N`&, the expander copies subsequent characters
9271 without interpretation until it reaches the next &`\N`& or the end of the
9272 string.
9273
9274
9275
9276 .section "Character escape sequences in expanded strings" "SECID82"
9277 .cindex "expansion" "escape sequences"
9278 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9279 expanded string is recognized as an escape sequence for the character newline,
9280 carriage return, or tab, respectively. A backslash followed by up to three
9281 octal digits is recognized as an octal encoding for a single character, and a
9282 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9283 encoding.
9284
9285 These escape sequences are also recognized in quoted strings when they are read
9286 in. Their interpretation in expansions as well is useful for unquoted strings,
9287 and for other cases such as looked-up strings that are then expanded.
9288
9289
9290 .section "Testing string expansions" "SECID83"
9291 .cindex "expansion" "testing"
9292 .cindex "testing" "string expansion"
9293 .oindex "&%-be%&"
9294 Many expansions can be tested by calling Exim with the &%-be%& option. This
9295 takes the command arguments, or lines from the standard input if there are no
9296 arguments, runs them through the string expansion code, and writes the results
9297 to the standard output. Variables based on configuration values are set up, but
9298 since no message is being processed, variables such as &$local_part$& have no
9299 value. Nevertheless the &%-be%& option can be useful for checking out file and
9300 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9301 and &%nhash%&.
9302
9303 Exim gives up its root privilege when it is called with the &%-be%& option, and
9304 instead runs under the uid and gid it was called with, to prevent users from
9305 using &%-be%& for reading files to which they do not have access.
9306
9307 .oindex "&%-bem%&"
9308 If you want to test expansions that include variables whose values are taken
9309 from a message, there are two other options that can be used. The &%-bem%&
9310 option is like &%-be%& except that it is followed by a filename. The file is
9311 read as a message before doing the test expansions. For example:
9312 .code
9313 exim -bem /tmp/test.message '$h_subject:'
9314 .endd
9315 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9316 Exim message identifier. For example:
9317 .code
9318 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9319 .endd
9320 This loads the message from Exim's spool before doing the test expansions, and
9321 is therefore restricted to admin users.
9322
9323
9324 .section "Forced expansion failure" "SECTforexpfai"
9325 .cindex "expansion" "forced failure"
9326 A number of expansions that are described in the following section have
9327 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9328 (which are sometimes called &"curly brackets"&). Which of the two strings is
9329 used depends on some condition that is evaluated as part of the expansion. If,
9330 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9331 the entire string expansion fails in a way that can be detected by the code
9332 that requested the expansion. This is called &"forced expansion failure"&, and
9333 its consequences depend on the circumstances. In some cases it is no different
9334 from any other expansion failure, but in others a different action may be
9335 taken. Such variations are mentioned in the documentation of the option that is
9336 being expanded.
9337
9338
9339
9340
9341 .section "Expansion items" "SECTexpansionitems"
9342 The following items are recognized in expanded strings. White space may be used
9343 between sub-items that are keywords or substrings enclosed in braces inside an
9344 outer set of braces, to improve readability. &*Warning*&: Within braces,
9345 white space is significant.
9346
9347 .vlist
9348 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9349 .cindex "expansion" "variables"
9350 Substitute the contents of the named variable, for example:
9351 .code
9352 $local_part
9353 ${domain}
9354 .endd
9355 The second form can be used to separate the name from subsequent alphanumeric
9356 characters. This form (using braces) is available only for variables; it does
9357 &'not'& apply to message headers. The names of the variables are given in
9358 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9359 given, the expansion fails.
9360
9361 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9362 .cindex "expansion" "operators"
9363 The string is first itself expanded, and then the operation specified by
9364 <&'op'&> is applied to it. For example:
9365 .code
9366 ${lc:$local_part}
9367 .endd
9368 The string starts with the first character after the colon, which may be
9369 leading white space. A list of operators is given in section &<<SECTexpop>>&
9370 below. The operator notation is used for simple expansion items that have just
9371 one argument, because it reduces the number of braces and therefore makes the
9372 string easier to understand.
9373
9374 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9375 This item inserts &"basic"& header lines. It is described with the &%header%&
9376 expansion item below.
9377
9378
9379 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9380 .cindex "expansion" "calling an acl"
9381 .cindex "&%acl%&" "call from expansion"
9382 The name and zero to nine argument strings are first expanded separately.  The expanded
9383 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9384 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9385 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9386 and may use the variables; if another acl expansion is used the values
9387 are restored after it returns.  If the ACL sets
9388 a value using a "message =" modifier and returns accept or deny, the value becomes
9389 the result of the expansion.
9390 If no message is set and the ACL returns accept or deny
9391 the expansion result is an empty string.
9392 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9393
9394
9395 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9396 .cindex authentication "results header"
9397 .cindex headers "authentication-results:"
9398 .cindex authentication "expansion item"
9399 This item returns a string suitable for insertion as an
9400 &'Authentication-Results:'&
9401 header line.
9402 The given <&'authserv-id'&> is included in the result; typically this
9403 will be a domain name identifying the system performing the authentications.
9404 Methods that might be present in the result include:
9405 .code
9406 none
9407 iprev
9408 auth
9409 spf
9410 dkim
9411 .endd
9412
9413 Example use (as an ACL modifier):
9414 .code
9415       add_header = :at_start:${authresults {$primary_hostname}}
9416 .endd
9417 This is safe even if no authentication results are available.
9418
9419
9420 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9421        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9422 .cindex "expansion" "extracting certificate fields"
9423 .cindex "&%certextract%&" "certificate fields"
9424 .cindex "certificate" "extracting fields"
9425 The <&'certificate'&> must be a variable of type certificate.
9426 The field name is expanded and used to retrieve the relevant field from
9427 the certificate.  Supported fields are:
9428 .display
9429 &`version        `&
9430 &`serial_number  `&
9431 &`subject        `& RFC4514 DN
9432 &`issuer         `& RFC4514 DN
9433 &`notbefore      `& time
9434 &`notafter       `& time
9435 &`sig_algorithm  `&
9436 &`signature      `&
9437 &`subj_altname   `& tagged list
9438 &`ocsp_uri       `& list
9439 &`crl_uri        `& list
9440 .endd
9441 If the field is found,
9442 <&'string2'&> is expanded, and replaces the whole item;
9443 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9444 variable &$value$& contains the value that has been extracted. Afterwards, it
9445 is restored to any previous value it might have had.
9446
9447 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9448 key is not found. If {<&'string2'&>} is also omitted, the value that was
9449 extracted is used.
9450
9451 Some field names take optional modifiers, appended and separated by commas.
9452
9453 The field selectors marked as "RFC4514" above
9454 output a Distinguished Name string which is
9455 not quite
9456 parseable by Exim as a comma-separated tagged list
9457 (the exceptions being elements containing commas).
9458 RDN elements of a single type may be selected by
9459 a modifier of the type label; if so the expansion
9460 result is a list (newline-separated by default).
9461 The separator may be changed by another modifier of
9462 a right angle-bracket followed immediately by the new separator.
9463 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9464
9465 The field selectors marked as "time" above
9466 take an optional modifier of "int"
9467 for which the result is the number of seconds since epoch.
9468 Otherwise the result is a human-readable string
9469 in the timezone selected by the main "timezone" option.
9470
9471 The field selectors marked as "list" above return a list,
9472 newline-separated by default,
9473 (embedded separator characters in elements are doubled).
9474 The separator may be changed by a modifier of
9475 a right angle-bracket followed immediately by the new separator.
9476
9477 The field selectors marked as "tagged" above
9478 prefix each list element with a type string and an equals sign.
9479 Elements of only one type may be selected by a modifier
9480 which is one of "dns", "uri" or "mail";
9481 if so the element tags are omitted.
9482
9483 If not otherwise noted field values are presented in human-readable form.
9484
9485 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9486        {*&<&'arg'&>&*}...}*&"
9487 .cindex &%dlfunc%&
9488 This expansion dynamically loads and then calls a locally-written C function.
9489 This functionality is available only if Exim is compiled with
9490 .code
9491 EXPAND_DLFUNC=yes
9492 .endd
9493 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9494 object so that it doesn't reload the same object file in the same Exim process
9495 (but of course Exim does start new processes frequently).
9496
9497 There may be from zero to eight arguments to the function.
9498
9499 When compiling
9500 a local function that is to be called in this way,
9501 first &_DLFUNC_IMPL_& should be defined,
9502 and second &_local_scan.h_& should be included.
9503 The Exim variables and functions that are defined by that API
9504 are also available for dynamically loaded functions. The function itself
9505 must have the following type:
9506 .code
9507 int dlfunction(uschar **yield, int argc, uschar *argv[])
9508 .endd
9509 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9510 function should return one of the following values:
9511
9512 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9513 into the expanded string that is being built.
9514
9515 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9516 from &'yield'&, if it is set.
9517
9518 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9519 taken from &'yield'& if it is set.
9520
9521 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9522
9523 When compiling a function that is to be used in this way with gcc,
9524 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9525 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9526
9527
9528 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9529 .cindex "expansion" "extracting value from environment"
9530 .cindex "environment" "values from"
9531 The key is first expanded separately, and leading and trailing white space
9532 removed.
9533 This is then searched for as a name in the environment.
9534 If a variable is found then its value is placed in &$value$&
9535 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9536
9537 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9538 appear, for example:
9539 .code
9540 ${env{USER}{$value} fail }
9541 .endd
9542 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9543 {<&'string1'&>} must be present for &"fail"& to be recognized.
9544
9545 If {<&'string2'&>} is omitted an empty string is substituted on
9546 search failure.
9547 If {<&'string1'&>} is omitted the search result is substituted on
9548 search success.
9549
9550 The environment is adjusted by the &%keep_environment%& and
9551 &%add_environment%& main section options.
9552
9553
9554 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9555        {*&<&'string3'&>&*}}*&"
9556 .cindex "expansion" "extracting substrings by key"
9557 .cindex "&%extract%&" "substrings by key"
9558 The key and <&'string1'&> are first expanded separately. Leading and trailing
9559 white space is removed from the key (but not from any of the strings). The key
9560 must not be empty and must not consist entirely of digits.
9561 The expanded <&'string1'&> must be of the form:
9562 .display
9563 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9564 .endd
9565 .vindex "&$value$&"
9566 where the equals signs and spaces (but not both) are optional. If any of the
9567 values contain white space, they must be enclosed in double quotes, and any
9568 values that are enclosed in double quotes are subject to escape processing as
9569 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9570 for the value that corresponds to the key. The search is case-insensitive. If
9571 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9572 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9573 variable &$value$& contains the value that has been extracted. Afterwards, it
9574 is restored to any previous value it might have had.
9575
9576 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9577 key is not found. If {<&'string2'&>} is also omitted, the value that was
9578 extracted is used. Thus, for example, these two expansions are identical, and
9579 yield &"2001"&:
9580 .code
9581 ${extract{gid}{uid=1984 gid=2001}}
9582 ${extract{gid}{uid=1984 gid=2001}{$value}}
9583 .endd
9584 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9585 appear, for example:
9586 .code
9587 ${extract{Z}{A=... B=...}{$value} fail }
9588 .endd
9589 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9590 {<&'string2'&>} must be present for &"fail"& to be recognized.
9591
9592 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9593        {*&<&'string3'&>&*}}*&" &&&
9594        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9595        {*&<&'string3'&>&*}}*&"
9596 .cindex "expansion" "extracting from JSON object"
9597 .cindex JSON expansions
9598 The key and <&'string1'&> are first expanded separately. Leading and trailing
9599 white space is removed from the key (but not from any of the strings). The key
9600 must not be empty and must not consist entirely of digits.
9601 The expanded <&'string1'&> must be of the form:
9602 .display
9603 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9604 .endd
9605 .vindex "&$value$&"
9606 The braces, commas and colons, and the quoting of the member name are required;
9607 the spaces are optional.
9608 Matching of the key against the member names is done case-sensitively.
9609 For the &"json"& variant,
9610 if a returned value is a JSON string, it retains its leading and
9611 trailing quotes.
9612 For the &"jsons"& variant, which is intended for use with JSON strings, the
9613 leading and trailing quotes are removed from the returned value.
9614 . XXX should be a UTF-8 compare
9615
9616 The results of matching are handled as above.
9617
9618
9619 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9620         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9621 .cindex "expansion" "extracting substrings by number"
9622 .cindex "&%extract%&" "substrings by number"
9623 The <&'number'&> argument must consist entirely of decimal digits,
9624 apart from leading and trailing white space, which is ignored.
9625 This is what distinguishes this form of &%extract%& from the previous kind. It
9626 behaves in the same way, except that, instead of extracting a named field, it
9627 extracts from <&'string1'&> the field whose number is given as the first
9628 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9629 <&'string3'&> as before.
9630
9631 The fields in the string are separated by any one of the characters in the
9632 separator string. These may include space or tab characters.
9633 The first field is numbered one. If the number is negative, the fields are
9634 counted from the end of the string, with the rightmost one numbered -1. If the
9635 number given is zero, the entire string is returned. If the modulus of the
9636 number is greater than the number of fields in the string, the result is the
9637 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9638 provided. For example:
9639 .code
9640 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9641 .endd
9642 yields &"42"&, and
9643 .code
9644 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9645 .endd
9646 yields &"99"&. Two successive separators mean that the field between them is
9647 empty (for example, the fifth field above).
9648
9649
9650 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9651         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9652        "&*${extract jsons{*&<&'number'&>&*}}&&&
9653         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9654 .cindex "expansion" "extracting from JSON array"
9655 .cindex JSON expansions
9656 The <&'number'&> argument must consist entirely of decimal digits,
9657 apart from leading and trailing white space, which is ignored.
9658
9659 Field selection and result handling is as above;
9660 there is no choice of field separator.
9661 For the &"json"& variant,
9662 if a returned value is a JSON string, it retains its leading and
9663 trailing quotes.
9664 For the &"jsons"& variant, which is intended for use with JSON strings, the
9665 leading and trailing quotes are removed from the returned value.
9666
9667
9668 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9669 .cindex "list" "selecting by condition"
9670 .cindex "expansion" "selecting from list by condition"
9671 .vindex "&$item$&"
9672 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9673 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9674 For each item
9675 in this list, its value is place in &$item$&, and then the condition is
9676 evaluated. If the condition is true, &$item$& is added to the output as an
9677 item in a new list; if the condition is false, the item is discarded. The
9678 separator used for the output list is the same as the one used for the
9679 input, but a separator setting is not included in the output. For example:
9680 .code
9681 ${filter{a:b:c}{!eq{$item}{b}}}
9682 .endd
9683 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9684 to what it was before. See also the &%map%& and &%reduce%& expansion items.
9685
9686
9687 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9688 .cindex "hash function" "textual"
9689 .cindex "expansion" "textual hash"
9690 This is a textual hashing function, and was the first to be implemented in
9691 early versions of Exim. In current releases, there are other hashing functions
9692 (numeric, MD5, and SHA-1), which are described below.
9693
9694 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9695 <&'n'&>. If you are using fixed values for these numbers, that is, if
9696 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9697 use the simpler operator notation that avoids some of the braces:
9698 .code
9699 ${hash_<n>_<m>:<string>}
9700 .endd
9701 The second number is optional (in both notations). If <&'n'&> is greater than
9702 or equal to the length of the string, the expansion item returns the string.
9703 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9704 function to the string. The new string consists of characters taken from the
9705 first <&'m'&> characters of the string
9706 .code
9707 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9708 .endd
9709 If <&'m'&> is not present the value 26 is used, so that only lower case
9710 letters appear. For example:
9711 .display
9712 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9713 &`$hash{5}{monty}}           `&   yields  &`monty`&
9714 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9715 .endd
9716
9717 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9718         &*$h_*&<&'header&~name'&>&*:*&" &&&
9719        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9720         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9721        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9722         &*$lh_*&<&'header&~name'&>&*:*&"
9723        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9724         &*$rh_*&<&'header&~name'&>&*:*&"
9725 .cindex "expansion" "header insertion"
9726 .vindex "&$header_$&"
9727 .vindex "&$bheader_$&"
9728 .vindex "&$lheader_$&"
9729 .vindex "&$rheader_$&"
9730 .cindex "header lines" "in expansion strings"
9731 .cindex "header lines" "character sets"
9732 .cindex "header lines" "decoding"
9733 Substitute the contents of the named message header line, for example
9734 .code
9735 $header_reply-to:
9736 .endd
9737 The newline that terminates a header line is not included in the expansion, but
9738 internal newlines (caused by splitting the header line over several physical
9739 lines) may be present.
9740
9741 The difference between the four pairs of expansions is in the way
9742 the data in the header line is interpreted.
9743
9744 .ilist
9745 .cindex "white space" "in header lines"
9746 &%rheader%& gives the original &"raw"& content of the header line, with no
9747 processing at all, and without the removal of leading and trailing white space.
9748
9749 .next
9750 .cindex "list" "of header lines"
9751 &%lheader%& gives a colon-separated list, one element per header when there
9752 are multiple headers with a given name.
9753 Any embedded colon characters within an element are doubled, so normal Exim
9754 list-processing facilities can be used.
9755 The terminating newline of each element is removed; in other respects
9756 the content is &"raw"&.
9757
9758 .next
9759 .cindex "base64 encoding" "in header lines"
9760 &%bheader%& removes leading and trailing white space, and then decodes base64
9761 or quoted-printable MIME &"words"& within the header text, but does no
9762 character set translation. If decoding of what looks superficially like a MIME
9763 &"word"& fails, the raw string is returned. If decoding
9764 .cindex "binary zero" "in header line"
9765 produces a binary zero character, it is replaced by a question mark &-- this is
9766 what Exim does for binary zeros that are actually received in header lines.
9767
9768 .next
9769 &%header%& tries to translate the string as decoded by &%bheader%& to a
9770 standard character set. This is an attempt to produce the same string as would
9771 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9772 returned. Translation is attempted only on operating systems that support the
9773 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9774 a system Makefile or in &_Local/Makefile_&.
9775 .endlist ilist
9776
9777 In a filter file, the target character set for &%header%& can be specified by a
9778 command of the following form:
9779 .code
9780 headers charset "UTF-8"
9781 .endd
9782 This command affects all references to &$h_$& (or &$header_$&) expansions in
9783 subsequently obeyed filter commands. In the absence of this command, the target
9784 character set in a filter is taken from the setting of the &%headers_charset%&
9785 option in the runtime configuration. The value of this option defaults to the
9786 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9787 ISO-8859-1.
9788
9789 Header names follow the syntax of RFC 2822, which states that they may contain
9790 any printing characters except space and colon. Consequently, curly brackets
9791 &'do not'& terminate header names, and should not be used to enclose them as
9792 if they were variables. Attempting to do so causes a syntax error.
9793
9794 Only header lines that are common to all copies of a message are visible to
9795 this mechanism. These are the original header lines that are received with the
9796 message, and any that are added by an ACL statement or by a system
9797 filter. Header lines that are added to a particular copy of a message by a
9798 router or transport are not accessible.
9799
9800 For incoming SMTP messages, no header lines are visible in
9801 ACLs that are obeyed before the data phase completes,
9802 because the header structure is not set up until the message is received.
9803 They are visible in DKIM, PRDR and DATA ACLs.
9804 Header lines that are added in a RCPT ACL (for example)
9805 are saved until the message's incoming header lines are available, at which
9806 point they are added.
9807 When any of the above ACLs ar
9808 running, however, header lines added by earlier ACLs are visible.
9809
9810 Upper case and lower case letters are synonymous in header names. If the
9811 following character is white space, the terminating colon may be omitted, but
9812 this is not recommended, because you may then forget it when it is needed. When
9813 white space terminates the header name, this white space is included in the
9814 expanded string.  If the message does not contain the given header, the
9815 expansion item is replaced by an empty string. (See the &%def%& condition in
9816 section &<<SECTexpcond>>& for a means of testing for the existence of a
9817 header.)
9818
9819 If there is more than one header with the same name, they are all concatenated
9820 to form the substitution string, up to a maximum length of 64K. Unless
9821 &%rheader%& is being used, leading and trailing white space is removed from
9822 each header before concatenation, and a completely empty header is ignored. A
9823 newline character is then inserted between non-empty headers, but there is no
9824 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9825 those headers that contain lists of addresses, a comma is also inserted at the
9826 junctions between headers. This does not happen for the &%rheader%& expansion.
9827
9828 .new
9829 .cindex "tainted data"
9830 When the headers are from an incoming message,
9831 the result of expanding any of these variables is tainted.
9832 .wen
9833
9834
9835 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9836 .cindex "expansion" "hmac hashing"
9837 .cindex &%hmac%&
9838 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9839 shared secret and some text into a message authentication code, as specified in
9840 RFC 2104. This differs from &`${md5:secret_text...}`& or
9841 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9842 cryptographic hash, allowing for authentication that is not possible with MD5
9843 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9844 present. For example:
9845 .code
9846 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9847 .endd
9848 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9849 produces:
9850 .code
9851 dd97e3ba5d1a61b5006108f8c8252953
9852 .endd
9853 As an example of how this might be used, you might put in the main part of
9854 an Exim configuration:
9855 .code
9856 SPAMSCAN_SECRET=cohgheeLei2thahw
9857 .endd
9858 In a router or a transport you could then have:
9859 .code
9860 headers_add = \
9861   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9862   ${hmac{md5}{SPAMSCAN_SECRET}\
9863   {${primary_hostname},${message_exim_id},$h_message-id:}}
9864 .endd
9865 Then given a message, you can check where it was scanned by looking at the
9866 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9867 this header line is authentic by recomputing the authentication code from the
9868 host name, message ID and the &'Message-id:'& header line. This can be done
9869 using Exim's &%-be%& option, or by other means, for example, by using the
9870 &'hmac_md5_hex()'& function in Perl.
9871
9872
9873 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9874 .cindex "expansion" "conditional"
9875 .cindex "&%if%&, expansion item"
9876 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9877 item; otherwise <&'string2'&> is used. The available conditions are described
9878 in section &<<SECTexpcond>>& below. For example:
9879 .code
9880 ${if eq {$local_part}{postmaster} {yes}{no} }
9881 .endd
9882 The second string need not be present; if it is not and the condition is not
9883 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9884 be present instead of the second string (without any curly brackets). In this
9885 case, the expansion is forced to fail if the condition is not true (see section
9886 &<<SECTforexpfai>>&).
9887
9888 If both strings are omitted, the result is the string &`true`& if the condition
9889 is true, and the empty string if the condition is false. This makes it less
9890 cumbersome to write custom ACL and router conditions. For example, instead of
9891 .code
9892 condition = ${if >{$acl_m4}{3}{true}{false}}
9893 .endd
9894 you can use
9895 .code
9896 condition = ${if >{$acl_m4}{3}}
9897 .endd
9898
9899
9900
9901 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9902 .cindex expansion "imap folder"
9903 .cindex "&%imapfolder%& expansion item"
9904 This item converts a (possibly multilevel, or with non-ASCII characters)
9905 folder specification to a Maildir name for filesystem use.
9906 For information on internationalisation support see &<<SECTi18nMDA>>&.
9907
9908
9909
9910 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9911 .cindex "expansion" "string truncation"
9912 .cindex "&%length%& expansion item"
9913 The &%length%& item is used to extract the initial portion of a string. Both
9914 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9915 you are using a fixed value for the number, that is, if <&'string1'&> does not
9916 change when expanded, you can use the simpler operator notation that avoids
9917 some of the braces:
9918 .code
9919 ${length_<n>:<string>}
9920 .endd
9921 The result of this item is either the first <&'n'&> bytes or the whole
9922 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9923 &%strlen%&, which gives the length of a string.
9924 All measurement is done in bytes and is not UTF-8 aware.
9925
9926
9927 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9928         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9929 .cindex "expansion" "extracting list elements by number"
9930 .cindex "&%listextract%&" "extract list elements by number"
9931 .cindex "list" "extracting elements by number"
9932 The <&'number'&> argument must consist entirely of decimal digits,
9933 apart from an optional leading minus,
9934 and leading and trailing white space (which is ignored).
9935
9936 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9937 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9938
9939 The first field of the list is numbered one.
9940 If the number is negative, the fields are
9941 counted from the end of the list, with the rightmost one numbered -1.
9942 The numbered element of the list is extracted and placed in &$value$&,
9943 then <&'string2'&> is expanded as the result.
9944
9945 If the modulus of the
9946 number is zero or greater than the number of fields in the string,
9947 the result is the expansion of <&'string3'&>.
9948
9949 For example:
9950 .code
9951 ${listextract{2}{x:42:99}}
9952 .endd
9953 yields &"42"&, and
9954 .code
9955 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9956 .endd
9957 yields &"result: 42"&.
9958
9959 If {<&'string3'&>} is omitted, an empty string is used for string3.
9960 If {<&'string2'&>} is also omitted, the value that was
9961 extracted is used.
9962 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9963
9964
9965 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9966         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9967 This is the first of one of two different types of lookup item, which are both
9968 described in the next item.
9969
9970 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9971         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9972 .cindex "expansion" "lookup in"
9973 .cindex "file" "lookups"
9974 .cindex "lookup" "in expanded string"
9975 The two forms of lookup item specify data lookups in files and databases, as
9976 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9977 lookups, and the second is used for query-style lookups. The <&'key'&>,
9978 <&'file'&>, and <&'query'&> strings are expanded before use.
9979
9980 If there is any white space in a lookup item which is part of a filter command,
9981 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9982 other place where white space is significant, the lookup item must be enclosed
9983 in double quotes. The use of data lookups in users' filter files may be locked
9984 out by the system administrator.
9985
9986 .vindex "&$value$&"
9987 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9988 During its expansion, the variable &$value$& contains the data returned by the
9989 lookup. Afterwards it reverts to the value it had previously (at the outer
9990 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9991 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9992 string on failure. If <&'string2'&> is provided, it can itself be a nested
9993 lookup, thus providing a mechanism for looking up a default value when the
9994 original lookup fails.
9995
9996 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9997 data for the outer lookup while the parameters of the second lookup are
9998 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9999 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10000 appear, and in this case, if the lookup fails, the entire expansion is forced
10001 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10002 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10003 successful lookup, and nothing in the case of failure.
10004
10005 For single-key lookups, the string &"partial"& is permitted to precede the
10006 search type in order to do partial matching, and * or *@ may follow a search
10007 type to request default lookups if the key does not match (see sections
10008 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10009
10010 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10011 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10012 and non-wild parts of the key during the expansion of the replacement text.
10013 They return to their previous values at the end of the lookup item.
10014
10015 This example looks up the postmaster alias in the conventional alias file:
10016 .code
10017 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10018 .endd
10019 This example uses NIS+ to look up the full name of the user corresponding to
10020 the local part of an address, forcing the expansion to fail if it is not found:
10021 .code
10022 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10023   {$value}fail}
10024 .endd
10025
10026
10027 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10028 .cindex "expansion" "list creation"
10029 .vindex "&$item$&"
10030 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10031 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10032 For each item
10033 in this list, its value is place in &$item$&, and then <&'string2'&> is
10034 expanded and added to the output as an item in a new list. The separator used
10035 for the output list is the same as the one used for the input, but a separator
10036 setting is not included in the output. For example:
10037 .code
10038 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10039 .endd
10040 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10041 value of &$item$& is restored to what it was before. See also the &%filter%&
10042 and &%reduce%& expansion items.
10043
10044 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10045 .cindex "expansion" "numeric hash"
10046 .cindex "hash function" "numeric"
10047 The three strings are expanded; the first two must yield numbers. Call them
10048 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10049 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10050 can use the simpler operator notation that avoids some of the braces:
10051 .code
10052 ${nhash_<n>_<m>:<string>}
10053 .endd
10054 The second number is optional (in both notations). If there is only one number,
10055 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10056 processed by a div/mod hash function that returns two numbers, separated by a
10057 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10058 example,
10059 .code
10060 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10061 .endd
10062 returns the string &"6/33"&.
10063
10064
10065
10066 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10067 .cindex "Perl" "use in expanded string"
10068 .cindex "expansion" "calling Perl from"
10069 This item is available only if Exim has been built to include an embedded Perl
10070 interpreter. The subroutine name and the arguments are first separately
10071 expanded, and then the Perl subroutine is called with those arguments. No
10072 additional arguments need be given; the maximum number permitted, including the
10073 name of the subroutine, is nine.
10074
10075 The return value of the subroutine is inserted into the expanded string, unless
10076 the return value is &%undef%&. In that case, the expansion fails in the same
10077 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10078 Whatever you return is evaluated in a scalar context. For example, if you
10079 return the name of a Perl vector, the return value is the size of the vector,
10080 not its contents.
10081
10082 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10083 with the error message that was passed to &%die%&. More details of the embedded
10084 Perl facility are given in chapter &<<CHAPperl>>&.
10085
10086 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10087 out the use of this expansion item in filter files.
10088
10089
10090 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10091 .cindex "&%prvs%& expansion item"
10092 The first argument is a complete email address and the second is secret
10093 keystring. The third argument, specifying a key number, is optional. If absent,
10094 it defaults to 0. The result of the expansion is a prvs-signed email address,
10095 to be typically used with the &%return_path%& option on an &(smtp)& transport
10096 as part of a bounce address tag validation (BATV) scheme. For more discussion
10097 and an example, see section &<<SECTverifyPRVS>>&.
10098
10099 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10100         {*&<&'string'&>&*}}*&"
10101 .cindex "&%prvscheck%& expansion item"
10102 This expansion item is the complement of the &%prvs%& item. It is used for
10103 checking prvs-signed addresses. If the expansion of the first argument does not
10104 yield a syntactically valid prvs-signed address, the whole item expands to the
10105 empty string. When the first argument does expand to a syntactically valid
10106 prvs-signed address, the second argument is expanded, with the prvs-decoded
10107 version of the address and the key number extracted from the address in the
10108 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10109
10110 These two variables can be used in the expansion of the second argument to
10111 retrieve the secret. The validity of the prvs-signed address is then checked
10112 against the secret. The result is stored in the variable &$prvscheck_result$&,
10113 which is empty for failure or &"1"& for success.
10114
10115 The third argument is optional; if it is missing, it defaults to an empty
10116 string. This argument is now expanded. If the result is an empty string, the
10117 result of the expansion is the decoded version of the address. This is the case
10118 whether or not the signature was valid. Otherwise, the result of the expansion
10119 is the expansion of the third argument.
10120
10121 All three variables can be used in the expansion of the third argument.
10122 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10123 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10124
10125 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10126 .cindex "expansion" "inserting an entire file"
10127 .cindex "file" "inserting into expansion"
10128 .cindex "&%readfile%& expansion item"
10129 The filename and end-of-line string are first expanded separately. The file is
10130 then read, and its contents replace the entire item. All newline characters in
10131 the file are replaced by the end-of-line string if it is present. Otherwise,
10132 newlines are left in the string.
10133 String expansion is not applied to the contents of the file. If you want this,
10134 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10135 the string expansion fails.
10136
10137 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10138 locks out the use of this expansion item in filter files.
10139
10140
10141
10142 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10143         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10144 .cindex "expansion" "inserting from a socket"
10145 .cindex "socket, use of in expansion"
10146 .cindex "&%readsocket%& expansion item"
10147 This item inserts data from a Unix domain or TCP socket into the expanded
10148 string. The minimal way of using it uses just two arguments, as in these
10149 examples:
10150 .code
10151 ${readsocket{/socket/name}{request string}}
10152 ${readsocket{inet:some.host:1234}{request string}}
10153 .endd
10154 For a Unix domain socket, the first substring must be the path to the socket.
10155 For an Internet socket, the first substring must contain &`inet:`& followed by
10156 a host name or IP address, followed by a colon and a port, which can be a
10157 number or the name of a TCP port in &_/etc/services_&. An IP address may
10158 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10159 example:
10160 .code
10161 ${readsocket{inet:[::1]:1234}{request string}}
10162 .endd
10163 Only a single host name may be given, but if looking it up yields more than
10164 one IP address, they are each tried in turn until a connection is made. For
10165 both kinds of socket, Exim makes a connection, writes the request string
10166 unless it is an empty string; and no terminating NUL is ever sent)
10167 and reads from the socket until an end-of-file
10168 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10169 extend what can be done. Firstly, you can vary the timeout. For example:
10170 .code
10171 ${readsocket{/socket/name}{request string}{3s}}
10172 .endd
10173
10174 The third argument is a list of options, of which the first element is the timeout
10175 and must be present if the argument is given.
10176 Further elements are options of form &'name=value'&.
10177 Two option types is currently recognised: shutdown and tls.
10178 The first defines whether (the default)
10179 or not a shutdown is done on the connection after sending the request.
10180 Example, to not do so (preferred, eg. by some webservers):
10181 .code
10182 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10183 .endd
10184 The second, tls, controls the use of TLS on the connection.  Example:
10185 .code
10186 ${readsocket{/socket/name}{request string}{3s:tls=yes}}
10187 .endd
10188 The default is to not use TLS.
10189 If it is enabled, a shutdown as descripbed above is never done.
10190
10191 A fourth argument allows you to change any newlines that are in the data
10192 that is read, in the same way as for &%readfile%& (see above). This example
10193 turns them into spaces:
10194 .code
10195 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10196 .endd
10197 As with all expansions, the substrings are expanded before the processing
10198 happens. Errors in these sub-expansions cause the expansion to fail. In
10199 addition, the following errors can occur:
10200
10201 .ilist
10202 Failure to create a socket file descriptor;
10203 .next
10204 Failure to connect the socket;
10205 .next
10206 Failure to write the request string;
10207 .next
10208 Timeout on reading from the socket.
10209 .endlist
10210
10211 By default, any of these errors causes the expansion to fail. However, if
10212 you supply a fifth substring, it is expanded and used when any of the above
10213 errors occurs. For example:
10214 .code
10215 ${readsocket{/socket/name}{request string}{3s}{\n}\
10216   {socket failure}}
10217 .endd
10218 You can test for the existence of a Unix domain socket by wrapping this
10219 expansion in &`${if exists`&, but there is a race condition between that test
10220 and the actual opening of the socket, so it is safer to use the fifth argument
10221 if you want to be absolutely sure of avoiding an expansion error for a
10222 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10223
10224 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10225 locks out the use of this expansion item in filter files.
10226
10227
10228 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10229 .cindex "expansion" "reducing a list to a scalar"
10230 .cindex "list" "reducing to a scalar"
10231 .vindex "&$value$&"
10232 .vindex "&$item$&"
10233 This operation reduces a list to a single, scalar string. After expansion,
10234 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10235 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10236 Then <&'string2'&> is expanded and
10237 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10238 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10239 them. The result of that expansion is assigned to &$value$& before the next
10240 iteration. When the end of the list is reached, the final value of &$value$& is
10241 added to the expansion output. The &%reduce%& expansion item can be used in a
10242 number of ways. For example, to add up a list of numbers:
10243 .code
10244 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10245 .endd
10246 The result of that expansion would be &`6`&. The maximum of a list of numbers
10247 can be found:
10248 .code
10249 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10250 .endd
10251 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10252 restored to what they were before. See also the &%filter%& and &%map%&
10253 expansion items.
10254
10255 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10256 This item inserts &"raw"& header lines. It is described with the &%header%&
10257 expansion item in section &<<SECTexpansionitems>>& above.
10258
10259 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10260         {*&<&'string2'&>&*}}*&"
10261 .cindex "expansion" "running a command"
10262 .cindex "&%run%& expansion item"
10263 The command and its arguments are first expanded as one string. The string is
10264 split apart into individual arguments by spaces, and then the command is run
10265 in a separate process, but under the same uid and gid.  As in other command
10266 executions from Exim, a shell is not used by default. If the command requires
10267 a shell, you must explicitly code it.
10268
10269 Since the arguments are split by spaces, when there is a variable expansion
10270 which has an empty result, it will cause the situation that the argument will
10271 simply be omitted when the program is actually executed by Exim. If the
10272 script/program requires a specific number of arguments and the expanded
10273 variable could possibly result in this empty expansion, the variable must be
10274 quoted. This is more difficult if the expanded variable itself could result
10275 in a string containing quotes, because it would interfere with the quotes
10276 around the command arguments. A possible guard against this is to wrap the
10277 variable in the &%sg%& operator to change any quote marks to some other
10278 character.
10279
10280 The standard input for the command exists, but is empty. The standard output
10281 and standard error are set to the same file descriptor.
10282 .cindex "return code" "from &%run%& expansion"
10283 .vindex "&$value$&"
10284 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10285 and replaces the entire item; during this expansion, the standard output/error
10286 from the command is in the variable &$value$&. If the command fails,
10287 <&'string2'&>, if present, is expanded and used. Once again, during the
10288 expansion, the standard output/error from the command is in the variable
10289 &$value$&.
10290
10291 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10292 can be the word &"fail"& (not in braces) to force expansion failure if the
10293 command does not succeed. If both strings are omitted, the result is contents
10294 of the standard output/error on success, and nothing on failure.
10295
10296 .vindex "&$run_in_acl$&"
10297 The standard output/error of the command is put in the variable &$value$&.
10298 In this ACL example, the output of a command is logged for the admin to
10299 troubleshoot:
10300 .code
10301 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10302       log_message  = Output of id: $value
10303 .endd
10304 If the command requires shell idioms, such as the > redirect operator, the
10305 shell must be invoked directly, such as with:
10306 .code
10307 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10308 .endd
10309
10310 .vindex "&$runrc$&"
10311 The return code from the command is put in the variable &$runrc$&, and this
10312 remains set afterwards, so in a filter file you can do things like this:
10313 .code
10314 if "${run{x y z}{}}$runrc" is 1 then ...
10315   elif $runrc is 2 then ...
10316   ...
10317 endif
10318 .endd
10319 If execution of the command fails (for example, the command does not exist),
10320 the return code is 127 &-- the same code that shells use for non-existent
10321 commands.
10322
10323 &*Warning*&: In a router or transport, you cannot assume the order in which
10324 option values are expanded, except for those preconditions whose order of
10325 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10326 by the expansion of one option, and use it in another.
10327
10328 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10329 out the use of this expansion item in filter files.
10330
10331
10332 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10333 .cindex "expansion" "string substitution"
10334 .cindex "&%sg%& expansion item"
10335 This item works like Perl's substitution operator (s) with the global (/g)
10336 option; hence its name. However, unlike the Perl equivalent, Exim does not
10337 modify the subject string; instead it returns the modified string for insertion
10338 into the overall expansion. The item takes three arguments: the subject string,
10339 a regular expression, and a substitution string. For example:
10340 .code
10341 ${sg{abcdefabcdef}{abc}{xyz}}
10342 .endd
10343 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10344 if any $, } or \ characters are required in the regular expression or in the
10345 substitution string, they have to be escaped. For example:
10346 .code
10347 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10348 .endd
10349 yields &"defabc"&, and
10350 .code
10351 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10352 .endd
10353 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10354 the regular expression from string expansion.
10355
10356 The regular expression is compiled in 8-bit mode, working against bytes
10357 rather than any Unicode-aware character handling.
10358
10359
10360 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10361 .cindex sorting "a list"
10362 .cindex list sorting
10363 .cindex expansion "list sorting"
10364 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10365 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10366 The <&'comparator'&> argument is interpreted as the operator
10367 of a two-argument expansion condition.
10368 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10369 The comparison should return true when applied to two values
10370 if the first value should sort before the second value.
10371 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10372 the element being placed in &$item$&,
10373 to give values for comparison.
10374
10375 The item result is a sorted list,
10376 with the original list separator,
10377 of the list elements (in full) of the original.
10378
10379 Examples:
10380 .code
10381 ${sort{3:2:1:4}{<}{$item}}
10382 .endd
10383 sorts a list of numbers, and
10384 .code
10385 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10386 .endd
10387 will sort an MX lookup into priority order.
10388
10389
10390 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10391 .cindex "&%substr%& expansion item"
10392 .cindex "substring extraction"
10393 .cindex "expansion" "substring extraction"
10394 The three strings are expanded; the first two must yield numbers. Call them
10395 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10396 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10397 can use the simpler operator notation that avoids some of the braces:
10398 .code
10399 ${substr_<n>_<m>:<string>}
10400 .endd
10401 The second number is optional (in both notations).
10402 If it is absent in the simpler format, the preceding underscore must also be
10403 omitted.
10404
10405 The &%substr%& item can be used to extract more general substrings than
10406 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10407 length required. For example
10408 .code
10409 ${substr{3}{2}{$local_part}}
10410 .endd
10411 If the starting offset is greater than the string length the result is the
10412 null string; if the length plus starting offset is greater than the string
10413 length, the result is the right-hand part of the string, starting from the
10414 given offset. The first byte (character) in the string has offset zero.
10415
10416 The &%substr%& expansion item can take negative offset values to count
10417 from the right-hand end of its operand. The last byte (character) is offset -1,
10418 the second-last is offset -2, and so on. Thus, for example,
10419 .code
10420 ${substr{-5}{2}{1234567}}
10421 .endd
10422 yields &"34"&. If the absolute value of a negative offset is greater than the
10423 length of the string, the substring starts at the beginning of the string, and
10424 the length is reduced by the amount of overshoot. Thus, for example,
10425 .code
10426 ${substr{-5}{2}{12}}
10427 .endd
10428 yields an empty string, but
10429 .code
10430 ${substr{-3}{2}{12}}
10431 .endd
10432 yields &"1"&.
10433
10434 When the second number is omitted from &%substr%&, the remainder of the string
10435 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10436 string preceding the offset point are taken. For example, an offset of -1 and
10437 no length, as in these semantically identical examples:
10438 .code
10439 ${substr_-1:abcde}
10440 ${substr{-1}{abcde}}
10441 .endd
10442 yields all but the last character of the string, that is, &"abcd"&.
10443
10444 All measurement is done in bytes and is not UTF-8 aware.
10445
10446
10447
10448 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10449         {*&<&'replacements'&>&*}}*&"
10450 .cindex "expansion" "character translation"
10451 .cindex "&%tr%& expansion item"
10452 This item does single-character (in bytes) translation on its subject string. The second
10453 argument is a list of characters to be translated in the subject string. Each
10454 matching character is replaced by the corresponding character from the
10455 replacement list. For example
10456 .code
10457 ${tr{abcdea}{ac}{13}}
10458 .endd
10459 yields &`1b3de1`&. If there are duplicates in the second character string, the
10460 last occurrence is used. If the third string is shorter than the second, its
10461 last character is replicated. However, if it is empty, no translation takes
10462 place.
10463
10464 All character handling is done in bytes and is not UTF-8 aware.
10465
10466 .endlist
10467
10468
10469
10470 .section "Expansion operators" "SECTexpop"
10471 .cindex "expansion" "operators"
10472 For expansion items that perform transformations on a single argument string,
10473 the &"operator"& notation is used because it is simpler and uses fewer braces.
10474 The substring is first expanded before the operation is applied to it. The
10475 following operations can be performed:
10476
10477 .vlist
10478 .vitem &*${address:*&<&'string'&>&*}*&
10479 .cindex "expansion" "RFC 2822 address handling"
10480 .cindex "&%address%& expansion item"
10481 The string is interpreted as an RFC 2822 address, as it might appear in a
10482 header line, and the effective address is extracted from it. If the string does
10483 not parse successfully, the result is empty.
10484
10485 The parsing correctly handles SMTPUTF8 Unicode in the string.
10486
10487
10488 .vitem &*${addresses:*&<&'string'&>&*}*&
10489 .cindex "expansion" "RFC 2822 address handling"
10490 .cindex "&%addresses%& expansion item"
10491 The string (after expansion) is interpreted as a list of addresses in RFC
10492 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10493 operative address (&'local-part@domain'&) is extracted from each item, and the
10494 result of the expansion is a colon-separated list, with appropriate
10495 doubling of colons should any happen to be present in the email addresses.
10496 Syntactically invalid RFC2822 address items are omitted from the output.
10497
10498 It is possible to specify a character other than colon for the output
10499 separator by starting the string with > followed by the new separator
10500 character. For example:
10501 .code
10502 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10503 .endd
10504 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10505 first, so if the expanded string starts with >, it may change the output
10506 separator unintentionally. This can be avoided by setting the output
10507 separator explicitly:
10508 .code
10509 ${addresses:>:$h_from:}
10510 .endd
10511
10512 Compare the &%address%& (singular)
10513 expansion item, which extracts the working address from a single RFC2822
10514 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10515 processing lists.
10516
10517 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10518 a strict interpretation of header line formatting.  Exim parses the bare,
10519 unquoted portion of an email address and if it finds a comma, treats it as an
10520 email address separator. For the example header line:
10521 .code
10522 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10523 .endd
10524 The first example below demonstrates that Q-encoded email addresses are parsed
10525 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10526 It does not see the comma because it's still encoded as "=2C".  The second
10527 example below is passed the contents of &`$header_from:`&, meaning it gets
10528 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10529 The third example shows that the presence of a comma is skipped when it is
10530 quoted.  The fourth example shows SMTPUTF8 handling.
10531 .code
10532 # exim -be '${addresses:From: \
10533 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10534 user@example.com
10535 # exim -be '${addresses:From: Last, First <user@example.com>}'
10536 Last:user@example.com
10537 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10538 user@example.com
10539 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10540 フィリップ@example.jp
10541 .endd
10542
10543 .vitem &*${base32:*&<&'digits'&>&*}*&
10544 .cindex "&%base32%& expansion item"
10545 .cindex "expansion" "conversion to base 32"
10546 The string must consist entirely of decimal digits. The number is converted to
10547 base 32 and output as a (empty, for zero) string of characters.
10548 Only lowercase letters are used.
10549
10550 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10551 .cindex "&%base32d%& expansion item"
10552 .cindex "expansion" "conversion to base 32"
10553 The string must consist entirely of base-32 digits.
10554 The number is converted to decimal and output as a string.
10555
10556 .vitem &*${base62:*&<&'digits'&>&*}*&
10557 .cindex "&%base62%& expansion item"
10558 .cindex "expansion" "conversion to base 62"
10559 The string must consist entirely of decimal digits. The number is converted to
10560 base 62 and output as a string of six characters, including leading zeros. In
10561 the few operating environments where Exim uses base 36 instead of base 62 for
10562 its message identifiers (because those systems do not have case-sensitive
10563 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10564 to be absolutely clear: this is &'not'& base64 encoding.
10565
10566 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10567 .cindex "&%base62d%& expansion item"
10568 .cindex "expansion" "conversion to base 62"
10569 The string must consist entirely of base-62 digits, or, in operating
10570 environments where Exim uses base 36 instead of base 62 for its message
10571 identifiers, base-36 digits. The number is converted to decimal and output as a
10572 string.
10573
10574 .vitem &*${base64:*&<&'string'&>&*}*&
10575 .cindex "expansion" "base64 encoding"
10576 .cindex "base64 encoding" "in string expansion"
10577 .cindex "&%base64%& expansion item"
10578 .cindex certificate "base64 of DER"
10579 This operator converts a string into one that is base64 encoded.
10580
10581 If the string is a single variable of type certificate,
10582 returns the base64 encoding of the DER form of the certificate.
10583
10584
10585 .vitem &*${base64d:*&<&'string'&>&*}*&
10586 .cindex "expansion" "base64 decoding"
10587 .cindex "base64 decoding" "in string expansion"
10588 .cindex "&%base64d%& expansion item"
10589 This operator converts a base64-encoded string into the un-coded form.
10590
10591
10592 .vitem &*${domain:*&<&'string'&>&*}*&
10593 .cindex "domain" "extraction"
10594 .cindex "expansion" "domain extraction"
10595 The string is interpreted as an RFC 2822 address and the domain is extracted
10596 from it. If the string does not parse successfully, the result is empty.
10597
10598
10599 .vitem &*${escape:*&<&'string'&>&*}*&
10600 .cindex "expansion" "escaping non-printing characters"
10601 .cindex "&%escape%& expansion item"
10602 If the string contains any non-printing characters, they are converted to
10603 escape sequences starting with a backslash. Whether characters with the most
10604 significant bit set (so-called &"8-bit characters"&) count as printing or not
10605 is controlled by the &%print_topbitchars%& option.
10606
10607 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10608 .cindex "expansion" "escaping 8-bit characters"
10609 .cindex "&%escape8bit%& expansion item"
10610 If the string contains and characters with the most significant bit set,
10611 they are converted to escape sequences starting with a backslash.
10612 Backslashes and DEL characters are also converted.
10613
10614
10615 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10616 .cindex "expansion" "expression evaluation"
10617 .cindex "expansion" "arithmetic expression"
10618 .cindex "&%eval%& expansion item"
10619 These items supports simple arithmetic and bitwise logical operations in
10620 expansion strings. The string (after expansion) must be a conventional
10621 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10622 logical operators, and parentheses. All operations are carried out using
10623 integer arithmetic. The operator priorities are as follows (the same as in the
10624 C programming language):
10625 .table2 70pt 300pt
10626 .irow &'highest:'& "not (~), negate (-)"
10627 .irow ""   "multiply (*), divide (/), remainder (%)"
10628 .irow ""   "plus (+), minus (-)"
10629 .irow ""   "shift-left (<<), shift-right (>>)"
10630 .irow ""   "and (&&)"
10631 .irow ""   "xor (^)"
10632 .irow &'lowest:'&  "or (|)"
10633 .endtable
10634 Binary operators with the same priority are evaluated from left to right. White
10635 space is permitted before or after operators.
10636
10637 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10638 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10639 decimal, even if they start with a leading zero; hexadecimal numbers are not
10640 permitted. This can be useful when processing numbers extracted from dates or
10641 times, which often do have leading zeros.
10642
10643 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10644 or 1024*1024*1024,
10645 respectively. Negative numbers are supported. The result of the computation is
10646 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10647
10648 .display
10649 &`${eval:1+1}            `&  yields 2
10650 &`${eval:1+2*3}          `&  yields 7
10651 &`${eval:(1+2)*3}        `&  yields 9
10652 &`${eval:2+42%5}         `&  yields 4
10653 &`${eval:0xc&amp;5}          `&  yields 4
10654 &`${eval:0xc|5}          `&  yields 13
10655 &`${eval:0xc^5}          `&  yields 9
10656 &`${eval:0xc>>1}         `&  yields 6
10657 &`${eval:0xc<<1}         `&  yields 24
10658 &`${eval:~255&amp;0x1234}    `&  yields 4608
10659 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10660 .endd
10661
10662 As a more realistic example, in an ACL you might have
10663 .code
10664 deny   message = Too many bad recipients
10665        condition =                    \
10666          ${if and {                   \
10667            {>{$rcpt_count}{10}}       \
10668            {                          \
10669            <                          \
10670              {$recipients_count}      \
10671              {${eval:$rcpt_count/2}}  \
10672            }                          \
10673          }{yes}{no}}
10674 .endd
10675 The condition is true if there have been more than 10 RCPT commands and
10676 fewer than half of them have resulted in a valid recipient.
10677
10678
10679 .vitem &*${expand:*&<&'string'&>&*}*&
10680 .cindex "expansion" "re-expansion of substring"
10681 The &%expand%& operator causes a string to be expanded for a second time. For
10682 example,
10683 .code
10684 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10685 .endd
10686 first looks up a string in a file while expanding the operand for &%expand%&,
10687 and then re-expands what it has found.
10688
10689
10690 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10691 .cindex "Unicode"
10692 .cindex "UTF-8" "conversion from"
10693 .cindex "expansion" "UTF-8 conversion"
10694 .cindex "&%from_utf8%& expansion item"
10695 The world is slowly moving towards Unicode, although there are no standards for
10696 email yet. However, other applications (including some databases) are starting
10697 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10698 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10699 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10700 the result is an undefined sequence of bytes.
10701
10702 Unicode code points with values less than 256 are compatible with ASCII and
10703 ISO-8859-1 (also known as Latin-1).
10704 For example, character 169 is the copyright symbol in both cases, though the
10705 way it is encoded is different. In UTF-8, more than one byte is needed for
10706 characters with code values greater than 127, whereas ISO-8859-1 is a
10707 single-byte encoding (but thereby limited to 256 characters). This makes
10708 translation from UTF-8 to ISO-8859-1 straightforward.
10709
10710
10711 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10712 .cindex "hash function" "textual"
10713 .cindex "expansion" "textual hash"
10714 The &%hash%& operator is a simpler interface to the hashing function that can
10715 be used when the two parameters are fixed numbers (as opposed to strings that
10716 change when expanded). The effect is the same as
10717 .code
10718 ${hash{<n>}{<m>}{<string>}}
10719 .endd
10720 See the description of the general &%hash%& item above for details. The
10721 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10722
10723
10724
10725 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10726 .cindex "base64 encoding" "conversion from hex"
10727 .cindex "expansion" "hex to base64"
10728 .cindex "&%hex2b64%& expansion item"
10729 This operator converts a hex string into one that is base64 encoded. This can
10730 be useful for processing the output of the various hashing functions.
10731
10732
10733
10734 .vitem &*${hexquote:*&<&'string'&>&*}*&
10735 .cindex "quoting" "hex-encoded unprintable characters"
10736 .cindex "&%hexquote%& expansion item"
10737 This operator converts non-printable characters in a string into a hex
10738 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10739 as is, and other byte values are converted to &`\xNN`&, for example, a
10740 byte value 127 is converted to &`\x7f`&.
10741
10742
10743 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10744 .cindex "&%ipv6denorm%& expansion item"
10745 .cindex "IP address" normalisation
10746 This expands an IPv6 address to a full eight-element colon-separated set
10747 of hex digits including leading zeroes.
10748 A trailing ipv4-style dotted-decimal set is converted to hex.
10749 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10750
10751 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10752 .cindex "&%ipv6norm%& expansion item"
10753 .cindex "IP address" normalisation
10754 .cindex "IP address" "canonical form"
10755 This converts an IPv6 address to canonical form.
10756 Leading zeroes of groups are omitted, and the longest
10757 set of zero-valued groups is replaced with a double colon.
10758 A trailing ipv4-style dotted-decimal set is converted to hex.
10759 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10760
10761
10762 .vitem &*${lc:*&<&'string'&>&*}*&
10763 .cindex "case forcing in strings"
10764 .cindex "string" "case forcing"
10765 .cindex "lower casing"
10766 .cindex "expansion" "case forcing"
10767 .cindex "&%lc%& expansion item"
10768 This forces the letters in the string into lower-case, for example:
10769 .code
10770 ${lc:$local_part}
10771 .endd
10772 Case is defined per the system C locale.
10773
10774 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10775 .cindex "expansion" "string truncation"
10776 .cindex "&%length%& expansion item"
10777 The &%length%& operator is a simpler interface to the &%length%& function that
10778 can be used when the parameter is a fixed number (as opposed to a string that
10779 changes when expanded). The effect is the same as
10780 .code
10781 ${length{<number>}{<string>}}
10782 .endd
10783 See the description of the general &%length%& item above for details. Note that
10784 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10785 when &%length%& is used as an operator.
10786 All measurement is done in bytes and is not UTF-8 aware.
10787
10788
10789 .vitem &*${listcount:*&<&'string'&>&*}*&
10790 .cindex "expansion" "list item count"
10791 .cindex "list" "item count"
10792 .cindex "list" "count of items"
10793 .cindex "&%listcount%& expansion item"
10794 The string is interpreted as a list and the number of items is returned.
10795
10796
10797 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10798 .cindex "expansion" "named list"
10799 .cindex "&%listnamed%& expansion item"
10800 The name is interpreted as a named list and the content of the list is returned,
10801 expanding any referenced lists, re-quoting as needed for colon-separation.
10802 If the optional type is given it must be one of "a", "d", "h" or "l"
10803 and selects address-, domain-, host- or localpart- lists to search among respectively.
10804 Otherwise all types are searched in an undefined order and the first
10805 matching list is returned.
10806
10807
10808 .vitem &*${local_part:*&<&'string'&>&*}*&
10809 .cindex "expansion" "local part extraction"
10810 .cindex "&%local_part%& expansion item"
10811 The string is interpreted as an RFC 2822 address and the local part is
10812 extracted from it. If the string does not parse successfully, the result is
10813 empty.
10814 The parsing correctly handles SMTPUTF8 Unicode in the string.
10815
10816
10817 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10818 .cindex "masked IP address"
10819 .cindex "IP address" "masking"
10820 .cindex "CIDR notation"
10821 .cindex "expansion" "IP address masking"
10822 .cindex "&%mask%& expansion item"
10823 If the form of the string to be operated on is not an IP address followed by a
10824 slash and an integer (that is, a network address in CIDR notation), the
10825 expansion fails. Otherwise, this operator converts the IP address to binary,
10826 masks off the least significant bits according to the bit count, and converts
10827 the result back to text, with mask appended. For example,
10828 .code
10829 ${mask:10.111.131.206/28}
10830 .endd
10831 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10832 be mostly used for looking up masked addresses in files, the result for an IPv6
10833 address uses dots to separate components instead of colons, because colon
10834 terminates a key string in lsearch files. So, for example,
10835 .code
10836 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10837 .endd
10838 returns the string
10839 .code
10840 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10841 .endd
10842 Letters in IPv6 addresses are always output in lower case.
10843
10844
10845 .vitem &*${md5:*&<&'string'&>&*}*&
10846 .cindex "MD5 hash"
10847 .cindex "expansion" "MD5 hash"
10848 .cindex certificate fingerprint
10849 .cindex "&%md5%& expansion item"
10850 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10851 as a 32-digit hexadecimal number, in which any letters are in lower case.
10852
10853 If the string is a single variable of type certificate,
10854 returns the MD5 hash fingerprint of the certificate.
10855
10856
10857 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10858 .cindex "expansion" "numeric hash"
10859 .cindex "hash function" "numeric"
10860 The &%nhash%& operator is a simpler interface to the numeric hashing function
10861 that can be used when the two parameters are fixed numbers (as opposed to
10862 strings that change when expanded). The effect is the same as
10863 .code
10864 ${nhash{<n>}{<m>}{<string>}}
10865 .endd
10866 See the description of the general &%nhash%& item above for details.
10867
10868
10869 .vitem &*${quote:*&<&'string'&>&*}*&
10870 .cindex "quoting" "in string expansions"
10871 .cindex "expansion" "quoting"
10872 .cindex "&%quote%& expansion item"
10873 The &%quote%& operator puts its argument into double quotes if it
10874 is an empty string or
10875 contains anything other than letters, digits, underscores, dots, and hyphens.
10876 Any occurrences of double quotes and backslashes are escaped with a backslash.
10877 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10878 respectively For example,
10879 .code
10880 ${quote:ab"*"cd}
10881 .endd
10882 becomes
10883 .code
10884 "ab\"*\"cd"
10885 .endd
10886 The place where this is useful is when the argument is a substitution from a
10887 variable or a message header.
10888
10889 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10890 .cindex "&%quote_local_part%& expansion item"
10891 This operator is like &%quote%&, except that it quotes the string only if
10892 required to do so by the rules of RFC 2822 for quoting local parts. For
10893 example, a plus sign would not cause quoting (but it would for &%quote%&).
10894 If you are creating a new email address from the contents of &$local_part$&
10895 (or any other unknown data), you should always use this operator.
10896
10897 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
10898 will likely use the quoting form.
10899 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
10900
10901
10902 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10903 .cindex "quoting" "lookup-specific"
10904 This operator applies lookup-specific quoting rules to the string. Each
10905 query-style lookup type has its own quoting rules which are described with
10906 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10907 .code
10908 ${quote_ldap:two * two}
10909 .endd
10910 returns
10911 .code
10912 two%20%5C2A%20two
10913 .endd
10914 For single-key lookup types, no quoting is ever necessary and this operator
10915 yields an unchanged string.
10916
10917
10918 .vitem &*${randint:*&<&'n'&>&*}*&
10919 .cindex "random number"
10920 This operator returns a somewhat random number which is less than the
10921 supplied number and is at least 0.  The quality of this randomness depends
10922 on how Exim was built; the values are not suitable for keying material.
10923 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10924 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10925 for versions of GnuTLS with that function.
10926 Otherwise, the implementation may be arc4random(), random() seeded by
10927 srandomdev() or srandom(), or a custom implementation even weaker than
10928 random().
10929
10930
10931 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10932 .cindex "expansion" "IP address"
10933 This operator reverses an IP address; for IPv4 addresses, the result is in
10934 dotted-quad decimal form, while for IPv6 addresses the result is in
10935 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10936 for DNS.  For example,
10937 .code
10938 ${reverse_ip:192.0.2.4}
10939 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10940 .endd
10941 returns
10942 .code
10943 4.2.0.192
10944 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
10945 .endd
10946
10947
10948 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10949 .cindex "expansion" "RFC 2047"
10950 .cindex "RFC 2047" "expansion operator"
10951 .cindex "&%rfc2047%& expansion item"
10952 This operator encodes text according to the rules of RFC 2047. This is an
10953 encoding that is used in header lines to encode non-ASCII characters. It is
10954 assumed that the input string is in the encoding specified by the
10955 &%headers_charset%& option, which gets its default at build time. If the string
10956 contains only characters in the range 33&--126, and no instances of the
10957 characters
10958 .code
10959 ? = ( ) < > @ , ; : \ " . [ ] _
10960 .endd
10961 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10962 string, using as many &"encoded words"& as necessary to encode all the
10963 characters.
10964
10965
10966 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10967 .cindex "expansion" "RFC 2047"
10968 .cindex "RFC 2047" "decoding"
10969 .cindex "&%rfc2047d%& expansion item"
10970 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10971 bytes are replaced by question marks. Characters are converted into the
10972 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10973 not recognized unless &%check_rfc2047_length%& is set false.
10974
10975 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10976 access a header line, RFC 2047 decoding is done automatically. You do not need
10977 to use this operator as well.
10978
10979
10980
10981 .vitem &*${rxquote:*&<&'string'&>&*}*&
10982 .cindex "quoting" "in regular expressions"
10983 .cindex "regular expressions" "quoting"
10984 .cindex "&%rxquote%& expansion item"
10985 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10986 characters in its argument. This is useful when substituting the values of
10987 variables or headers inside regular expressions.
10988
10989
10990 .vitem &*${sha1:*&<&'string'&>&*}*&
10991 .cindex "SHA-1 hash"
10992 .cindex "expansion" "SHA-1 hashing"
10993 .cindex certificate fingerprint
10994 .cindex "&%sha1%& expansion item"
10995 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10996 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10997
10998 If the string is a single variable of type certificate,
10999 returns the SHA-1 hash fingerprint of the certificate.
11000
11001
11002 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11003        &*${sha2:*&<&'string'&>&*}*& &&&
11004        &*${sha2_<n>:*&<&'string'&>&*}*&
11005 .cindex "SHA-256 hash"
11006 .cindex "SHA-2 hash"
11007 .cindex certificate fingerprint
11008 .cindex "expansion" "SHA-256 hashing"
11009 .cindex "&%sha256%& expansion item"
11010 .cindex "&%sha2%& expansion item"
11011 The &%sha256%& operator computes the SHA-256 hash value of the string
11012 and returns
11013 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11014
11015 If the string is a single variable of type certificate,
11016 returns the SHA-256 hash fingerprint of the certificate.
11017
11018 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11019 (except for certificates, which are not supported).
11020 Finally, if an underbar
11021 and a number is appended it specifies the output length, selecting a
11022 member of the SHA-2 family of hash functions.
11023 Values of 256, 384 and 512 are accepted, with 256 being the default.
11024
11025
11026 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11027        &*${sha3_<n>:*&<&'string'&>&*}*&
11028 .cindex "SHA3 hash"
11029 .cindex "expansion" "SHA3 hashing"
11030 .cindex "&%sha3%& expansion item"
11031 The &%sha3%& operator computes the SHA3-256 hash value of the string
11032 and returns
11033 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11034
11035 If a number is appended, separated by an underbar, it specifies
11036 the output length.  Values of 224, 256, 384 and 512 are accepted;
11037 with 256 being the default.
11038
11039 The &%sha3%& expansion item is only supported if Exim has been
11040 compiled with GnuTLS 3.5.0 or later,
11041 or OpenSSL 1.1.1 or later.
11042 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11043
11044
11045 .vitem &*${stat:*&<&'string'&>&*}*&
11046 .cindex "expansion" "statting a file"
11047 .cindex "file" "extracting characteristics"
11048 .cindex "&%stat%& expansion item"
11049 The string, after expansion, must be a file path. A call to the &[stat()]&
11050 function is made for this path. If &[stat()]& fails, an error occurs and the
11051 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11052 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11053 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11054 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11055 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11056 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11057 can extract individual fields using the &%extract%& expansion item.
11058
11059 The use of the &%stat%& expansion in users' filter files can be locked out by
11060 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11061 systems for files larger than 2GB.
11062
11063 .vitem &*${str2b64:*&<&'string'&>&*}*&
11064 .cindex "&%str2b64%& expansion item"
11065 Now deprecated, a synonym for the &%base64%& expansion operator.
11066
11067
11068
11069 .vitem &*${strlen:*&<&'string'&>&*}*&
11070 .cindex "expansion" "string length"
11071 .cindex "string" "length in expansion"
11072 .cindex "&%strlen%& expansion item"
11073 The item is replace by the length of the expanded string, expressed as a
11074 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11075 All measurement is done in bytes and is not UTF-8 aware.
11076
11077
11078 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11079 .cindex "&%substr%& expansion item"
11080 .cindex "substring extraction"
11081 .cindex "expansion" "substring expansion"
11082 The &%substr%& operator is a simpler interface to the &%substr%& function that
11083 can be used when the two parameters are fixed numbers (as opposed to strings
11084 that change when expanded). The effect is the same as
11085 .code
11086 ${substr{<start>}{<length>}{<string>}}
11087 .endd
11088 See the description of the general &%substr%& item above for details. The
11089 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11090 All measurement is done in bytes and is not UTF-8 aware.
11091
11092 .vitem &*${time_eval:*&<&'string'&>&*}*&
11093 .cindex "&%time_eval%& expansion item"
11094 .cindex "time interval" "decoding"
11095 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11096 seconds.
11097
11098 .vitem &*${time_interval:*&<&'string'&>&*}*&
11099 .cindex "&%time_interval%& expansion item"
11100 .cindex "time interval" "formatting"
11101 The argument (after sub-expansion) must be a sequence of decimal digits that
11102 represents an interval of time as a number of seconds. It is converted into a
11103 number of larger units and output in Exim's normal time format, for example,
11104 &`1w3d4h2m6s`&.
11105
11106 .vitem &*${uc:*&<&'string'&>&*}*&
11107 .cindex "case forcing in strings"
11108 .cindex "string" "case forcing"
11109 .cindex "upper casing"
11110 .cindex "expansion" "case forcing"
11111 .cindex "&%uc%& expansion item"
11112 This forces the letters in the string into upper-case.
11113 Case is defined per the system C locale.
11114
11115 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11116 .cindex "correction of invalid utf-8 sequences in strings"
11117 .cindex "utf-8" "utf-8 sequences"
11118 .cindex "incorrect utf-8"
11119 .cindex "expansion" "utf-8 forcing"
11120 .cindex "&%utf8clean%& expansion item"
11121 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11122 In versions of Exim before 4.92, this did not correctly do so for a truncated
11123 final codepoint's encoding, and the character would be silently dropped.
11124 If you must handle detection of this scenario across both sets of Exim behavior,
11125 the complexity will depend upon the task.
11126 For instance, to detect if the first character is multibyte and a 1-byte
11127 extraction can be successfully used as a path component (as is common for
11128 dividing up delivery folders), you might use:
11129 .code
11130 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11131 .endd
11132 (which will false-positive if the first character of the local part is a
11133 literal question mark).
11134
11135 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11136        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11137        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11138        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11139 .cindex expansion UTF-8
11140 .cindex UTF-8 expansion
11141 .cindex EAI
11142 .cindex internationalisation
11143 .cindex "&%utf8_domain_to_alabel%& expansion item"
11144 .cindex "&%utf8_domain_from_alabel%& expansion item"
11145 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11146 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11147 These convert EAI mail name components between UTF-8 and a-label forms.
11148 For information on internationalisation support see &<<SECTi18nMTA>>&.
11149 .endlist
11150
11151
11152
11153
11154
11155
11156 .section "Expansion conditions" "SECTexpcond"
11157 .scindex IIDexpcond "expansion" "conditions"
11158 The following conditions are available for testing by the &%${if%& construct
11159 while expanding strings:
11160
11161 .vlist
11162 .vitem &*!*&<&'condition'&>
11163 .cindex "expansion" "negating a condition"
11164 .cindex "negation" "in expansion condition"
11165 Preceding any condition with an exclamation mark negates the result of the
11166 condition.
11167
11168 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11169 .cindex "numeric comparison"
11170 .cindex "expansion" "numeric comparison"
11171 There are a number of symbolic operators for doing numeric comparisons. They
11172 are:
11173 .display
11174 &`=   `&   equal
11175 &`==  `&   equal
11176 &`>   `&   greater
11177 &`>=  `&   greater or equal
11178 &`<   `&   less
11179 &`<=  `&   less or equal
11180 .endd
11181 For example:
11182 .code
11183 ${if >{$message_size}{10M} ...
11184 .endd
11185 Note that the general negation operator provides for inequality testing. The
11186 two strings must take the form of optionally signed decimal integers,
11187 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11188 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11189 As a special case, the numerical value of an empty string is taken as
11190 zero.
11191
11192 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11193 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11194 10M, not if 10M is larger than &$message_size$&.
11195
11196
11197 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11198         {*&<&'arg2'&>&*}...}*&
11199 .cindex "expansion" "calling an acl"
11200 .cindex "&%acl%&" "expansion condition"
11201 The name and zero to nine argument strings are first expanded separately.  The expanded
11202 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11203 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11204 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11205 and may use the variables; if another acl expansion is used the values
11206 are restored after it returns.  If the ACL sets
11207 a value using a "message =" modifier the variable $value becomes
11208 the result of the expansion, otherwise it is empty.
11209 If the ACL returns accept the condition is true; if deny, false.
11210 If the ACL returns defer the result is a forced-fail.
11211
11212 .vitem &*bool&~{*&<&'string'&>&*}*&
11213 .cindex "expansion" "boolean parsing"
11214 .cindex "&%bool%& expansion condition"
11215 This condition turns a string holding a true or false representation into
11216 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11217 (case-insensitively); also integer numbers map to true if non-zero,
11218 false if zero.
11219 An empty string is treated as false.
11220 Leading and trailing whitespace is ignored;
11221 thus a string consisting only of whitespace is false.
11222 All other string values will result in expansion failure.
11223
11224 When combined with ACL variables, this expansion condition will let you
11225 make decisions in one place and act on those decisions in another place.
11226 For example:
11227 .code
11228 ${if bool{$acl_m_privileged_sender} ...
11229 .endd
11230
11231
11232 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11233 .cindex "expansion" "boolean parsing"
11234 .cindex "&%bool_lax%& expansion condition"
11235 Like &%bool%&, this condition turns a string into a boolean state.  But
11236 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11237 loose definition that the Router &%condition%& option uses.  The empty string
11238 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11239 true.  Leading and trailing whitespace is ignored.
11240
11241 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11242
11243 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11244 .cindex "expansion" "encrypted comparison"
11245 .cindex "encrypted strings, comparing"
11246 .cindex "&%crypteq%& expansion condition"
11247 This condition is included in the Exim binary if it is built to support any
11248 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11249 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11250 included in the binary.
11251
11252 The &%crypteq%& condition has two arguments. The first is encrypted and
11253 compared against the second, which is already encrypted. The second string may
11254 be in the LDAP form for storing encrypted strings, which starts with the
11255 encryption type in curly brackets, followed by the data. If the second string
11256 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11257 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11258 Typically this will be a field from a password file. An example of an encrypted
11259 string in LDAP form is:
11260 .code
11261 {md5}CY9rzUYh03PK3k6DJie09g==
11262 .endd
11263 If such a string appears directly in an expansion, the curly brackets have to
11264 be quoted, because they are part of the expansion syntax. For example:
11265 .code
11266 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11267 .endd
11268 The following encryption types (whose names are matched case-independently) are
11269 supported:
11270
11271 .ilist
11272 .cindex "MD5 hash"
11273 .cindex "base64 encoding" "in encrypted password"
11274 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11275 printable characters to compare with the remainder of the second string. If the
11276 length of the comparison string is 24, Exim assumes that it is base64 encoded
11277 (as in the above example). If the length is 32, Exim assumes that it is a
11278 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11279 comparison fails.
11280
11281 .next
11282 .cindex "SHA-1 hash"
11283 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11284 printable characters to compare with the remainder of the second string. If the
11285 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11286 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11287 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11288
11289 .next
11290 .cindex "&[crypt()]&"
11291 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11292 only the first eight characters of the password. However, in modern operating
11293 systems this is no longer true, and in many cases the entire password is used,
11294 whatever its length.
11295
11296 .next
11297 .cindex "&[crypt16()]&"
11298 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11299 use up to 16 characters of the password in some operating systems. Again, in
11300 modern operating systems, more characters may be used.
11301 .endlist
11302 Exim has its own version of &[crypt16()]&, which is just a double call to
11303 &[crypt()]&. For operating systems that have their own version, setting
11304 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11305 operating system version instead of its own. This option is set by default in
11306 the OS-dependent &_Makefile_& for those operating systems that are known to
11307 support &[crypt16()]&.
11308
11309 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11310 it was not using the same algorithm as some operating systems' versions. It
11311 turns out that as well as &[crypt16()]& there is a function called
11312 &[bigcrypt()]& in some operating systems. This may or may not use the same
11313 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11314
11315 However, since there is now a move away from the traditional &[crypt()]&
11316 functions towards using SHA1 and other algorithms, tidying up this area of
11317 Exim is seen as very low priority.
11318
11319 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11320 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11321 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11322 default is &`{crypt}`&. Whatever the default, you can always use either
11323 function by specifying it explicitly in curly brackets.
11324
11325 .vitem &*def:*&<&'variable&~name'&>
11326 .cindex "expansion" "checking for empty variable"
11327 .cindex "&%def%& expansion condition"
11328 The &%def%& condition must be followed by the name of one of the expansion
11329 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11330 variable does not contain the empty string. For example:
11331 .code
11332 ${if def:sender_ident {from $sender_ident}}
11333 .endd
11334 Note that the variable name is given without a leading &%$%& character. If the
11335 variable does not exist, the expansion fails.
11336
11337 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11338         &~&*def:h_*&<&'header&~name'&>&*:*&"
11339 .cindex "expansion" "checking header line existence"
11340 This condition is true if a message is being processed and the named header
11341 exists in the message. For example,
11342 .code
11343 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11344 .endd
11345 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11346 the header name must be terminated by a colon if white space does not follow.
11347
11348 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11349        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11350 .cindex "string" "comparison"
11351 .cindex "expansion" "string comparison"
11352 .cindex "&%eq%& expansion condition"
11353 .cindex "&%eqi%& expansion condition"
11354 The two substrings are first expanded. The condition is true if the two
11355 resulting strings are identical. For &%eq%& the comparison includes the case of
11356 letters, whereas for &%eqi%& the comparison is case-independent, where
11357 case is defined per the system C locale.
11358
11359 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11360 .cindex "expansion" "file existence test"
11361 .cindex "file" "existence test"
11362 .cindex "&%exists%&, expansion condition"
11363 The substring is first expanded and then interpreted as an absolute path. The
11364 condition is true if the named file (or directory) exists. The existence test
11365 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11366 users' filter files may be locked out by the system administrator.
11367
11368 .vitem &*first_delivery*&
11369 .cindex "delivery" "first"
11370 .cindex "first delivery"
11371 .cindex "expansion" "first delivery test"
11372 .cindex "&%first_delivery%& expansion condition"
11373 This condition, which has no data, is true during a message's first delivery
11374 attempt. It is false during any subsequent delivery attempts.
11375
11376
11377 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11378        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11379 .cindex "list" "iterative conditions"
11380 .cindex "expansion" "&*forall*& condition"
11381 .cindex "expansion" "&*forany*& condition"
11382 .vindex "&$item$&"
11383 These conditions iterate over a list. The first argument is expanded to form
11384 the list. By default, the list separator is a colon, but it can be changed by
11385 the normal method (&<<SECTlistsepchange>>&).
11386 The second argument is interpreted as a condition that is to
11387 be applied to each item in the list in turn. During the interpretation of the
11388 condition, the current list item is placed in a variable called &$item$&.
11389 .ilist
11390 For &*forany*&, interpretation stops if the condition is true for any item, and
11391 the result of the whole condition is true. If the condition is false for all
11392 items in the list, the overall condition is false.
11393 .next
11394 For &*forall*&, interpretation stops if the condition is false for any item,
11395 and the result of the whole condition is false. If the condition is true for
11396 all items in the list, the overall condition is true.
11397 .endlist
11398 Note that negation of &*forany*& means that the condition must be false for all
11399 items for the overall condition to succeed, and negation of &*forall*& means
11400 that the condition must be false for at least one item. In this example, the
11401 list separator is changed to a comma:
11402 .code
11403 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11404 .endd
11405 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11406 being processed, to enable these expansion items to be nested.
11407
11408 To scan a named list, expand it with the &*listnamed*& operator.
11409
11410 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11411        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11412        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11413        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11414 .cindex JSON "iterative conditions"
11415 .cindex JSON expansions
11416 .cindex expansion "&*forall_json*& condition"
11417 .cindex expansion "&*forany_json*& condition"
11418 .cindex expansion "&*forall_jsons*& condition"
11419 .cindex expansion "&*forany_jsons*& condition"
11420 As for the above, except that the first argument must, after expansion,
11421 be a JSON array.
11422 The array separator is not changeable.
11423 For the &"jsons"& variants the elements are expected to be JSON strings
11424 and have their quotes removed before the evaluation of the condition.
11425
11426
11427
11428 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11429        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11430 .cindex "string" "comparison"
11431 .cindex "expansion" "string comparison"
11432 .cindex "&%ge%& expansion condition"
11433 .cindex "&%gei%& expansion condition"
11434 The two substrings are first expanded. The condition is true if the first
11435 string is lexically greater than or equal to the second string. For &%ge%& the
11436 comparison includes the case of letters, whereas for &%gei%& the comparison is
11437 case-independent.
11438 Case and collation order are defined per the system C locale.
11439
11440 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11441        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11442 .cindex "string" "comparison"
11443 .cindex "expansion" "string comparison"
11444 .cindex "&%gt%& expansion condition"
11445 .cindex "&%gti%& expansion condition"
11446 The two substrings are first expanded. The condition is true if the first
11447 string is lexically greater than the second string. For &%gt%& the comparison
11448 includes the case of letters, whereas for &%gti%& the comparison is
11449 case-independent.
11450 Case and collation order are defined per the system C locale.
11451
11452 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11453        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11454 .cindex "string" "comparison"
11455 .cindex "list" "iterative conditions"
11456 Both strings are expanded; the second string is treated as a list of simple
11457 strings; if the first string is a member of the second, then the condition
11458 is true.
11459 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11460
11461 These are simpler to use versions of the more powerful &*forany*& condition.
11462 Examples, and the &*forany*& equivalents:
11463 .code
11464 ${if inlist{needle}{foo:needle:bar}}
11465   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11466 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11467   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11468 .endd
11469
11470 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11471        &*isip4&~{*&<&'string'&>&*}*& &&&
11472        &*isip6&~{*&<&'string'&>&*}*&
11473 .cindex "IP address" "testing string format"
11474 .cindex "string" "testing for IP address"
11475 .cindex "&%isip%& expansion condition"
11476 .cindex "&%isip4%& expansion condition"
11477 .cindex "&%isip6%& expansion condition"
11478 The substring is first expanded, and then tested to see if it has the form of
11479 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11480 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11481
11482 For an IPv4 address, the test is for four dot-separated components, each of
11483 which consists of from one to three digits. For an IPv6 address, up to eight
11484 colon-separated components are permitted, each containing from one to four
11485 hexadecimal digits. There may be fewer than eight components if an empty
11486 component (adjacent colons) is present. Only one empty component is permitted.
11487
11488 &*Note*&: The checks used to be just on the form of the address; actual numerical
11489 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11490 check.
11491 This is no longer the case.
11492
11493 The main use of these tests is to distinguish between IP addresses and
11494 host names, or between IPv4 and IPv6 addresses. For example, you could use
11495 .code
11496 ${if isip4{$sender_host_address}...
11497 .endd
11498 to test which IP version an incoming SMTP connection is using.
11499
11500 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11501 .cindex "LDAP" "use for authentication"
11502 .cindex "expansion" "LDAP authentication test"
11503 .cindex "&%ldapauth%& expansion condition"
11504 This condition supports user authentication using LDAP. See section
11505 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11506 queries. For this use, the query must contain a user name and password. The
11507 query itself is not used, and can be empty. The condition is true if the
11508 password is not empty, and the user name and password are accepted by the LDAP
11509 server. An empty password is rejected without calling LDAP because LDAP binds
11510 with an empty password are considered anonymous regardless of the username, and
11511 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11512 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11513 this can be used.
11514
11515
11516 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11517        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11518 .cindex "string" "comparison"
11519 .cindex "expansion" "string comparison"
11520 .cindex "&%le%& expansion condition"
11521 .cindex "&%lei%& expansion condition"
11522 The two substrings are first expanded. The condition is true if the first
11523 string is lexically less than or equal to the second string. For &%le%& the
11524 comparison includes the case of letters, whereas for &%lei%& the comparison is
11525 case-independent.
11526 Case and collation order are defined per the system C locale.
11527
11528 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11529        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11530 .cindex "string" "comparison"
11531 .cindex "expansion" "string comparison"
11532 .cindex "&%lt%& expansion condition"
11533 .cindex "&%lti%& expansion condition"
11534 The two substrings are first expanded. The condition is true if the first
11535 string is lexically less than the second string. For &%lt%& the comparison
11536 includes the case of letters, whereas for &%lti%& the comparison is
11537 case-independent.
11538 Case and collation order are defined per the system C locale.
11539
11540
11541 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11542 .cindex "expansion" "regular expression comparison"
11543 .cindex "regular expressions" "match in expanded string"
11544 .cindex "&%match%& expansion condition"
11545 The two substrings are first expanded. The second is then treated as a regular
11546 expression and applied to the first. Because of the pre-expansion, if the
11547 regular expression contains dollar, or backslash characters, they must be
11548 escaped. Care must also be taken if the regular expression contains braces
11549 (curly brackets). A closing brace must be escaped so that it is not taken as a
11550 premature termination of <&'string2'&>. The easiest approach is to use the
11551 &`\N`& feature to disable expansion of the regular expression.
11552 For example,
11553 .code
11554 ${if match {$local_part}{\N^\d{3}\N} ...
11555 .endd
11556 If the whole expansion string is in double quotes, further escaping of
11557 backslashes is also required.
11558
11559 The condition is true if the regular expression match succeeds.
11560 The regular expression is not required to begin with a circumflex
11561 metacharacter, but if there is no circumflex, the expression is not anchored,
11562 and it may match anywhere in the subject, not just at the start. If you want
11563 the pattern to match at the end of the subject, you must include the &`$`&
11564 metacharacter at an appropriate point.
11565 All character handling is done in bytes and is not UTF-8 aware,
11566 but we might change this in a future Exim release.
11567
11568 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11569 At the start of an &%if%& expansion the values of the numeric variable
11570 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11571 succeeds causes them to be reset to the substrings of that condition and they
11572 will have these values during the expansion of the success string. At the end
11573 of the &%if%& expansion, the previous values are restored. After testing a
11574 combination of conditions using &%or%&, the subsequent values of the numeric
11575 variables are those of the condition that succeeded.
11576
11577 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11578 .cindex "&%match_address%& expansion condition"
11579 See &*match_local_part*&.
11580
11581 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11582 .cindex "&%match_domain%& expansion condition"
11583 See &*match_local_part*&.
11584
11585 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11586 .cindex "&%match_ip%& expansion condition"
11587 This condition matches an IP address to a list of IP address patterns. It must
11588 be followed by two argument strings. The first (after expansion) must be an IP
11589 address or an empty string. The second (not expanded) is a restricted host
11590 list that can match only an IP address, not a host name. For example:
11591 .code
11592 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11593 .endd
11594 The specific types of host list item that are permitted in the list are:
11595
11596 .ilist
11597 An IP address, optionally with a CIDR mask.
11598 .next
11599 A single asterisk, which matches any IP address.
11600 .next
11601 An empty item, which matches only if the IP address is empty. This could be
11602 useful for testing for a locally submitted message or one from specific hosts
11603 in a single test such as
11604 . ==== As this is a nested list, any displays it contains must be indented
11605 . ==== as otherwise they are too far to the left. This comment applies to
11606 . ==== the use of xmlto plus fop. There's no problem when formatting with
11607 . ==== sdop, with or without the extra indent.
11608 .code
11609   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11610 .endd
11611 where the first item in the list is the empty string.
11612 .next
11613 The item @[] matches any of the local host's interface addresses.
11614 .next
11615 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11616 even if &`net-`& is not specified. There is never any attempt to turn the IP
11617 address into a host name. The most common type of linear search for
11618 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11619 masks. For example:
11620 .code
11621   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11622 .endd
11623 It is of course possible to use other kinds of lookup, and in such a case, you
11624 do need to specify the &`net-`& prefix if you want to specify a specific
11625 address mask, for example:
11626 .code
11627   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11628 .endd
11629 However, unless you are combining a &%match_ip%& condition with others, it is
11630 just as easy to use the fact that a lookup is itself a condition, and write:
11631 .code
11632   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11633 .endd
11634 .endlist ilist
11635
11636 Note that <&'string2'&> is not itself subject to string expansion, unless
11637 Exim was built with the EXPAND_LISTMATCH_RHS option.
11638
11639 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11640
11641 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11642 .cindex "domain list" "in expansion condition"
11643 .cindex "address list" "in expansion condition"
11644 .cindex "local part" "list, in expansion condition"
11645 .cindex "&%match_local_part%& expansion condition"
11646 This condition, together with &%match_address%& and &%match_domain%&, make it
11647 possible to test domain, address, and local part lists within expansions. Each
11648 condition requires two arguments: an item and a list to match. A trivial
11649 example is:
11650 .code
11651 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11652 .endd
11653 In each case, the second argument may contain any of the allowable items for a
11654 list of the appropriate type. Also, because the second argument
11655 is a standard form of list, it is possible to refer to a named list.
11656 Thus, you can use conditions like this:
11657 .code
11658 ${if match_domain{$domain}{+local_domains}{...
11659 .endd
11660 .cindex "&`+caseful`&"
11661 For address lists, the matching starts off caselessly, but the &`+caseful`&
11662 item can be used, as in all address lists, to cause subsequent items to
11663 have their local parts matched casefully. Domains are always matched
11664 caselessly.
11665
11666 Note that <&'string2'&> is not itself subject to string expansion, unless
11667 Exim was built with the EXPAND_LISTMATCH_RHS option.
11668
11669 &*Note*&: Host lists are &'not'& supported in this way. This is because
11670 hosts have two identities: a name and an IP address, and it is not clear
11671 how to specify cleanly how such a test would work. However, IP addresses can be
11672 matched using &%match_ip%&.
11673
11674 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11675 .cindex "PAM authentication"
11676 .cindex "AUTH" "with PAM"
11677 .cindex "Solaris" "PAM support"
11678 .cindex "expansion" "PAM authentication test"
11679 .cindex "&%pam%& expansion condition"
11680 &'Pluggable Authentication Modules'&
11681 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11682 available in the latest releases of Solaris and in some GNU/Linux
11683 distributions. The Exim support, which is intended for use in conjunction with
11684 the SMTP AUTH command, is available only if Exim is compiled with
11685 .code
11686 SUPPORT_PAM=yes
11687 .endd
11688 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11689 in some releases of GNU/Linux &%-ldl%& is also needed.
11690
11691 The argument string is first expanded, and the result must be a
11692 colon-separated list of strings. Leading and trailing white space is ignored.
11693 The PAM module is initialized with the service name &"exim"& and the user name
11694 taken from the first item in the colon-separated data string (<&'string1'&>).
11695 The remaining items in the data string are passed over in response to requests
11696 from the authentication function. In the simple case there will only be one
11697 request, for a password, so the data consists of just two strings.
11698
11699 There can be problems if any of the strings are permitted to contain colon
11700 characters. In the usual way, these have to be doubled to avoid being taken as
11701 separators. If the data is being inserted from a variable, the &%sg%& expansion
11702 item can be used to double any existing colons. For example, the configuration
11703 of a LOGIN authenticator might contain this setting:
11704 .code
11705 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11706 .endd
11707 For a PLAIN authenticator you could use:
11708 .code
11709 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11710 .endd
11711 In some operating systems, PAM authentication can be done only from a process
11712 running as root. Since Exim is running as the Exim user when receiving
11713 messages, this means that PAM cannot be used directly in those systems.
11714 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11715
11716
11717 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11718 .cindex "&'pwcheck'& daemon"
11719 .cindex "Cyrus"
11720 .cindex "expansion" "&'pwcheck'& authentication test"
11721 .cindex "&%pwcheck%& expansion condition"
11722 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11723 This is one way of making it possible for passwords to be checked by a process
11724 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11725 deprecated. Its replacement is &'saslauthd'& (see below).
11726
11727 The pwcheck support is not included in Exim by default. You need to specify
11728 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11729 building Exim. For example:
11730 .code
11731 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11732 .endd
11733 You do not need to install the full Cyrus software suite in order to use
11734 the pwcheck daemon. You can compile and install just the daemon alone
11735 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11736 access to the &_/var/pwcheck_& directory.
11737
11738 The &%pwcheck%& condition takes one argument, which must be the user name and
11739 password, separated by a colon. For example, in a LOGIN authenticator
11740 configuration, you might have this:
11741 .code
11742 server_condition = ${if pwcheck{$auth1:$auth2}}
11743 .endd
11744 Again, for a PLAIN authenticator configuration, this would be:
11745 .code
11746 server_condition = ${if pwcheck{$auth2:$auth3}}
11747 .endd
11748 .vitem &*queue_running*&
11749 .cindex "queue runner" "detecting when delivering from"
11750 .cindex "expansion" "queue runner test"
11751 .cindex "&%queue_running%& expansion condition"
11752 This condition, which has no data, is true during delivery attempts that are
11753 initiated by queue runner processes, and false otherwise.
11754
11755
11756 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11757 .cindex "Radius"
11758 .cindex "expansion" "Radius authentication"
11759 .cindex "&%radius%& expansion condition"
11760 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11761 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11762 the Radius client configuration file in order to build Exim with Radius
11763 support.
11764
11765 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11766 library, using the original API. If you are using release 0.4.0 or later of
11767 this library, you need to set
11768 .code
11769 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11770 .endd
11771 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11772 &%libradius%& library that comes with FreeBSD. To do this, set
11773 .code
11774 RADIUS_LIB_TYPE=RADLIB
11775 .endd
11776 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11777 You may also have to supply a suitable setting in EXTRALIBS so that the
11778 Radius library can be found when Exim is linked.
11779
11780 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11781 Radius client library, which calls the Radius server. The condition is true if
11782 the authentication is successful. For example:
11783 .code
11784 server_condition = ${if radius{<arguments>}}
11785 .endd
11786
11787
11788 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11789         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11790 .cindex "&'saslauthd'& daemon"
11791 .cindex "Cyrus"
11792 .cindex "expansion" "&'saslauthd'& authentication test"
11793 .cindex "&%saslauthd%& expansion condition"
11794 This condition supports user authentication using the Cyrus &'saslauthd'&
11795 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11796 Using this daemon is one way of making it possible for passwords to be checked
11797 by a process that is not running as root.
11798
11799 The saslauthd support is not included in Exim by default. You need to specify
11800 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11801 building Exim. For example:
11802 .code
11803 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11804 .endd
11805 You do not need to install the full Cyrus software suite in order to use
11806 the saslauthd daemon. You can compile and install just the daemon alone
11807 from the Cyrus SASL library.
11808
11809 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11810 two are mandatory. For example:
11811 .code
11812 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11813 .endd
11814 The service and the realm are optional (which is why the arguments are enclosed
11815 in their own set of braces). For details of the meaning of the service and
11816 realm, and how to run the daemon, consult the Cyrus documentation.
11817 .endlist vlist
11818
11819
11820
11821 .section "Combining expansion conditions" "SECID84"
11822 .cindex "expansion" "combining conditions"
11823 Several conditions can be tested at once by combining them using the &%and%&
11824 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11825 conditions on their own, and precede their lists of sub-conditions. Each
11826 sub-condition must be enclosed in braces within the overall braces that contain
11827 the list. No repetition of &%if%& is used.
11828
11829
11830 .vlist
11831 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11832 .cindex "&""or""& expansion condition"
11833 .cindex "expansion" "&""or""& of conditions"
11834 The sub-conditions are evaluated from left to right. The condition is true if
11835 any one of the sub-conditions is true.
11836 For example,
11837 .code
11838 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11839 .endd
11840 When a true sub-condition is found, the following ones are parsed but not
11841 evaluated. If there are several &"match"& sub-conditions the values of the
11842 numeric variables afterwards are taken from the first one that succeeds.
11843
11844 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11845 .cindex "&""and""& expansion condition"
11846 .cindex "expansion" "&""and""& of conditions"
11847 The sub-conditions are evaluated from left to right. The condition is true if
11848 all of the sub-conditions are true. If there are several &"match"&
11849 sub-conditions, the values of the numeric variables afterwards are taken from
11850 the last one. When a false sub-condition is found, the following ones are
11851 parsed but not evaluated.
11852 .endlist
11853 .ecindex IIDexpcond
11854
11855
11856
11857
11858 .section "Expansion variables" "SECTexpvar"
11859 .cindex "expansion" "variables, list of"
11860 This section contains an alphabetical list of all the expansion variables. Some
11861 of them are available only when Exim is compiled with specific options such as
11862 support for TLS or the content scanning extension.
11863
11864 .vlist
11865 .vitem "&$0$&, &$1$&, etc"
11866 .cindex "numerical variables (&$1$& &$2$& etc)"
11867 When a &%match%& expansion condition succeeds, these variables contain the
11868 captured substrings identified by the regular expression during subsequent
11869 processing of the success string of the containing &%if%& expansion item.
11870 In the expansion condition case
11871 they do not retain their values afterwards; in fact, their previous
11872 values are restored at the end of processing an &%if%& item. The numerical
11873 variables may also be set externally by some other matching process which
11874 precedes the expansion of the string. For example, the commands available in
11875 Exim filter files include an &%if%& command with its own regular expression
11876 matching condition.
11877
11878 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11879 Within an acl condition, expansion condition or expansion item
11880 any arguments are copied to these variables,
11881 any unused variables being made empty.
11882
11883 .vitem "&$acl_c...$&"
11884 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11885 can be given any name that starts with &$acl_c$& and is at least six characters
11886 long, but the sixth character must be either a digit or an underscore. For
11887 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11888 variables persist throughout the lifetime of an SMTP connection. They can be
11889 used to pass information between ACLs and between different invocations of the
11890 same ACL. When a message is received, the values of these variables are saved
11891 with the message, and can be accessed by filters, routers, and transports
11892 during subsequent delivery.
11893
11894 .vitem "&$acl_m...$&"
11895 These variables are like the &$acl_c...$& variables, except that their values
11896 are reset after a message has been received. Thus, if several messages are
11897 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11898 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11899 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11900 message is received, the values of these variables are saved with the message,
11901 and can be accessed by filters, routers, and transports during subsequent
11902 delivery.
11903
11904 .vitem &$acl_narg$&
11905 Within an acl condition, expansion condition or expansion item
11906 this variable has the number of arguments.
11907
11908 .vitem &$acl_verify_message$&
11909 .vindex "&$acl_verify_message$&"
11910 After an address verification has failed, this variable contains the failure
11911 message. It retains its value for use in subsequent modifiers. The message can
11912 be preserved by coding like this:
11913 .code
11914 warn !verify = sender
11915      set acl_m0 = $acl_verify_message
11916 .endd
11917 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11918 &%log_message%& modifiers, to include information about the verification
11919 failure.
11920
11921 .vitem &$address_data$&
11922 .vindex "&$address_data$&"
11923 This variable is set by means of the &%address_data%& option in routers. The
11924 value then remains with the address while it is processed by subsequent routers
11925 and eventually a transport. If the transport is handling multiple addresses,
11926 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11927 for more details. &*Note*&: The contents of &$address_data$& are visible in
11928 user filter files.
11929
11930 If &$address_data$& is set when the routers are called from an ACL to verify
11931 a recipient address, the final value is still in the variable for subsequent
11932 conditions and modifiers of the ACL statement. If routing the address caused it
11933 to be redirected to just one address, the child address is also routed as part
11934 of the verification, and in this case the final value of &$address_data$& is
11935 from the child's routing.
11936
11937 If &$address_data$& is set when the routers are called from an ACL to verify a
11938 sender address, the final value is also preserved, but this time in
11939 &$sender_address_data$&, to distinguish it from data from a recipient
11940 address.
11941
11942 In both cases (recipient and sender verification), the value does not persist
11943 after the end of the current ACL statement. If you want to preserve
11944 these values for longer, you can save them in ACL variables.
11945
11946 .vitem &$address_file$&
11947 .vindex "&$address_file$&"
11948 When, as a result of aliasing, forwarding, or filtering, a message is directed
11949 to a specific file, this variable holds the name of the file when the transport
11950 is running. At other times, the variable is empty. For example, using the
11951 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11952 .code
11953 /home/r2d2/savemail
11954 .endd
11955 then when the &(address_file)& transport is running, &$address_file$&
11956 contains the text string &`/home/r2d2/savemail`&.
11957 .cindex "Sieve filter" "value of &$address_file$&"
11958 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11959 then up to the transport configuration to generate an appropriate absolute path
11960 to the relevant file.
11961
11962 .vitem &$address_pipe$&
11963 .vindex "&$address_pipe$&"
11964 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11965 this variable holds the pipe command when the transport is running.
11966
11967 .vitem "&$auth1$& &-- &$auth3$&"
11968 .vindex "&$auth1$&, &$auth2$&, etc"
11969 These variables are used in SMTP authenticators (see chapters
11970 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11971
11972 .vitem &$authenticated_id$&
11973 .cindex "authentication" "id"
11974 .vindex "&$authenticated_id$&"
11975 When a server successfully authenticates a client it may be configured to
11976 preserve some of the authentication information in the variable
11977 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11978 user/password authenticator configuration might preserve the user name for use
11979 in the routers. Note that this is not the same information that is saved in
11980 &$sender_host_authenticated$&.
11981
11982 When a message is submitted locally (that is, not over a TCP connection)
11983 the value of &$authenticated_id$& is normally the login name of the calling
11984 process. However, a trusted user can override this by means of the &%-oMai%&
11985 command line option.
11986 This second case also sets up information used by the
11987 &$authresults$& expansion item.
11988
11989 .vitem &$authenticated_fail_id$&
11990 .cindex "authentication" "fail" "id"
11991 .vindex "&$authenticated_fail_id$&"
11992 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11993 will contain the failed authentication id. If more than one authentication
11994 id is attempted, it will contain only the last one. The variable is
11995 available for processing in the ACL's, generally the quit or notquit ACL.
11996 A message to a local recipient could still be accepted without requiring
11997 authentication, which means this variable could also be visible in all of
11998 the ACL's as well.
11999
12000
12001 .vitem &$authenticated_sender$&
12002 .cindex "sender" "authenticated"
12003 .cindex "authentication" "sender"
12004 .cindex "AUTH" "on MAIL command"
12005 .vindex "&$authenticated_sender$&"
12006 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12007 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12008 described in section &<<SECTauthparamail>>&. Unless the data is the string
12009 &"<>"&, it is set as the authenticated sender of the message, and the value is
12010 available during delivery in the &$authenticated_sender$& variable. If the
12011 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12012
12013 .vindex "&$qualify_domain$&"
12014 When a message is submitted locally (that is, not over a TCP connection), the
12015 value of &$authenticated_sender$& is an address constructed from the login
12016 name of the calling process and &$qualify_domain$&, except that a trusted user
12017 can override this by means of the &%-oMas%& command line option.
12018
12019
12020 .vitem &$authentication_failed$&
12021 .cindex "authentication" "failure"
12022 .vindex "&$authentication_failed$&"
12023 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12024 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12025 possible to distinguish between &"did not try to authenticate"&
12026 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12027 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12028 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12029 negative response to an AUTH command, including (for example) an attempt to use
12030 an undefined mechanism.
12031
12032 .vitem &$av_failed$&
12033 .cindex "content scanning" "AV scanner failure"
12034 This variable is available when Exim is compiled with the content-scanning
12035 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12036 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12037 the ACL malware condition.
12038
12039 .vitem &$body_linecount$&
12040 .cindex "message body" "line count"
12041 .cindex "body of message" "line count"
12042 .vindex "&$body_linecount$&"
12043 When a message is being received or delivered, this variable contains the
12044 number of lines in the message's body. See also &$message_linecount$&.
12045
12046 .vitem &$body_zerocount$&
12047 .cindex "message body" "binary zero count"
12048 .cindex "body of message" "binary zero count"
12049 .cindex "binary zero" "in message body"
12050 .vindex "&$body_zerocount$&"
12051 When a message is being received or delivered, this variable contains the
12052 number of binary zero bytes (ASCII NULs) in the message's body.
12053
12054 .vitem &$bounce_recipient$&
12055 .vindex "&$bounce_recipient$&"
12056 This is set to the recipient address of a bounce message while Exim is creating
12057 it. It is useful if a customized bounce message text file is in use (see
12058 chapter &<<CHAPemsgcust>>&).
12059
12060 .vitem &$bounce_return_size_limit$&
12061 .vindex "&$bounce_return_size_limit$&"
12062 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12063 up to a multiple of 1000. It is useful when a customized error message text
12064 file is in use (see chapter &<<CHAPemsgcust>>&).
12065
12066 .vitem &$caller_gid$&
12067 .cindex "gid (group id)" "caller"
12068 .vindex "&$caller_gid$&"
12069 The real group id under which the process that called Exim was running. This is
12070 not the same as the group id of the originator of a message (see
12071 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12072 incarnation normally contains the Exim gid.
12073
12074 .vitem &$caller_uid$&
12075 .cindex "uid (user id)" "caller"
12076 .vindex "&$caller_uid$&"
12077 The real user id under which the process that called Exim was running. This is
12078 not the same as the user id of the originator of a message (see
12079 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12080 incarnation normally contains the Exim uid.
12081
12082 .vitem &$callout_address$&
12083 .vindex "&$callout_address$&"
12084 After a callout for verification, spamd or malware daemon service, the
12085 address that was connected to.
12086
12087 .vitem &$compile_number$&
12088 .vindex "&$compile_number$&"
12089 The building process for Exim keeps a count of the number
12090 of times it has been compiled. This serves to distinguish different
12091 compilations of the same version of Exim.
12092
12093 .vitem &$config_dir$&
12094 .vindex "&$config_dir$&"
12095 The directory name of the main configuration file. That is, the content of
12096 &$config_file$& with the last component stripped. The value does not
12097 contain the trailing slash. If &$config_file$& does not contain a slash,
12098 &$config_dir$& is ".".
12099
12100 .vitem &$config_file$&
12101 .vindex "&$config_file$&"
12102 The name of the main configuration file Exim is using.
12103
12104 .vitem &$dmarc_domain_policy$& &&&
12105        &$dmarc_status$& &&&
12106        &$dmarc_status_text$& &&&
12107        &$dmarc_used_domains$&
12108 Results of DMARC verification.
12109 For details see section &<<SECDMARC>>&.
12110
12111 .vitem &$dkim_verify_status$&
12112 Results of DKIM verification.
12113 For details see section &<<SECDKIMVFY>>&.
12114
12115 .vitem &$dkim_cur_signer$& &&&
12116        &$dkim_verify_reason$& &&&
12117        &$dkim_domain$& &&&
12118        &$dkim_identity$& &&&
12119        &$dkim_selector$& &&&
12120        &$dkim_algo$& &&&
12121        &$dkim_canon_body$& &&&
12122        &$dkim_canon_headers$& &&&
12123        &$dkim_copiedheaders$& &&&
12124        &$dkim_bodylength$& &&&
12125        &$dkim_created$& &&&
12126        &$dkim_expires$& &&&
12127        &$dkim_headernames$& &&&
12128        &$dkim_key_testing$& &&&
12129        &$dkim_key_nosubdomains$& &&&
12130        &$dkim_key_srvtype$& &&&
12131        &$dkim_key_granularity$& &&&
12132        &$dkim_key_notes$& &&&
12133        &$dkim_key_length$&
12134 These variables are only available within the DKIM ACL.
12135 For details see section &<<SECDKIMVFY>>&.
12136
12137 .vitem &$dkim_signers$&
12138 .vindex &$dkim_signers$&
12139 When a message has been received this variable contains
12140 a colon-separated list of signer domains and identities for the message.
12141 For details see section &<<SECDKIMVFY>>&.
12142
12143 .vitem &$dnslist_domain$& &&&
12144        &$dnslist_matched$& &&&
12145        &$dnslist_text$& &&&
12146        &$dnslist_value$&
12147 .vindex "&$dnslist_domain$&"
12148 .vindex "&$dnslist_matched$&"
12149 .vindex "&$dnslist_text$&"
12150 .vindex "&$dnslist_value$&"
12151 .cindex "black list (DNS)"
12152 When a DNS (black) list lookup succeeds, these variables are set to contain
12153 the following data from the lookup: the list's domain name, the key that was
12154 looked up, the contents of any associated TXT record, and the value from the
12155 main A record. See section &<<SECID204>>& for more details.
12156
12157 .vitem &$domain$&
12158 .vindex "&$domain$&"
12159 When an address is being routed, or delivered on its own, this variable
12160 contains the domain. Uppercase letters in the domain are converted into lower
12161 case for &$domain$&.
12162
12163 Global address rewriting happens when a message is received, so the value of
12164 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12165 is set during user filtering, but not during system filtering, because a
12166 message may have many recipients and the system filter is called just once.
12167
12168 When more than one address is being delivered at once (for example, several
12169 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12170 have the same domain. Transports can be restricted to handling only one domain
12171 at a time if the value of &$domain$& is required at transport time &-- this is
12172 the default for local transports. For further details of the environment in
12173 which local transports are run, see chapter &<<CHAPenvironment>>&.
12174
12175 .oindex "&%delay_warning_condition%&"
12176 At the end of a delivery, if all deferred addresses have the same domain, it is
12177 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12178
12179 The &$domain$& variable is also used in some other circumstances:
12180
12181 .ilist
12182 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12183 the recipient address. The domain of the &'sender'& address is in
12184 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12185 normally set during the running of the MAIL ACL. However, if the sender address
12186 is verified with a callout during the MAIL ACL, the sender domain is placed in
12187 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12188 the &(smtp)& transport.
12189
12190 .next
12191 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12192 &$domain$& contains the domain portion of the address that is being rewritten;
12193 it can be used in the expansion of the replacement address, for example, to
12194 rewrite domains by file lookup.
12195
12196 .next
12197 With one important exception, whenever a domain list is being scanned,
12198 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12199 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12200 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12201 that, in a RCPT ACL, the sender domain list can be dependent on the
12202 recipient domain (which is what is in &$domain$& at this time).
12203
12204 .next
12205 .cindex "ETRN" "value of &$domain$&"
12206 .oindex "&%smtp_etrn_command%&"
12207 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12208 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12209 .endlist
12210
12211 .new
12212 .cindex "tainted data"
12213 If the origin of the data is an incoming message,
12214 the result of expanding this variable is tainted.
12215 See also &$domain_verified$&.
12216 .wen
12217
12218
12219 .vitem &$domain_data$&
12220 .vindex "&$domain_data$&"
12221 When the &%domains%& option on a router matches a domain by
12222 means of a lookup, the data read by the lookup is available during the running
12223 of the router as &$domain_data$&. In addition, if the driver routes the
12224 address to a transport, the value is available in that transport. If the
12225 transport is handling multiple addresses, the value from the first address is
12226 used.
12227
12228 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
12229 domain by means of a lookup. The data read by the lookup is available during
12230 the rest of the ACL statement. In all other situations, this variable expands
12231 to nothing.
12232
12233 .vitem &$exim_gid$&
12234 .vindex "&$exim_gid$&"
12235 This variable contains the numerical value of the Exim group id.
12236
12237 .vitem &$exim_path$&
12238 .vindex "&$exim_path$&"
12239 This variable contains the path to the Exim binary.
12240
12241 .vitem &$exim_uid$&
12242 .vindex "&$exim_uid$&"
12243 This variable contains the numerical value of the Exim user id.
12244
12245 .vitem &$exim_version$&
12246 .vindex "&$exim_version$&"
12247 This variable contains the version string of the Exim build.
12248 The first character is a major version number, currently 4.
12249 Then after a dot, the next group of digits is a minor version number.
12250 There may be other characters following the minor version.
12251 This value may be overridden by the &%exim_version%& main config option.
12252
12253 .vitem &$header_$&<&'name'&>
12254 This is not strictly an expansion variable. It is expansion syntax for
12255 inserting the message header line with the given name. Note that the name must
12256 be terminated by colon or white space, because it may contain a wide variety of
12257 characters. Note also that braces must &'not'& be used.
12258 See the full description in section &<<SECTexpansionitems>>& above.
12259
12260 .vitem &$headers_added$&
12261 .vindex "&$headers_added$&"
12262 Within an ACL this variable contains the headers added so far by
12263 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12264 The headers are a newline-separated list.
12265
12266 .vitem &$home$&
12267 .vindex "&$home$&"
12268 When the &%check_local_user%& option is set for a router, the user's home
12269 directory is placed in &$home$& when the check succeeds. In particular, this
12270 means it is set during the running of users' filter files. A router may also
12271 explicitly set a home directory for use by a transport; this can be overridden
12272 by a setting on the transport itself.
12273
12274 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12275 of the environment variable HOME, which is subject to the
12276 &%keep_environment%& and &%add_environment%& main config options.
12277
12278 .vitem &$host$&
12279 .vindex "&$host$&"
12280 If a router assigns an address to a transport (any transport), and passes a
12281 list of hosts with the address, the value of &$host$& when the transport starts
12282 to run is the name of the first host on the list. Note that this applies both
12283 to local and remote transports.
12284
12285 .cindex "transport" "filter"
12286 .cindex "filter" "transport filter"
12287 For the &(smtp)& transport, if there is more than one host, the value of
12288 &$host$& changes as the transport works its way through the list. In
12289 particular, when the &(smtp)& transport is expanding its options for encryption
12290 using TLS, or for specifying a transport filter (see chapter
12291 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12292 is connected.
12293
12294 When used in the client part of an authenticator configuration (see chapter
12295 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12296 client is connected.
12297
12298
12299 .vitem &$host_address$&
12300 .vindex "&$host_address$&"
12301 This variable is set to the remote host's IP address whenever &$host$& is set
12302 for a remote connection. It is also set to the IP address that is being checked
12303 when the &%ignore_target_hosts%& option is being processed.
12304
12305 .vitem &$host_data$&
12306 .vindex "&$host_data$&"
12307 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12308 result of the lookup is made available in the &$host_data$& variable. This
12309 allows you, for example, to do things like this:
12310 .code
12311 deny  hosts = net-lsearch;/some/file
12312 message = $host_data
12313 .endd
12314 .vitem &$host_lookup_deferred$&
12315 .cindex "host name" "lookup, failure of"
12316 .vindex "&$host_lookup_deferred$&"
12317 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12318 message comes from a remote host and there is an attempt to look up the host's
12319 name from its IP address, and the attempt is not successful, one of these
12320 variables is set to &"1"&.
12321
12322 .ilist
12323 If the lookup receives a definite negative response (for example, a DNS lookup
12324 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12325
12326 .next
12327 If there is any kind of problem during the lookup, such that Exim cannot
12328 tell whether or not the host name is defined (for example, a timeout for a DNS
12329 lookup), &$host_lookup_deferred$& is set to &"1"&.
12330 .endlist ilist
12331
12332 Looking up a host's name from its IP address consists of more than just a
12333 single reverse lookup. Exim checks that a forward lookup of at least one of the
12334 names it receives from a reverse lookup yields the original IP address. If this
12335 is not the case, Exim does not accept the looked up name(s), and
12336 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12337 IP address (for example, the existence of a PTR record in the DNS) is not
12338 sufficient on its own for the success of a host name lookup. If the reverse
12339 lookup succeeds, but there is a lookup problem such as a timeout when checking
12340 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12341 &"1"&. See also &$sender_host_name$&.
12342
12343 .cindex authentication "expansion item"
12344 Performing these checks sets up information used by the
12345 &%authresults%& expansion item.
12346
12347
12348 .vitem &$host_lookup_failed$&
12349 .vindex "&$host_lookup_failed$&"
12350 See &$host_lookup_deferred$&.
12351
12352 .vitem &$host_port$&
12353 .vindex "&$host_port$&"
12354 This variable is set to the remote host's TCP port whenever &$host$& is set
12355 for an outbound connection.
12356
12357 .vitem &$initial_cwd$&
12358 .vindex "&$initial_cwd$&
12359 This variable contains the full path name of the initial working
12360 directory of the current Exim process. This may differ from the current
12361 working directory, as Exim changes this to "/" during early startup, and
12362 to &$spool_directory$& later.
12363
12364 .vitem &$inode$&
12365 .vindex "&$inode$&"
12366 The only time this variable is set is while expanding the &%directory_file%&
12367 option in the &(appendfile)& transport. The variable contains the inode number
12368 of the temporary file which is about to be renamed. It can be used to construct
12369 a unique name for the file.
12370
12371 .vitem &$interface_address$&
12372 .vindex "&$interface_address$&"
12373 This is an obsolete name for &$received_ip_address$&.
12374
12375 .vitem &$interface_port$&
12376 .vindex "&$interface_port$&"
12377 This is an obsolete name for &$received_port$&.
12378
12379 .vitem &$item$&
12380 .vindex "&$item$&"
12381 This variable is used during the expansion of &*forall*& and &*forany*&
12382 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12383 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12384 empty.
12385
12386 .vitem &$ldap_dn$&
12387 .vindex "&$ldap_dn$&"
12388 This variable, which is available only when Exim is compiled with LDAP support,
12389 contains the DN from the last entry in the most recently successful LDAP
12390 lookup.
12391
12392 .vitem &$load_average$&
12393 .vindex "&$load_average$&"
12394 This variable contains the system load average, multiplied by 1000 so that it
12395 is an integer. For example, if the load average is 0.21, the value of the
12396 variable is 210. The value is recomputed every time the variable is referenced.
12397
12398 .vitem &$local_part$&
12399 .vindex "&$local_part$&"
12400 When an address is being routed, or delivered on its own, this
12401 variable contains the local part. When a number of addresses are being
12402 delivered together (for example, multiple RCPT commands in an SMTP
12403 session), &$local_part$& is not set.
12404
12405 Global address rewriting happens when a message is received, so the value of
12406 &$local_part$& during routing and delivery is the value after rewriting.
12407 &$local_part$& is set during user filtering, but not during system filtering,
12408 because a message may have many recipients and the system filter is called just
12409 once.
12410
12411 .new
12412 .cindex "tainted data"
12413 If the origin of the data is an incoming message,
12414 the result of expanding this variable is tainted.
12415
12416 &*Warning*&: the content of this variable is usually provided by a potential
12417 attacker.
12418 Consider carefully the implications of using it unvalidated as a name
12419 for file access.
12420 This presents issues for users' &_.forward_& and filter files.
12421 For traditional full user accounts, use &%check_local_users%& and the
12422 &$local_part_verified$& variable rather than this one.
12423 For virtual users, store a suitable pathname component in the database
12424 which is used for account name validation, and use that retrieved value
12425 rather than this variable.
12426 If needed, use a router &%address_data%& or &%set%& option for
12427 the retrieved data.
12428 .wen
12429
12430 .vindex "&$local_part_prefix$&"
12431 .vindex "&$local_part_suffix$&"
12432 .cindex affix variables
12433 If a local part prefix or suffix has been recognized, it is not included in the
12434 value of &$local_part$& during routing and subsequent delivery. The values of
12435 any prefix or suffix are in &$local_part_prefix$& and
12436 &$local_part_suffix$&, respectively.
12437
12438 When a message is being delivered to a file, pipe, or autoreply transport as a
12439 result of aliasing or forwarding, &$local_part$& is set to the local part of
12440 the parent address, not to the filename or command (see &$address_file$& and
12441 &$address_pipe$&).
12442
12443 When an ACL is running for a RCPT command, &$local_part$& contains the
12444 local part of the recipient address.
12445
12446 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12447 &$local_part$& contains the local part of the address that is being rewritten;
12448 it can be used in the expansion of the replacement address, for example.
12449
12450 In all cases, all quoting is removed from the local part. For example, for both
12451 the addresses
12452 .code
12453 "abc:xyz"@test.example
12454 abc\:xyz@test.example
12455 .endd
12456 the value of &$local_part$& is
12457 .code
12458 abc:xyz
12459 .endd
12460 If you use &$local_part$& to create another address, you should always wrap it
12461 inside a quoting operator. For example, in a &(redirect)& router you could
12462 have:
12463 .code
12464 data = ${quote_local_part:$local_part}@new.domain.example
12465 .endd
12466 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12467 to process local parts in a case-dependent manner in a router, you can set the
12468 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12469
12470 .vitem &$local_part_data$&
12471 .vindex "&$local_part_data$&"
12472 When the &%local_parts%& option on a router matches a local part by means of a
12473 lookup, the data read by the lookup is available during the running of the
12474 router as &$local_part_data$&. In addition, if the driver routes the address
12475 to a transport, the value is available in that transport. If the transport is
12476 handling multiple addresses, the value from the first address is used.
12477
12478 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12479 matches a local part by means of a lookup. The data read by the lookup is
12480 available during the rest of the ACL statement. In all other situations, this
12481 variable expands to nothing.
12482
12483 .vitem &$local_part_prefix$&
12484 .vindex "&$local_part_prefix$&"
12485 .cindex affix variables
12486 When an address is being routed or delivered, and a
12487 specific prefix for the local part was recognized, it is available in this
12488 variable, having been removed from &$local_part$&.
12489
12490 .vitem &$local_part_suffix$&
12491 .vindex "&$local_part_suffix$&"
12492 When an address is being routed or delivered, and a
12493 specific suffix for the local part was recognized, it is available in this
12494 variable, having been removed from &$local_part$&.
12495
12496 .new
12497 .vitem &$local_part_verified$&
12498 .vindex "&$local_part_verified$&"
12499 If the router generic option &%check_local_part%& has run successfully,
12500 this variable has the user database version of &$local_part$&.
12501 Such values are not tainted and hence usable for building file names.
12502 .wen
12503
12504 .vitem &$local_scan_data$&
12505 .vindex "&$local_scan_data$&"
12506 This variable contains the text returned by the &[local_scan()]& function when
12507 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12508
12509 .vitem &$local_user_gid$&
12510 .vindex "&$local_user_gid$&"
12511 See &$local_user_uid$&.
12512
12513 .vitem &$local_user_uid$&
12514 .vindex "&$local_user_uid$&"
12515 This variable and &$local_user_gid$& are set to the uid and gid after the
12516 &%check_local_user%& router precondition succeeds. This means that their values
12517 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12518 and &%condition%&), for the &%address_data%& expansion, and for any
12519 router-specific expansions. At all other times, the values in these variables
12520 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12521
12522 .vitem &$localhost_number$&
12523 .vindex "&$localhost_number$&"
12524 This contains the expanded value of the
12525 &%localhost_number%& option. The expansion happens after the main options have
12526 been read.
12527
12528 .vitem &$log_inodes$&
12529 .vindex "&$log_inodes$&"
12530 The number of free inodes in the disk partition where Exim's
12531 log files are being written. The value is recalculated whenever the variable is
12532 referenced. If the relevant file system does not have the concept of inodes,
12533 the value of is -1. See also the &%check_log_inodes%& option.
12534
12535 .vitem &$log_space$&
12536 .vindex "&$log_space$&"
12537 The amount of free space (as a number of kilobytes) in the disk
12538 partition where Exim's log files are being written. The value is recalculated
12539 whenever the variable is referenced. If the operating system does not have the
12540 ability to find the amount of free space (only true for experimental systems),
12541 the space value is -1. See also the &%check_log_space%& option.
12542
12543
12544 .vitem &$lookup_dnssec_authenticated$&
12545 .vindex "&$lookup_dnssec_authenticated$&"
12546 This variable is set after a DNS lookup done by
12547 a dnsdb lookup expansion, dnslookup router or smtp transport.
12548 .cindex "DNS" "DNSSEC"
12549 It will be empty if &(DNSSEC)& was not requested,
12550 &"no"& if the result was not labelled as authenticated data
12551 and &"yes"& if it was.
12552 Results that are labelled as authoritative answer that match
12553 the &%dns_trust_aa%& configuration variable count also
12554 as authenticated data.
12555
12556 .vitem &$mailstore_basename$&
12557 .vindex "&$mailstore_basename$&"
12558 This variable is set only when doing deliveries in &"mailstore"& format in the
12559 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12560 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12561 contains the basename of the files that are being written, that is, the name
12562 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12563 variable is empty.
12564
12565 .vitem &$malware_name$&
12566 .vindex "&$malware_name$&"
12567 This variable is available when Exim is compiled with the
12568 content-scanning extension. It is set to the name of the virus that was found
12569 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12570
12571 .vitem &$max_received_linelength$&
12572 .vindex "&$max_received_linelength$&"
12573 .cindex "maximum" "line length"
12574 .cindex "line length" "maximum"
12575 This variable contains the number of bytes in the longest line that was
12576 received as part of the message, not counting the line termination
12577 character(s).
12578 It is not valid if the &%spool_files_wireformat%& option is used.
12579
12580 .vitem &$message_age$&
12581 .cindex "message" "age of"
12582 .vindex "&$message_age$&"
12583 This variable is set at the start of a delivery attempt to contain the number
12584 of seconds since the message was received. It does not change during a single
12585 delivery attempt.
12586
12587 .vitem &$message_body$&
12588 .cindex "body of message" "expansion variable"
12589 .cindex "message body" "in expansion"
12590 .cindex "binary zero" "in message body"
12591 .vindex "&$message_body$&"
12592 .oindex "&%message_body_visible%&"
12593 This variable contains the initial portion of a message's body while it is
12594 being delivered, and is intended mainly for use in filter files. The maximum
12595 number of characters of the body that are put into the variable is set by the
12596 &%message_body_visible%& configuration option; the default is 500.
12597
12598 .oindex "&%message_body_newlines%&"
12599 By default, newlines are converted into spaces in &$message_body$&, to make it
12600 easier to search for phrases that might be split over a line break. However,
12601 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12602 zeros are always converted into spaces.
12603
12604 .vitem &$message_body_end$&
12605 .cindex "body of message" "expansion variable"
12606 .cindex "message body" "in expansion"
12607 .vindex "&$message_body_end$&"
12608 This variable contains the final portion of a message's
12609 body while it is being delivered. The format and maximum size are as for
12610 &$message_body$&.
12611
12612 .vitem &$message_body_size$&
12613 .cindex "body of message" "size"
12614 .cindex "message body" "size"
12615 .vindex "&$message_body_size$&"
12616 When a message is being delivered, this variable contains the size of the body
12617 in bytes. The count starts from the character after the blank line that
12618 separates the body from the header. Newlines are included in the count. See
12619 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12620
12621 If the spool file is wireformat
12622 (see the &%spool_files_wireformat%& main option)
12623 the CRLF line-terminators are included in the count.
12624
12625 .vitem &$message_exim_id$&
12626 .vindex "&$message_exim_id$&"
12627 When a message is being received or delivered, this variable contains the
12628 unique message id that is generated and used by Exim to identify the message.
12629 An id is not created for a message until after its header has been successfully
12630 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12631 line; it is the local id that Exim assigns to the message, for example:
12632 &`1BXTIK-0001yO-VA`&.
12633
12634 .vitem &$message_headers$&
12635 .vindex &$message_headers$&
12636 This variable contains a concatenation of all the header lines when a message
12637 is being processed, except for lines added by routers or transports. The header
12638 lines are separated by newline characters. Their contents are decoded in the
12639 same way as a header line that is inserted by &%bheader%&.
12640
12641 .vitem &$message_headers_raw$&
12642 .vindex &$message_headers_raw$&
12643 This variable is like &$message_headers$& except that no processing of the
12644 contents of header lines is done.
12645
12646 .vitem &$message_id$&
12647 This is an old name for &$message_exim_id$&. It is now deprecated.
12648
12649 .vitem &$message_linecount$&
12650 .vindex "&$message_linecount$&"
12651 This variable contains the total number of lines in the header and body of the
12652 message. Compare &$body_linecount$&, which is the count for the body only.
12653 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12654 number of lines received. Before delivery happens (that is, before filters,
12655 routers, and transports run) the count is increased to include the
12656 &'Received:'& header line that Exim standardly adds, and also any other header
12657 lines that are added by ACLs. The blank line that separates the message header
12658 from the body is not counted.
12659
12660 As with the special case of &$message_size$&, during the expansion of the
12661 appendfile transport's maildir_tag option in maildir format, the value of
12662 &$message_linecount$& is the precise size of the number of newlines in the
12663 file that has been written (minus one for the blank line between the
12664 header and the body).
12665
12666 Here is an example of the use of this variable in a DATA ACL:
12667 .code
12668 deny message   = Too many lines in message header
12669      condition = \
12670       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12671 .endd
12672 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12673 message has not yet been received.
12674
12675 This variable is not valid if the &%spool_files_wireformat%& option is used.
12676
12677 .vitem &$message_size$&
12678 .cindex "size" "of message"
12679 .cindex "message" "size"
12680 .vindex "&$message_size$&"
12681 When a message is being processed, this variable contains its size in bytes. In
12682 most cases, the size includes those headers that were received with the
12683 message, but not those (such as &'Envelope-to:'&) that are added to individual
12684 deliveries as they are written. However, there is one special case: during the
12685 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12686 doing a delivery in maildir format, the value of &$message_size$& is the
12687 precise size of the file that has been written. See also
12688 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12689
12690 .cindex "RCPT" "value of &$message_size$&"
12691 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12692 contains the size supplied on the MAIL command, or -1 if no size was given. The
12693 value may not, of course, be truthful.
12694
12695 .vitem &$mime_$&&'xxx'&
12696 A number of variables whose names start with &$mime$& are
12697 available when Exim is compiled with the content-scanning extension. For
12698 details, see section &<<SECTscanmimepart>>&.
12699
12700 .vitem "&$n0$& &-- &$n9$&"
12701 These variables are counters that can be incremented by means
12702 of the &%add%& command in filter files.
12703
12704 .vitem &$original_domain$&
12705 .vindex "&$domain$&"
12706 .vindex "&$original_domain$&"
12707 When a top-level address is being processed for delivery, this contains the
12708 same value as &$domain$&. However, if a &"child"& address (for example,
12709 generated by an alias, forward, or filter file) is being processed, this
12710 variable contains the domain of the original address (lower cased). This
12711 differs from &$parent_domain$& only when there is more than one level of
12712 aliasing or forwarding. When more than one address is being delivered in a
12713 single transport run, &$original_domain$& is not set.
12714
12715 If a new address is created by means of a &%deliver%& command in a system
12716 filter, it is set up with an artificial &"parent"& address. This has the local
12717 part &'system-filter'& and the default qualify domain.
12718
12719 .vitem &$original_local_part$&
12720 .vindex "&$local_part$&"
12721 .vindex "&$original_local_part$&"
12722 When a top-level address is being processed for delivery, this contains the
12723 same value as &$local_part$&, unless a prefix or suffix was removed from the
12724 local part, because &$original_local_part$& always contains the full local
12725 part. When a &"child"& address (for example, generated by an alias, forward, or
12726 filter file) is being processed, this variable contains the full local part of
12727 the original address.
12728
12729 If the router that did the redirection processed the local part
12730 case-insensitively, the value in &$original_local_part$& is in lower case.
12731 This variable differs from &$parent_local_part$& only when there is more than
12732 one level of aliasing or forwarding. When more than one address is being
12733 delivered in a single transport run, &$original_local_part$& is not set.
12734
12735 If a new address is created by means of a &%deliver%& command in a system
12736 filter, it is set up with an artificial &"parent"& address. This has the local
12737 part &'system-filter'& and the default qualify domain.
12738
12739 .vitem &$originator_gid$&
12740 .cindex "gid (group id)" "of originating user"
12741 .cindex "sender" "gid"
12742 .vindex "&$caller_gid$&"
12743 .vindex "&$originator_gid$&"
12744 This variable contains the value of &$caller_gid$& that was set when the
12745 message was received. For messages received via the command line, this is the
12746 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12747 normally the gid of the Exim user.
12748
12749 .vitem &$originator_uid$&
12750 .cindex "uid (user id)" "of originating user"
12751 .cindex "sender" "uid"
12752 .vindex "&$caller_uid$&"
12753 .vindex "&$originator_uid$&"
12754 The value of &$caller_uid$& that was set when the message was received. For
12755 messages received via the command line, this is the uid of the sending user.
12756 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12757 user.
12758
12759 .vitem &$parent_domain$&
12760 .vindex "&$parent_domain$&"
12761 This variable is similar to &$original_domain$& (see
12762 above), except that it refers to the immediately preceding parent address.
12763
12764 .vitem &$parent_local_part$&
12765 .vindex "&$parent_local_part$&"
12766 This variable is similar to &$original_local_part$&
12767 (see above), except that it refers to the immediately preceding parent address.
12768
12769 .vitem &$pid$&
12770 .cindex "pid (process id)" "of current process"
12771 .vindex "&$pid$&"
12772 This variable contains the current process id.
12773
12774 .vitem &$pipe_addresses$&
12775 .cindex "filter" "transport filter"
12776 .cindex "transport" "filter"
12777 .vindex "&$pipe_addresses$&"
12778 This is not an expansion variable, but is mentioned here because the string
12779 &`$pipe_addresses`& is handled specially in the command specification for the
12780 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12781 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12782 It cannot be used in general expansion strings, and provokes an &"unknown
12783 variable"& error if encountered.
12784
12785 .vitem &$primary_hostname$&
12786 .vindex "&$primary_hostname$&"
12787 This variable contains the value set by &%primary_hostname%& in the
12788 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12789 a single-component name, Exim calls &[gethostbyname()]& (or
12790 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12791 qualified host name. See also &$smtp_active_hostname$&.
12792
12793
12794 .vitem &$proxy_external_address$& &&&
12795        &$proxy_external_port$& &&&
12796        &$proxy_local_address$& &&&
12797        &$proxy_local_port$& &&&
12798        &$proxy_session$&
12799 These variables are only available when built with Proxy Protocol
12800 or SOCKS5 support.
12801 For details see chapter &<<SECTproxyInbound>>&.
12802
12803 .vitem &$prdr_requested$&
12804 .cindex "PRDR" "variable for"
12805 This variable is set to &"yes"& if PRDR was requested by the client for the
12806 current message, otherwise &"no"&.
12807
12808 .vitem &$prvscheck_address$&
12809 This variable is used in conjunction with the &%prvscheck%& expansion item,
12810 which is described in sections &<<SECTexpansionitems>>& and
12811 &<<SECTverifyPRVS>>&.
12812
12813 .vitem &$prvscheck_keynum$&
12814 This variable is used in conjunction with the &%prvscheck%& expansion item,
12815 which is described in sections &<<SECTexpansionitems>>& and
12816 &<<SECTverifyPRVS>>&.
12817
12818 .vitem &$prvscheck_result$&
12819 This variable is used in conjunction with the &%prvscheck%& expansion item,
12820 which is described in sections &<<SECTexpansionitems>>& and
12821 &<<SECTverifyPRVS>>&.
12822
12823 .vitem &$qualify_domain$&
12824 .vindex "&$qualify_domain$&"
12825 The value set for the &%qualify_domain%& option in the configuration file.
12826
12827 .vitem &$qualify_recipient$&
12828 .vindex "&$qualify_recipient$&"
12829 The value set for the &%qualify_recipient%& option in the configuration file,
12830 or if not set, the value of &$qualify_domain$&.
12831
12832 .vitem &$queue_name$&
12833 .vindex &$queue_name$&
12834 .cindex "named queues"
12835 .cindex queues named
12836 The name of the spool queue in use; empty for the default queue.
12837
12838 .vitem &$r_...$&
12839 .vindex &$r_...$&
12840 .cindex router variables
12841 Values can be placed in these variables by the &%set%& option of a router.
12842 They can be given any name that starts with &$r_$&.
12843 The values persist for the address being handled through subsequent routers
12844 and the eventual transport.
12845
12846 .vitem &$rcpt_count$&
12847 .vindex "&$rcpt_count$&"
12848 When a message is being received by SMTP, this variable contains the number of
12849 RCPT commands received for the current message. If this variable is used in a
12850 RCPT ACL, its value includes the current command.
12851
12852 .vitem &$rcpt_defer_count$&
12853 .vindex "&$rcpt_defer_count$&"
12854 .cindex "4&'xx'& responses" "count of"
12855 When a message is being received by SMTP, this variable contains the number of
12856 RCPT commands in the current message that have previously been rejected with a
12857 temporary (4&'xx'&) response.
12858
12859 .vitem &$rcpt_fail_count$&
12860 .vindex "&$rcpt_fail_count$&"
12861 When a message is being received by SMTP, this variable contains the number of
12862 RCPT commands in the current message that have previously been rejected with a
12863 permanent (5&'xx'&) response.
12864
12865 .vitem &$received_count$&
12866 .vindex "&$received_count$&"
12867 This variable contains the number of &'Received:'& header lines in the message,
12868 including the one added by Exim (so its value is always greater than zero). It
12869 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12870 delivering.
12871
12872 .vitem &$received_for$&
12873 .vindex "&$received_for$&"
12874 If there is only a single recipient address in an incoming message, this
12875 variable contains that address when the &'Received:'& header line is being
12876 built. The value is copied after recipient rewriting has happened, but before
12877 the &[local_scan()]& function is run.
12878
12879 .vitem &$received_ip_address$&
12880 .vindex "&$received_ip_address$&"
12881 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12882 variable is set to the address of the local IP interface, and &$received_port$&
12883 is set to the local port number. (The remote IP address and port are in
12884 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12885 the port value is -1 unless it has been set using the &%-oMi%& command line
12886 option.
12887
12888 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12889 could be used, for example, to make the filename for a TLS certificate depend
12890 on which interface and/or port is being used for the incoming connection. The
12891 values of &$received_ip_address$& and &$received_port$& are saved with any
12892 messages that are received, thus making these variables available at delivery
12893 time.
12894 For outbound connections see &$sending_ip_address$&.
12895
12896 .vitem &$received_port$&
12897 .vindex "&$received_port$&"
12898 See &$received_ip_address$&.
12899
12900 .vitem &$received_protocol$&
12901 .vindex "&$received_protocol$&"
12902 When a message is being processed, this variable contains the name of the
12903 protocol by which it was received. Most of the names used by Exim are defined
12904 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12905 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12906 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12907 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12908 connection and the client was successfully authenticated.
12909
12910 Exim uses the protocol name &"smtps"& for the case when encryption is
12911 automatically set up on connection without the use of STARTTLS (see
12912 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12913 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12914 where the client initially uses EHLO, sets up an encrypted connection using
12915 STARTTLS, and then uses HELO afterwards.
12916
12917 The &%-oMr%& option provides a way of specifying a custom protocol name for
12918 messages that are injected locally by trusted callers. This is commonly used to
12919 identify messages that are being re-injected after some kind of scanning.
12920
12921 .vitem &$received_time$&
12922 .vindex "&$received_time$&"
12923 This variable contains the date and time when the current message was received,
12924 as a number of seconds since the start of the Unix epoch.
12925
12926 .vitem &$recipient_data$&
12927 .vindex "&$recipient_data$&"
12928 This variable is set after an indexing lookup success in an ACL &%recipients%&
12929 condition. It contains the data from the lookup, and the value remains set
12930 until the next &%recipients%& test. Thus, you can do things like this:
12931 .display
12932 &`require recipients  = cdb*@;/some/file`&
12933 &`deny    `&&'some further test involving'& &`$recipient_data`&
12934 .endd
12935 &*Warning*&: This variable is set only when a lookup is used as an indexing
12936 method in the address list, using the semicolon syntax as in the example above.
12937 The variable is not set for a lookup that is used as part of the string
12938 expansion that all such lists undergo before being interpreted.
12939
12940 .vitem &$recipient_verify_failure$&
12941 .vindex "&$recipient_verify_failure$&"
12942 In an ACL, when a recipient verification fails, this variable contains
12943 information about the failure. It is set to one of the following words:
12944
12945 .ilist
12946 &"qualify"&: The address was unqualified (no domain), and the message
12947 was neither local nor came from an exempted host.
12948
12949 .next
12950 &"route"&: Routing failed.
12951
12952 .next
12953 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12954 or before the MAIL command (that is, on initial connection, HELO, or
12955 MAIL).
12956
12957 .next
12958 &"recipient"&: The RCPT command in a callout was rejected.
12959 .next
12960
12961 &"postmaster"&: The postmaster check in a callout was rejected.
12962 .endlist
12963
12964 The main use of this variable is expected to be to distinguish between
12965 rejections of MAIL and rejections of RCPT.
12966
12967 .vitem &$recipients$&
12968 .vindex "&$recipients$&"
12969 This variable contains a list of envelope recipients for a message. A comma and
12970 a space separate the addresses in the replacement text. However, the variable
12971 is not generally available, to prevent exposure of Bcc recipients in
12972 unprivileged users' filter files. You can use &$recipients$& only in these
12973 cases:
12974
12975 .olist
12976 In a system filter file.
12977 .next
12978 In the ACLs associated with the DATA command and with non-SMTP messages, that
12979 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12980 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12981 &%acl_not_smtp_mime%&.
12982 .next
12983 From within a &[local_scan()]& function.
12984 .endlist
12985
12986
12987 .vitem &$recipients_count$&
12988 .vindex "&$recipients_count$&"
12989 When a message is being processed, this variable contains the number of
12990 envelope recipients that came with the message. Duplicates are not excluded
12991 from the count. While a message is being received over SMTP, the number
12992 increases for each accepted recipient. It can be referenced in an ACL.
12993
12994
12995 .vitem &$regex_match_string$&
12996 .vindex "&$regex_match_string$&"
12997 This variable is set to contain the matching regular expression after a
12998 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12999
13000 .vitem "&$regex1$&, &$regex2$&, etc"
13001 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13002 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13003 these variables contain the
13004 captured substrings identified by the regular expression.
13005
13006
13007 .vitem &$reply_address$&
13008 .vindex "&$reply_address$&"
13009 When a message is being processed, this variable contains the contents of the
13010 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13011 contents of the &'From:'& header line. Apart from the removal of leading
13012 white space, the value is not processed in any way. In particular, no RFC 2047
13013 decoding or character code translation takes place.
13014
13015 .vitem &$return_path$&
13016 .vindex "&$return_path$&"
13017 When a message is being delivered, this variable contains the return path &--
13018 the sender field that will be sent as part of the envelope. It is not enclosed
13019 in <> characters. At the start of routing an address, &$return_path$& has the
13020 same value as &$sender_address$&, but if, for example, an incoming message to a
13021 mailing list has been expanded by a router which specifies a different address
13022 for bounce messages, &$return_path$& subsequently contains the new bounce
13023 address, whereas &$sender_address$& always contains the original sender address
13024 that was received with the message. In other words, &$sender_address$& contains
13025 the incoming envelope sender, and &$return_path$& contains the outgoing
13026 envelope sender.
13027
13028 .vitem &$return_size_limit$&
13029 .vindex "&$return_size_limit$&"
13030 This is an obsolete name for &$bounce_return_size_limit$&.
13031
13032 .vitem &$router_name$&
13033 .cindex "router" "name"
13034 .cindex "name" "of router"
13035 .vindex "&$router_name$&"
13036 During the running of a router this variable contains its name.
13037
13038 .vitem &$runrc$&
13039 .cindex "return code" "from &%run%& expansion"
13040 .vindex "&$runrc$&"
13041 This variable contains the return code from a command that is run by the
13042 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13043 assume the order in which option values are expanded, except for those
13044 preconditions whose order of testing is documented. Therefore, you cannot
13045 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13046 another.
13047
13048 .vitem &$self_hostname$&
13049 .oindex "&%self%&" "value of host name"
13050 .vindex "&$self_hostname$&"
13051 When an address is routed to a supposedly remote host that turns out to be the
13052 local host, what happens is controlled by the &%self%& generic router option.
13053 One of its values causes the address to be passed to another router. When this
13054 happens, &$self_hostname$& is set to the name of the local host that the
13055 original router encountered. In other circumstances its contents are null.
13056
13057 .vitem &$sender_address$&
13058 .vindex "&$sender_address$&"
13059 When a message is being processed, this variable contains the sender's address
13060 that was received in the message's envelope. The case of letters in the address
13061 is retained, in both the local part and the domain. For bounce messages, the
13062 value of this variable is the empty string. See also &$return_path$&.
13063
13064 .vitem &$sender_address_data$&
13065 .vindex "&$address_data$&"
13066 .vindex "&$sender_address_data$&"
13067 If &$address_data$& is set when the routers are called from an ACL to verify a
13068 sender address, the final value is preserved in &$sender_address_data$&, to
13069 distinguish it from data from a recipient address. The value does not persist
13070 after the end of the current ACL statement. If you want to preserve it for
13071 longer, you can save it in an ACL variable.
13072
13073 .vitem &$sender_address_domain$&
13074 .vindex "&$sender_address_domain$&"
13075 The domain portion of &$sender_address$&.
13076
13077 .vitem &$sender_address_local_part$&
13078 .vindex "&$sender_address_local_part$&"
13079 The local part portion of &$sender_address$&.
13080
13081 .vitem &$sender_data$&
13082 .vindex "&$sender_data$&"
13083 This variable is set after a lookup success in an ACL &%senders%& condition or
13084 in a router &%senders%& option. It contains the data from the lookup, and the
13085 value remains set until the next &%senders%& test. Thus, you can do things like
13086 this:
13087 .display
13088 &`require senders      = cdb*@;/some/file`&
13089 &`deny    `&&'some further test involving'& &`$sender_data`&
13090 .endd
13091 &*Warning*&: This variable is set only when a lookup is used as an indexing
13092 method in the address list, using the semicolon syntax as in the example above.
13093 The variable is not set for a lookup that is used as part of the string
13094 expansion that all such lists undergo before being interpreted.
13095
13096 .vitem &$sender_fullhost$&
13097 .vindex "&$sender_fullhost$&"
13098 When a message is received from a remote host, this variable contains the host
13099 name and IP address in a single string. It ends with the IP address in square
13100 brackets, followed by a colon and a port number if the logging of ports is
13101 enabled. The format of the rest of the string depends on whether the host
13102 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13103 looking up its IP address. (Looking up the IP address can be forced by the
13104 &%host_lookup%& option, independent of verification.) A plain host name at the
13105 start of the string is a verified host name; if this is not present,
13106 verification either failed or was not requested. A host name in parentheses is
13107 the argument of a HELO or EHLO command. This is omitted if it is identical to
13108 the verified host name or to the host's IP address in square brackets.
13109
13110 .vitem &$sender_helo_dnssec$&
13111 .vindex "&$sender_helo_dnssec$&"
13112 This boolean variable is true if a successful HELO verification was
13113 .cindex "DNS" "DNSSEC"
13114 done using DNS information the resolver library stated was authenticated data.
13115
13116 .vitem &$sender_helo_name$&
13117 .vindex "&$sender_helo_name$&"
13118 When a message is received from a remote host that has issued a HELO or EHLO
13119 command, the argument of that command is placed in this variable. It is also
13120 set if HELO or EHLO is used when a message is received using SMTP locally via
13121 the &%-bs%& or &%-bS%& options.
13122
13123 .vitem &$sender_host_address$&
13124 .vindex "&$sender_host_address$&"
13125 When a message is received from a remote host using SMTP,
13126 this variable contains that
13127 host's IP address. For locally non-SMTP submitted messages, it is empty.
13128
13129 .vitem &$sender_host_authenticated$&
13130 .vindex "&$sender_host_authenticated$&"
13131 This variable contains the name (not the public name) of the authenticator
13132 driver that successfully authenticated the client from which the message was
13133 received. It is empty if there was no successful authentication. See also
13134 &$authenticated_id$&.
13135
13136 .vitem &$sender_host_dnssec$&
13137 .vindex "&$sender_host_dnssec$&"
13138 If an attempt to populate &$sender_host_name$& has been made
13139 (by reference, &%hosts_lookup%& or
13140 otherwise) then this boolean will have been set true if, and only if, the
13141 resolver library states that both
13142 the reverse and forward DNS were authenticated data.  At all
13143 other times, this variable is false.
13144
13145 .cindex "DNS" "DNSSEC"
13146 It is likely that you will need to coerce DNSSEC support on in the resolver
13147 library, by setting:
13148 .code
13149 dns_dnssec_ok = 1
13150 .endd
13151
13152 Exim does not perform DNSSEC validation itself, instead leaving that to a
13153 validating resolver (e.g. unbound, or bind with suitable configuration).
13154
13155 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13156 mechanism in the list, then this variable will be false.
13157
13158 This requires that your system resolver library support EDNS0 (and that
13159 DNSSEC flags exist in the system headers).  If the resolver silently drops
13160 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13161 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13162
13163
13164 .vitem &$sender_host_name$&
13165 .vindex "&$sender_host_name$&"
13166 When a message is received from a remote host, this variable contains the
13167 host's name as obtained by looking up its IP address. For messages received by
13168 other means, this variable is empty.
13169
13170 .vindex "&$host_lookup_failed$&"
13171 If the host name has not previously been looked up, a reference to
13172 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13173 A looked up name is accepted only if it leads back to the original IP address
13174 via a forward lookup. If either the reverse or the forward lookup fails to find
13175 any data, or if the forward lookup does not yield the original IP address,
13176 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13177
13178 .vindex "&$host_lookup_deferred$&"
13179 However, if either of the lookups cannot be completed (for example, there is a
13180 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13181 &$host_lookup_failed$& remains set to &"0"&.
13182
13183 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13184 host name again if there is a subsequent reference to &$sender_host_name$&
13185 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13186 is set to &"1"&.
13187
13188 Exim does not automatically look up every calling host's name. If you want
13189 maximum efficiency, you should arrange your configuration so that it avoids
13190 these lookups altogether. The lookup happens only if one or more of the
13191 following are true:
13192
13193 .ilist
13194 A string containing &$sender_host_name$& is expanded.
13195 .next
13196 The calling host matches the list in &%host_lookup%&. In the default
13197 configuration, this option is set to *, so it must be changed if lookups are
13198 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13199 .next
13200 Exim needs the host name in order to test an item in a host list. The items
13201 that require this are described in sections &<<SECThoslispatnam>>& and
13202 &<<SECThoslispatnamsk>>&.
13203 .next
13204 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13205 In this case, the host name is required to compare with the name quoted in any
13206 EHLO or HELO commands that the client issues.
13207 .next
13208 The remote host issues a EHLO or HELO command that quotes one of the
13209 domains in &%helo_lookup_domains%&. The default value of this option is
13210 . ==== As this is a nested list, any displays it contains must be indented
13211 . ==== as otherwise they are too far to the left.
13212 .code
13213   helo_lookup_domains = @ : @[]
13214 .endd
13215 which causes a lookup if a remote host (incorrectly) gives the server's name or
13216 IP address in an EHLO or HELO command.
13217 .endlist
13218
13219
13220 .vitem &$sender_host_port$&
13221 .vindex "&$sender_host_port$&"
13222 When a message is received from a remote host, this variable contains the port
13223 number that was used on the remote host.
13224
13225 .vitem &$sender_ident$&
13226 .vindex "&$sender_ident$&"
13227 When a message is received from a remote host, this variable contains the
13228 identification received in response to an RFC 1413 request. When a message has
13229 been received locally, this variable contains the login name of the user that
13230 called Exim.
13231
13232 .vitem &$sender_rate_$&&'xxx'&
13233 A number of variables whose names begin &$sender_rate_$& are set as part of the
13234 &%ratelimit%& ACL condition. Details are given in section
13235 &<<SECTratelimiting>>&.
13236
13237 .vitem &$sender_rcvhost$&
13238 .cindex "DNS" "reverse lookup"
13239 .cindex "reverse DNS lookup"
13240 .vindex "&$sender_rcvhost$&"
13241 This is provided specifically for use in &'Received:'& headers. It starts with
13242 either the verified host name (as obtained from a reverse DNS lookup) or, if
13243 there is no verified host name, the IP address in square brackets. After that
13244 there may be text in parentheses. When the first item is a verified host name,
13245 the first thing in the parentheses is the IP address in square brackets,
13246 followed by a colon and a port number if port logging is enabled. When the
13247 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13248 the parentheses.
13249
13250 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13251 was used and its argument was not identical to the real host name or IP
13252 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13253 all three items are present in the parentheses, a newline and tab are inserted
13254 into the string, to improve the formatting of the &'Received:'& header.
13255
13256 .vitem &$sender_verify_failure$&
13257 .vindex "&$sender_verify_failure$&"
13258 In an ACL, when a sender verification fails, this variable contains information
13259 about the failure. The details are the same as for
13260 &$recipient_verify_failure$&.
13261
13262 .vitem &$sending_ip_address$&
13263 .vindex "&$sending_ip_address$&"
13264 This variable is set whenever an outgoing SMTP connection to another host has
13265 been set up. It contains the IP address of the local interface that is being
13266 used. This is useful if a host that has more than one IP address wants to take
13267 on different personalities depending on which one is being used. For incoming
13268 connections, see &$received_ip_address$&.
13269
13270 .vitem &$sending_port$&
13271 .vindex "&$sending_port$&"
13272 This variable is set whenever an outgoing SMTP connection to another host has
13273 been set up. It contains the local port that is being used. For incoming
13274 connections, see &$received_port$&.
13275
13276 .vitem &$smtp_active_hostname$&
13277 .vindex "&$smtp_active_hostname$&"
13278 During an incoming SMTP session, this variable contains the value of the active
13279 host name, as specified by the &%smtp_active_hostname%& option. The value of
13280 &$smtp_active_hostname$& is saved with any message that is received, so its
13281 value can be consulted during routing and delivery.
13282
13283 .vitem &$smtp_command$&
13284 .vindex "&$smtp_command$&"
13285 During the processing of an incoming SMTP command, this variable contains the
13286 entire command. This makes it possible to distinguish between HELO and EHLO in
13287 the HELO ACL, and also to distinguish between commands such as these:
13288 .code
13289 MAIL FROM:<>
13290 MAIL FROM: <>
13291 .endd
13292 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13293 command, the address in &$smtp_command$& is the original address before any
13294 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13295 the address after SMTP-time rewriting.
13296
13297 .vitem &$smtp_command_argument$&
13298 .cindex "SMTP" "command, argument for"
13299 .vindex "&$smtp_command_argument$&"
13300 While an ACL is running to check an SMTP command, this variable contains the
13301 argument, that is, the text that follows the command name, with leading white
13302 space removed. Following the introduction of &$smtp_command$&, this variable is
13303 somewhat redundant, but is retained for backwards compatibility.
13304
13305 .vitem &$smtp_command_history$&
13306 .cindex SMTP "command history"
13307 .vindex "&$smtp_command_history$&"
13308 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13309 received, in time-order left to right.  Only a limited number of commands
13310 are remembered.
13311
13312 .vitem &$smtp_count_at_connection_start$&
13313 .vindex "&$smtp_count_at_connection_start$&"
13314 This variable is set greater than zero only in processes spawned by the Exim
13315 daemon for handling incoming SMTP connections. The name is deliberately long,
13316 in order to emphasize what the contents are. When the daemon accepts a new
13317 connection, it increments this variable. A copy of the variable is passed to
13318 the child process that handles the connection, but its value is fixed, and
13319 never changes. It is only an approximation of how many incoming connections
13320 there actually are, because many other connections may come and go while a
13321 single connection is being processed. When a child process terminates, the
13322 daemon decrements its copy of the variable.
13323
13324 .vitem "&$sn0$& &-- &$sn9$&"
13325 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13326 that were current at the end of the system filter file. This allows a system
13327 filter file to set values that can be tested in users' filter files. For
13328 example, a system filter could set a value indicating how likely it is that a
13329 message is junk mail.
13330
13331 .vitem &$spam_$&&'xxx'&
13332 A number of variables whose names start with &$spam$& are available when Exim
13333 is compiled with the content-scanning extension. For details, see section
13334 &<<SECTscanspamass>>&.
13335
13336 .vitem &$spf_header_comment$& &&&
13337        &$spf_received$& &&&
13338        &$spf_result$& &&&
13339        &$spf_result_guessed$& &&&
13340        &$spf_smtp_comment$&
13341 These variables are only available if Exim is built with SPF support.
13342 For details see section &<<SECSPF>>&.
13343
13344 .vitem &$spool_directory$&
13345 .vindex "&$spool_directory$&"
13346 The name of Exim's spool directory.
13347
13348 .vitem &$spool_inodes$&
13349 .vindex "&$spool_inodes$&"
13350 The number of free inodes in the disk partition where Exim's spool files are
13351 being written. The value is recalculated whenever the variable is referenced.
13352 If the relevant file system does not have the concept of inodes, the value of
13353 is -1. See also the &%check_spool_inodes%& option.
13354
13355 .vitem &$spool_space$&
13356 .vindex "&$spool_space$&"
13357 The amount of free space (as a number of kilobytes) in the disk partition where
13358 Exim's spool files are being written. The value is recalculated whenever the
13359 variable is referenced. If the operating system does not have the ability to
13360 find the amount of free space (only true for experimental systems), the space
13361 value is -1. For example, to check in an ACL that there is at least 50
13362 megabytes free on the spool, you could write:
13363 .code
13364 condition = ${if > {$spool_space}{50000}}
13365 .endd
13366 See also the &%check_spool_space%& option.
13367
13368
13369 .vitem &$thisaddress$&
13370 .vindex "&$thisaddress$&"
13371 This variable is set only during the processing of the &%foranyaddress%&
13372 command in a filter file. Its use is explained in the description of that
13373 command, which can be found in the separate document entitled &'Exim's
13374 interfaces to mail filtering'&.
13375
13376 .vitem &$tls_in_bits$&
13377 .vindex "&$tls_in_bits$&"
13378 Contains an approximation of the TLS cipher's bit-strength
13379 on the inbound connection; the meaning of
13380 this depends upon the TLS implementation used.
13381 If TLS has not been negotiated, the value will be 0.
13382 The value of this is automatically fed into the Cyrus SASL authenticator
13383 when acting as a server, to specify the "external SSF" (a SASL term).
13384
13385 The deprecated &$tls_bits$& variable refers to the inbound side
13386 except when used in the context of an outbound SMTP delivery, when it refers to
13387 the outbound.
13388
13389 .vitem &$tls_out_bits$&
13390 .vindex "&$tls_out_bits$&"
13391 Contains an approximation of the TLS cipher's bit-strength
13392 on an outbound SMTP connection; the meaning of
13393 this depends upon the TLS implementation used.
13394 If TLS has not been negotiated, the value will be 0.
13395
13396 .vitem &$tls_in_ourcert$&
13397 .vindex "&$tls_in_ourcert$&"
13398 .cindex certificate variables
13399 This variable refers to the certificate presented to the peer of an
13400 inbound connection when the message was received.
13401 It is only useful as the argument of a
13402 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13403 or a &%def%& condition.
13404
13405 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13406 when a list of more than one
13407 file is used for &%tls_certificate%&, this variable is not reliable.
13408 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13409
13410 .vitem &$tls_in_peercert$&
13411 .vindex "&$tls_in_peercert$&"
13412 This variable refers to the certificate presented by the peer of an
13413 inbound connection when the message was received.
13414 It is only useful as the argument of a
13415 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13416 or a &%def%& condition.
13417 If certificate verification fails it may refer to a failing chain element
13418 which is not the leaf.
13419
13420 .vitem &$tls_out_ourcert$&
13421 .vindex "&$tls_out_ourcert$&"
13422 This variable refers to the certificate presented to the peer of an
13423 outbound connection.  It is only useful as the argument of a
13424 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13425 or a &%def%& condition.
13426
13427 .vitem &$tls_out_peercert$&
13428 .vindex "&$tls_out_peercert$&"
13429 This variable refers to the certificate presented by the peer of an
13430 outbound connection.  It is only useful as the argument of a
13431 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13432 or a &%def%& condition.
13433 If certificate verification fails it may refer to a failing chain element
13434 which is not the leaf.
13435
13436 .vitem &$tls_in_certificate_verified$&
13437 .vindex "&$tls_in_certificate_verified$&"
13438 This variable is set to &"1"& if a TLS certificate was verified when the
13439 message was received, and &"0"& otherwise.
13440
13441 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13442 except when used in the context of an outbound SMTP delivery, when it refers to
13443 the outbound.
13444
13445 .vitem &$tls_out_certificate_verified$&
13446 .vindex "&$tls_out_certificate_verified$&"
13447 This variable is set to &"1"& if a TLS certificate was verified when an
13448 outbound SMTP connection was made,
13449 and &"0"& otherwise.
13450
13451 .vitem &$tls_in_cipher$&
13452 .vindex "&$tls_in_cipher$&"
13453 .vindex "&$tls_cipher$&"
13454 When a message is received from a remote host over an encrypted SMTP
13455 connection, this variable is set to the cipher suite that was negotiated, for
13456 example DES-CBC3-SHA. In other circumstances, in particular, for message
13457 received over unencrypted connections, the variable is empty. Testing
13458 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13459 non-encrypted connections during ACL processing.
13460
13461 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13462 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13463 becomes the same as &$tls_out_cipher$&.
13464
13465 .vitem &$tls_in_cipher_std$&
13466 .vindex "&$tls_in_cipher_std$&"
13467 As above, but returning the RFC standard name for the cipher suite.
13468
13469 .vitem &$tls_out_cipher$&
13470 .vindex "&$tls_out_cipher$&"
13471 This variable is
13472 cleared before any outgoing SMTP connection is made,
13473 and then set to the outgoing cipher suite if one is negotiated. See chapter
13474 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13475 details of the &(smtp)& transport.
13476
13477 .vitem &$tls_out_cipher_std$&
13478 .vindex "&$tls_out_cipher_std$&"
13479 As above, but returning the RFC standard name for the cipher suite.
13480
13481 .vitem &$tls_out_dane$&
13482 .vindex &$tls_out_dane$&
13483 DANE active status.  See section &<<SECDANE>>&.
13484
13485 .vitem &$tls_in_ocsp$&
13486 .vindex "&$tls_in_ocsp$&"
13487 When a message is received from a remote client connection
13488 the result of any OCSP request from the client is encoded in this variable:
13489 .code
13490 0 OCSP proof was not requested (default value)
13491 1 No response to request
13492 2 Response not verified
13493 3 Verification failed
13494 4 Verification succeeded
13495 .endd
13496
13497 .vitem &$tls_out_ocsp$&
13498 .vindex "&$tls_out_ocsp$&"
13499 When a message is sent to a remote host connection
13500 the result of any OCSP request made is encoded in this variable.
13501 See &$tls_in_ocsp$& for values.
13502
13503 .vitem &$tls_in_peerdn$&
13504 .vindex "&$tls_in_peerdn$&"
13505 .vindex "&$tls_peerdn$&"
13506 .cindex certificate "extracting fields"
13507 When a message is received from a remote host over an encrypted SMTP
13508 connection, and Exim is configured to request a certificate from the client,
13509 the value of the Distinguished Name of the certificate is made available in the
13510 &$tls_in_peerdn$& during subsequent processing.
13511 If certificate verification fails it may refer to a failing chain element
13512 which is not the leaf.
13513
13514 The deprecated &$tls_peerdn$& variable refers to the inbound side
13515 except when used in the context of an outbound SMTP delivery, when it refers to
13516 the outbound.
13517
13518 .vitem &$tls_out_peerdn$&
13519 .vindex "&$tls_out_peerdn$&"
13520 When a message is being delivered to a remote host over an encrypted SMTP
13521 connection, and Exim is configured to request a certificate from the server,
13522 the value of the Distinguished Name of the certificate is made available in the
13523 &$tls_out_peerdn$& during subsequent processing.
13524 If certificate verification fails it may refer to a failing chain element
13525 which is not the leaf.
13526
13527 .vitem &$tls_in_sni$&
13528 .vindex "&$tls_in_sni$&"
13529 .vindex "&$tls_sni$&"
13530 .cindex "TLS" "Server Name Indication"
13531 When a TLS session is being established, if the client sends the Server
13532 Name Indication extension, the value will be placed in this variable.
13533 If the variable appears in &%tls_certificate%& then this option and
13534 some others, described in &<<SECTtlssni>>&,
13535 will be re-expanded early in the TLS session, to permit
13536 a different certificate to be presented (and optionally a different key to be
13537 used) to the client, based upon the value of the SNI extension.
13538
13539 The deprecated &$tls_sni$& variable refers to the inbound side
13540 except when used in the context of an outbound SMTP delivery, when it refers to
13541 the outbound.
13542
13543 .vitem &$tls_out_sni$&
13544 .vindex "&$tls_out_sni$&"
13545 .cindex "TLS" "Server Name Indication"
13546 During outbound
13547 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13548 the transport.
13549
13550 .vitem &$tls_out_tlsa_usage$&
13551 .vindex &$tls_out_tlsa_usage$&
13552 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13553
13554 .vitem &$tls_in_ver$&
13555 .vindex "&$tls_in_ver$&"
13556 When a message is received from a remote host over an encrypted SMTP connection
13557 this variable is set to the protocol version, eg &'TLS1.2'&.
13558
13559 .vitem &$tls_out_ver$&
13560 .vindex "&$tls_out_ver$&"
13561 When a message is being delivered to a remote host over an encrypted SMTP connection
13562 this variable is set to the protocol version.
13563
13564
13565 .vitem &$tod_bsdinbox$&
13566 .vindex "&$tod_bsdinbox$&"
13567 The time of day and the date, in the format required for BSD-style mailbox
13568 files, for example: Thu Oct 17 17:14:09 1995.
13569
13570 .vitem &$tod_epoch$&
13571 .vindex "&$tod_epoch$&"
13572 The time and date as a number of seconds since the start of the Unix epoch.
13573
13574 .vitem &$tod_epoch_l$&
13575 .vindex "&$tod_epoch_l$&"
13576 The time and date as a number of microseconds since the start of the Unix epoch.
13577
13578 .vitem &$tod_full$&
13579 .vindex "&$tod_full$&"
13580 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13581 +0100. The timezone is always given as a numerical offset from UTC, with
13582 positive values used for timezones that are ahead (east) of UTC, and negative
13583 values for those that are behind (west).
13584
13585 .vitem &$tod_log$&
13586 .vindex "&$tod_log$&"
13587 The time and date in the format used for writing Exim's log files, for example:
13588 1995-10-12 15:32:29, but without a timezone.
13589
13590 .vitem &$tod_logfile$&
13591 .vindex "&$tod_logfile$&"
13592 This variable contains the date in the format yyyymmdd. This is the format that
13593 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13594 flag.
13595
13596 .vitem &$tod_zone$&
13597 .vindex "&$tod_zone$&"
13598 This variable contains the numerical value of the local timezone, for example:
13599 -0500.
13600
13601 .vitem &$tod_zulu$&
13602 .vindex "&$tod_zulu$&"
13603 This variable contains the UTC date and time in &"Zulu"& format, as specified
13604 by ISO 8601, for example: 20030221154023Z.
13605
13606 .vitem &$transport_name$&
13607 .cindex "transport" "name"
13608 .cindex "name" "of transport"
13609 .vindex "&$transport_name$&"
13610 During the running of a transport, this variable contains its name.
13611
13612 .vitem &$value$&
13613 .vindex "&$value$&"
13614 This variable contains the result of an expansion lookup, extraction operation,
13615 or external command, as described above. It is also used during a
13616 &*reduce*& expansion.
13617
13618 .vitem &$verify_mode$&
13619 .vindex "&$verify_mode$&"
13620 While a router or transport is being run in verify mode or for cutthrough delivery,
13621 contains "S" for sender-verification or "R" for recipient-verification.
13622 Otherwise, empty.
13623
13624 .vitem &$version_number$&
13625 .vindex "&$version_number$&"
13626 The version number of Exim. Same as &$exim_version$&, may be overridden
13627 by the &%exim_version%& main config option.
13628
13629 .vitem &$warn_message_delay$&
13630 .vindex "&$warn_message_delay$&"
13631 This variable is set only during the creation of a message warning about a
13632 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13633
13634 .vitem &$warn_message_recipients$&
13635 .vindex "&$warn_message_recipients$&"
13636 This variable is set only during the creation of a message warning about a
13637 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13638 .endlist
13639 .ecindex IIDstrexp
13640
13641
13642
13643 . ////////////////////////////////////////////////////////////////////////////
13644 . ////////////////////////////////////////////////////////////////////////////
13645
13646 .chapter "Embedded Perl" "CHAPperl"
13647 .scindex IIDperl "Perl" "calling from Exim"
13648 Exim can be built to include an embedded Perl interpreter. When this is done,
13649 Perl subroutines can be called as part of the string expansion process. To make
13650 use of the Perl support, you need version 5.004 or later of Perl installed on
13651 your system. To include the embedded interpreter in the Exim binary, include
13652 the line
13653 .code
13654 EXIM_PERL = perl.o
13655 .endd
13656 in your &_Local/Makefile_& and then build Exim in the normal way.
13657
13658
13659 .section "Setting up so Perl can be used" "SECID85"
13660 .oindex "&%perl_startup%&"
13661 Access to Perl subroutines is via a global configuration option called
13662 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13663 no &%perl_startup%& option in the Exim configuration file then no Perl
13664 interpreter is started and there is almost no overhead for Exim (since none of
13665 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13666 option then the associated value is taken to be Perl code which is executed in
13667 a newly created Perl interpreter.
13668
13669 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13670 need backslashes before any characters to escape special meanings. The option
13671 should usually be something like
13672 .code
13673 perl_startup = do '/etc/exim.pl'
13674 .endd
13675 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13676 use from Exim. Exim can be configured either to start up a Perl interpreter as
13677 soon as it is entered, or to wait until the first time it is needed. Starting
13678 the interpreter at the beginning ensures that it is done while Exim still has
13679 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13680 fact used in a particular run. Also, note that this does not mean that Exim is
13681 necessarily running as root when Perl is called at a later time. By default,
13682 the interpreter is started only when it is needed, but this can be changed in
13683 two ways:
13684
13685 .ilist
13686 .oindex "&%perl_at_start%&"
13687 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13688 a startup when Exim is entered.
13689 .next
13690 The command line option &%-ps%& also requests a startup when Exim is entered,
13691 overriding the setting of &%perl_at_start%&.
13692 .endlist
13693
13694 There is also a command line option &%-pd%& (for delay) which suppresses the
13695 initial startup, even if &%perl_at_start%& is set.
13696
13697 .ilist
13698 .oindex "&%perl_taintmode%&"
13699 .cindex "Perl" "taintmode"
13700 To provide more security executing Perl code via the embedded Perl
13701 interpreter, the &%perl_taintmode%& option can be set. This enables the
13702 taint mode of the Perl interpreter. You are encouraged to set this
13703 option to a true value. To avoid breaking existing installations, it
13704 defaults to false.
13705
13706
13707 .section "Calling Perl subroutines" "SECID86"
13708 When the configuration file includes a &%perl_startup%& option you can make use
13709 of the string expansion item to call the Perl subroutines that are defined
13710 by the &%perl_startup%& code. The operator is used in any of the following
13711 forms:
13712 .code
13713 ${perl{foo}}
13714 ${perl{foo}{argument}}
13715 ${perl{foo}{argument1}{argument2} ... }
13716 .endd
13717 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13718 arguments may be passed. Passing more than this results in an expansion failure
13719 with an error message of the form
13720 .code
13721 Too many arguments passed to Perl subroutine "foo" (max is 8)
13722 .endd
13723 The return value of the Perl subroutine is evaluated in a scalar context before
13724 it is passed back to Exim to be inserted into the expanded string. If the
13725 return value is &'undef'&, the expansion is forced to fail in the same way as
13726 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13727 by obeying Perl's &%die%& function, the expansion fails with the error message
13728 that was passed to &%die%&.
13729
13730
13731 .section "Calling Exim functions from Perl" "SECID87"
13732 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13733 is available to call back into Exim's string expansion function. For example,
13734 the Perl code
13735 .code
13736 my $lp = Exim::expand_string('$local_part');
13737 .endd
13738 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13739 Note those are single quotes and not double quotes to protect against
13740 &$local_part$& being interpolated as a Perl variable.
13741
13742 If the string expansion is forced to fail by a &"fail"& item, the result of
13743 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13744 expansion string, the Perl call from the original expansion string fails with
13745 an appropriate error message, in the same way as if &%die%& were used.
13746
13747 .cindex "debugging" "from embedded Perl"
13748 .cindex "log" "writing from embedded Perl"
13749 Two other Exim functions are available for use from within Perl code.
13750 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13751 debugging is enabled. If you want a newline at the end, you must supply it.
13752 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13753 timestamp. In this case, you should not supply a terminating newline.
13754
13755
13756 .section "Use of standard output and error by Perl" "SECID88"
13757 .cindex "Perl" "standard output and error"
13758 You should not write to the standard error or output streams from within your
13759 Perl code, as it is not defined how these are set up. In versions of Exim
13760 before 4.50, it is possible for the standard output or error to refer to the
13761 SMTP connection during message reception via the daemon. Writing to this stream
13762 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13763 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13764 avoided, but the output is lost.
13765
13766 .cindex "Perl" "use of &%warn%&"
13767 The Perl &%warn%& statement writes to the standard error stream by default.
13768 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13769 you have no control. When Exim starts up the Perl interpreter, it arranges for
13770 output from the &%warn%& statement to be written to the Exim main log. You can
13771 change this by including appropriate Perl magic somewhere in your Perl code.
13772 For example, to discard &%warn%& output completely, you need this:
13773 .code
13774 $SIG{__WARN__} = sub { };
13775 .endd
13776 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13777 example, the code for the subroutine is empty, so it does nothing, but you can
13778 include any Perl code that you like. The text of the &%warn%& message is passed
13779 as the first subroutine argument.
13780 .ecindex IIDperl
13781
13782
13783 . ////////////////////////////////////////////////////////////////////////////
13784 . ////////////////////////////////////////////////////////////////////////////
13785
13786 .chapter "Starting the daemon and the use of network interfaces" &&&
13787          "CHAPinterfaces" &&&
13788          "Starting the daemon"
13789 .cindex "daemon" "starting"
13790 .cindex "interface" "listening"
13791 .cindex "network interface"
13792 .cindex "interface" "network"
13793 .cindex "IP address" "for listening"
13794 .cindex "daemon" "listening IP addresses"
13795 .cindex "TCP/IP" "setting listening interfaces"
13796 .cindex "TCP/IP" "setting listening ports"
13797 A host that is connected to a TCP/IP network may have one or more physical
13798 hardware network interfaces. Each of these interfaces may be configured as one
13799 or more &"logical"& interfaces, which are the entities that a program actually
13800 works with. Each of these logical interfaces is associated with an IP address.
13801 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13802 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13803 knowledge about the host's interfaces for use in three different circumstances:
13804
13805 .olist
13806 When a listening daemon is started, Exim needs to know which interfaces
13807 and ports to listen on.
13808 .next
13809 When Exim is routing an address, it needs to know which IP addresses
13810 are associated with local interfaces. This is required for the correct
13811 processing of MX lists by removing the local host and others with the
13812 same or higher priority values. Also, Exim needs to detect cases
13813 when an address is routed to an IP address that in fact belongs to the
13814 local host. Unless the &%self%& router option or the &%allow_localhost%&
13815 option of the smtp transport is set (as appropriate), this is treated
13816 as an error situation.
13817 .next
13818 When Exim connects to a remote host, it may need to know which interface to use
13819 for the outgoing connection.
13820 .endlist
13821
13822
13823 Exim's default behaviour is likely to be appropriate in the vast majority
13824 of cases. If your host has only one interface, and you want all its IP
13825 addresses to be treated in the same way, and you are using only the
13826 standard SMTP port, you should not need to take any special action. The
13827 rest of this chapter does not apply to you.
13828
13829 In a more complicated situation you may want to listen only on certain
13830 interfaces, or on different ports, and for this reason there are a number of
13831 options that can be used to influence Exim's behaviour. The rest of this
13832 chapter describes how they operate.
13833
13834 When a message is received over TCP/IP, the interface and port that were
13835 actually used are set in &$received_ip_address$& and &$received_port$&.
13836
13837
13838
13839 .section "Starting a listening daemon" "SECID89"
13840 When a listening daemon is started (by means of the &%-bd%& command line
13841 option), the interfaces and ports on which it listens are controlled by the
13842 following options:
13843
13844 .ilist
13845 &%daemon_smtp_ports%& contains a list of default ports
13846 or service names.
13847 (For backward compatibility, this option can also be specified in the singular.)
13848 .next
13849 &%local_interfaces%& contains list of interface IP addresses on which to
13850 listen. Each item may optionally also specify a port.
13851 .endlist
13852
13853 The default list separator in both cases is a colon, but this can be changed as
13854 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
13855 it is usually best to change the separator to avoid having to double all the
13856 colons. For example:
13857 .code
13858 local_interfaces = <; 127.0.0.1 ; \
13859                       192.168.23.65 ; \
13860                       ::1 ; \
13861                       3ffe:ffff:836f::fe86:a061
13862 .endd
13863 There are two different formats for specifying a port along with an IP address
13864 in &%local_interfaces%&:
13865
13866 .olist
13867 The port is added onto the address with a dot separator. For example, to listen
13868 on port 1234 on two different IP addresses:
13869 .code
13870 local_interfaces = <; 192.168.23.65.1234 ; \
13871                       3ffe:ffff:836f::fe86:a061.1234
13872 .endd
13873 .next
13874 The IP address is enclosed in square brackets, and the port is added
13875 with a colon separator, for example:
13876 .code
13877 local_interfaces = <; [192.168.23.65]:1234 ; \
13878                       [3ffe:ffff:836f::fe86:a061]:1234
13879 .endd
13880 .endlist
13881
13882 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13883 default setting contains just one port:
13884 .code
13885 daemon_smtp_ports = smtp
13886 .endd
13887 If more than one port is listed, each interface that does not have its own port
13888 specified listens on all of them. Ports that are listed in
13889 &%daemon_smtp_ports%& can be identified either by name (defined in
13890 &_/etc/services_&) or by number. However, when ports are given with individual
13891 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13892
13893
13894
13895 .section "Special IP listening addresses" "SECID90"
13896 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13897 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13898 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13899 instead of setting up separate listening sockets for each interface. The
13900 default value of &%local_interfaces%& is
13901 .code
13902 local_interfaces = 0.0.0.0
13903 .endd
13904 when Exim is built without IPv6 support; otherwise it is:
13905 .code
13906 local_interfaces = <; ::0 ; 0.0.0.0
13907 .endd
13908 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13909
13910
13911
13912 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13913 The &%-oX%& command line option can be used to override the values of
13914 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13915 instance. Another way of doing this would be to use macros and the &%-D%&
13916 option. However, &%-oX%& can be used by any admin user, whereas modification of
13917 the runtime configuration by &%-D%& is allowed only when the caller is root or
13918 exim.
13919
13920 The value of &%-oX%& is a list of items. The default colon separator can be
13921 changed in the usual way (&<<SECTlistsepchange>>&) if required.
13922 If there are any items that do not
13923 contain dots or colons (that is, are not IP addresses), the value of
13924 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13925 items that do contain dots or colons, the value of &%local_interfaces%& is
13926 replaced by those items. Thus, for example,
13927 .code
13928 -oX 1225
13929 .endd
13930 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13931 whereas
13932 .code
13933 -oX 192.168.34.5.1125
13934 .endd
13935 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13936 (However, since &%local_interfaces%& now contains no items without ports, the
13937 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13938
13939
13940
13941 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
13942 .cindex "submissions protocol"
13943 .cindex "ssmtp protocol"
13944 .cindex "smtps protocol"
13945 .cindex "SMTP" "ssmtp protocol"
13946 .cindex "SMTP" "smtps protocol"
13947 Exim supports the use of TLS-on-connect, used by mail clients in the
13948 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
13949 For some years, IETF Standards Track documents only blessed the
13950 STARTTLS-based Submission service (port 587) while common practice was to support
13951 the same feature set on port 465, but using TLS-on-connect.
13952 If your installation needs to provide service to mail clients
13953 (Mail User Agents, MUAs) then you should provide service on both the 587 and
13954 the 465 TCP ports.
13955
13956 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
13957 service names, connections to those ports must first establish TLS, before
13958 proceeding to the application layer use of the SMTP protocol.
13959
13960 The common use of this option is expected to be
13961 .code
13962 tls_on_connect_ports = 465
13963 .endd
13964 per RFC 8314.
13965 There is also a command line option &%-tls-on-connect%&, which forces all ports
13966 to behave in this way when a daemon is started.
13967
13968 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13969 daemon to listen on those ports. You must still specify them in
13970 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13971 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13972 connections via the daemon.)
13973
13974
13975
13976
13977 .section "IPv6 address scopes" "SECID92"
13978 .cindex "IPv6" "address scopes"
13979 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13980 can, in principle, have the same link-local IPv6 address on different
13981 interfaces. Thus, additional information is needed, over and above the IP
13982 address, to distinguish individual interfaces. A convention of using a
13983 percent sign followed by something (often the interface name) has been
13984 adopted in some cases, leading to addresses like this:
13985 .code
13986 fe80::202:b3ff:fe03:45c1%eth0
13987 .endd
13988 To accommodate this usage, a percent sign followed by an arbitrary string is
13989 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13990 to convert a textual IPv6 address for actual use. This function recognizes the
13991 percent convention in operating systems that support it, and it processes the
13992 address appropriately. Unfortunately, some older libraries have problems with
13993 &[getaddrinfo()]&. If
13994 .code
13995 IPV6_USE_INET_PTON=yes
13996 .endd
13997 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13998 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13999 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14000 function.) Of course, this means that the additional functionality of
14001 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14002
14003 .section "Disabling IPv6" "SECID93"
14004 .cindex "IPv6" "disabling"
14005 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14006 run on a host whose kernel does not support IPv6. The binary will fall back to
14007 using IPv4, but it may waste resources looking up AAAA records, and trying to
14008 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14009 .oindex "&%disable_ipv6%&"
14010 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14011 activities take place. AAAA records are never looked up, and any IPv6 addresses
14012 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14013 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14014 to handle IPv6 literal addresses.
14015
14016 On the other hand, when IPv6 is in use, there may be times when you want to
14017 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14018 option to globally suppress the lookup of AAAA records for specified domains,
14019 and you can use the &%ignore_target_hosts%& generic router option to ignore
14020 IPv6 addresses in an individual router.
14021
14022
14023
14024 .section "Examples of starting a listening daemon" "SECID94"
14025 The default case in an IPv6 environment is
14026 .code
14027 daemon_smtp_ports = smtp
14028 local_interfaces = <; ::0 ; 0.0.0.0
14029 .endd
14030 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14031 Either one or two sockets may be used, depending on the characteristics of
14032 the TCP/IP stack. (This is complicated and messy; for more information,
14033 read the comments in the &_daemon.c_& source file.)
14034
14035 To specify listening on ports 25 and 26 on all interfaces:
14036 .code
14037 daemon_smtp_ports = 25 : 26
14038 .endd
14039 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14040 .code
14041 local_interfaces = <; ::0.25     ; ::0.26 \
14042                       0.0.0.0.25 ; 0.0.0.0.26
14043 .endd
14044 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14045 IPv4 loopback address only:
14046 .code
14047 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14048 .endd
14049 To specify listening on the default port on specific interfaces only:
14050 .code
14051 local_interfaces = 10.0.0.67 : 192.168.34.67
14052 .endd
14053 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14054
14055
14056
14057 .section "Recognizing the local host" "SECTreclocipadd"
14058 The &%local_interfaces%& option is also used when Exim needs to determine
14059 whether or not an IP address refers to the local host. That is, the IP
14060 addresses of all the interfaces on which a daemon is listening are always
14061 treated as local.
14062
14063 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14064 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14065 available interfaces from the operating system, and extracts the relevant
14066 (that is, IPv4 or IPv6) addresses to use for checking.
14067
14068 Some systems set up large numbers of virtual interfaces in order to provide
14069 many virtual web servers. In this situation, you may want to listen for
14070 email on only a few of the available interfaces, but nevertheless treat all
14071 interfaces as local when routing. You can do this by setting
14072 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14073 &"all"& wildcard values. These addresses are recognized as local, but are not
14074 used for listening. Consider this example:
14075 .code
14076 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14077                       192.168.53.235 ; \
14078                       3ffe:2101:12:1:a00:20ff:fe86:a061
14079
14080 extra_local_interfaces = <; ::0 ; 0.0.0.0
14081 .endd
14082 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14083 address, but all available interface addresses are treated as local when
14084 Exim is routing.
14085
14086 In some environments the local host name may be in an MX list, but with an IP
14087 address that is not assigned to any local interface. In other cases it may be
14088 desirable to treat other host names as if they referred to the local host. Both
14089 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14090 This contains host names rather than IP addresses. When a host is referenced
14091 during routing, either via an MX record or directly, it is treated as the local
14092 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14093 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14094
14095
14096
14097 .section "Delivering to a remote host" "SECID95"
14098 Delivery to a remote host is handled by the smtp transport. By default, it
14099 allows the system's TCP/IP functions to choose which interface to use (if
14100 there is more than one) when connecting to a remote host. However, the
14101 &%interface%& option can be set to specify which interface is used. See the
14102 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14103 details.
14104
14105
14106
14107
14108 . ////////////////////////////////////////////////////////////////////////////
14109 . ////////////////////////////////////////////////////////////////////////////
14110
14111 .chapter "Main configuration" "CHAPmainconfig"
14112 .scindex IIDconfima "configuration file" "main section"
14113 .scindex IIDmaiconf "main configuration"
14114 The first part of the runtime configuration file contains three types of item:
14115
14116 .ilist
14117 Macro definitions: These lines start with an upper case letter. See section
14118 &<<SECTmacrodefs>>& for details of macro processing.
14119 .next
14120 Named list definitions: These lines start with one of the words &"domainlist"&,
14121 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14122 section &<<SECTnamedlists>>&.
14123 .next
14124 Main configuration settings: Each setting occupies one line of the file
14125 (with possible continuations). If any setting is preceded by the word
14126 &"hide"&, the &%-bP%& command line option displays its value to admin users
14127 only. See section &<<SECTcos>>& for a description of the syntax of these option
14128 settings.
14129 .endlist
14130
14131 This chapter specifies all the main configuration options, along with their
14132 types and default values. For ease of finding a particular option, they appear
14133 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14134 are now so many options, they are first listed briefly in functional groups, as
14135 an aid to finding the name of the option you are looking for. Some options are
14136 listed in more than one group.
14137
14138 .section "Miscellaneous" "SECID96"
14139 .table2
14140 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14141 .row &%debug_store%&                 "do extra internal checks"
14142 .row &%disable_ipv6%&                "do no IPv6 processing"
14143 .row &%keep_malformed%&              "for broken files &-- should not happen"
14144 .row &%localhost_number%&            "for unique message ids in clusters"
14145 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14146 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14147 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14148 .row &%print_topbitchars%&           "top-bit characters are printing"
14149 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14150 .row &%timezone%&                    "force time zone"
14151 .endtable
14152
14153
14154 .section "Exim parameters" "SECID97"
14155 .table2
14156 .row &%exim_group%&                  "override compiled-in value"
14157 .row &%exim_path%&                   "override compiled-in value"
14158 .row &%exim_user%&                   "override compiled-in value"
14159 .row &%primary_hostname%&            "default from &[uname()]&"
14160 .row &%split_spool_directory%&       "use multiple directories"
14161 .row &%spool_directory%&             "override compiled-in value"
14162 .endtable
14163
14164
14165
14166 .section "Privilege controls" "SECID98"
14167 .table2
14168 .row &%admin_groups%&                "groups that are Exim admin users"
14169 .row &%commandline_checks_require_admin%& "require admin for various checks"
14170 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14171 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14172 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14173 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14174 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14175 .row &%never_users%&                 "do not run deliveries as these"
14176 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14177 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14178 .row &%trusted_groups%&              "groups that are trusted"
14179 .row &%trusted_users%&               "users that are trusted"
14180 .endtable
14181
14182
14183
14184 .section "Logging" "SECID99"
14185 .table2
14186 .row &%event_action%&                "custom logging"
14187 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14188 .row &%log_file_path%&               "override compiled-in value"
14189 .row &%log_selector%&                "set/unset optional logging"
14190 .row &%log_timezone%&                "add timezone to log lines"
14191 .row &%message_logs%&                "create per-message logs"
14192 .row &%preserve_message_logs%&       "after message completion"
14193 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14194 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14195 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14196 .row &%syslog_facility%&             "set syslog &""facility""& field"
14197 .row &%syslog_pid%&                  "pid in syslog lines"
14198 .row &%syslog_processname%&          "set syslog &""ident""& field"
14199 .row &%syslog_timestamp%&            "timestamp syslog lines"
14200 .row &%write_rejectlog%&             "control use of message log"
14201 .endtable
14202
14203
14204
14205 .section "Frozen messages" "SECID100"
14206 .table2
14207 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14208 .row &%freeze_tell%&                 "send message when freezing"
14209 .row &%move_frozen_messages%&        "to another directory"
14210 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14211 .endtable
14212
14213
14214
14215 .section "Data lookups" "SECID101"
14216 .table2
14217 .row &%ibase_servers%&               "InterBase servers"
14218 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14219 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14220 .row &%ldap_cert_file%&              "client cert file for LDAP"
14221 .row &%ldap_cert_key%&               "client key file for LDAP"
14222 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14223 .row &%ldap_default_servers%&        "used if no server in query"
14224 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14225 .row &%ldap_start_tls%&              "require TLS within LDAP"
14226 .row &%ldap_version%&                "set protocol version"
14227 .row &%lookup_open_max%&             "lookup files held open"
14228 .row &%mysql_servers%&               "default MySQL servers"
14229 .row &%oracle_servers%&              "Oracle servers"
14230 .row &%pgsql_servers%&               "default PostgreSQL servers"
14231 .row &%sqlite_lock_timeout%&         "as it says"
14232 .endtable
14233
14234
14235
14236 .section "Message ids" "SECID102"
14237 .table2
14238 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14239 .row &%message_id_header_text%&      "ditto"
14240 .endtable
14241
14242
14243
14244 .section "Embedded Perl Startup" "SECID103"
14245 .table2
14246 .row &%perl_at_start%&               "always start the interpreter"
14247 .row &%perl_startup%&                "code to obey when starting Perl"
14248 .row &%perl_taintmode%&              "enable taint mode in Perl"
14249 .endtable
14250
14251
14252
14253 .section "Daemon" "SECID104"
14254 .table2
14255 .row &%daemon_smtp_ports%&           "default ports"
14256 .row &%daemon_startup_retries%&      "number of times to retry"
14257 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14258 .row &%extra_local_interfaces%&      "not necessarily listened on"
14259 .row &%local_interfaces%&            "on which to listen, with optional ports"
14260 .row &%pid_file_path%&               "override compiled-in value"
14261 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14262 .endtable
14263
14264
14265
14266 .section "Resource control" "SECID105"
14267 .table2
14268 .row &%check_log_inodes%&            "before accepting a message"
14269 .row &%check_log_space%&             "before accepting a message"
14270 .row &%check_spool_inodes%&          "before accepting a message"
14271 .row &%check_spool_space%&           "before accepting a message"
14272 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14273 .row &%queue_only_load%&             "queue incoming if load high"
14274 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14275 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14276 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14277 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14278 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14279 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14280 .row &%smtp_accept_max_per_connection%& "messages per connection"
14281 .row &%smtp_accept_max_per_host%&    "connections from one host"
14282 .row &%smtp_accept_queue%&           "queue mail if more connections"
14283 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14284                                            connection"
14285 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14286 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14287 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14288 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14289 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14290 .endtable
14291
14292
14293
14294 .section "Policy controls" "SECID106"
14295 .table2
14296 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14297 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14298 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14299 .row &%acl_smtp_auth%&               "ACL for AUTH"
14300 .row &%acl_smtp_connect%&            "ACL for connection"
14301 .row &%acl_smtp_data%&               "ACL for DATA"
14302 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14303 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14304 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14305 .row &%acl_smtp_expn%&               "ACL for EXPN"
14306 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14307 .row &%acl_smtp_mail%&               "ACL for MAIL"
14308 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14309 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14310 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14311 .row &%acl_smtp_predata%&            "ACL for start of data"
14312 .row &%acl_smtp_quit%&               "ACL for QUIT"
14313 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14314 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14315 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14316 .row &%av_scanner%&                  "specify virus scanner"
14317 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14318                                       words""&"
14319 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14320 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14321 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14322 .row &%header_maxsize%&              "total size of message header"
14323 .row &%header_line_maxsize%&         "individual header line limit"
14324 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14325 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14326 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14327 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14328 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14329 .row &%host_lookup%&                 "host name looked up for these hosts"
14330 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14331 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14332 .row &%host_reject_connection%&      "reject connection from these hosts"
14333 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14334 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14335 .row &%message_size_limit%&          "for all messages"
14336 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14337 .row &%spamd_address%&               "set interface to SpamAssassin"
14338 .row &%strict_acl_vars%&             "object to unset ACL variables"
14339 .endtable
14340
14341
14342
14343 .section "Callout cache" "SECID107"
14344 .table2
14345 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14346                                          item"
14347 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14348                                          item"
14349 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14350 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14351 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14352 .endtable
14353
14354
14355
14356 .section "TLS" "SECID108"
14357 .table2
14358 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14359 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14360 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14361 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14362 .row &%tls_certificate%&             "location of server certificate"
14363 .row &%tls_crl%&                     "certificate revocation list"
14364 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14365 .row &%tls_dhparam%&                 "DH parameters for server"
14366 .row &%tls_eccurve%&                 "EC curve selection for server"
14367 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14368 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14369 .row &%tls_privatekey%&              "location of server private key"
14370 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14371 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14372 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14373 .row &%tls_verify_certificates%&     "expected client certificates"
14374 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14375 .endtable
14376
14377
14378
14379 .section "Local user handling" "SECID109"
14380 .table2
14381 .row &%finduser_retries%&            "useful in NIS environments"
14382 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14383 .row &%gecos_pattern%&               "ditto"
14384 .row &%max_username_length%&         "for systems that truncate"
14385 .row &%unknown_login%&               "used when no login name found"
14386 .row &%unknown_username%&            "ditto"
14387 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14388 .row &%uucp_from_sender%&            "ditto"
14389 .endtable
14390
14391
14392
14393 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14394 .table2
14395 .row &%header_maxsize%&              "total size of message header"
14396 .row &%header_line_maxsize%&         "individual header line limit"
14397 .row &%message_size_limit%&          "applies to all messages"
14398 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14399 .row &%received_header_text%&        "expanded to make &'Received:'&"
14400 .row &%received_headers_max%&        "for mail loop detection"
14401 .row &%recipients_max%&              "limit per message"
14402 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14403 .endtable
14404
14405
14406
14407
14408 .section "Non-SMTP incoming messages" "SECID111"
14409 .table2
14410 .row &%receive_timeout%&             "for non-SMTP messages"
14411 .endtable
14412
14413
14414
14415
14416
14417 .section "Incoming SMTP messages" "SECID112"
14418 See also the &'Policy controls'& section above.
14419
14420 .table2
14421 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14422 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14423 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14424 .row &%host_lookup%&                 "host name looked up for these hosts"
14425 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14426 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14427 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14428 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14429 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14430 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14431 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14432 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14433 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14434 .row &%smtp_accept_max_per_connection%& "messages per connection"
14435 .row &%smtp_accept_max_per_host%&    "connections from one host"
14436 .row &%smtp_accept_queue%&           "queue mail if more connections"
14437 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14438                                            connection"
14439 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14440 .row &%smtp_active_hostname%&        "host name to use in messages"
14441 .row &%smtp_banner%&                 "text for welcome banner"
14442 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14443 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14444 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14445 .row &%smtp_etrn_command%&           "what to run for ETRN"
14446 .row &%smtp_etrn_serialize%&         "only one at once"
14447 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14448 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14449 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14450 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14451 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14452 .row &%smtp_receive_timeout%&        "per command or data line"
14453 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14454 .row &%smtp_return_error_details%&   "give detail on rejections"
14455 .endtable
14456
14457
14458
14459 .section "SMTP extensions" "SECID113"
14460 .table2
14461 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14462 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14463 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14464 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14465 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14466 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14467 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14468 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14469 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14470 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14471 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14472 .endtable
14473
14474
14475
14476 .section "Processing messages" "SECID114"
14477 .table2
14478 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14479 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14480 .row &%allow_utf8_domains%&          "in addresses"
14481 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14482                                       words""&"
14483 .row &%delivery_date_remove%&        "from incoming messages"
14484 .row &%envelope_to_remove%&          "from incoming messages"
14485 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14486 .row &%headers_charset%&             "default for translations"
14487 .row &%qualify_domain%&              "default for senders"
14488 .row &%qualify_recipient%&           "default for recipients"
14489 .row &%return_path_remove%&          "from incoming messages"
14490 .row &%strip_excess_angle_brackets%& "in addresses"
14491 .row &%strip_trailing_dot%&          "at end of addresses"
14492 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14493 .endtable
14494
14495
14496
14497 .section "System filter" "SECID115"
14498 .table2
14499 .row &%system_filter%&               "locate system filter"
14500 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14501                                             directory"
14502 .row &%system_filter_file_transport%& "transport for delivery to a file"
14503 .row &%system_filter_group%&         "group for filter running"
14504 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14505 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14506 .row &%system_filter_user%&          "user for filter running"
14507 .endtable
14508
14509
14510
14511 .section "Routing and delivery" "SECID116"
14512 .table2
14513 .row &%disable_ipv6%&                "do no IPv6 processing"
14514 .row &%dns_again_means_nonexist%&    "for broken domains"
14515 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14516 .row &%dns_dnssec_ok%&               "parameter for resolver"
14517 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14518 .row &%dns_retrans%&                 "parameter for resolver"
14519 .row &%dns_retry%&                   "parameter for resolver"
14520 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14521 .row &%dns_use_edns0%&               "parameter for resolver"
14522 .row &%hold_domains%&                "hold delivery for these domains"
14523 .row &%local_interfaces%&            "for routing checks"
14524 .row &%queue_domains%&               "no immediate delivery for these"
14525 .row &%queue_only%&                  "no immediate delivery at all"
14526 .row &%queue_only_file%&             "no immediate delivery if file exists"
14527 .row &%queue_only_load%&             "no immediate delivery if load is high"
14528 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14529 .row &%queue_only_override%&         "allow command line to override"
14530 .row &%queue_run_in_order%&          "order of arrival"
14531 .row &%queue_run_max%&               "of simultaneous queue runners"
14532 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14533 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14534 .row &%remote_sort_domains%&         "order of remote deliveries"
14535 .row &%retry_data_expire%&           "timeout for retry data"
14536 .row &%retry_interval_max%&          "safety net for retry rules"
14537 .endtable
14538
14539
14540
14541 .section "Bounce and warning messages" "SECID117"
14542 .table2
14543 .row &%bounce_message_file%&         "content of bounce"
14544 .row &%bounce_message_text%&         "content of bounce"
14545 .row &%bounce_return_body%&          "include body if returning message"
14546 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14547 .row &%bounce_return_message%&       "include original message in bounce"
14548 .row &%bounce_return_size_limit%&    "limit on returned message"
14549 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14550 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14551 .row &%errors_copy%&                 "copy bounce messages"
14552 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14553 .row &%delay_warning%&               "time schedule"
14554 .row &%delay_warning_condition%&     "condition for warning messages"
14555 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14556 .row &%smtp_return_error_details%&   "give detail on rejections"
14557 .row &%warn_message_file%&           "content of warning message"
14558 .endtable
14559
14560
14561
14562 .section "Alphabetical list of main options" "SECTalomo"
14563 Those options that undergo string expansion before use are marked with
14564 &dagger;.
14565
14566 .option accept_8bitmime main boolean true
14567 .cindex "8BITMIME"
14568 .cindex "8-bit characters"
14569 .cindex "log" "selectors"
14570 .cindex "log" "8BITMIME"
14571 This option causes Exim to send 8BITMIME in its response to an SMTP
14572 EHLO command, and to accept the BODY= parameter on MAIL commands.
14573 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14574 takes no steps to do anything special with messages received by this route.
14575
14576 Historically Exim kept this option off by default, but the maintainers
14577 feel that in today's Internet, this causes more problems than it solves.
14578 It now defaults to true.
14579 A more detailed analysis of the issues is provided by Dan Bernstein:
14580 .display
14581 &url(https://cr.yp.to/smtp/8bitmime.html)
14582 .endd
14583
14584 To log received 8BITMIME status use
14585 .code
14586 log_selector = +8bitmime
14587 .endd
14588
14589 .option acl_not_smtp main string&!! unset
14590 .cindex "&ACL;" "for non-SMTP messages"
14591 .cindex "non-SMTP messages" "ACLs for"
14592 This option defines the ACL that is run when a non-SMTP message has been
14593 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14594 further details.
14595
14596 .option acl_not_smtp_mime main string&!! unset
14597 This option defines the ACL that is run for individual MIME parts of non-SMTP
14598 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14599 SMTP messages.
14600
14601 .option acl_not_smtp_start main string&!! unset
14602 .cindex "&ACL;" "at start of non-SMTP message"
14603 .cindex "non-SMTP messages" "ACLs for"
14604 This option defines the ACL that is run before Exim starts reading a
14605 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14606
14607 .option acl_smtp_auth main string&!! unset
14608 .cindex "&ACL;" "setting up for SMTP commands"
14609 .cindex "AUTH" "ACL for"
14610 This option defines the ACL that is run when an SMTP AUTH command is
14611 received. See chapter &<<CHAPACL>>& for further details.
14612
14613 .option acl_smtp_connect main string&!! unset
14614 .cindex "&ACL;" "on SMTP connection"
14615 This option defines the ACL that is run when an SMTP connection is received.
14616 See chapter &<<CHAPACL>>& for further details.
14617
14618 .option acl_smtp_data main string&!! unset
14619 .cindex "DATA" "ACL for"
14620 This option defines the ACL that is run after an SMTP DATA command has been
14621 processed and the message itself has been received, but before the final
14622 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14623
14624 .option acl_smtp_data_prdr main string&!! accept
14625 .cindex "PRDR" "ACL for"
14626 .cindex "DATA" "PRDR ACL for"
14627 .cindex "&ACL;" "PRDR-related"
14628 .cindex "&ACL;" "per-user data processing"
14629 This option defines the ACL that,
14630 if the PRDR feature has been negotiated,
14631 is run for each recipient after an SMTP DATA command has been
14632 processed and the message itself has been received, but before the
14633 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14634
14635 .option acl_smtp_dkim main string&!! unset
14636 .cindex DKIM "ACL for"
14637 This option defines the ACL that is run for each DKIM signature
14638 (by default, or as specified in the dkim_verify_signers option)
14639 of a received message.
14640 See section &<<SECDKIMVFY>>& for further details.
14641
14642 .option acl_smtp_etrn main string&!! unset
14643 .cindex "ETRN" "ACL for"
14644 This option defines the ACL that is run when an SMTP ETRN command is
14645 received. See chapter &<<CHAPACL>>& for further details.
14646
14647 .option acl_smtp_expn main string&!! unset
14648 .cindex "EXPN" "ACL for"
14649 This option defines the ACL that is run when an SMTP EXPN command is
14650 received. See chapter &<<CHAPACL>>& for further details.
14651
14652 .option acl_smtp_helo main string&!! unset
14653 .cindex "EHLO" "ACL for"
14654 .cindex "HELO" "ACL for"
14655 This option defines the ACL that is run when an SMTP EHLO or HELO
14656 command is received. See chapter &<<CHAPACL>>& for further details.
14657
14658
14659 .option acl_smtp_mail main string&!! unset
14660 .cindex "MAIL" "ACL for"
14661 This option defines the ACL that is run when an SMTP MAIL command is
14662 received. See chapter &<<CHAPACL>>& for further details.
14663
14664 .option acl_smtp_mailauth main string&!! unset
14665 .cindex "AUTH" "on MAIL command"
14666 This option defines the ACL that is run when there is an AUTH parameter on
14667 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14668 &<<CHAPSMTPAUTH>>& for details of authentication.
14669
14670 .option acl_smtp_mime main string&!! unset
14671 .cindex "MIME content scanning" "ACL for"
14672 This option is available when Exim is built with the content-scanning
14673 extension. It defines the ACL that is run for each MIME part in a message. See
14674 section &<<SECTscanmimepart>>& for details.
14675
14676 .option acl_smtp_notquit main string&!! unset
14677 .cindex "not-QUIT, ACL for"
14678 This option defines the ACL that is run when an SMTP session
14679 ends without a QUIT command being received.
14680 See chapter &<<CHAPACL>>& for further details.
14681
14682 .option acl_smtp_predata main string&!! unset
14683 This option defines the ACL that is run when an SMTP DATA command is
14684 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14685 further details.
14686
14687 .option acl_smtp_quit main string&!! unset
14688 .cindex "QUIT, ACL for"
14689 This option defines the ACL that is run when an SMTP QUIT command is
14690 received. See chapter &<<CHAPACL>>& for further details.
14691
14692 .option acl_smtp_rcpt main string&!! unset
14693 .cindex "RCPT" "ACL for"
14694 This option defines the ACL that is run when an SMTP RCPT command is
14695 received. See chapter &<<CHAPACL>>& for further details.
14696
14697 .option acl_smtp_starttls main string&!! unset
14698 .cindex "STARTTLS, ACL for"
14699 This option defines the ACL that is run when an SMTP STARTTLS command is
14700 received. See chapter &<<CHAPACL>>& for further details.
14701
14702 .option acl_smtp_vrfy main string&!! unset
14703 .cindex "VRFY" "ACL for"
14704 This option defines the ACL that is run when an SMTP VRFY command is
14705 received. See chapter &<<CHAPACL>>& for further details.
14706
14707 .option add_environment main "string list" empty
14708 .cindex "environment" "set values"
14709 This option adds individual environment variables that the
14710 currently linked libraries and programs in child processes may use.
14711 Each list element should be of the form &"name=value"&.
14712
14713 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14714
14715 .option admin_groups main "string list&!!" unset
14716 .cindex "admin user"
14717 This option is expanded just once, at the start of Exim's processing. If the
14718 current group or any of the supplementary groups of an Exim caller is in this
14719 colon-separated list, the caller has admin privileges. If all your system
14720 programmers are in a specific group, for example, you can give them all Exim
14721 admin privileges by putting that group in &%admin_groups%&. However, this does
14722 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14723 To permit this, you have to add individuals to the Exim group.
14724
14725 .option allow_domain_literals main boolean false
14726 .cindex "domain literal"
14727 If this option is set, the RFC 2822 domain literal format is permitted in
14728 email addresses. The option is not set by default, because the domain literal
14729 format is not normally required these days, and few people know about it. It
14730 has, however, been exploited by mail abusers.
14731
14732 Unfortunately, it seems that some DNS black list maintainers are using this
14733 format to report black listing to postmasters. If you want to accept messages
14734 addressed to your hosts by IP address, you need to set
14735 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14736 domains (defined in the named domain list &%local_domains%& in the default
14737 configuration). This &"magic string"& matches the domain literal form of all
14738 the local host's IP addresses.
14739
14740
14741 .option allow_mx_to_ip main boolean false
14742 .cindex "MX record" "pointing to IP address"
14743 It appears that more and more DNS zone administrators are breaking the rules
14744 and putting domain names that look like IP addresses on the right hand side of
14745 MX records. Exim follows the rules and rejects this, giving an error message
14746 that explains the misconfiguration. However, some other MTAs support this
14747 practice, so to avoid &"Why can't Exim do this?"& complaints,
14748 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14749 recommended, except when you have no other choice.
14750
14751 .option allow_utf8_domains main boolean false
14752 .cindex "domain" "UTF-8 characters in"
14753 .cindex "UTF-8" "in domain name"
14754 Lots of discussion is going on about internationalized domain names. One
14755 camp is strongly in favour of just using UTF-8 characters, and it seems
14756 that at least two other MTAs permit this.
14757 This option allows Exim users to experiment if they wish.
14758
14759 If it is set true, Exim's domain parsing function allows valid
14760 UTF-8 multicharacters to appear in domain name components, in addition to
14761 letters, digits, and hyphens.
14762
14763 If Exim is built with internationalization support
14764 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
14765 this option can be left as default.
14766 Without that,
14767 if you want to look up such domain names in the DNS, you must also
14768 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14769 suitable setting is:
14770 .code
14771 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14772   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14773 .endd
14774 Alternatively, you can just disable this feature by setting
14775 .code
14776 dns_check_names_pattern =
14777 .endd
14778 That is, set the option to an empty string so that no check is done.
14779
14780
14781 .option auth_advertise_hosts main "host list&!!" *
14782 .cindex "authentication" "advertising"
14783 .cindex "AUTH" "advertising"
14784 If any server authentication mechanisms are configured, Exim advertises them in
14785 response to an EHLO command only if the calling host matches this list.
14786 Otherwise, Exim does not advertise AUTH.
14787 Exim does not accept AUTH commands from clients to which it has not
14788 advertised the availability of AUTH. The advertising of individual
14789 authentication mechanisms can be controlled by the use of the
14790 &%server_advertise_condition%& generic authenticator option on the individual
14791 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14792
14793 Certain mail clients (for example, Netscape) require the user to provide a name
14794 and password for authentication if AUTH is advertised, even though it may
14795 not be needed (the host may accept messages from hosts on its local LAN without
14796 authentication, for example). The &%auth_advertise_hosts%& option can be used
14797 to make these clients more friendly by excluding them from the set of hosts to
14798 which Exim advertises AUTH.
14799
14800 .cindex "AUTH" "advertising when encrypted"
14801 If you want to advertise the availability of AUTH only when the connection
14802 is encrypted using TLS, you can make use of the fact that the value of this
14803 option is expanded, with a setting like this:
14804 .code
14805 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14806 .endd
14807 .vindex "&$tls_in_cipher$&"
14808 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14809 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14810 expansion is *, which matches all hosts.
14811
14812
14813 .option auto_thaw main time 0s
14814 .cindex "thawing messages"
14815 .cindex "unfreezing messages"
14816 If this option is set to a time greater than zero, a queue runner will try a
14817 new delivery attempt on any frozen message, other than a bounce message, if
14818 this much time has passed since it was frozen. This may result in the message
14819 being re-frozen if nothing has changed since the last attempt. It is a way of
14820 saying &"keep on trying, even though there are big problems"&.
14821
14822 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14823 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14824 thought to be very useful any more, and its use should probably be avoided.
14825
14826
14827 .option av_scanner main string "see below"
14828 This option is available if Exim is built with the content-scanning extension.
14829 It specifies which anti-virus scanner to use. The default value is:
14830 .code
14831 sophie:/var/run/sophie
14832 .endd
14833 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14834 before use. See section &<<SECTscanvirus>>& for further details.
14835
14836
14837 .option bi_command main string unset
14838 .oindex "&%-bi%&"
14839 This option supplies the name of a command that is run when Exim is called with
14840 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14841 just the command name, it is not a complete command line. If an argument is
14842 required, it must come from the &%-oA%& command line option.
14843
14844
14845 .option bounce_message_file main string unset
14846 .cindex "bounce message" "customizing"
14847 .cindex "customizing" "bounce message"
14848 This option defines a template file containing paragraphs of text to be used
14849 for constructing bounce messages.  Details of the file's contents are given in
14850 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14851
14852
14853 .option bounce_message_text main string unset
14854 When this option is set, its contents are included in the default bounce
14855 message immediately after &"This message was created automatically by mail
14856 delivery software."& It is not used if &%bounce_message_file%& is set.
14857
14858 .option bounce_return_body main boolean true
14859 .cindex "bounce message" "including body"
14860 This option controls whether the body of an incoming message is included in a
14861 bounce message when &%bounce_return_message%& is true. The default setting
14862 causes the entire message, both header and body, to be returned (subject to the
14863 value of &%bounce_return_size_limit%&). If this option is false, only the
14864 message header is included. In the case of a non-SMTP message containing an
14865 error that is detected during reception, only those header lines preceding the
14866 point at which the error was detected are returned.
14867 .cindex "bounce message" "including original"
14868
14869 .option bounce_return_linesize_limit main integer 998
14870 .cindex "size" "of bounce lines, limit"
14871 .cindex "bounce message" "line length limit"
14872 .cindex "limit" "bounce message line length"
14873 This option sets a limit in bytes on the line length of messages
14874 that are returned to senders due to delivery problems,
14875 when &%bounce_return_message%& is true.
14876 The default value corresponds to RFC limits.
14877 If the message being returned has lines longer than this value it is
14878 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14879
14880 The option also applies to bounces returned when an error is detected
14881 during reception of a message.
14882 In this case lines from the original are truncated.
14883
14884 The option does not apply to messages generated by an &(autoreply)& transport.
14885
14886
14887 .option bounce_return_message main boolean true
14888 If this option is set false, none of the original message is included in
14889 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14890 &%bounce_return_body%&.
14891
14892
14893 .option bounce_return_size_limit main integer 100K
14894 .cindex "size" "of bounce, limit"
14895 .cindex "bounce message" "size limit"
14896 .cindex "limit" "bounce message size"
14897 This option sets a limit in bytes on the size of messages that are returned to
14898 senders as part of bounce messages when &%bounce_return_message%& is true. The
14899 limit should be less than the value of the global &%message_size_limit%& and of
14900 any &%message_size_limit%& settings on transports, to allow for the bounce text
14901 that Exim generates. If this option is set to zero there is no limit.
14902
14903 When the body of any message that is to be included in a bounce message is
14904 greater than the limit, it is truncated, and a comment pointing this out is
14905 added at the top. The actual cutoff may be greater than the value given, owing
14906 to the use of buffering for transferring the message in chunks (typically 8K in
14907 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14908 messages.
14909
14910 .option bounce_sender_authentication main string unset
14911 .cindex "bounce message" "sender authentication"
14912 .cindex "authentication" "bounce message"
14913 .cindex "AUTH" "on bounce message"
14914 This option provides an authenticated sender address that is sent with any
14915 bounce messages generated by Exim that are sent over an authenticated SMTP
14916 connection. A typical setting might be:
14917 .code
14918 bounce_sender_authentication = mailer-daemon@my.domain.example
14919 .endd
14920 which would cause bounce messages to be sent using the SMTP command:
14921 .code
14922 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14923 .endd
14924 The value of &%bounce_sender_authentication%& must always be a complete email
14925 address.
14926
14927 .option callout_domain_negative_expire main time 3h
14928 .cindex "caching" "callout timeouts"
14929 .cindex "callout" "caching timeouts"
14930 This option specifies the expiry time for negative callout cache data for a
14931 domain. See section &<<SECTcallver>>& for details of callout verification, and
14932 section &<<SECTcallvercache>>& for details of the caching.
14933
14934
14935 .option callout_domain_positive_expire main time 7d
14936 This option specifies the expiry time for positive callout cache data for a
14937 domain. See section &<<SECTcallver>>& for details of callout verification, and
14938 section &<<SECTcallvercache>>& for details of the caching.
14939
14940
14941 .option callout_negative_expire main time 2h
14942 This option specifies the expiry time for negative callout cache data for an
14943 address. See section &<<SECTcallver>>& for details of callout verification, and
14944 section &<<SECTcallvercache>>& for details of the caching.
14945
14946
14947 .option callout_positive_expire main time 24h
14948 This option specifies the expiry time for positive callout cache data for an
14949 address. See section &<<SECTcallver>>& for details of callout verification, and
14950 section &<<SECTcallvercache>>& for details of the caching.
14951
14952
14953 .option callout_random_local_part main string&!! "see below"
14954 This option defines the &"random"& local part that can be used as part of
14955 callout verification. The default value is
14956 .code
14957 $primary_hostname-$tod_epoch-testing
14958 .endd
14959 See section &<<CALLaddparcall>>& for details of how this value is used.
14960
14961
14962 .option check_log_inodes main integer 100
14963 See &%check_spool_space%& below.
14964
14965
14966 .option check_log_space main integer 10M
14967 See &%check_spool_space%& below.
14968
14969 .oindex "&%check_rfc2047_length%&"
14970 .cindex "RFC 2047" "disabling length check"
14971 .option check_rfc2047_length main boolean true
14972 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14973 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14974 word; strings to be encoded that exceed this length are supposed to use
14975 multiple encoded words. By default, Exim does not recognize encoded words that
14976 exceed the maximum length. However, it seems that some software, in violation
14977 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14978 set false, Exim recognizes encoded words of any length.
14979
14980
14981 .option check_spool_inodes main integer 100
14982 See &%check_spool_space%& below.
14983
14984
14985 .option check_spool_space main integer 10M
14986 .cindex "checking disk space"
14987 .cindex "disk space, checking"
14988 .cindex "spool directory" "checking space"
14989 The four &%check_...%& options allow for checking of disk resources before a
14990 message is accepted.
14991
14992 .vindex "&$log_inodes$&"
14993 .vindex "&$log_space$&"
14994 .vindex "&$spool_inodes$&"
14995 .vindex "&$spool_space$&"
14996 When any of these options are nonzero, they apply to all incoming messages. If you
14997 want to apply different checks to different kinds of message, you can do so by
14998 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14999 &$spool_space$& in an ACL with appropriate additional conditions.
15000
15001
15002 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15003 either value is greater than zero, for example:
15004 .code
15005 check_spool_space = 100M
15006 check_spool_inodes = 100
15007 .endd
15008 The spool partition is the one that contains the directory defined by
15009 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15010 transit.
15011
15012 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15013 files are written if either is greater than zero. These should be set only if
15014 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15015
15016 If there is less space or fewer inodes than requested, Exim refuses to accept
15017 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15018 error response to the MAIL command. If ESMTP is in use and there was a
15019 SIZE parameter on the MAIL command, its value is added to the
15020 &%check_spool_space%& value, and the check is performed even if
15021 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15022
15023 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15024 number of kilobytes (though specified in bytes).
15025 If a non-multiple of 1024 is specified, it is rounded up.
15026
15027 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15028 failure a message is written to stderr and Exim exits with a non-zero code, as
15029 it obviously cannot send an error message of any kind.
15030
15031 There is a slight performance penalty for these checks.
15032 Versions of Exim preceding 4.88 had these disabled by default;
15033 high-rate installations confident they will never run out of resources
15034 may wish to deliberately disable them.
15035
15036 .option chunking_advertise_hosts main "host list&!!" *
15037 .cindex CHUNKING advertisement
15038 .cindex "RFC 3030" "CHUNKING"
15039 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15040 these hosts.
15041 Hosts may use the BDAT command as an alternate to DATA.
15042
15043 .option commandline_checks_require_admin main boolean &`false`&
15044 .cindex "restricting access to features"
15045 This option restricts various basic checking features to require an
15046 administrative user.
15047 This affects most of the &%-b*%& options, such as &%-be%&.
15048
15049 .option debug_store main boolean &`false`&
15050 .cindex debugging "memory corruption"
15051 .cindex memory debugging
15052 This option, when true, enables extra checking in Exim's internal memory
15053 management.  For use when a memory corruption issue is being investigated,
15054 it should normally be left as default.
15055
15056 .option daemon_smtp_ports main string &`smtp`&
15057 .cindex "port" "for daemon"
15058 .cindex "TCP/IP" "setting listening ports"
15059 This option specifies one or more default SMTP ports on which the Exim daemon
15060 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15061 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15062
15063 .option daemon_startup_retries main integer 9
15064 .cindex "daemon startup, retrying"
15065 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15066 the daemon at startup when it cannot immediately bind a listening socket
15067 (typically because the socket is already in use): &%daemon_startup_retries%&
15068 defines the number of retries after the first failure, and
15069 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15070
15071 .option daemon_startup_sleep main time 30s
15072 See &%daemon_startup_retries%&.
15073
15074 .option delay_warning main "time list" 24h
15075 .cindex "warning of delay"
15076 .cindex "delay warning, specifying"
15077 .cindex "queue" "delay warning"
15078 When a message is delayed, Exim sends a warning message to the sender at
15079 intervals specified by this option. The data is a colon-separated list of times
15080 after which to send warning messages. If the value of the option is an empty
15081 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15082 message has been in the queue for longer than the last time, the last interval
15083 between the times is used to compute subsequent warning times. For example,
15084 with
15085 .code
15086 delay_warning = 4h:8h:24h
15087 .endd
15088 the first message is sent after 4 hours, the second after 8 hours, and
15089 the third one after 24 hours. After that, messages are sent every 16 hours,
15090 because that is the interval between the last two times on the list. If you set
15091 just one time, it specifies the repeat interval. For example, with:
15092 .code
15093 delay_warning = 6h
15094 .endd
15095 messages are repeated every six hours. To stop warnings after a given time, set
15096 a very large time at the end of the list. For example:
15097 .code
15098 delay_warning = 2h:12h:99d
15099 .endd
15100 Note that the option is only evaluated at the time a delivery attempt fails,
15101 which depends on retry and queue-runner configuration.
15102 Typically retries will be configured more frequently than warning messages.
15103
15104 .option delay_warning_condition main string&!! "see below"
15105 .vindex "&$domain$&"
15106 The string is expanded at the time a warning message might be sent. If all the
15107 deferred addresses have the same domain, it is set in &$domain$& during the
15108 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15109 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15110 &"false"& (the comparison being done caselessly) then the warning message is
15111 not sent. The default is:
15112 .code
15113 delay_warning_condition = ${if or {\
15114   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15115   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15116   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15117   } {no}{yes}}
15118 .endd
15119 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15120 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15121 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15122 &"auto-replied"& in an &'Auto-Submitted:'& header.
15123
15124 .option deliver_drop_privilege main boolean false
15125 .cindex "unprivileged delivery"
15126 .cindex "delivery" "unprivileged"
15127 If this option is set true, Exim drops its root privilege at the start of a
15128 delivery process, and runs as the Exim user throughout. This severely restricts
15129 the kinds of local delivery that are possible, but is viable in certain types
15130 of configuration. There is a discussion about the use of root privilege in
15131 chapter &<<CHAPsecurity>>&.
15132
15133 .option deliver_queue_load_max main fixed-point unset
15134 .cindex "load average"
15135 .cindex "queue runner" "abandoning"
15136 When this option is set, a queue run is abandoned if the system load average
15137 becomes greater than the value of the option. The option has no effect on
15138 ancient operating systems on which Exim cannot determine the load average.
15139 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15140
15141
15142 .option delivery_date_remove main boolean true
15143 .cindex "&'Delivery-date:'& header line"
15144 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15145 message when it is delivered, in exactly the same way as &'Return-path:'& is
15146 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15147 should not be present in incoming messages, and this option causes them to be
15148 removed at the time the message is received, to avoid any problems that might
15149 occur when a delivered message is subsequently sent on to some other recipient.
15150
15151 .option disable_fsync main boolean false
15152 .cindex "&[fsync()]&, disabling"
15153 This option is available only if Exim was built with the compile-time option
15154 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15155 a runtime configuration generates an &"unknown option"& error. You should not
15156 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15157 really, really, really understand what you are doing. &'No pre-compiled
15158 distributions of Exim should ever make this option available.'&
15159
15160 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15161 updated files' data to be written to disc before continuing. Unexpected events
15162 such as crashes and power outages may cause data to be lost or scrambled.
15163 Here be Dragons. &*Beware.*&
15164
15165
15166 .option disable_ipv6 main boolean false
15167 .cindex "IPv6" "disabling"
15168 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15169 activities take place. AAAA records are never looked up, and any IPv6 addresses
15170 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15171 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15172 to handle IPv6 literal addresses.
15173
15174
15175 .new
15176 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15177 .cindex DKIM "selecting signature algorithms"
15178 This option gives a list of hash types which are acceptable in signatures,
15179 .wen
15180 and an order of processing.
15181 Signatures with algorithms not in the list will be ignored.
15182
15183 Acceptable values include:
15184 .code
15185 sha1
15186 sha256
15187 sha512
15188 .endd
15189
15190 Note that the acceptance of sha1 violates RFC 8301.
15191
15192 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15193 This option gives a list of key types which are acceptable in signatures,
15194 and an order of processing.
15195 Signatures with algorithms not in the list will be ignored.
15196
15197 .option dkim_verify_minimal main boolean false
15198 If set to true, verification of signatures will terminate after the
15199 first success.
15200
15201 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15202 .cindex DKIM "controlling calls to the ACL"
15203 This option gives a list of DKIM domains for which the DKIM ACL is run.
15204 It is expanded after the message is received; by default it runs
15205 the ACL once for each signature in the message.
15206 See section &<<SECDKIMVFY>>&.
15207
15208
15209 .option dns_again_means_nonexist main "domain list&!!" unset
15210 .cindex "DNS" "&""try again""& response; overriding"
15211 DNS lookups give a &"try again"& response for the DNS errors
15212 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15213 keep trying to deliver a message, or to give repeated temporary errors to
15214 incoming mail. Sometimes the effect is caused by a badly set up name server and
15215 may persist for a long time. If a domain which exhibits this problem matches
15216 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15217 This option should be used with care. You can make it apply to reverse lookups
15218 by a setting such as this:
15219 .code
15220 dns_again_means_nonexist = *.in-addr.arpa
15221 .endd
15222 This option applies to all DNS lookups that Exim does. It also applies when the
15223 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15224 since these are most likely to be caused by DNS lookup problems. The
15225 &(dnslookup)& router has some options of its own for controlling what happens
15226 when lookups for MX or SRV records give temporary errors. These more specific
15227 options are applied after this global option.
15228
15229 .option dns_check_names_pattern main string "see below"
15230 .cindex "DNS" "pre-check of name syntax"
15231 When this option is set to a non-empty string, it causes Exim to check domain
15232 names for characters that are not allowed in host names before handing them to
15233 the DNS resolver, because some resolvers give temporary errors for names that
15234 contain unusual characters. If a domain name contains any unwanted characters,
15235 a &"not found"& result is forced, and the resolver is not called. The check is
15236 done by matching the domain name against a regular expression, which is the
15237 value of this option. The default pattern is
15238 .code
15239 dns_check_names_pattern = \
15240   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15241 .endd
15242 which permits only letters, digits, slashes, and hyphens in components, but
15243 they must start and end with a letter or digit. Slashes are not, in fact,
15244 permitted in host names, but they are found in certain NS records (which can be
15245 accessed in Exim by using a &%dnsdb%& lookup). If you set
15246 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15247 empty string.
15248
15249 .option dns_csa_search_limit main integer 5
15250 This option controls the depth of parental searching for CSA SRV records in the
15251 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15252
15253 .option dns_csa_use_reverse main boolean true
15254 This option controls whether or not an IP address, given as a CSA domain, is
15255 reversed and looked up in the reverse DNS, as described in more detail in
15256 section &<<SECTverifyCSA>>&.
15257
15258 .option dns_cname_loops main integer 1
15259 .cindex DNS "CNAME following"
15260 This option controls the following of CNAME chains, needed if the resolver does
15261 not do it internally.
15262 As of 2018 most should, and the default can be left.
15263 If you have an ancient one, a value of 10 is likely needed.
15264
15265 The default value of one CNAME-follow is needed
15266 thanks to the observed return for an MX request,
15267 given no MX presence but a CNAME to an A, of the CNAME.
15268
15269
15270 .option dns_dnssec_ok main integer -1
15271 .cindex "DNS" "resolver options"
15272 .cindex "DNS" "DNSSEC"
15273 If this option is set to a non-negative number then Exim will initialise the
15274 DNS resolver library to either use or not use DNSSEC, overriding the system
15275 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15276
15277 If the resolver library does not support DNSSEC then this option has no effect.
15278
15279
15280 .option dns_ipv4_lookup main "domain list&!!" unset
15281 .cindex "IPv6" "DNS lookup for AAAA records"
15282 .cindex "DNS" "IPv6 lookup for AAAA records"
15283 .cindex DNS "IPv6 disabling"
15284 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15285 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15286 (A records) when trying to find IP addresses for hosts, unless the host's
15287 domain matches this list.
15288
15289 This is a fudge to help with name servers that give big delays or otherwise do
15290 not work for the AAAA record type. In due course, when the world's name
15291 servers have all been upgraded, there should be no need for this option.
15292 Note that all lookups, including those done for verification, are affected;
15293 this will result in verify failure for IPv6 connections or ones using names
15294 only valid for IPv6 addresses.
15295
15296
15297 .option dns_retrans main time 0s
15298 .cindex "DNS" "resolver options"
15299 .cindex timeout "dns lookup"
15300 .cindex "DNS" timeout
15301 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15302 retransmission and retry parameters for DNS lookups. Values of zero (the
15303 defaults) leave the system default settings unchanged. The first value is the
15304 time between retries, and the second is the number of retries. It isn't
15305 totally clear exactly how these settings affect the total time a DNS lookup may
15306 take. I haven't found any documentation about timeouts on DNS lookups; these
15307 parameter values are available in the external resolver interface structure,
15308 but nowhere does it seem to describe how they are used or what you might want
15309 to set in them.
15310 See also the &%slow_lookup_log%& option.
15311
15312
15313 .option dns_retry main integer 0
15314 See &%dns_retrans%& above.
15315
15316
15317 .option dns_trust_aa main "domain list&!!" unset
15318 .cindex "DNS" "resolver options"
15319 .cindex "DNS" "DNSSEC"
15320 If this option is set then lookup results marked with the AA bit
15321 (Authoritative Answer) are trusted the same way as if they were
15322 DNSSEC-verified. The authority section's name of the answer must
15323 match with this expanded domain list.
15324
15325 Use this option only if you talk directly to a resolver that is
15326 authoritative for some zones and does not set the AD (Authentic Data)
15327 bit in the answer. Some DNS servers may have an configuration option to
15328 mark the answers from their own zones as verified (they set the AD bit).
15329 Others do not have this option. It is considered as poor practice using
15330 a resolver that is an authoritative server for some zones.
15331
15332 Use this option only if you really have to (e.g. if you want
15333 to use DANE for remote delivery to a server that is listed in the DNS
15334 zones that your resolver is authoritative for).
15335
15336 If the DNS answer packet has the AA bit set and contains resource record
15337 in the answer section, the name of the first NS record appearing in the
15338 authority section is compared against the list. If the answer packet is
15339 authoritative but the answer section is empty, the name of the first SOA
15340 record in the authoritative section is used instead.
15341
15342 .cindex "DNS" "resolver options"
15343 .option dns_use_edns0 main integer -1
15344 .cindex "DNS" "resolver options"
15345 .cindex "DNS" "EDNS0"
15346 .cindex "DNS" "OpenBSD
15347 If this option is set to a non-negative number then Exim will initialise the
15348 DNS resolver library to either use or not use EDNS0 extensions, overriding
15349 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15350 on.
15351
15352 If the resolver library does not support EDNS0 then this option has no effect.
15353
15354 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15355 means that DNSSEC will not work with Exim on that platform either, unless Exim
15356 is linked against an alternative DNS client library.
15357
15358
15359 .option drop_cr main boolean false
15360 This is an obsolete option that is now a no-op. It used to affect the way Exim
15361 handled CR and LF characters in incoming messages. What happens now is
15362 described in section &<<SECTlineendings>>&.
15363
15364 .option dsn_advertise_hosts main "host list&!!" unset
15365 .cindex "bounce messages" "success"
15366 .cindex "DSN" "success"
15367 .cindex "Delivery Status Notification" "success"
15368 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15369 and accepted from, these hosts.
15370 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15371 and RET and ORCPT options on MAIL FROM commands.
15372 A NOTIFY=SUCCESS option requests success-DSN messages.
15373 A NOTIFY= option with no argument requests that no delay or failure DSNs
15374 are sent.
15375
15376 .option dsn_from main "string&!!" "see below"
15377 .cindex "&'From:'& header line" "in bounces"
15378 .cindex "bounce messages" "&'From:'& line, specifying"
15379 This option can be used to vary the contents of &'From:'& header lines in
15380 bounces and other automatically generated messages (&"Delivery Status
15381 Notifications"& &-- hence the name of the option). The default setting is:
15382 .code
15383 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15384 .endd
15385 The value is expanded every time it is needed. If the expansion fails, a
15386 panic is logged, and the default value is used.
15387
15388 .option envelope_to_remove main boolean true
15389 .cindex "&'Envelope-to:'& header line"
15390 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15391 message when it is delivered, in exactly the same way as &'Return-path:'& is
15392 handled. &'Envelope-to:'& records the original recipient address from the
15393 message's envelope that caused the delivery to happen. Such headers should not
15394 be present in incoming messages, and this option causes them to be removed at
15395 the time the message is received, to avoid any problems that might occur when a
15396 delivered message is subsequently sent on to some other recipient.
15397
15398
15399 .option errors_copy main "string list&!!" unset
15400 .cindex "bounce message" "copy to other address"
15401 .cindex "copy of bounce message"
15402 Setting this option causes Exim to send bcc copies of bounce messages that it
15403 generates to other addresses. &*Note*&: This does not apply to bounce messages
15404 coming from elsewhere. The value of the option is a colon-separated list of
15405 items. Each item consists of a pattern, terminated by white space, followed by
15406 a comma-separated list of email addresses. If a pattern contains spaces, it
15407 must be enclosed in double quotes.
15408
15409 Each pattern is processed in the same way as a single item in an address list
15410 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15411 the bounce message, the message is copied to the addresses on the list. The
15412 items are scanned in order, and once a matching one is found, no further items
15413 are examined. For example:
15414 .code
15415 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15416               rqps@mydomain   hostmaster@mydomain.example,\
15417                               postmaster@mydomain.example
15418 .endd
15419 .vindex "&$domain$&"
15420 .vindex "&$local_part$&"
15421 The address list is expanded before use. The expansion variables &$local_part$&
15422 and &$domain$& are set from the original recipient of the error message, and if
15423 there was any wildcard matching in the pattern, the expansion
15424 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15425 variables &$0$&, &$1$&, etc. are set in the normal way.
15426
15427
15428 .option errors_reply_to main string unset
15429 .cindex "bounce message" "&'Reply-to:'& in"
15430 By default, Exim's bounce and delivery warning messages contain the header line
15431 .display
15432 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15433 .endd
15434 .oindex &%quota_warn_message%&
15435 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15436 A warning message that is generated by the &%quota_warn_message%& option in an
15437 &(appendfile)& transport may contain its own &'From:'& header line that
15438 overrides the default.
15439
15440 Experience shows that people reply to bounce messages. If the
15441 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15442 and warning messages. For example:
15443 .code
15444 errors_reply_to = postmaster@my.domain.example
15445 .endd
15446 The value of the option is not expanded. It must specify a valid RFC 2822
15447 address. However, if a warning message that is generated by the
15448 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15449 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15450 not used.
15451
15452
15453 .option event_action main string&!! unset
15454 .cindex events
15455 This option declares a string to be expanded for Exim's events mechanism.
15456 For details see chapter &<<CHAPevents>>&.
15457
15458
15459 .option exim_group main string "compile-time configured"
15460 .cindex "gid (group id)" "Exim's own"
15461 .cindex "Exim group"
15462 This option changes the gid under which Exim runs when it gives up root
15463 privilege. The default value is compiled into the binary. The value of this
15464 option is used only when &%exim_user%& is also set. Unless it consists entirely
15465 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15466 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15467 security issues.
15468
15469
15470 .option exim_path main string "see below"
15471 .cindex "Exim binary, path name"
15472 This option specifies the path name of the Exim binary, which is used when Exim
15473 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15474 the directory configured at compile time by the BIN_DIRECTORY setting. It
15475 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15476 other place.
15477 &*Warning*&: Do not use a macro to define the value of this option, because
15478 you will break those Exim utilities that scan the configuration file to find
15479 where the binary is. (They then use the &%-bP%& option to extract option
15480 settings such as the value of &%spool_directory%&.)
15481
15482
15483 .option exim_user main string "compile-time configured"
15484 .cindex "uid (user id)" "Exim's own"
15485 .cindex "Exim user"
15486 This option changes the uid under which Exim runs when it gives up root
15487 privilege. The default value is compiled into the binary. Ownership of the run
15488 time configuration file and the use of the &%-C%& and &%-D%& command line
15489 options is checked against the values in the binary, not what is set here.
15490
15491 Unless it consists entirely of digits, the string is looked up using
15492 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15493 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15494 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15495
15496
15497 .option exim_version main string "current version"
15498 .cindex "Exim version"
15499 .cindex customizing "version number"
15500 .cindex "version number of Exim" override
15501 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15502 various places.  Use with care; this may fool stupid security scanners.
15503
15504
15505 .option extra_local_interfaces main "string list" unset
15506 This option defines network interfaces that are to be considered local when
15507 routing, but which are not used for listening by the daemon. See section
15508 &<<SECTreclocipadd>>& for details.
15509
15510
15511 . Allow this long option name to split; give it unsplit as a fifth argument
15512 . for the automatic .oindex that is generated by .option.
15513
15514 .option "extract_addresses_remove_arguments" main boolean true &&&
15515          extract_addresses_remove_arguments
15516 .oindex "&%-t%&"
15517 .cindex "command line" "addresses with &%-t%&"
15518 .cindex "Sendmail compatibility" "&%-t%& option"
15519 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15520 are present on the command line when the &%-t%& option is used to build an
15521 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15522 line addresses are removed from the recipients list. This is also how Smail
15523 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15524 command line addresses are added to those obtained from the header lines. When
15525 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15526 argument headers. If it is set false, Exim adds rather than removes argument
15527 addresses.
15528
15529
15530 .option finduser_retries main integer 0
15531 .cindex "NIS, retrying user lookups"
15532 On systems running NIS or other schemes in which user and group information is
15533 distributed from a remote system, there can be times when &[getpwnam()]& and
15534 related functions fail, even when given valid data, because things time out.
15535 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15536 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15537 many extra times to find a user or a group, waiting for one second between
15538 retries.
15539
15540 .cindex "&_/etc/passwd_&" "multiple reading of"
15541 You should not set this option greater than zero if your user information is in
15542 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15543 search the file multiple times for non-existent users, and also cause delay.
15544
15545
15546
15547 .option freeze_tell main "string list, comma separated" unset
15548 .cindex "freezing messages" "sending a message when freezing"
15549 On encountering certain errors, or when configured to do so in a system filter,
15550 ACL, or special router, Exim freezes a message. This means that no further
15551 delivery attempts take place until an administrator thaws the message, or the
15552 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15553 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15554 warning message whenever it freezes something, unless the message it is
15555 freezing is a locally-generated bounce message. (Without this exception there
15556 is the possibility of looping.) The warning message is sent to the addresses
15557 supplied as the comma-separated value of this option. If several of the
15558 message's addresses cause freezing, only a single message is sent. If the
15559 freezing was automatic, the reason(s) for freezing can be found in the message
15560 log. If you configure freezing in a filter or ACL, you must arrange for any
15561 logging that you require.
15562
15563
15564 .option gecos_name main string&!! unset
15565 .cindex "HP-UX"
15566 .cindex "&""gecos""& field, parsing"
15567 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15568 password file to hold other information in addition to users' real names. Exim
15569 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15570 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15571 of the field are used unchanged, except that, if an ampersand is encountered,
15572 it is replaced by the user's login name with the first character forced to
15573 upper case, since this is a convention that is observed on many systems.
15574
15575 When these options are set, &%gecos_pattern%& is treated as a regular
15576 expression that is to be applied to the field (again with && replaced by the
15577 login name), and if it matches, &%gecos_name%& is expanded and used as the
15578 user's name.
15579
15580 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15581 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15582 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15583 name terminates at the first comma, the following can be used:
15584 .code
15585 gecos_pattern = ([^,]*)
15586 gecos_name = $1
15587 .endd
15588
15589 .option gecos_pattern main string unset
15590 See &%gecos_name%& above.
15591
15592
15593 .option gnutls_compat_mode main boolean unset
15594 This option controls whether GnuTLS is used in compatibility mode in an Exim
15595 server. This reduces security slightly, but improves interworking with older
15596 implementations of TLS.
15597
15598
15599 .option gnutls_allow_auto_pkcs11 main boolean unset
15600 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15601 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15602
15603 See
15604 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15605 for documentation.
15606
15607
15608
15609 .option headers_charset main string "see below"
15610 This option sets a default character set for translating from encoded MIME
15611 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15612 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15613 ultimate default is ISO-8859-1. For more details see the description of header
15614 insertions in section &<<SECTexpansionitems>>&.
15615
15616
15617
15618 .option header_maxsize main integer "see below"
15619 .cindex "header section" "maximum size of"
15620 .cindex "limit" "size of message header section"
15621 This option controls the overall maximum size of a message's header
15622 section. The default is the value of HEADER_MAXSIZE in
15623 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15624 sections are rejected.
15625
15626
15627 .option header_line_maxsize main integer 0
15628 .cindex "header lines" "maximum size of"
15629 .cindex "limit" "size of one header line"
15630 This option limits the length of any individual header line in a message, after
15631 all the continuations have been joined together. Messages with individual
15632 header lines that are longer than the limit are rejected. The default value of
15633 zero means &"no limit"&.
15634
15635
15636
15637
15638 .option helo_accept_junk_hosts main "host list&!!" unset
15639 .cindex "HELO" "accepting junk data"
15640 .cindex "EHLO" "accepting junk data"
15641 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15642 mail, and gives an error response for invalid data. Unfortunately, there are
15643 some SMTP clients that send syntactic junk. They can be accommodated by setting
15644 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15645 if you want to do semantic checking.
15646 See also &%helo_allow_chars%& for a way of extending the permitted character
15647 set.
15648
15649
15650 .option helo_allow_chars main string unset
15651 .cindex "HELO" "underscores in"
15652 .cindex "EHLO" "underscores in"
15653 .cindex "underscore in EHLO/HELO"
15654 This option can be set to a string of rogue characters that are permitted in
15655 all EHLO and HELO names in addition to the standard letters, digits,
15656 hyphens, and dots. If you really must allow underscores, you can set
15657 .code
15658 helo_allow_chars = _
15659 .endd
15660 Note that the value is one string, not a list.
15661
15662
15663 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15664 .cindex "HELO" "forcing reverse lookup"
15665 .cindex "EHLO" "forcing reverse lookup"
15666 If the domain given by a client in a HELO or EHLO command matches this
15667 list, a reverse lookup is done in order to establish the host's true name. The
15668 default forces a lookup if the client host gives the server's name or any of
15669 its IP addresses (in brackets), something that broken clients have been seen to
15670 do.
15671
15672
15673 .option helo_try_verify_hosts main "host list&!!" unset
15674 .cindex "HELO verifying" "optional"
15675 .cindex "EHLO" "verifying, optional"
15676 By default, Exim just checks the syntax of HELO and EHLO commands (see
15677 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15678 to do more extensive checking of the data supplied by these commands. The ACL
15679 condition &`verify = helo`& is provided to make this possible.
15680 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15681 to force the check to occur. From release 4.53 onwards, this is no longer
15682 necessary. If the check has not been done before &`verify = helo`& is
15683 encountered, it is done at that time. Consequently, this option is obsolete.
15684 Its specification is retained here for backwards compatibility.
15685
15686 When an EHLO or HELO command is received, if the calling host matches
15687 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15688 EHLO command either:
15689
15690 .ilist
15691 is an IP literal matching the calling address of the host, or
15692 .next
15693 .cindex "DNS" "reverse lookup"
15694 .cindex "reverse DNS lookup"
15695 matches the host name that Exim obtains by doing a reverse lookup of the
15696 calling host address, or
15697 .next
15698 when looked up in DNS yields the calling host address.
15699 .endlist
15700
15701 However, the EHLO or HELO command is not rejected if any of the checks
15702 fail. Processing continues, but the result of the check is remembered, and can
15703 be detected later in an ACL by the &`verify = helo`& condition.
15704
15705 If DNS was used for successful verification, the variable
15706 .cindex "DNS" "DNSSEC"
15707 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15708
15709 .option helo_verify_hosts main "host list&!!" unset
15710 .cindex "HELO verifying" "mandatory"
15711 .cindex "EHLO" "verifying, mandatory"
15712 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15713 backwards compatibility. For hosts that match this option, Exim checks the host
15714 name given in the HELO or EHLO in the same way as for
15715 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15716 rejected with a 550 error, and entries are written to the main and reject logs.
15717 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15718 error.
15719
15720 .option hold_domains main "domain list&!!" unset
15721 .cindex "domain" "delaying delivery"
15722 .cindex "delivery" "delaying certain domains"
15723 This option allows mail for particular domains to be held in the queue
15724 manually. The option is overridden if a message delivery is forced with the
15725 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15726 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15727 item in &%hold_domains%&, no routing or delivery for that address is done, and
15728 it is deferred every time the message is looked at.
15729
15730 This option is intended as a temporary operational measure for delaying the
15731 delivery of mail while some problem is being sorted out, or some new
15732 configuration tested. If you just want to delay the processing of some
15733 domains until a queue run occurs, you should use &%queue_domains%& or
15734 &%queue_smtp_domains%&, not &%hold_domains%&.
15735
15736 A setting of &%hold_domains%& does not override Exim's code for removing
15737 messages from the queue if they have been there longer than the longest retry
15738 time in any retry rule. If you want to hold messages for longer than the normal
15739 retry times, insert a dummy retry rule with a long retry time.
15740
15741
15742 .option host_lookup main "host list&!!" unset
15743 .cindex "host name" "lookup, forcing"
15744 Exim does not look up the name of a calling host from its IP address unless it
15745 is required to compare against some host list, or the host matches
15746 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15747 option (which normally contains IP addresses rather than host names). The
15748 default configuration file contains
15749 .code
15750 host_lookup = *
15751 .endd
15752 which causes a lookup to happen for all hosts. If the expense of these lookups
15753 is felt to be too great, the setting can be changed or removed.
15754
15755 After a successful reverse lookup, Exim does a forward lookup on the name it
15756 has obtained, to verify that it yields the IP address that it started with. If
15757 this check fails, Exim behaves as if the name lookup failed.
15758
15759 .vindex "&$host_lookup_failed$&"
15760 .vindex "&$sender_host_name$&"
15761 After any kind of failure, the host name (in &$sender_host_name$&) remains
15762 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15763 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15764 &`verify = reverse_host_lookup`& in ACLs.
15765
15766
15767 .option host_lookup_order main "string list" &`bydns:byaddr`&
15768 This option specifies the order of different lookup methods when Exim is trying
15769 to find a host name from an IP address. The default is to do a DNS lookup
15770 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15771 if that fails. You can change the order of these lookups, or omit one entirely,
15772 if you want.
15773
15774 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15775 multiple PTR records in the DNS and the IP address is not listed in
15776 &_/etc/hosts_&. Different operating systems give different results in this
15777 case. That is why the default tries a DNS lookup first.
15778
15779
15780
15781 .option host_reject_connection main "host list&!!" unset
15782 .cindex "host" "rejecting connections from"
15783 If this option is set, incoming SMTP calls from the hosts listed are rejected
15784 as soon as the connection is made.
15785 This option is obsolete, and retained only for backward compatibility, because
15786 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15787 connections immediately.
15788
15789 The ability to give an immediate rejection (either by this option or using an
15790 ACL) is provided for use in unusual cases. Many hosts will just try again,
15791 sometimes without much delay. Normally, it is better to use an ACL to reject
15792 incoming messages at a later stage, such as after RCPT commands. See
15793 chapter &<<CHAPACL>>&.
15794
15795
15796 .option hosts_connection_nolog main "host list&!!" unset
15797 .cindex "host" "not logging connections from"
15798 This option defines a list of hosts for which connection logging does not
15799 happen, even though the &%smtp_connection%& log selector is set. For example,
15800 you might want not to log SMTP connections from local processes, or from
15801 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15802 the daemon; you should therefore strive to restrict its value to a short inline
15803 list of IP addresses and networks. To disable logging SMTP connections from
15804 local processes, you must create a host list with an empty item. For example:
15805 .code
15806 hosts_connection_nolog = :
15807 .endd
15808 If the &%smtp_connection%& log selector is not set, this option has no effect.
15809
15810
15811
15812 .option hosts_proxy main "host list&!!" unset
15813 .cindex proxy "proxy protocol"
15814 This option enables use of Proxy Protocol proxies for incoming
15815 connections.  For details see section &<<SECTproxyInbound>>&.
15816
15817
15818 .option hosts_treat_as_local main "domain list&!!" unset
15819 .cindex "local host" "domains treated as"
15820 .cindex "host" "treated as local"
15821 If this option is set, any host names that match the domain list are treated as
15822 if they were the local host when Exim is scanning host lists obtained from MX
15823 records
15824 or other sources. Note that the value of this option is a domain list, not a
15825 host list, because it is always used to check host names, not IP addresses.
15826
15827 This option also applies when Exim is matching the special items
15828 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15829 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15830 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15831 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15832 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15833 interfaces and recognizing the local host.
15834
15835
15836 .option ibase_servers main "string list" unset
15837 .cindex "InterBase" "server list"
15838 This option provides a list of InterBase servers and associated connection data,
15839 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15840 The option is available only if Exim has been built with InterBase support.
15841
15842
15843
15844 .option ignore_bounce_errors_after main time 10w
15845 .cindex "bounce message" "discarding"
15846 .cindex "discarding bounce message"
15847 This option affects the processing of bounce messages that cannot be delivered,
15848 that is, those that suffer a permanent delivery failure. (Bounce messages that
15849 suffer temporary delivery failures are of course retried in the usual way.)
15850
15851 After a permanent delivery failure, bounce messages are frozen,
15852 because there is no sender to whom they can be returned. When a frozen bounce
15853 message has been in the queue for more than the given time, it is unfrozen at
15854 the next queue run, and a further delivery is attempted. If delivery fails
15855 again, the bounce message is discarded. This makes it possible to keep failed
15856 bounce messages around for a shorter time than the normal maximum retry time
15857 for frozen messages. For example,
15858 .code
15859 ignore_bounce_errors_after = 12h
15860 .endd
15861 retries failed bounce message deliveries after 12 hours, discarding any further
15862 failures. If the value of this option is set to a zero time period, bounce
15863 failures are discarded immediately. Setting a very long time (as in the default
15864 value) has the effect of disabling this option. For ways of automatically
15865 dealing with other kinds of frozen message, see &%auto_thaw%& and
15866 &%timeout_frozen_after%&.
15867
15868
15869 .option ignore_fromline_hosts main "host list&!!" unset
15870 .cindex "&""From""& line"
15871 .cindex "UUCP" "&""From""& line"
15872 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15873 the headers of a message. By default this is treated as the start of the
15874 message's body, which means that any following headers are not recognized as
15875 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15876 match those hosts that insist on sending it. If the sender is actually a local
15877 process rather than a remote host, and is using &%-bs%& to inject the messages,
15878 &%ignore_fromline_local%& must be set to achieve this effect.
15879
15880
15881 .option ignore_fromline_local main boolean false
15882 See &%ignore_fromline_hosts%& above.
15883
15884 .option keep_environment main "string list" unset
15885 .cindex "environment" "values from"
15886 This option contains a string list of environment variables to keep.
15887 You have to trust these variables or you have to be sure that
15888 these variables do not impose any security risk. Keep in mind that
15889 during the startup phase Exim is running with an effective UID 0 in most
15890 installations. As the default value is an empty list, the default
15891 environment for using libraries, running embedded Perl code, or running
15892 external binaries is empty, and does not not even contain PATH or HOME.
15893
15894 Actually the list is interpreted as a list of patterns
15895 (&<<SECTlistexpand>>&), except that it is not expanded first.
15896
15897 WARNING: Macro substitution is still done first, so having a macro
15898 FOO and having FOO_HOME in your &%keep_environment%& option may have
15899 unexpected results. You may work around this using a regular expression
15900 that does not match the macro name: ^[F]OO_HOME$.
15901
15902 Current versions of Exim issue a warning during startup if you do not mention
15903 &%keep_environment%& in your runtime configuration file and if your
15904 current environment is not empty. Future versions may not issue that warning
15905 anymore.
15906
15907 See the &%add_environment%& main config option for a way to set
15908 environment variables to a fixed value.  The environment for &(pipe)&
15909 transports is handled separately, see section &<<SECTpipeenv>>& for
15910 details.
15911
15912
15913 .option keep_malformed main time 4d
15914 This option specifies the length of time to keep messages whose spool files
15915 have been corrupted in some way. This should, of course, never happen. At the
15916 next attempt to deliver such a message, it gets removed. The incident is
15917 logged.
15918
15919
15920 .option ldap_ca_cert_dir main string unset
15921 .cindex "LDAP", "TLS CA certificate directory"
15922 .cindex certificate "directory for LDAP"
15923 This option indicates which directory contains CA certificates for verifying
15924 a TLS certificate presented by an LDAP server.
15925 While Exim does not provide a default value, your SSL library may.
15926 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15927 and constrained to be a directory.
15928
15929
15930 .option ldap_ca_cert_file main string unset
15931 .cindex "LDAP", "TLS CA certificate file"
15932 .cindex certificate "file for LDAP"
15933 This option indicates which file contains CA certificates for verifying
15934 a TLS certificate presented by an LDAP server.
15935 While Exim does not provide a default value, your SSL library may.
15936 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15937 and constrained to be a file.
15938
15939
15940 .option ldap_cert_file main string unset
15941 .cindex "LDAP" "TLS client certificate file"
15942 .cindex certificate "file for LDAP"
15943 This option indicates which file contains an TLS client certificate which
15944 Exim should present to the LDAP server during TLS negotiation.
15945 Should be used together with &%ldap_cert_key%&.
15946
15947
15948 .option ldap_cert_key main string unset
15949 .cindex "LDAP" "TLS client key file"
15950 .cindex certificate "key for LDAP"
15951 This option indicates which file contains the secret/private key to use
15952 to prove identity to the LDAP server during TLS negotiation.
15953 Should be used together with &%ldap_cert_file%&, which contains the
15954 identity to be proven.
15955
15956
15957 .option ldap_cipher_suite main string unset
15958 .cindex "LDAP" "TLS cipher suite"
15959 This controls the TLS cipher-suite negotiation during TLS negotiation with
15960 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15961 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15962
15963
15964 .option ldap_default_servers main "string list" unset
15965 .cindex "LDAP" "default servers"
15966 This option provides a list of LDAP servers which are tried in turn when an
15967 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15968 details of LDAP queries. This option is available only when Exim has been built
15969 with LDAP support.
15970
15971
15972 .option ldap_require_cert main string unset.
15973 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15974 This should be one of the values "hard", "demand", "allow", "try" or "never".
15975 A value other than one of these is interpreted as "never".
15976 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15977 Although Exim does not set a default, the LDAP library probably defaults
15978 to hard/demand.
15979
15980
15981 .option ldap_start_tls main boolean false
15982 .cindex "LDAP" "whether or not to negotiate TLS"
15983 If set, Exim will attempt to negotiate TLS with the LDAP server when
15984 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15985 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15986 of SSL-on-connect.
15987 In the event of failure to negotiate TLS, the action taken is controlled
15988 by &%ldap_require_cert%&.
15989 This option is ignored for &`ldapi`& connections.
15990
15991
15992 .option ldap_version main integer unset
15993 .cindex "LDAP" "protocol version, forcing"
15994 This option can be used to force Exim to set a specific protocol version for
15995 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15996 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15997 the LDAP headers; otherwise it is 2. This option is available only when Exim
15998 has been built with LDAP support.
15999
16000
16001
16002 .option local_from_check main boolean true
16003 .cindex "&'Sender:'& header line" "disabling addition of"
16004 .cindex "&'From:'& header line" "disabling checking of"
16005 When a message is submitted locally (that is, not over a TCP/IP connection) by
16006 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16007 checks that the &'From:'& header line matches the login of the calling user and
16008 the domain specified by &%qualify_domain%&.
16009
16010 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16011 locally submitted message is automatically qualified by Exim, unless the
16012 &%-bnq%& command line option is used.
16013
16014 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16015 on the local part. If the &'From:'& header line does not match, Exim adds a
16016 &'Sender:'& header with an address constructed from the calling user's login
16017 and the default qualify domain.
16018
16019 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16020 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16021 &'Sender:'& header lines supplied by untrusted users, you must also set
16022 &%local_sender_retain%& to be true.
16023
16024 .cindex "envelope from"
16025 .cindex "envelope sender"
16026 These options affect only the header lines in the message. The envelope sender
16027 is still forced to be the login id at the qualify domain unless
16028 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16029
16030 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16031 request similar header line checking. See section &<<SECTthesenhea>>&, which
16032 has more details about &'Sender:'& processing.
16033
16034
16035
16036
16037 .option local_from_prefix main string unset
16038 When Exim checks the &'From:'& header line of locally submitted messages for
16039 matching the login id (see &%local_from_check%& above), it can be configured to
16040 ignore certain prefixes and suffixes in the local part of the address. This is
16041 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16042 appropriate lists, in the same form as the &%local_part_prefix%& and
16043 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16044 example, if
16045 .code
16046 local_from_prefix = *-
16047 .endd
16048 is set, a &'From:'& line containing
16049 .code
16050 From: anything-user@your.domain.example
16051 .endd
16052 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16053 matches the actual sender address that is constructed from the login name and
16054 qualify domain.
16055
16056
16057 .option local_from_suffix main string unset
16058 See &%local_from_prefix%& above.
16059
16060
16061 .option local_interfaces main "string list" "see below"
16062 This option controls which network interfaces are used by the daemon for
16063 listening; they are also used to identify the local host when routing. Chapter
16064 &<<CHAPinterfaces>>& contains a full description of this option and the related
16065 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16066 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16067 &%local_interfaces%& is
16068 .code
16069 local_interfaces = 0.0.0.0
16070 .endd
16071 when Exim is built without IPv6 support; otherwise it is
16072 .code
16073 local_interfaces = <; ::0 ; 0.0.0.0
16074 .endd
16075
16076 .option local_scan_timeout main time 5m
16077 .cindex "timeout" "for &[local_scan()]& function"
16078 .cindex "&[local_scan()]& function" "timeout"
16079 This timeout applies to the &[local_scan()]& function (see chapter
16080 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16081 the incoming message is rejected with a temporary error if it is an SMTP
16082 message. For a non-SMTP message, the message is dropped and Exim ends with a
16083 non-zero code. The incident is logged on the main and reject logs.
16084
16085
16086
16087 .option local_sender_retain main boolean false
16088 .cindex "&'Sender:'& header line" "retaining from local submission"
16089 When a message is submitted locally (that is, not over a TCP/IP connection) by
16090 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16091 do not want this to happen, you must set &%local_sender_retain%&, and you must
16092 also set &%local_from_check%& to be false (Exim will complain if you do not).
16093 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16094 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16095
16096
16097
16098
16099 .option localhost_number main string&!! unset
16100 .cindex "host" "locally unique number for"
16101 .cindex "message ids" "with multiple hosts"
16102 .vindex "&$localhost_number$&"
16103 Exim's message ids are normally unique only within the local host. If
16104 uniqueness among a set of hosts is required, each host must set a different
16105 value for the &%localhost_number%& option. The string is expanded immediately
16106 after reading the configuration file (so that a number can be computed from the
16107 host name, for example) and the result of the expansion must be a number in the
16108 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16109 systems). This is available in subsequent string expansions via the variable
16110 &$localhost_number$&. When &%localhost_number is set%&, the final two
16111 characters of the message id, instead of just being a fractional part of the
16112 time, are computed from the time and the local host number as described in
16113 section &<<SECTmessiden>>&.
16114
16115
16116
16117 .option log_file_path main "string list&!!" "set at compile time"
16118 .cindex "log" "file path for"
16119 This option sets the path which is used to determine the names of Exim's log
16120 files, or indicates that logging is to be to syslog, or both. It is expanded
16121 when Exim is entered, so it can, for example, contain a reference to the host
16122 name. If no specific path is set for the log files at compile or runtime,
16123 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16124 they are written in a sub-directory called &_log_& in Exim's spool directory.
16125 A path must start with a slash.
16126 To send to syslog, use the word &"syslog"&.
16127 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16128 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16129 used. If this string is fixed at your installation (contains no expansion
16130 variables) it is recommended that you do not set this option in the
16131 configuration file, but instead supply the path using LOG_FILE_PATH in
16132 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16133 early on &-- in particular, failure to read the configuration file.
16134
16135
16136 .option log_selector main string unset
16137 .cindex "log" "selectors"
16138 This option can be used to reduce or increase the number of things that Exim
16139 writes to its log files. Its argument is made up of names preceded by plus or
16140 minus characters. For example:
16141 .code
16142 log_selector = +arguments -retry_defer
16143 .endd
16144 A list of possible names and what they control is given in the chapter on
16145 logging, in section &<<SECTlogselector>>&.
16146
16147
16148 .option log_timezone main boolean false
16149 .cindex "log" "timezone for entries"
16150 .vindex "&$tod_log$&"
16151 .vindex "&$tod_zone$&"
16152 By default, the timestamps on log lines are in local time without the
16153 timezone. This means that if your timezone changes twice a year, the timestamps
16154 in log lines are ambiguous for an hour when the clocks go back. One way of
16155 avoiding this problem is to set the timezone to UTC. An alternative is to set
16156 &%log_timezone%& true. This turns on the addition of the timezone offset to
16157 timestamps in log lines. Turning on this option can add quite a lot to the size
16158 of log files because each line is extended by 6 characters. Note that the
16159 &$tod_log$& variable contains the log timestamp without the zone, but there is
16160 another variable called &$tod_zone$& that contains just the timezone offset.
16161
16162
16163 .option lookup_open_max main integer 25
16164 .cindex "too many open files"
16165 .cindex "open files, too many"
16166 .cindex "file" "too many open"
16167 .cindex "lookup" "maximum open files"
16168 .cindex "limit" "open files for lookups"
16169 This option limits the number of simultaneously open files for single-key
16170 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16171 Exim normally keeps these files open during routing, because often the same
16172 file is required several times. If the limit is reached, Exim closes the least
16173 recently used file. Note that if you are using the &'ndbm'& library, it
16174 actually opens two files for each logical DBM database, though it still counts
16175 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16176 open files"& errors with NDBM, you need to reduce the value of
16177 &%lookup_open_max%&.
16178
16179
16180 .option max_username_length main integer 0
16181 .cindex "length of login name"
16182 .cindex "user name" "maximum length"
16183 .cindex "limit" "user name length"
16184 Some operating systems are broken in that they truncate long arguments to
16185 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16186 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16187 an argument that is longer behaves as if &[getpwnam()]& failed.
16188
16189
16190 .option message_body_newlines main bool false
16191 .cindex "message body" "newlines in variables"
16192 .cindex "newline" "in message body variables"
16193 .vindex "&$message_body$&"
16194 .vindex "&$message_body_end$&"
16195 By default, newlines in the message body are replaced by spaces when setting
16196 the &$message_body$& and &$message_body_end$& expansion variables. If this
16197 option is set true, this no longer happens.
16198
16199
16200 .option message_body_visible main integer 500
16201 .cindex "body of message" "visible size"
16202 .cindex "message body" "visible size"
16203 .vindex "&$message_body$&"
16204 .vindex "&$message_body_end$&"
16205 This option specifies how much of a message's body is to be included in the
16206 &$message_body$& and &$message_body_end$& expansion variables.
16207
16208
16209 .option message_id_header_domain main string&!! unset
16210 .cindex "&'Message-ID:'& header line"
16211 If this option is set, the string is expanded and used as the right hand side
16212 (domain) of the &'Message-ID:'& header that Exim creates if a
16213 locally-originated incoming message does not have one. &"Locally-originated"&
16214 means &"not received over TCP/IP."&
16215 Otherwise, the primary host name is used.
16216 Only letters, digits, dot and hyphen are accepted; any other characters are
16217 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16218 empty string, the option is ignored.
16219
16220
16221 .option message_id_header_text main string&!! unset
16222 If this variable is set, the string is expanded and used to augment the text of
16223 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16224 message does not have one. The text of this header is required by RFC 2822 to
16225 take the form of an address. By default, Exim uses its internal message id as
16226 the local part, and the primary host name as the domain. If this option is set,
16227 it is expanded, and provided the expansion is not forced to fail, and does not
16228 yield an empty string, the result is inserted into the header immediately
16229 before the @, separated from the internal message id by a dot. Any characters
16230 that are illegal in an address are automatically converted into hyphens. This
16231 means that variables such as &$tod_log$& can be used, because the spaces and
16232 colons will become hyphens.
16233
16234
16235 .option message_logs main boolean true
16236 .cindex "message logs" "disabling"
16237 .cindex "log" "message log; disabling"
16238 If this option is turned off, per-message log files are not created in the
16239 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16240 Exim, by reducing the number of files involved in handling a message from a
16241 minimum of four (header spool file, body spool file, delivery journal, and
16242 per-message log) to three. The other major I/O activity is Exim's main log,
16243 which is not affected by this option.
16244
16245
16246 .option message_size_limit main string&!! 50M
16247 .cindex "message" "size limit"
16248 .cindex "limit" "message size"
16249 .cindex "size" "of message, limit"
16250 This option limits the maximum size of message that Exim will process. The
16251 value is expanded for each incoming connection so, for example, it can be made
16252 to depend on the IP address of the remote host for messages arriving via
16253 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16254 optionally followed by K or M.
16255
16256 &*Note*&: This limit cannot be made to depend on a message's sender or any
16257 other properties of an individual message, because it has to be advertised in
16258 the server's response to EHLO. String expansion failure causes a temporary
16259 error. A value of zero means no limit, but its use is not recommended. See also
16260 &%bounce_return_size_limit%&.
16261
16262 Incoming SMTP messages are failed with a 552 error if the limit is
16263 exceeded; locally-generated messages either get a stderr message or a delivery
16264 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16265 an oversized message is logged in both the main and the reject logs. See also
16266 the generic transport option &%message_size_limit%&, which limits the size of
16267 message that an individual transport can process.
16268
16269 If you use a virus-scanner and set this option to to a value larger than the
16270 maximum size that your virus-scanner is configured to support, you may get
16271 failures triggered by large mails.  The right size to configure for the
16272 virus-scanner depends upon what data is passed and the options in use but it's
16273 probably safest to just set it to a little larger than this value.  E.g., with a
16274 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16275 some problems may result.
16276
16277 A value of 0 will disable size limit checking; Exim will still advertise the
16278 SIZE extension in an EHLO response, but without a limit, so as to permit
16279 SMTP clients to still indicate the message size along with the MAIL verb.
16280
16281
16282 .option move_frozen_messages main boolean false
16283 .cindex "frozen messages" "moving"
16284 This option, which is available only if Exim has been built with the setting
16285 .code
16286 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16287 .endd
16288 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16289 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16290 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16291 standard utilities for handling such moved messages, and they do not show up in
16292 lists generated by &%-bp%& or by the Exim monitor.
16293
16294
16295 .option mua_wrapper main boolean false
16296 Setting this option true causes Exim to run in a very restrictive mode in which
16297 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16298 contains a full description of this facility.
16299
16300
16301
16302 .option mysql_servers main "string list" unset
16303 .cindex "MySQL" "server list"
16304 This option provides a list of MySQL servers and associated connection data, to
16305 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16306 option is available only if Exim has been built with MySQL support.
16307
16308
16309 .option never_users main "string list&!!" unset
16310 This option is expanded just once, at the start of Exim's processing. Local
16311 message deliveries are normally run in processes that are setuid to the
16312 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16313 It is usually desirable to prevent any deliveries from running as root, as a
16314 safety precaution.
16315
16316 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16317 list of users that must not be used for local deliveries. This list is fixed in
16318 the binary and cannot be overridden by the configuration file. By default, it
16319 contains just the single user name &"root"&. The &%never_users%& runtime option
16320 can be used to add more users to the fixed list.
16321
16322 If a message is to be delivered as one of the users on the fixed list or the
16323 &%never_users%& list, an error occurs, and delivery is deferred. A common
16324 example is
16325 .code
16326 never_users = root:daemon:bin
16327 .endd
16328 Including root is redundant if it is also on the fixed list, but it does no
16329 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16330 transport driver.
16331
16332
16333 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16334 .cindex "OpenSSL "compatibility options"
16335 This option allows an administrator to adjust the SSL options applied
16336 by OpenSSL to connections.  It is given as a space-separated list of items,
16337 each one to be +added or -subtracted from the current value.
16338
16339 This option is only available if Exim is built against OpenSSL.  The values
16340 available for this option vary according to the age of your OpenSSL install.
16341 The &"all"& value controls a subset of flags which are available, typically
16342 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16343 list the values known on your system and Exim should support all the
16344 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16345 names lose the leading &"SSL_OP_"& and are lower-cased.
16346
16347 Note that adjusting the options can have severe impact upon the security of
16348 SSL as used by Exim.  It is possible to disable safety checks and shoot
16349 yourself in the foot in various unpleasant ways.  This option should not be
16350 adjusted lightly.  An unrecognised item will be detected at startup, by
16351 invoking Exim with the &%-bV%& flag.
16352
16353 The option affects Exim operating both as a server and as a client.
16354
16355 Historical note: prior to release 4.80, Exim defaulted this value to
16356 "+dont_insert_empty_fragments", which may still be needed for compatibility
16357 with some clients, but which lowers security by increasing exposure to
16358 some now infamous attacks.
16359
16360 Examples:
16361 .code
16362 # Make both old MS and old Eudora happy:
16363 openssl_options = -all +microsoft_big_sslv3_buffer \
16364                        +dont_insert_empty_fragments
16365
16366 # Disable older protocol versions:
16367 openssl_options = +no_sslv2 +no_sslv3
16368 .endd
16369
16370 Possible options may include:
16371 .ilist
16372 &`all`&
16373 .next
16374 &`allow_unsafe_legacy_renegotiation`&
16375 .next
16376 &`cipher_server_preference`&
16377 .next
16378 &`dont_insert_empty_fragments`&
16379 .next
16380 &`ephemeral_rsa`&
16381 .next
16382 &`legacy_server_connect`&
16383 .next
16384 &`microsoft_big_sslv3_buffer`&
16385 .next
16386 &`microsoft_sess_id_bug`&
16387 .next
16388 &`msie_sslv2_rsa_padding`&
16389 .next
16390 &`netscape_challenge_bug`&
16391 .next
16392 &`netscape_reuse_cipher_change_bug`&
16393 .next
16394 &`no_compression`&
16395 .next
16396 &`no_session_resumption_on_renegotiation`&
16397 .next
16398 &`no_sslv2`&
16399 .next
16400 &`no_sslv3`&
16401 .next
16402 &`no_ticket`&
16403 .next
16404 &`no_tlsv1`&
16405 .next
16406 &`no_tlsv1_1`&
16407 .next
16408 &`no_tlsv1_2`&
16409 .next
16410 &`safari_ecdhe_ecdsa_bug`&
16411 .next
16412 &`single_dh_use`&
16413 .next
16414 &`single_ecdh_use`&
16415 .next
16416 &`ssleay_080_client_dh_bug`&
16417 .next
16418 &`sslref2_reuse_cert_type_bug`&
16419 .next
16420 &`tls_block_padding_bug`&
16421 .next
16422 &`tls_d5_bug`&
16423 .next
16424 &`tls_rollback_bug`&
16425 .endlist
16426
16427 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16428 all clients connecting using the MacOS SecureTransport TLS facility prior
16429 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16430 to negotiate TLS then this option value might help, provided that your OpenSSL
16431 release is new enough to contain this work-around.  This may be a situation
16432 where you have to upgrade OpenSSL to get buggy clients working.
16433
16434
16435 .option oracle_servers main "string list" unset
16436 .cindex "Oracle" "server list"
16437 This option provides a list of Oracle servers and associated connection data,
16438 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16439 The option is available only if Exim has been built with Oracle support.
16440
16441
16442 .option percent_hack_domains main "domain list&!!" unset
16443 .cindex "&""percent hack""&"
16444 .cindex "source routing" "in email address"
16445 .cindex "address" "source-routed"
16446 The &"percent hack"& is the convention whereby a local part containing a
16447 percent sign is re-interpreted as a new email address, with the percent
16448 replaced by @. This is sometimes called &"source routing"&, though that term is
16449 also applied to RFC 2822 addresses that begin with an @ character. If this
16450 option is set, Exim implements the percent facility for those domains listed,
16451 but no others. This happens before an incoming SMTP address is tested against
16452 an ACL.
16453
16454 &*Warning*&: The &"percent hack"& has often been abused by people who are
16455 trying to get round relaying restrictions. For this reason, it is best avoided
16456 if at all possible. Unfortunately, a number of less security-conscious MTAs
16457 implement it unconditionally. If you are running Exim on a gateway host, and
16458 routing mail through to internal MTAs without processing the local parts, it is
16459 a good idea to reject recipient addresses with percent characters in their
16460 local parts. Exim's default configuration does this.
16461
16462
16463 .option perl_at_start main boolean false
16464 .cindex "Perl"
16465 This option is available only when Exim is built with an embedded Perl
16466 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16467
16468
16469 .option perl_startup main string unset
16470 .cindex "Perl"
16471 This option is available only when Exim is built with an embedded Perl
16472 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16473
16474 .option perl_taintmode main boolean false
16475 .cindex "Perl"
16476 This option enables the taint mode of the embedded Perl interpreter.
16477
16478
16479 .option pgsql_servers main "string list" unset
16480 .cindex "PostgreSQL lookup type" "server list"
16481 This option provides a list of PostgreSQL servers and associated connection
16482 data, to be used in conjunction with &(pgsql)& lookups (see section
16483 &<<SECID72>>&). The option is available only if Exim has been built with
16484 PostgreSQL support.
16485
16486
16487 .option pid_file_path main string&!! "set at compile time"
16488 .cindex "daemon" "pid file path"
16489 .cindex "pid file, path for"
16490 This option sets the name of the file to which the Exim daemon writes its
16491 process id. The string is expanded, so it can contain, for example, references
16492 to the host name:
16493 .code
16494 pid_file_path = /var/log/$primary_hostname/exim.pid
16495 .endd
16496 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16497 spool directory.
16498 The value set by the option can be overridden by the &%-oP%& command line
16499 option. A pid file is not written if a &"non-standard"& daemon is run by means
16500 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16501
16502
16503 .option pipelining_advertise_hosts main "host list&!!" *
16504 .cindex "PIPELINING" "suppressing advertising"
16505 This option can be used to suppress the advertisement of the SMTP
16506 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16507 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16508 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16509 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16510 that clients will use it; &"out of order"& commands that are &"expected"& do
16511 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16512
16513 .option pipelining_connect_advertise_hosts main "host list&!!" *
16514 .cindex "pipelining" "early connection"
16515 .cindex "pipelining" PIPE_CONNECT
16516 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16517 this option controls which hosts the facility is advertised to
16518 and from which pipeline early-connection (before MAIL) SMTP
16519 commands are acceptable.
16520 When used, the pipelining saves on roundtrip times.
16521
16522 See also the &%hosts_pipe_connect%& smtp transport option.
16523
16524 Currently the option name &"X_PIPE_CONNECT"& is used.
16525
16526
16527 .option prdr_enable main boolean false
16528 .cindex "PRDR" "enabling on server"
16529 This option can be used to enable the Per-Recipient Data Response extension
16530 to SMTP, defined by Eric Hall.
16531 If the option is set, PRDR is advertised by Exim when operating as a server.
16532 If the client requests PRDR, and more than one recipient, for a message
16533 an additional ACL is called for each recipient after the message content
16534 is received.  See section &<<SECTPRDRACL>>&.
16535
16536 .option preserve_message_logs main boolean false
16537 .cindex "message logs" "preserving"
16538 If this option is set, message log files are not deleted when messages are
16539 completed. Instead, they are moved to a sub-directory of the spool directory
16540 called &_msglog.OLD_&, where they remain available for statistical or debugging
16541 purposes. This is a dangerous option to set on systems with any appreciable
16542 volume of mail. Use with care!
16543
16544
16545 .option primary_hostname main string "see below"
16546 .cindex "name" "of local host"
16547 .cindex "host" "name of local"
16548 .cindex "local host" "name of"
16549 .vindex "&$primary_hostname$&"
16550 This specifies the name of the current host. It is used in the default EHLO or
16551 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16552 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16553 The value is also used by default in some SMTP response messages from an Exim
16554 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16555
16556 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16557 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16558 contains only one component, Exim passes it to &[gethostbyname()]& (or
16559 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16560 version. The variable &$primary_hostname$& contains the host name, whether set
16561 explicitly by this option, or defaulted.
16562
16563
16564 .option print_topbitchars main boolean false
16565 .cindex "printing characters"
16566 .cindex "8-bit characters"
16567 By default, Exim considers only those characters whose codes lie in the range
16568 32&--126 to be printing characters. In a number of circumstances (for example,
16569 when writing log entries) non-printing characters are converted into escape
16570 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16571 is set, code values of 128 and above are also considered to be printing
16572 characters.
16573
16574 This option also affects the header syntax checks performed by the
16575 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16576 the user's full name when constructing From: and Sender: addresses (as
16577 described in section &<<SECTconstr>>&). Setting this option can cause
16578 Exim to generate eight bit message headers that do not conform to the
16579 standards.
16580
16581
16582 .option process_log_path main string unset
16583 .cindex "process log path"
16584 .cindex "log" "process log"
16585 .cindex "&'exiwhat'&"
16586 This option sets the name of the file to which an Exim process writes its
16587 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16588 utility script. If this option is unset, the file called &_exim-process.info_&
16589 in Exim's spool directory is used. The ability to specify the name explicitly
16590 can be useful in environments where two different Exims are running, using
16591 different spool directories.
16592
16593
16594 .option prod_requires_admin main boolean true
16595 .cindex "restricting access to features"
16596 .oindex "&%-M%&"
16597 .oindex "&%-R%&"
16598 .oindex "&%-q%&"
16599 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16600 admin user unless &%prod_requires_admin%& is set false. See also
16601 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16602
16603
16604 .option qualify_domain main string "see below"
16605 .cindex "domain" "for qualifying addresses"
16606 .cindex "address" "qualification"
16607 This option specifies the domain name that is added to any envelope sender
16608 addresses that do not have a domain qualification. It also applies to
16609 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16610 are accepted by default only for locally-generated messages. Qualification is
16611 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16612 locally-generated messages, unless the &%-bnq%& command line option is used.
16613
16614 Messages from external sources must always contain fully qualified addresses,
16615 unless the sending host matches &%sender_unqualified_hosts%& or
16616 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16617 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16618 necessary. Internally, Exim always works with fully qualified envelope
16619 addresses. If &%qualify_domain%& is not set, it defaults to the
16620 &%primary_hostname%& value.
16621
16622
16623 .option qualify_recipient main string "see below"
16624 This option allows you to specify a different domain for qualifying recipient
16625 addresses to the one that is used for senders. See &%qualify_domain%& above.
16626
16627
16628
16629 .option queue_domains main "domain list&!!" unset
16630 .cindex "domain" "specifying non-immediate delivery"
16631 .cindex "queueing incoming messages"
16632 .cindex "message" "queueing certain domains"
16633 This option lists domains for which immediate delivery is not required.
16634 A delivery process is started whenever a message is received, but only those
16635 domains that do not match are processed. All other deliveries wait until the
16636 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16637
16638
16639 .option queue_list_requires_admin main boolean true
16640 .cindex "restricting access to features"
16641 .oindex "&%-bp%&"
16642 The &%-bp%& command-line option, which lists the messages that are on the
16643 queue, requires the caller to be an admin user unless
16644 &%queue_list_requires_admin%& is set false.
16645 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16646
16647
16648 .option queue_only main boolean false
16649 .cindex "queueing incoming messages"
16650 .cindex "message" "queueing unconditionally"
16651 If &%queue_only%& is set, a delivery process is not automatically started
16652 whenever a message is received. Instead, the message waits in the queue for the
16653 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16654 delivered immediately when certain conditions (such as heavy load) occur.
16655
16656 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16657 and &%-odi%& command line options override &%queue_only%& unless
16658 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16659 &%queue_only_load%&, and &%smtp_accept_queue%&.
16660
16661
16662 .option queue_only_file main string unset
16663 .cindex "queueing incoming messages"
16664 .cindex "message" "queueing by file existence"
16665 This option can be set to a colon-separated list of absolute path names, each
16666 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16667 it tests for the existence of each listed path using a call to &[stat()]&. For
16668 each path that exists, the corresponding queueing option is set.
16669 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16670 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16671 .code
16672 queue_only_file = smtp/some/file
16673 .endd
16674 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16675 &_/some/file_& exists.
16676
16677
16678 .option queue_only_load main fixed-point unset
16679 .cindex "load average"
16680 .cindex "queueing incoming messages"
16681 .cindex "message" "queueing by load"
16682 If the system load average is higher than this value, incoming messages from
16683 all sources are queued, and no automatic deliveries are started. If this
16684 happens during local or remote SMTP input, all subsequent messages received on
16685 the same SMTP connection are queued by default, whatever happens to the load in
16686 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16687 false.
16688
16689 Deliveries will subsequently be performed by queue runner processes. This
16690 option has no effect on ancient operating systems on which Exim cannot
16691 determine the load average. See also &%deliver_queue_load_max%& and
16692 &%smtp_load_reserve%&.
16693
16694
16695 .option queue_only_load_latch main boolean true
16696 .cindex "load average" "re-evaluating per message"
16697 When this option is true (the default), once one message has been queued
16698 because the load average is higher than the value set by &%queue_only_load%&,
16699 all subsequent messages received on the same SMTP connection are also queued.
16700 This is a deliberate choice; even though the load average may fall below the
16701 threshold, it doesn't seem right to deliver later messages on the same
16702 connection when not delivering earlier ones. However, there are special
16703 circumstances such as very long-lived connections from scanning appliances
16704 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16705 should be set false. This causes the value of the load average to be
16706 re-evaluated for each message.
16707
16708
16709 .option queue_only_override main boolean true
16710 .cindex "queueing incoming messages"
16711 When this option is true, the &%-od%&&'x'& command line options override the
16712 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16713 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16714 to override; they are accepted, but ignored.
16715
16716
16717 .option queue_run_in_order main boolean false
16718 .cindex "queue runner" "processing messages in order"
16719 If this option is set, queue runs happen in order of message arrival instead of
16720 in an arbitrary order. For this to happen, a complete list of the entire queue
16721 must be set up before the deliveries start. When the queue is all held in a
16722 single directory (the default), a single list is created for both the ordered
16723 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16724 single list is not created when &%queue_run_in_order%& is false. In this case,
16725 the sub-directories are processed one at a time (in a random order), and this
16726 avoids setting up one huge list for the whole queue. Thus, setting
16727 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16728 when the queue is large, because of the extra work in setting up the single,
16729 large list. In most situations, &%queue_run_in_order%& should not be set.
16730
16731
16732
16733 .option queue_run_max main integer&!! 5
16734 .cindex "queue runner" "maximum number of"
16735 This controls the maximum number of queue runner processes that an Exim daemon
16736 can run simultaneously. This does not mean that it starts them all at once,
16737 but rather that if the maximum number are still running when the time comes to
16738 start another one, it refrains from starting another one. This can happen with
16739 very large queues and/or very sluggish deliveries. This option does not,
16740 however, interlock with other processes, so additional queue runners can be
16741 started by other means, or by killing and restarting the daemon.
16742
16743 Setting this option to zero does not suppress queue runs; rather, it disables
16744 the limit, allowing any number of simultaneous queue runner processes to be
16745 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16746 the daemon's command line.
16747
16748 .cindex queues named
16749 .cindex "named queues"
16750 To set limits for different named queues use
16751 an expansion depending on the &$queue_name$& variable.
16752
16753 .option queue_smtp_domains main "domain list&!!" unset
16754 .cindex "queueing incoming messages"
16755 .cindex "message" "queueing remote deliveries"
16756 When this option is set, a delivery process is started whenever a message is
16757 received, routing is performed, and local deliveries take place.
16758 However, if any SMTP deliveries are required for domains that match
16759 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16760 message waits in the queue for the next queue run. Since routing of the message
16761 has taken place, Exim knows to which remote hosts it must be delivered, and so
16762 when the queue run happens, multiple messages for the same host are delivered
16763 over a single SMTP connection. The &%-odqs%& command line option causes all
16764 SMTP deliveries to be queued in this way, and is equivalent to setting
16765 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16766 &%queue_domains%&.
16767
16768
16769 .option receive_timeout main time 0s
16770 .cindex "timeout" "for non-SMTP input"
16771 This option sets the timeout for accepting a non-SMTP message, that is, the
16772 maximum time that Exim waits when reading a message on the standard input. If
16773 the value is zero, it will wait forever. This setting is overridden by the
16774 &%-or%& command line option. The timeout for incoming SMTP messages is
16775 controlled by &%smtp_receive_timeout%&.
16776
16777 .option received_header_text main string&!! "see below"
16778 .cindex "customizing" "&'Received:'& header"
16779 .cindex "&'Received:'& header line" "customizing"
16780 This string defines the contents of the &'Received:'& message header that is
16781 added to each message, except for the timestamp, which is automatically added
16782 on at the end (preceded by a semicolon). The string is expanded each time it is
16783 used. If the expansion yields an empty string, no &'Received:'& header line is
16784 added to the message. Otherwise, the string should start with the text
16785 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16786 header lines.
16787 The default setting is:
16788
16789 .code
16790 received_header_text = Received: \
16791   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16792     {${if def:sender_ident \
16793       {from ${quote_local_part:$sender_ident} }}\
16794         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16795   by $primary_hostname \
16796   ${if def:received_protocol {with $received_protocol }}\
16797   ${if def:tls_ver           { ($tls_ver)}}\
16798   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
16799   (Exim $version_number)\n\t\
16800   ${if def:sender_address \
16801   {(envelope-from <$sender_address>)\n\t}}\
16802   id $message_exim_id\
16803   ${if def:received_for {\n\tfor $received_for}}
16804 .endd
16805
16806 The reference to the TLS cipher is omitted when Exim is built without TLS
16807 support. The use of conditional expansions ensures that this works for both
16808 locally generated messages and messages received from remote hosts, giving
16809 header lines such as the following:
16810 .code
16811 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16812 by marley.carol.example with esmtp (Exim 4.00)
16813 (envelope-from <bob@carol.example>)
16814 id 16IOWa-00019l-00
16815 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16816 Received: by scrooge.carol.example with local (Exim 4.00)
16817 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16818 .endd
16819 Until the body of the message has been received, the timestamp is the time when
16820 the message started to be received. Once the body has arrived, and all policy
16821 checks have taken place, the timestamp is updated to the time at which the
16822 message was accepted.
16823
16824
16825 .option received_headers_max main integer 30
16826 .cindex "loop" "prevention"
16827 .cindex "mail loop prevention"
16828 .cindex "&'Received:'& header line" "counting"
16829 When a message is to be delivered, the number of &'Received:'& headers is
16830 counted, and if it is greater than this parameter, a mail loop is assumed to
16831 have occurred, the delivery is abandoned, and an error message is generated.
16832 This applies to both local and remote deliveries.
16833
16834
16835 .option recipient_unqualified_hosts main "host list&!!" unset
16836 .cindex "unqualified addresses"
16837 .cindex "host" "unqualified addresses from"
16838 This option lists those hosts from which Exim is prepared to accept unqualified
16839 recipient addresses in message envelopes. The addresses are made fully
16840 qualified by the addition of the &%qualify_recipient%& value. This option also
16841 affects message header lines. Exim does not reject unqualified recipient
16842 addresses in headers, but it qualifies them only if the message came from a
16843 host that matches &%recipient_unqualified_hosts%&,
16844 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16845 option was not set.
16846
16847
16848 .option recipients_max main integer 0
16849 .cindex "limit" "number of recipients"
16850 .cindex "recipient" "maximum number"
16851 If this option is set greater than zero, it specifies the maximum number of
16852 original recipients for any message. Additional recipients that are generated
16853 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16854 all recipients over the limit; earlier recipients are delivered as normal.
16855 Non-SMTP messages with too many recipients are failed, and no deliveries are
16856 done.
16857
16858 .cindex "RCPT" "maximum number of incoming"
16859 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16860 RCPT commands in a single message.
16861
16862
16863 .option recipients_max_reject main boolean false
16864 If this option is set true, Exim rejects SMTP messages containing too many
16865 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16866 error to the eventual DATA command. Otherwise (the default) it gives a 452
16867 error to the surplus RCPT commands and accepts the message on behalf of the
16868 initial set of recipients. The remote server should then re-send the message
16869 for the remaining recipients at a later time.
16870
16871
16872 .option remote_max_parallel main integer 2
16873 .cindex "delivery" "parallelism for remote"
16874 This option controls parallel delivery of one message to a number of remote
16875 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16876 does all the remote deliveries for a message one by one. Otherwise, if a single
16877 message has to be delivered to more than one remote host, or if several copies
16878 have to be sent to the same remote host, up to &%remote_max_parallel%&
16879 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16880 deliveries are required, the maximum number of processes are started, and as
16881 each one finishes, another is begun. The order of starting processes is the
16882 same as if sequential delivery were being done, and can be controlled by the
16883 &%remote_sort_domains%& option. If parallel delivery takes place while running
16884 with debugging turned on, the debugging output from each delivery process is
16885 tagged with its process id.
16886
16887 This option controls only the maximum number of parallel deliveries for one
16888 message in one Exim delivery process. Because Exim has no central queue
16889 manager, there is no way of controlling the total number of simultaneous
16890 deliveries if the configuration allows a delivery attempt as soon as a message
16891 is received.
16892
16893 .cindex "number of deliveries"
16894 .cindex "delivery" "maximum number of"
16895 If you want to control the total number of deliveries on the system, you
16896 need to set the &%queue_only%& option. This ensures that all incoming messages
16897 are added to the queue without starting a delivery process. Then set up an Exim
16898 daemon to start queue runner processes at appropriate intervals (probably
16899 fairly often, for example, every minute), and limit the total number of queue
16900 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16901 delivers only one message at a time, the maximum number of deliveries that can
16902 then take place at once is &%queue_run_max%& multiplied by
16903 &%remote_max_parallel%&.
16904
16905 If it is purely remote deliveries you want to control, use
16906 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16907 doing the SMTP routing before queueing, so that several messages for the same
16908 host will eventually get delivered down the same connection.
16909
16910
16911 .option remote_sort_domains main "domain list&!!" unset
16912 .cindex "sorting remote deliveries"
16913 .cindex "delivery" "sorting remote"
16914 When there are a number of remote deliveries for a message, they are sorted by
16915 domain into the order given by this list. For example,
16916 .code
16917 remote_sort_domains = *.cam.ac.uk:*.uk
16918 .endd
16919 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16920 then to those in the &%uk%& domain, then to any others.
16921
16922
16923 .option retry_data_expire main time 7d
16924 .cindex "hints database" "data expiry"
16925 This option sets a &"use before"& time on retry information in Exim's hints
16926 database. Any older retry data is ignored. This means that, for example, once a
16927 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16928 past failures.
16929
16930
16931 .option retry_interval_max main time 24h
16932 .cindex "retry" "limit on interval"
16933 .cindex "limit" "on retry interval"
16934 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16935 intervals between delivery attempts for messages that cannot be delivered
16936 straight away. This option sets an overall limit to the length of time between
16937 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16938 the default value.
16939
16940
16941 .option return_path_remove main boolean true
16942 .cindex "&'Return-path:'& header line" "removing"
16943 RFC 2821, section 4.4, states that an SMTP server must insert a
16944 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16945 The &'Return-path:'& header preserves the sender address as received in the
16946 MAIL command. This description implies that this header should not be present
16947 in an incoming message. If &%return_path_remove%& is true, any existing
16948 &'Return-path:'& headers are removed from messages at the time they are
16949 received. Exim's transports have options for adding &'Return-path:'& headers at
16950 the time of delivery. They are normally used only for final local deliveries.
16951
16952
16953 .option return_size_limit main integer 100K
16954 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16955
16956
16957 .option rfc1413_hosts main "host list&!!" @[]
16958 .cindex "RFC 1413"
16959 .cindex "host" "for RFC 1413 calls"
16960 RFC 1413 identification calls are made to any client host which matches
16961 an item in the list.
16962 The default value specifies just this host, being any local interface
16963 for the system.
16964
16965 .option rfc1413_query_timeout main time 0s
16966 .cindex "RFC 1413" "query timeout"
16967 .cindex "timeout" "for RFC 1413 call"
16968 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16969 no RFC 1413 calls are ever made.
16970
16971
16972 .option sender_unqualified_hosts main "host list&!!" unset
16973 .cindex "unqualified addresses"
16974 .cindex "host" "unqualified addresses from"
16975 This option lists those hosts from which Exim is prepared to accept unqualified
16976 sender addresses. The addresses are made fully qualified by the addition of
16977 &%qualify_domain%&. This option also affects message header lines. Exim does
16978 not reject unqualified addresses in headers that contain sender addresses, but
16979 it qualifies them only if the message came from a host that matches
16980 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16981 using TCP/IP), and the &%-bnq%& option was not set.
16982
16983
16984 .option slow_lookup_log main integer 0
16985 .cindex "logging" "slow lookups"
16986 .cindex "dns" "logging slow lookups"
16987 This option controls logging of slow lookups.
16988 If the value is nonzero it is taken as a number of milliseconds
16989 and lookups taking longer than this are logged.
16990 Currently this applies only to DNS lookups.
16991
16992
16993
16994 .option smtp_accept_keepalive main boolean true
16995 .cindex "keepalive" "on incoming connection"
16996 This option controls the setting of the SO_KEEPALIVE option on incoming
16997 TCP/IP socket connections. When set, it causes the kernel to probe idle
16998 connections periodically, by sending packets with &"old"& sequence numbers. The
16999 other end of the connection should send an acknowledgment if the connection is
17000 still okay or a reset if the connection has been aborted. The reason for doing
17001 this is that it has the beneficial effect of freeing up certain types of
17002 connection that can get stuck when the remote host is disconnected without
17003 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17004 hours to detect unreachable hosts.
17005
17006
17007
17008 .option smtp_accept_max main integer 20
17009 .cindex "limit" "incoming SMTP connections"
17010 .cindex "SMTP" "incoming connection count"
17011 .cindex "inetd"
17012 This option specifies the maximum number of simultaneous incoming SMTP calls
17013 that Exim will accept. It applies only to the listening daemon; there is no
17014 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17015 value is set to zero, no limit is applied. However, it is required to be
17016 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17017 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17018
17019 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17020 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17021 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17022 and &%smtp_load_reserve%& are then checked before accepting the connection.
17023
17024
17025 .option smtp_accept_max_nonmail main integer 10
17026 .cindex "limit" "non-mail SMTP commands"
17027 .cindex "SMTP" "limiting non-mail commands"
17028 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17029 the connection if there are too many. This option defines &"too many"&. The
17030 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17031 client looping sending EHLO, for example. The check is applied only if the
17032 client host matches &%smtp_accept_max_nonmail_hosts%&.
17033
17034 When a new message is expected, one occurrence of RSET is not counted. This
17035 allows a client to send one RSET between messages (this is not necessary,
17036 but some clients do it). Exim also allows one uncounted occurrence of HELO
17037 or EHLO, and one occurrence of STARTTLS between messages. After
17038 starting up a TLS session, another EHLO is expected, and so it too is not
17039 counted. The first occurrence of AUTH in a connection, or immediately
17040 following STARTTLS is not counted. Otherwise, all commands other than
17041 MAIL, RCPT, DATA, and QUIT are counted.
17042
17043
17044 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17045 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17046 check by setting this option. The default value makes it apply to all hosts. By
17047 changing the value, you can exclude any badly-behaved hosts that you have to
17048 live with.
17049
17050
17051 . Allow this long option name to split; give it unsplit as a fifth argument
17052 . for the automatic .oindex that is generated by .option.
17053 . We insert " &~&~" which is both pretty nasty visually and results in
17054 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17055 . zero-width-space, which would be nicer visually and results in (at least)
17056 . html that Firefox will split on when it's forced to reflow (rather than
17057 . inserting a horizontal scrollbar).  However, the text is still not
17058 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17059 . the option name to split.
17060
17061 .option "smtp_accept_max_per_connection" main integer 1000 &&&
17062          smtp_accept_max_per_connection
17063 .cindex "SMTP" "limiting incoming message count"
17064 .cindex "limit" "messages per SMTP connection"
17065 The value of this option limits the number of MAIL commands that Exim is
17066 prepared to accept over a single SMTP connection, whether or not each command
17067 results in the transfer of a message. After the limit is reached, a 421
17068 response is given to subsequent MAIL commands. This limit is a safety
17069 precaution against a client that goes mad (incidents of this type have been
17070 seen).
17071
17072
17073 .option smtp_accept_max_per_host main string&!! unset
17074 .cindex "limit" "SMTP connections from one host"
17075 .cindex "host" "limiting SMTP connections from"
17076 This option restricts the number of simultaneous IP connections from a single
17077 host (strictly, from a single IP address) to the Exim daemon. The option is
17078 expanded, to enable different limits to be applied to different hosts by
17079 reference to &$sender_host_address$&. Once the limit is reached, additional
17080 connection attempts from the same host are rejected with error code 421. This
17081 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17082 of zero imposes no limit. If this option is set greater than zero, it is
17083 required that &%smtp_accept_max%& be non-zero.
17084
17085 &*Warning*&: When setting this option you should not use any expansion
17086 constructions that take an appreciable amount of time. The expansion and test
17087 happen in the main daemon loop, in order to reject additional connections
17088 without forking additional processes (otherwise a denial-of-service attack
17089 could cause a vast number or processes to be created). While the daemon is
17090 doing this processing, it cannot accept any other incoming connections.
17091
17092
17093
17094 .option smtp_accept_queue main integer 0
17095 .cindex "SMTP" "incoming connection count"
17096 .cindex "queueing incoming messages"
17097 .cindex "message" "queueing by SMTP connection count"
17098 If the number of simultaneous incoming SMTP connections being handled via the
17099 listening daemon exceeds this value, messages received by SMTP are just placed
17100 in the queue; no delivery processes are started automatically. The count is
17101 fixed at the start of an SMTP connection. It cannot be updated in the
17102 subprocess that receives messages, and so the queueing or not queueing applies
17103 to all messages received in the same connection.
17104
17105 A value of zero implies no limit, and clearly any non-zero value is useful only
17106 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17107 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17108 various &%-od%&&'x'& command line options.
17109
17110
17111 . See the comment on smtp_accept_max_per_connection
17112
17113 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17114          smtp_accept_queue_per_connection
17115 .cindex "queueing incoming messages"
17116 .cindex "message" "queueing by message count"
17117 This option limits the number of delivery processes that Exim starts
17118 automatically when receiving messages via SMTP, whether via the daemon or by
17119 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17120 and the number of messages received in a single SMTP session exceeds this
17121 number, subsequent messages are placed in the queue, but no delivery processes
17122 are started. This helps to limit the number of Exim processes when a server
17123 restarts after downtime and there is a lot of mail waiting for it on other
17124 systems. On large systems, the default should probably be increased, and on
17125 dial-in client systems it should probably be set to zero (that is, disabled).
17126
17127
17128 .option smtp_accept_reserve main integer 0
17129 .cindex "SMTP" "incoming call count"
17130 .cindex "host" "reserved"
17131 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17132 number of SMTP connections that are reserved for connections from the hosts
17133 that are specified in &%smtp_reserve_hosts%&. The value set in
17134 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17135 restricted to this number of connections; the option specifies a minimum number
17136 of connection slots for them, not a maximum. It is a guarantee that this group
17137 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17138 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17139 individual host.
17140
17141 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17142 set to 5, once there are 45 active connections (from any hosts), new
17143 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17144 provided the other criteria for acceptance are met.
17145
17146
17147 .option smtp_active_hostname main string&!! unset
17148 .cindex "host" "name in SMTP responses"
17149 .cindex "SMTP" "host name in responses"
17150 .vindex "&$primary_hostname$&"
17151 This option is provided for multi-homed servers that want to masquerade as
17152 several different hosts. At the start of an incoming SMTP connection, its value
17153 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17154 responses. For example, it is used as domain name in the response to an
17155 incoming HELO or EHLO command.
17156
17157 .vindex "&$smtp_active_hostname$&"
17158 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17159 is saved with any messages that are received. It is therefore available for use
17160 in routers and transports when the message is later delivered.
17161
17162 If this option is unset, or if its expansion is forced to fail, or if the
17163 expansion results in an empty string, the value of &$primary_hostname$& is
17164 used. Other expansion failures cause a message to be written to the main and
17165 panic logs, and the SMTP command receives a temporary error. Typically, the
17166 value of &%smtp_active_hostname%& depends on the incoming interface address.
17167 For example:
17168 .code
17169 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17170   {cox.mydomain}{box.mydomain}}
17171 .endd
17172
17173 Although &$smtp_active_hostname$& is primarily concerned with incoming
17174 messages, it is also used as the default for HELO commands in callout
17175 verification if there is no remote transport from which to obtain a
17176 &%helo_data%& value.
17177
17178 .option smtp_banner main string&!! "see below"
17179 .cindex "SMTP" "welcome banner"
17180 .cindex "banner for SMTP"
17181 .cindex "welcome banner for SMTP"
17182 .cindex "customizing" "SMTP banner"
17183 This string, which is expanded every time it is used, is output as the initial
17184 positive response to an SMTP connection. The default setting is:
17185 .code
17186 smtp_banner = $smtp_active_hostname ESMTP Exim \
17187   $version_number $tod_full
17188 .endd
17189 Failure to expand the string causes a panic error. If you want to create a
17190 multiline response to the initial SMTP connection, use &"\n"& in the string at
17191 appropriate points, but not at the end. Note that the 220 code is not included
17192 in this string. Exim adds it automatically (several times in the case of a
17193 multiline response).
17194
17195
17196 .option smtp_check_spool_space main boolean true
17197 .cindex "checking disk space"
17198 .cindex "disk space, checking"
17199 .cindex "spool directory" "checking space"
17200 When this option is set, if an incoming SMTP session encounters the SIZE
17201 option on a MAIL command, it checks that there is enough space in the
17202 spool directory's partition to accept a message of that size, while still
17203 leaving free the amount specified by &%check_spool_space%& (even if that value
17204 is zero). If there isn't enough space, a temporary error code is returned.
17205
17206
17207 .option smtp_connect_backlog main integer 20
17208 .cindex "connection backlog"
17209 .cindex "SMTP" "connection backlog"
17210 .cindex "backlog of connections"
17211 This option specifies a maximum number of waiting SMTP connections. Exim passes
17212 this value to the TCP/IP system when it sets up its listener. Once this number
17213 of connections are waiting for the daemon's attention, subsequent connection
17214 attempts are refused at the TCP/IP level. At least, that is what the manuals
17215 say; in some circumstances such connection attempts have been observed to time
17216 out instead. For large systems it is probably a good idea to increase the
17217 value (to 50, say). It also gives some protection against denial-of-service
17218 attacks by SYN flooding.
17219
17220
17221 .option smtp_enforce_sync main boolean true
17222 .cindex "SMTP" "synchronization checking"
17223 .cindex "synchronization checking in SMTP"
17224 The SMTP protocol specification requires the client to wait for a response from
17225 the server at certain points in the dialogue. Without PIPELINING these
17226 synchronization points are after every command; with PIPELINING they are
17227 fewer, but they still exist.
17228
17229 Some spamming sites send out a complete set of SMTP commands without waiting
17230 for any response. Exim protects against this by rejecting a message if the
17231 client has sent further input when it should not have. The error response &"554
17232 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17233 for this error cannot be perfect because of transmission delays (unexpected
17234 input may be on its way but not yet received when Exim checks). However, it
17235 does detect many instances.
17236
17237 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17238 If you want to disable the check selectively (for example, only for certain
17239 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17240 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17241
17242
17243
17244 .option smtp_etrn_command main string&!! unset
17245 .cindex "ETRN" "command to be run"
17246 .vindex "&$domain$&"
17247 If this option is set, the given command is run whenever an SMTP ETRN
17248 command is received from a host that is permitted to issue such commands (see
17249 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17250 are independently expanded. The expansion variable &$domain$& is set to the
17251 argument of the ETRN command, and no syntax checking is done on it. For
17252 example:
17253 .code
17254 smtp_etrn_command = /etc/etrn_command $domain \
17255                     $sender_host_address
17256 .endd
17257 A new process is created to run the command, but Exim does not wait for it to
17258 complete. Consequently, its status cannot be checked. If the command cannot be
17259 run, a line is written to the panic log, but the ETRN caller still receives
17260 a 250 success response. Exim is normally running under its own uid when
17261 receiving SMTP, so it is not possible for it to change the uid before running
17262 the command.
17263
17264
17265 .option smtp_etrn_serialize main boolean true
17266 .cindex "ETRN" "serializing"
17267 When this option is set, it prevents the simultaneous execution of more than
17268 one identical command as a result of ETRN in an SMTP connection. See
17269 section &<<SECTETRN>>& for details.
17270
17271
17272 .option smtp_load_reserve main fixed-point unset
17273 .cindex "load average"
17274 If the system load average ever gets higher than this, incoming SMTP calls are
17275 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17276 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17277 the load is over the limit. The option has no effect on ancient operating
17278 systems on which Exim cannot determine the load average. See also
17279 &%deliver_queue_load_max%& and &%queue_only_load%&.
17280
17281
17282
17283 .option smtp_max_synprot_errors main integer 3
17284 .cindex "SMTP" "limiting syntax and protocol errors"
17285 .cindex "limit" "SMTP syntax and protocol errors"
17286 Exim rejects SMTP commands that contain syntax or protocol errors. In
17287 particular, a syntactically invalid email address, as in this command:
17288 .code
17289 RCPT TO:<abc xyz@a.b.c>
17290 .endd
17291 causes immediate rejection of the command, before any other tests are done.
17292 (The ACL cannot be run if there is no valid address to set up for it.) An
17293 example of a protocol error is receiving RCPT before MAIL. If there are
17294 too many syntax or protocol errors in one SMTP session, the connection is
17295 dropped. The limit is set by this option.
17296
17297 .cindex "PIPELINING" "expected errors"
17298 When the PIPELINING extension to SMTP is in use, some protocol errors are
17299 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17300 Exim assumes that PIPELINING will be used if it advertises it (see
17301 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17302 not count towards the limit.
17303
17304
17305
17306 .option smtp_max_unknown_commands main integer 3
17307 .cindex "SMTP" "limiting unknown commands"
17308 .cindex "limit" "unknown SMTP commands"
17309 If there are too many unrecognized commands in an incoming SMTP session, an
17310 Exim server drops the connection. This is a defence against some kinds of abuse
17311 that subvert web
17312 clients
17313 into making connections to SMTP ports; in these circumstances, a number of
17314 non-SMTP command lines are sent first.
17315
17316
17317
17318 .option smtp_ratelimit_hosts main "host list&!!" unset
17319 .cindex "SMTP" "rate limiting"
17320 .cindex "limit" "rate of message arrival"
17321 .cindex "RCPT" "rate limiting"
17322 Some sites find it helpful to be able to limit the rate at which certain hosts
17323 can send them messages, and the rate at which an individual message can specify
17324 recipients.
17325
17326 Exim has two rate-limiting facilities. This section describes the older
17327 facility, which can limit rates within a single connection. The newer
17328 &%ratelimit%& ACL condition can limit rates across all connections. See section
17329 &<<SECTratelimiting>>& for details of the newer facility.
17330
17331 When a host matches &%smtp_ratelimit_hosts%&, the values of
17332 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17333 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17334 respectively. Each option, if set, must contain a set of four comma-separated
17335 values:
17336
17337 .ilist
17338 A threshold, before which there is no rate limiting.
17339 .next
17340 An initial time delay. Unlike other times in Exim, numbers with decimal
17341 fractional parts are allowed here.
17342 .next
17343 A factor by which to increase the delay each time.
17344 .next
17345 A maximum value for the delay. This should normally be less than 5 minutes,
17346 because after that time, the client is liable to timeout the SMTP command.
17347 .endlist
17348
17349 For example, these settings have been used successfully at the site which
17350 first suggested this feature, for controlling mail from their customers:
17351 .code
17352 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17353 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17354 .endd
17355 The first setting specifies delays that are applied to MAIL commands after
17356 two have been received over a single connection. The initial delay is 0.5
17357 seconds, increasing by a factor of 1.05 each time. The second setting applies
17358 delays to RCPT commands when more than four occur in a single message.
17359
17360
17361 .option smtp_ratelimit_mail main string unset
17362 See &%smtp_ratelimit_hosts%& above.
17363
17364
17365 .option smtp_ratelimit_rcpt main string unset
17366 See &%smtp_ratelimit_hosts%& above.
17367
17368
17369 .option smtp_receive_timeout main time&!! 5m
17370 .cindex "timeout" "for SMTP input"
17371 .cindex "SMTP" "input timeout"
17372 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17373 input, including batch SMTP. If a line of input (either an SMTP command or a
17374 data line) is not received within this time, the SMTP connection is dropped and
17375 the message is abandoned.
17376 A line is written to the log containing one of the following messages:
17377 .code
17378 SMTP command timeout on connection from...
17379 SMTP data timeout on connection from...
17380 .endd
17381 The former means that Exim was expecting to read an SMTP command; the latter
17382 means that it was in the DATA phase, reading the contents of a message.
17383
17384 If the first character of the option is a &"$"& the option is
17385 expanded before use and may depend on
17386 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17387
17388
17389 .oindex "&%-os%&"
17390 The value set by this option can be overridden by the
17391 &%-os%& command-line option. A setting of zero time disables the timeout, but
17392 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17393 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17394 timeout is controlled by &%receive_timeout%& and &%-or%&.
17395
17396
17397 .option smtp_reserve_hosts main "host list&!!" unset
17398 This option defines hosts for which SMTP connections are reserved; see
17399 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17400
17401
17402 .option smtp_return_error_details main boolean false
17403 .cindex "SMTP" "details policy failures"
17404 .cindex "policy control" "rejection, returning details"
17405 In the default state, Exim uses bland messages such as
17406 &"Administrative prohibition"& when it rejects SMTP commands for policy
17407 reasons. Many sysadmins like this because it gives away little information
17408 to spammers. However, some other sysadmins who are applying strict checking
17409 policies want to give out much fuller information about failures. Setting
17410 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17411 example, instead of &"Administrative prohibition"&, it might give:
17412 .code
17413 550-Rejected after DATA: '>' missing at end of address:
17414 550 failing address in "From" header is: <user@dom.ain
17415 .endd
17416
17417
17418 .option smtputf8_advertise_hosts main "host list&!!" *
17419 .cindex "SMTPUTF8" "advertising"
17420 When Exim is built with support for internationalised mail names,
17421 the availability thereof is advertised in
17422 response to EHLO only to those client hosts that match this option. See
17423 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17424
17425
17426 .option spamd_address main string "127.0.0.1 783"
17427 This option is available when Exim is compiled with the content-scanning
17428 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17429 See section &<<SECTscanspamass>>& for more details.
17430
17431
17432
17433 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17434 This option is available when Exim is compiled with SPF support.
17435 See section &<<SECSPF>>& for more details.
17436
17437
17438
17439 .option split_spool_directory main boolean false
17440 .cindex "multiple spool directories"
17441 .cindex "spool directory" "split"
17442 .cindex "directories, multiple"
17443 If this option is set, it causes Exim to split its input directory into 62
17444 subdirectories, each with a single alphanumeric character as its name. The
17445 sixth character of the message id is used to allocate messages to
17446 subdirectories; this is the least significant base-62 digit of the time of
17447 arrival of the message.
17448
17449 Splitting up the spool in this way may provide better performance on systems
17450 where there are long mail queues, by reducing the number of files in any one
17451 directory. The msglog directory is also split up in a similar way to the input
17452 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17453 are still placed in the single directory &_msglog.OLD_&.
17454
17455 It is not necessary to take any special action for existing messages when
17456 changing &%split_spool_directory%&. Exim notices messages that are in the
17457 &"wrong"& place, and continues to process them. If the option is turned off
17458 after a period of being on, the subdirectories will eventually empty and be
17459 automatically deleted.
17460
17461 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17462 changes. Instead of creating a list of all messages in the queue, and then
17463 trying to deliver each one, in turn, it constructs a list of those in one
17464 sub-directory and tries to deliver them, before moving on to the next
17465 sub-directory. The sub-directories are processed in a random order. This
17466 spreads out the scanning of the input directories, and uses less memory. It is
17467 particularly beneficial when there are lots of messages in the queue. However,
17468 if &%queue_run_in_order%& is set, none of this new processing happens. The
17469 entire queue has to be scanned and sorted before any deliveries can start.
17470
17471
17472 .option spool_directory main string&!! "set at compile time"
17473 .cindex "spool directory" "path to"
17474 This defines the directory in which Exim keeps its spool, that is, the messages
17475 it is waiting to deliver. The default value is taken from the compile-time
17476 configuration setting, if there is one. If not, this option must be set. The
17477 string is expanded, so it can contain, for example, a reference to
17478 &$primary_hostname$&.
17479
17480 If the spool directory name is fixed on your installation, it is recommended
17481 that you set it at build time rather than from this option, particularly if the
17482 log files are being written to the spool directory (see &%log_file_path%&).
17483 Otherwise log files cannot be used for errors that are detected early on, such
17484 as failures in the configuration file.
17485
17486 By using this option to override the compiled-in path, it is possible to run
17487 tests of Exim without using the standard spool.
17488
17489 .option spool_wireformat main boolean false
17490 .cindex "spool directory" "file formats"
17491 If this option is set, Exim may for some messages use an alternative format
17492 for data-files in the spool which matches the wire format.
17493 Doing this permits more efficient message reception and transmission.
17494 Currently it is only done for messages received using the ESMTP CHUNKING
17495 option.
17496
17497 The following variables will not have useful values:
17498 .code
17499 $max_received_linelength
17500 $body_linecount
17501 $body_zerocount
17502 .endd
17503
17504 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17505 and any external programs which are passed a reference to a message data file
17506 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17507 will need to be aware of the different formats potentially available.
17508
17509 Using any of the ACL conditions noted will negate the reception benefit
17510 (as a Unix-mbox-format file is constructed for them).
17511 The transmission benefit is maintained.
17512
17513 .option sqlite_lock_timeout main time 5s
17514 .cindex "sqlite lookup type" "lock timeout"
17515 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17516 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17517
17518 .option strict_acl_vars main boolean false
17519 .cindex "&ACL;" "variables, handling unset"
17520 This option controls what happens if a syntactically valid but undefined ACL
17521 variable is referenced. If it is false (the default), an empty string
17522 is substituted; if it is true, an error is generated. See section
17523 &<<SECTaclvariables>>& for details of ACL variables.
17524
17525 .option strip_excess_angle_brackets main boolean false
17526 .cindex "angle brackets, excess"
17527 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17528 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17529 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17530 passed on to another MTA, the excess angle brackets are not passed on. If this
17531 option is not set, multiple pairs of angle brackets cause a syntax error.
17532
17533
17534 .option strip_trailing_dot main boolean false
17535 .cindex "trailing dot on domain"
17536 .cindex "dot" "trailing on domain"
17537 If this option is set, a trailing dot at the end of a domain in an address is
17538 ignored. If this is in the envelope and the message is passed on to another
17539 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17540 domain causes a syntax error.
17541 However, addresses in header lines are checked only when an ACL requests header
17542 syntax checking.
17543
17544
17545 .option syslog_duplication main boolean true
17546 .cindex "syslog" "duplicate log lines; suppressing"
17547 When Exim is logging to syslog, it writes the log lines for its three
17548 separate logs at different syslog priorities so that they can in principle
17549 be separated on the logging hosts. Some installations do not require this
17550 separation, and in those cases, the duplication of certain log lines is a
17551 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17552 particular log line is written to syslog. For lines that normally go to
17553 both the main log and the reject log, the reject log version (possibly
17554 containing message header lines) is written, at LOG_NOTICE priority.
17555 Lines that normally go to both the main and the panic log are written at
17556 the LOG_ALERT priority.
17557
17558
17559 .option syslog_facility main string unset
17560 .cindex "syslog" "facility; setting"
17561 This option sets the syslog &"facility"& name, used when Exim is logging to
17562 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17563 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17564 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17565 details of Exim's logging.
17566
17567
17568 .option syslog_pid main boolean true
17569 .cindex "syslog" "pid"
17570 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17571 omitted when these lines are sent to syslog. (Syslog normally prefixes
17572 the log lines with the PID of the logging process automatically.) You need
17573 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17574 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17575
17576
17577
17578 .option syslog_processname main string &`exim`&
17579 .cindex "syslog" "process name; setting"
17580 This option sets the syslog &"ident"& name, used when Exim is logging to
17581 syslog. The value must be no longer than 32 characters. See chapter
17582 &<<CHAPlog>>& for details of Exim's logging.
17583
17584
17585
17586 .option syslog_timestamp main boolean true
17587 .cindex "syslog" "timestamps"
17588 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17589 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17590 details of Exim's logging.
17591
17592
17593 .option system_filter main string&!! unset
17594 .cindex "filter" "system filter"
17595 .cindex "system filter" "specifying"
17596 .cindex "Sieve filter" "not available for system filter"
17597 This option specifies an Exim filter file that is applied to all messages at
17598 the start of each delivery attempt, before any routing is done. System filters
17599 must be Exim filters; they cannot be Sieve filters. If the system filter
17600 generates any deliveries to files or pipes, or any new mail messages, the
17601 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17602 which transports are to be used. Details of this facility are given in chapter
17603 &<<CHAPsystemfilter>>&.
17604 A forced expansion failure results in no filter operation.
17605
17606
17607 .option system_filter_directory_transport main string&!! unset
17608 .vindex "&$address_file$&"
17609 This sets the name of the transport driver that is to be used when the
17610 &%save%& command in a system message filter specifies a path ending in &"/"&,
17611 implying delivery of each message into a separate file in some directory.
17612 During the delivery, the variable &$address_file$& contains the path name.
17613
17614
17615 .option system_filter_file_transport main string&!! unset
17616 .cindex "file" "transport for system filter"
17617 This sets the name of the transport driver that is to be used when the &%save%&
17618 command in a system message filter specifies a path not ending in &"/"&. During
17619 the delivery, the variable &$address_file$& contains the path name.
17620
17621 .option system_filter_group main string unset
17622 .cindex "gid (group id)" "system filter"
17623 This option is used only when &%system_filter_user%& is also set. It sets the
17624 gid under which the system filter is run, overriding any gid that is associated
17625 with the user. The value may be numerical or symbolic.
17626
17627 .option system_filter_pipe_transport main string&!! unset
17628 .cindex "&(pipe)& transport" "for system filter"
17629 .vindex "&$address_pipe$&"
17630 This specifies the transport driver that is to be used when a &%pipe%& command
17631 is used in a system filter. During the delivery, the variable &$address_pipe$&
17632 contains the pipe command.
17633
17634
17635 .option system_filter_reply_transport main string&!! unset
17636 .cindex "&(autoreply)& transport" "for system filter"
17637 This specifies the transport driver that is to be used when a &%mail%& command
17638 is used in a system filter.
17639
17640
17641 .option system_filter_user main string unset
17642 .cindex "uid (user id)" "system filter"
17643 If this option is set to root, the system filter is run in the main Exim
17644 delivery process, as root.  Otherwise, the system filter runs in a separate
17645 process, as the given user, defaulting to the Exim run-time user.
17646 Unless the string consists entirely of digits, it
17647 is looked up in the password data. Failure to find the named user causes a
17648 configuration error. The gid is either taken from the password data, or
17649 specified by &%system_filter_group%&. When the uid is specified numerically,
17650 &%system_filter_group%& is required to be set.
17651
17652 If the system filter generates any pipe, file, or reply deliveries, the uid
17653 under which the filter is run is used when transporting them, unless a
17654 transport option overrides.
17655
17656
17657 .option tcp_nodelay main boolean true
17658 .cindex "daemon" "TCP_NODELAY on sockets"
17659 .cindex "Nagle algorithm"
17660 .cindex "TCP_NODELAY on listening sockets"
17661 If this option is set false, it stops the Exim daemon setting the
17662 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17663 turns off the &"Nagle algorithm"&, which is a way of improving network
17664 performance in interactive (character-by-character) situations. Turning it off
17665 should improve Exim's performance a bit, so that is what happens by default.
17666 However, it appears that some broken clients cannot cope, and time out. Hence
17667 this option. It affects only those sockets that are set up for listening by the
17668 daemon. Sockets created by the smtp transport for delivering mail always set
17669 TCP_NODELAY.
17670
17671
17672 .option timeout_frozen_after main time 0s
17673 .cindex "frozen messages" "timing out"
17674 .cindex "timeout" "frozen messages"
17675 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17676 message of any kind that has been in the queue for longer than the given time
17677 is automatically cancelled at the next queue run. If the frozen message is a
17678 bounce message, it is just discarded; otherwise, a bounce is sent to the
17679 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17680 If you want to timeout frozen bounce messages earlier than other kinds of
17681 frozen message, see &%ignore_bounce_errors_after%&.
17682
17683 &*Note:*& the default value of zero means no timeouts; with this setting,
17684 frozen messages remain in the queue forever (except for any frozen bounce
17685 messages that are released by &%ignore_bounce_errors_after%&).
17686
17687
17688 .option timezone main string unset
17689 .cindex "timezone, setting"
17690 .cindex "environment" "values from"
17691 The value of &%timezone%& is used to set the environment variable TZ while
17692 running Exim (if it is different on entry). This ensures that all timestamps
17693 created by Exim are in the required timezone. If you want all your timestamps
17694 to be in UTC (aka GMT) you should set
17695 .code
17696 timezone = UTC
17697 .endd
17698 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17699 or, if that is not set, from the value of the TZ environment variable when Exim
17700 is built. If &%timezone%& is set to the empty string, either at build or run
17701 time, any existing TZ variable is removed from the environment when Exim
17702 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17703 unfortunately not all, operating systems.
17704
17705
17706 .option tls_advertise_hosts main "host list&!!" *
17707 .cindex "TLS" "advertising"
17708 .cindex "encryption" "on SMTP connection"
17709 .cindex "SMTP" "encrypted connection"
17710 When Exim is built with support for TLS encrypted connections, the availability
17711 of the STARTTLS command to set up an encrypted session is advertised in
17712 response to EHLO only to those client hosts that match this option. See
17713 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17714 Note that the default value requires that a certificate be supplied
17715 using the &%tls_certificate%& option.  If TLS support for incoming connections
17716 is not required the &%tls_advertise_hosts%& option should be set empty.
17717
17718
17719 .option tls_certificate main string list&!! unset
17720 .cindex "TLS" "server certificate; location of"
17721 .cindex "certificate" "server, location of"
17722 The value of this option is expanded, and must then be a list of absolute paths to
17723 files which contain the server's certificates (in PEM format).
17724 Commonly only one file is needed.
17725 The server's private key is also
17726 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17727 &<<CHAPTLS>>& for further details.
17728
17729 &*Note*&: The certificates defined by this option are used only when Exim is
17730 receiving incoming messages as a server. If you want to supply certificates for
17731 use when sending messages as a client, you must set the &%tls_certificate%&
17732 option in the relevant &(smtp)& transport.
17733
17734 &*Note*&: If you use filenames based on IP addresses, change the list
17735 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
17736
17737 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
17738 when a list of more than one
17739 file is used, the &$tls_in_ourcert$& variable is unreliable.
17740 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
17741
17742 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17743 if the OpenSSL build supports TLS extensions and the TLS client sends the
17744 Server Name Indication extension, then this option and others documented in
17745 &<<SECTtlssni>>& will be re-expanded.
17746
17747 If this option is unset or empty a fresh self-signed certificate will be
17748 generated for every connection.
17749
17750 .option tls_crl main string&!! unset
17751 .cindex "TLS" "server certificate revocation list"
17752 .cindex "certificate" "revocation list for server"
17753 This option specifies a certificate revocation list. The expanded value must
17754 be the name of a file that contains CRLs in PEM format.
17755
17756 Under OpenSSL the option can specify a directory with CRL files.
17757
17758 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
17759 for each signing element of the certificate chain (i.e. all but the leaf).
17760 For the file variant this can be multiple PEM blocks in the one file.
17761
17762 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17763
17764
17765 .option tls_dh_max_bits main integer 2236
17766 .cindex "TLS" "D-H bit count"
17767 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17768 the chosen TLS library.  That value might prove to be too high for
17769 interoperability.  This option provides a maximum clamp on the value
17770 suggested, trading off security for interoperability.
17771
17772 The value must be at least 1024.
17773
17774 The value 2236 was chosen because, at time of adding the option, it was the
17775 hard-coded maximum value supported by the NSS cryptographic library, as used
17776 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17777
17778 If you prefer more security and are willing to break some clients, raise this
17779 number.
17780
17781 Note that the value passed to GnuTLS for *generating* a new prime may be a
17782 little less than this figure, because GnuTLS is inexact and may produce a
17783 larger prime than requested.
17784
17785
17786 .option tls_dhparam main string&!! unset
17787 .cindex "TLS" "D-H parameters for server"
17788 The value of this option is expanded and indicates the source of DH parameters
17789 to be used by Exim.
17790
17791 This option is ignored for GnuTLS version 3.6.0 and later.
17792 The library manages parameter negotiation internally.
17793
17794 &*Note: The Exim Maintainers strongly recommend,
17795 for other TLS library versions,
17796 using a filename with site-generated
17797 local DH parameters*&, which has been supported across all versions of Exim.  The
17798 other specific constants available are a fallback so that even when
17799 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17800
17801 If &%tls_dhparam%& is a filename starting with a &`/`&,
17802 then it names a file from which DH
17803 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17804 PKCS#3 representation of the DH prime.  If the file does not exist, for
17805 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17806 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17807 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17808 and treated as though the &%tls_dhparam%& were set to "none".
17809
17810 If this option expands to the string "none", then no DH parameters will be
17811 loaded by Exim.
17812
17813 If this option expands to the string "historic" and Exim is using GnuTLS, then
17814 Exim will attempt to load a file from inside the spool directory.  If the file
17815 does not exist, Exim will attempt to create it.
17816 See section &<<SECTgnutlsparam>>& for further details.
17817
17818 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17819 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17820
17821 In older versions of Exim the default was the 2048 bit prime described in section
17822 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17823 in IKE is assigned number 23.
17824
17825 Otherwise, the option must expand to the name used by Exim for any of a number
17826 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17827 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17828 the number used by IKE, or "default" which corresponds to
17829 &`exim.dev.20160529.3`&.
17830
17831 The available standard primes are:
17832 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17833 &`ike1`&, &`ike2`&, &`ike5`&,
17834 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17835 &`ike22`&, &`ike23`& and &`ike24`&.
17836
17837 The available additional primes are:
17838 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17839
17840 Some of these will be too small to be accepted by clients.
17841 Some may be too large to be accepted by clients.
17842 The open cryptographic community has suspicions about the integrity of some
17843 of the later IKE values, which led into RFC7919 providing new fixed constants
17844 (the "ffdhe" identifiers).
17845
17846 At this point, all of the "ike" values should be considered obsolete;
17847 they're still in Exim to avoid breaking unusual configurations, but are
17848 candidates for removal the next time we have backwards-incompatible changes.
17849
17850 The TLS protocol does not negotiate an acceptable size for this; clients tend
17851 to hard-drop connections if what is offered by the server is unacceptable,
17852 whether too large or too small, and there's no provision for the client to
17853 tell the server what these constraints are.  Thus, as a server operator, you
17854 need to make an educated guess as to what is most likely to work for your
17855 userbase.
17856
17857 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17858 is most likely to maximise interoperability.  The upper bound comes from
17859 applications using the Mozilla Network Security Services (NSS) library, which
17860 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17861 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17862 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17863 acceptable bound from 1024 to 2048.
17864
17865
17866 .option tls_eccurve main string&!! &`auto`&
17867 .cindex TLS "EC cryptography"
17868 This option selects a EC curve for use by Exim when used with OpenSSL.
17869 It has no effect when Exim is used with GnuTLS.
17870
17871 After expansion it must contain a valid EC curve parameter, such as
17872 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17873 for valid selections.
17874
17875 For OpenSSL versions before (and not including) 1.0.2, the string
17876 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17877 &`auto`& tells the library to choose.
17878
17879 If the option expands to an empty string, no EC curves will be enabled.
17880
17881
17882 .option tls_ocsp_file main string&!! unset
17883 .cindex TLS "certificate status"
17884 .cindex TLS "OCSP proof file"
17885 This option
17886 must if set expand to the absolute path to a file which contains a current
17887 status proof for the server's certificate, as obtained from the
17888 Certificate Authority.
17889
17890 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17891 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
17892
17893 For OpenSSL 1.1.0 or later, and
17894 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
17895 of files, to match a list given for the &%tls_certificate%& option.
17896 The ordering of the two lists must match.
17897 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
17898
17899 The file(s) should be in DER format,
17900 except for GnuTLS 3.6.3 or later
17901 or for OpenSSL,
17902 when an optional filetype prefix can be used.
17903 The prefix must be one of "DER" or "PEM", followed by
17904 a single space.  If one is used it sets the format for subsequent
17905 files in the list; the initial format is DER.
17906 If multiple proofs are wanted, for multiple chain elements
17907 (this only works under TLS1.3)
17908 they must be coded as a combined OCSP response.
17909
17910 Although GnuTLS will accept PEM files with multiple separate
17911 PEM blobs (ie. separate OCSP responses), it sends them in the
17912 TLS Certificate record interleaved with the certificates of the chain;
17913 although a GnuTLS client is happy with that, an OpenSSL client is not.
17914
17915 .option tls_on_connect_ports main "string list" unset
17916 .cindex SSMTP
17917 .cindex SMTPS
17918 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17919 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
17920 set up without waiting for the client to issue a STARTTLS command. For
17921 further details, see section &<<SECTsupobssmt>>&.
17922
17923
17924
17925 .option tls_privatekey main string list&!! unset
17926 .cindex "TLS" "server private key; location of"
17927 The value of this option is expanded, and must then be a list of absolute paths to
17928 files which contains the server's private keys.
17929 If this option is unset, or if
17930 the expansion is forced to fail, or the result is an empty string, the private
17931 key is assumed to be in the same file as the server's certificates. See chapter
17932 &<<CHAPTLS>>& for further details.
17933
17934 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17935
17936
17937 .option tls_remember_esmtp main boolean false
17938 .cindex "TLS" "esmtp state; remembering"
17939 .cindex "TLS" "broken clients"
17940 If this option is set true, Exim violates the RFCs by remembering that it is in
17941 &"esmtp"& state after successfully negotiating a TLS session. This provides
17942 support for broken clients that fail to send a new EHLO after starting a
17943 TLS session.
17944
17945
17946 .option tls_require_ciphers main string&!! unset
17947 .cindex "TLS" "requiring specific ciphers"
17948 .cindex "cipher" "requiring specific"
17949 This option controls which ciphers can be used for incoming TLS connections.
17950 The &(smtp)& transport has an option of the same name for controlling outgoing
17951 connections. This option is expanded for each connection, so can be varied for
17952 different clients if required. The value of this option must be a list of
17953 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17954 in somewhat different ways. If GnuTLS is being used, the client controls the
17955 preference order of the available ciphers. Details are given in sections
17956 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17957
17958
17959 .option tls_try_verify_hosts main "host list&!!" unset
17960 .cindex "TLS" "client certificate verification"
17961 .cindex "certificate" "verification of client"
17962 See &%tls_verify_hosts%& below.
17963
17964
17965 .option tls_verify_certificates main string&!! system
17966 .cindex "TLS" "client certificate verification"
17967 .cindex "certificate" "verification of client"
17968 The value of this option is expanded, and must then be either the
17969 word "system"
17970 or the absolute path to
17971 a file or directory containing permitted certificates for clients that
17972 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17973
17974 The "system" value for the option will use a
17975 system default location compiled into the SSL library.
17976 This is not available for GnuTLS versions preceding 3.0.20,
17977 and will be taken as empty; an explicit location
17978 must be specified.
17979
17980 The use of a directory for the option value is not available for GnuTLS versions
17981 preceding 3.3.6 and a single file must be used.
17982
17983 With OpenSSL the certificates specified
17984 explicitly
17985 either by file or directory
17986 are added to those given by the system default location.
17987
17988 These certificates should be for the certificate authorities trusted, rather
17989 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17990 the value is a file then the certificates are sent by Exim as a server to
17991 connecting clients, defining the list of accepted certificate authorities.
17992 Thus the values defined should be considered public data.  To avoid this,
17993 use the explicit directory version.
17994
17995 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17996
17997 A forced expansion failure or setting to an empty string is equivalent to
17998 being unset.
17999
18000
18001 .option tls_verify_hosts main "host list&!!" unset
18002 .cindex "TLS" "client certificate verification"
18003 .cindex "certificate" "verification of client"
18004 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18005 certificates from clients. The expected certificates are defined by
18006 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18007 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18008 &%tls_verify_certificates%& is not set.
18009
18010 Any client that matches &%tls_verify_hosts%& is constrained by
18011 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18012 present one of the listed certificates. If it does not, the connection is
18013 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18014 the host to use TLS. It can still send SMTP commands through unencrypted
18015 connections. Forcing a client to use TLS has to be done separately using an
18016 ACL to reject inappropriate commands when the connection is not encrypted.
18017
18018 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18019 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18020 certificate and checks it against &%tls_verify_certificates%&, but does not
18021 abort the connection if there is no certificate or if it does not match. This
18022 state can be detected in an ACL, which makes it possible to implement policies
18023 such as &"accept for relay only if a verified certificate has been received,
18024 but accept for local delivery if encrypted, even without a verified
18025 certificate"&.
18026
18027 Client hosts that match neither of these lists are not asked to present
18028 certificates.
18029
18030
18031 .option trusted_groups main "string list&!!" unset
18032 .cindex "trusted groups"
18033 .cindex "groups" "trusted"
18034 This option is expanded just once, at the start of Exim's processing. If this
18035 option is set, any process that is running in one of the listed groups, or
18036 which has one of them as a supplementary group, is trusted. The groups can be
18037 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18038 details of what trusted callers are permitted to do. If neither
18039 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18040 are trusted.
18041
18042 .option trusted_users main "string list&!!" unset
18043 .cindex "trusted users"
18044 .cindex "user" "trusted"
18045 This option is expanded just once, at the start of Exim's processing. If this
18046 option is set, any process that is running as one of the listed users is
18047 trusted. The users can be specified numerically or by name. See section
18048 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18049 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18050 Exim user are trusted.
18051
18052 .option unknown_login main string&!! unset
18053 .cindex "uid (user id)" "unknown caller"
18054 .vindex "&$caller_uid$&"
18055 This is a specialized feature for use in unusual configurations. By default, if
18056 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18057 gives up. The &%unknown_login%& option can be used to set a login name to be
18058 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18059 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18060 is used for the user's real name (gecos field), unless this has been set by the
18061 &%-F%& option.
18062
18063 .option unknown_username main string unset
18064 See &%unknown_login%&.
18065
18066 .option untrusted_set_sender main "address list&!!" unset
18067 .cindex "trusted users"
18068 .cindex "sender" "setting by untrusted user"
18069 .cindex "untrusted user setting sender"
18070 .cindex "user" "untrusted setting sender"
18071 .cindex "envelope from"
18072 .cindex "envelope sender"
18073 When an untrusted user submits a message to Exim using the standard input, Exim
18074 normally creates an envelope sender address from the user's login and the
18075 default qualification domain. Data from the &%-f%& option (for setting envelope
18076 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18077 is used) is ignored.
18078
18079 However, untrusted users are permitted to set an empty envelope sender address,
18080 to declare that a message should never generate any bounces. For example:
18081 .code
18082 exim -f '<>' user@domain.example
18083 .endd
18084 .vindex "&$sender_ident$&"
18085 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18086 other envelope sender addresses in a controlled way. When it is set, untrusted
18087 users are allowed to set envelope sender addresses that match any of the
18088 patterns in the list. Like all address lists, the string is expanded. The
18089 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18090 users to setting senders that start with their login ids
18091 followed by a hyphen
18092 by a setting like this:
18093 .code
18094 untrusted_set_sender = ^$sender_ident-
18095 .endd
18096 If you want to allow untrusted users to set envelope sender addresses without
18097 restriction, you can use
18098 .code
18099 untrusted_set_sender = *
18100 .endd
18101 The &%untrusted_set_sender%& option applies to all forms of local input, but
18102 only to the setting of the envelope sender. It does not permit untrusted users
18103 to use the other options which trusted user can use to override message
18104 parameters. Furthermore, it does not stop Exim from removing an existing
18105 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18106 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18107 overriding these actions. The handling of the &'Sender:'& header is also
18108 described in section &<<SECTthesenhea>>&.
18109
18110 The log line for a message's arrival shows the envelope sender following
18111 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18112 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18113 envelope sender address, the user's login is shown in parentheses after the
18114 sender address.
18115
18116
18117 .option uucp_from_pattern main string "see below"
18118 .cindex "&""From""& line"
18119 .cindex "UUCP" "&""From""& line"
18120 Some applications that pass messages to an MTA via a command line interface use
18121 an initial line starting with &"From&~"& to pass the envelope sender. In
18122 particular, this is used by UUCP software. Exim recognizes such a line by means
18123 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18124 matches, the sender address is constructed by expanding the contents of
18125 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18126 default pattern recognizes lines in the following two forms:
18127 .code
18128 From ph10 Fri Jan  5 12:35 GMT 1996
18129 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18130 .endd
18131 The pattern can be seen by running
18132 .code
18133 exim -bP uucp_from_pattern
18134 .endd
18135 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18136 year in the second case. The first word after &"From&~"& is matched in the
18137 regular expression by a parenthesized subpattern. The default value for
18138 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18139 (&"ph10"& in the example above) as the message's sender. See also
18140 &%ignore_fromline_hosts%&.
18141
18142
18143 .option uucp_from_sender main string&!! &`$1`&
18144 See &%uucp_from_pattern%& above.
18145
18146
18147 .option warn_message_file main string unset
18148 .cindex "warning of delay" "customizing the message"
18149 .cindex "customizing" "warning message"
18150 This option defines a template file containing paragraphs of text to be used
18151 for constructing the warning message which is sent by Exim when a message has
18152 been in the queue for a specified amount of time, as specified by
18153 &%delay_warning%&. Details of the file's contents are given in chapter
18154 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
18155
18156
18157 .option write_rejectlog main boolean true
18158 .cindex "reject log" "disabling"
18159 If this option is set false, Exim no longer writes anything to the reject log.
18160 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18161 .ecindex IIDconfima
18162 .ecindex IIDmaiconf
18163
18164
18165
18166
18167 . ////////////////////////////////////////////////////////////////////////////
18168 . ////////////////////////////////////////////////////////////////////////////
18169
18170 .chapter "Generic options for routers" "CHAProutergeneric"
18171 .scindex IIDgenoprou1 "options" "generic; for routers"
18172 .scindex IIDgenoprou2 "generic options" "router"
18173 This chapter describes the generic options that apply to all routers.
18174 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18175
18176 For a general description of how a router operates, see sections
18177 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18178 which the preconditions are tested. The order of expansion of the options that
18179 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18180 &%headers_remove%&, &%transport%&.
18181
18182
18183
18184 .option address_data routers string&!! unset
18185 .cindex "router" "data attached to address"
18186 The string is expanded just before the router is run, that is, after all the
18187 precondition tests have succeeded. If the expansion is forced to fail, the
18188 router declines, the value of &%address_data%& remains unchanged, and the
18189 &%more%& option controls what happens next. Other expansion failures cause
18190 delivery of the address to be deferred.
18191
18192 .vindex "&$address_data$&"
18193 When the expansion succeeds, the value is retained with the address, and can be
18194 accessed using the variable &$address_data$& in the current router, subsequent
18195 routers, and the eventual transport.
18196
18197 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18198 that runs a user's filter file, the contents of &$address_data$& are accessible
18199 in the filter. This is not normally a problem, because such data is usually
18200 either not confidential or it &"belongs"& to the current user, but if you do
18201 put confidential data into &$address_data$& you need to remember this point.
18202
18203 Even if the router declines or passes, the value of &$address_data$& remains
18204 with the address, though it can be changed by another &%address_data%& setting
18205 on a subsequent router. If a router generates child addresses, the value of
18206 &$address_data$& propagates to them. This also applies to the special kind of
18207 &"child"& that is generated by a router with the &%unseen%& option.
18208
18209 The idea of &%address_data%& is that you can use it to look up a lot of data
18210 for the address once, and then pick out parts of the data later. For example,
18211 you could use a single LDAP lookup to return a string of the form
18212 .code
18213 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18214 .endd
18215 In the transport you could pick out the mailbox by a setting such as
18216 .code
18217 file = ${extract{mailbox}{$address_data}}
18218 .endd
18219 This makes the configuration file less messy, and also reduces the number of
18220 lookups (though Exim does cache lookups).
18221
18222 See also the &%set%& option below.
18223
18224 .vindex "&$sender_address_data$&"
18225 .vindex "&$address_data$&"
18226 The &%address_data%& facility is also useful as a means of passing information
18227 from one router to another, and from a router to a transport. In addition, if
18228 &$address_data$& is set by a router when verifying a recipient address from an
18229 ACL, it remains available for use in the rest of the ACL statement. After
18230 verifying a sender, the value is transferred to &$sender_address_data$&.
18231
18232
18233
18234 .option address_test routers&!? boolean true
18235 .oindex "&%-bt%&"
18236 .cindex "router" "skipping when address testing"
18237 If this option is set false, the router is skipped when routing is being tested
18238 by means of the &%-bt%& command line option. This can be a convenience when
18239 your first router sends messages to an external scanner, because it saves you
18240 having to set the &"already scanned"& indicator when testing real address
18241 routing.
18242
18243
18244
18245 .option cannot_route_message routers string&!! unset
18246 .cindex "router" "customizing &""cannot route""& message"
18247 .cindex "customizing" "&""cannot route""& message"
18248 This option specifies a text message that is used when an address cannot be
18249 routed because Exim has run out of routers. The default message is
18250 &"Unrouteable address"&. This option is useful only on routers that have
18251 &%more%& set false, or on the very last router in a configuration, because the
18252 value that is used is taken from the last router that is considered. This
18253 includes a router that is skipped because its preconditions are not met, as
18254 well as a router that declines. For example, using the default configuration,
18255 you could put:
18256 .code
18257 cannot_route_message = Remote domain not found in DNS
18258 .endd
18259 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18260 and
18261 .code
18262 cannot_route_message = Unknown local user
18263 .endd
18264 on the final router that checks for local users. If string expansion fails for
18265 this option, the default message is used. Unless the expansion failure was
18266 explicitly forced, a message about the failure is written to the main and panic
18267 logs, in addition to the normal message about the routing failure.
18268
18269
18270 .option caseful_local_part routers boolean false
18271 .cindex "case of local parts"
18272 .cindex "router" "case of local parts"
18273 By default, routers handle the local parts of addresses in a case-insensitive
18274 manner, though the actual case is preserved for transmission with the message.
18275 If you want the case of letters to be significant in a router, you must set
18276 this option true. For individual router options that contain address or local
18277 part lists (for example, &%local_parts%&), case-sensitive matching can be
18278 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18279 more details.
18280
18281 .vindex "&$local_part$&"
18282 .vindex "&$original_local_part$&"
18283 .vindex "&$parent_local_part$&"
18284 The value of the &$local_part$& variable is forced to lower case while a
18285 router is running unless &%caseful_local_part%& is set. When a router assigns
18286 an address to a transport, the value of &$local_part$& when the transport runs
18287 is the same as it was in the router. Similarly, when a router generates child
18288 addresses by aliasing or forwarding, the values of &$original_local_part$&
18289 and &$parent_local_part$& are those that were used by the redirecting router.
18290
18291 This option applies to the processing of an address by a router. When a
18292 recipient address is being processed in an ACL, there is a separate &%control%&
18293 modifier that can be used to specify case-sensitive processing within the ACL
18294 (see section &<<SECTcontrols>>&).
18295
18296
18297
18298 .option check_local_user routers&!? boolean false
18299 .cindex "local user, checking in router"
18300 .cindex "router" "checking for local user"
18301 .cindex "&_/etc/passwd_&"
18302 .vindex "&$home$&"
18303 When this option is true, Exim checks that the local part of the recipient
18304 address (with affixes removed if relevant) is the name of an account on the
18305 local system. The check is done by calling the &[getpwnam()]& function rather
18306 than trying to read &_/etc/passwd_& directly. This means that other methods of
18307 holding password data (such as NIS) are supported. If the local part is a local
18308 user, &$home$& is set from the password data, and can be tested in other
18309 preconditions that are evaluated after this one (the order of evaluation is
18310 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18311 overridden by &%router_home_directory%&. If the local part is not a local user,
18312 the router is skipped.
18313
18314 If you want to check that the local part is either the name of a local user
18315 or matches something else, you cannot combine &%check_local_user%& with a
18316 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18317 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18318 setting to achieve this. For example:
18319 .code
18320 local_parts = passwd;$local_part : lsearch;/etc/other/users
18321 .endd
18322 Note, however, that the side effects of &%check_local_user%& (such as setting
18323 up a home directory) do not occur when a &(passwd)& lookup is used in a
18324 &%local_parts%& (or any other) precondition.
18325
18326
18327
18328 .option condition routers&!? string&!! unset
18329 .cindex "router" "customized precondition"
18330 This option specifies a general precondition test that has to succeed for the
18331 router to be called. The &%condition%& option is the last precondition to be
18332 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18333 result is a forced failure, or an empty string, or one of the strings &"0"& or
18334 &"no"& or &"false"& (checked without regard to the case of the letters), the
18335 router is skipped, and the address is offered to the next one.
18336
18337 If the result is any other value, the router is run (as this is the last
18338 precondition to be evaluated, all the other preconditions must be true).
18339
18340 This option is unusual in that multiple &%condition%& options may be present.
18341 All &%condition%& options must succeed.
18342
18343 The &%condition%& option provides a means of applying custom conditions to the
18344 running of routers. Note that in the case of a simple conditional expansion,
18345 the default expansion values are exactly what is wanted. For example:
18346 .code
18347 condition = ${if >{$message_age}{600}}
18348 .endd
18349 Because of the default behaviour of the string expansion, this is equivalent to
18350 .code
18351 condition = ${if >{$message_age}{600}{true}{}}
18352 .endd
18353
18354 A multiple condition example, which succeeds:
18355 .code
18356 condition = ${if >{$message_age}{600}}
18357 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18358 condition = foobar
18359 .endd
18360
18361 If the expansion fails (other than forced failure) delivery is deferred. Some
18362 of the other precondition options are common special cases that could in fact
18363 be specified using &%condition%&.
18364
18365 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18366 are far older, and use one set of semantics.  ACLs are newer and when
18367 they were created, the ACL &%condition%& process was given far stricter
18368 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18369 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18370 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18371 Router rules processing behavior.
18372
18373 This is best illustrated in an example:
18374 .code
18375 # If used in an ACL condition will fail with a syntax error, but
18376 # in a router condition any extra characters are treated as a string
18377
18378 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18379 true {yes} {no}}
18380
18381 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18382  {yes} {no}}
18383 .endd
18384 In each example above, the &%if%& statement actually ends after
18385 &"{google.com}}"&.  Since no true or false braces were defined, the
18386 default &%if%& behavior is to return a boolean true or a null answer
18387 (which evaluates to false). The rest of the line is then treated as a
18388 string. So the first example resulted in the boolean answer &"true"&
18389 with the string &" {yes} {no}}"& appended to it. The second example
18390 resulted in the null output (indicating false) with the string
18391 &" {yes} {no}}"& appended to it.
18392
18393 In fact you can put excess forward braces in too.  In the router
18394 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18395 mean something, like after a &"$"& or when required as part of a
18396 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18397 string characters.
18398
18399 Thus, in a Router, the above expansion strings will both always evaluate
18400 true, as the result of expansion is a non-empty string which doesn't
18401 match an explicit false value.  This can be tricky to debug.  By
18402 contrast, in an ACL either of those strings will always result in an
18403 expansion error because the result doesn't look sufficiently boolean.
18404
18405
18406 .option debug_print routers string&!! unset
18407 .cindex "testing" "variables in drivers"
18408 If this option is set and debugging is enabled (see the &%-d%& command line
18409 option) or in address-testing mode (see the &%-bt%& command line option),
18410 the string is expanded and included in the debugging output.
18411 If expansion of the string fails, the error message is written to the debugging
18412 output, and Exim carries on processing.
18413 This option is provided to help with checking out the values of variables and
18414 so on when debugging router configurations. For example, if a &%condition%&
18415 option appears not to be working, &%debug_print%& can be used to output the
18416 variables it references. The output happens after checks for &%domains%&,
18417 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18418 are tested. A newline is added to the text if it does not end with one.
18419 The variable &$router_name$& contains the name of the router.
18420
18421
18422
18423 .option disable_logging routers boolean false
18424 If this option is set true, nothing is logged for any routing errors
18425 or for any deliveries caused by this router. You should not set this option
18426 unless you really, really know what you are doing. See also the generic
18427 transport option of the same name.
18428
18429 .option dnssec_request_domains routers "domain list&!!" *
18430 .cindex "MX record" "security"
18431 .cindex "DNSSEC" "MX lookup"
18432 .cindex "security" "MX lookup"
18433 .cindex "DNS" "DNSSEC"
18434 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18435 the dnssec request bit set.
18436 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18437
18438 .option dnssec_require_domains routers "domain list&!!" unset
18439 .cindex "MX record" "security"
18440 .cindex "DNSSEC" "MX lookup"
18441 .cindex "security" "MX lookup"
18442 .cindex "DNS" "DNSSEC"
18443 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18444 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18445 (AD bit) set will be ignored and logged as a host-lookup failure.
18446 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18447
18448
18449 .option domains routers&!? "domain list&!!" unset
18450 .cindex "router" "restricting to specific domains"
18451 .vindex "&$domain_data$&"
18452 If this option is set, the router is skipped unless the current domain matches
18453 the list. If the match is achieved by means of a file lookup, the data that the
18454 lookup returned for the domain is placed in &$domain_data$& for use in string
18455 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18456 a list of the order in which preconditions are evaluated.
18457
18458
18459
18460 .option driver routers string unset
18461 This option must always be set. It specifies which of the available routers is
18462 to be used.
18463
18464
18465 .option dsn_lasthop routers boolean false
18466 .cindex "DSN" "success"
18467 .cindex "Delivery Status Notification" "success"
18468 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18469 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18470 instead send a success DSN as if the next hop does not support DSN.
18471 Not effective on redirect routers.
18472
18473
18474
18475 .option errors_to routers string&!! unset
18476 .cindex "envelope from"
18477 .cindex "envelope sender"
18478 .cindex "router" "changing address for errors"
18479 If a router successfully handles an address, it may assign the address to a
18480 transport for delivery or it may generate child addresses. In both cases, if
18481 there is a delivery problem during later processing, the resulting bounce
18482 message is sent to the address that results from expanding this string,
18483 provided that the address verifies successfully. The &%errors_to%& option is
18484 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18485
18486 The &%errors_to%& setting associated with an address can be overridden if it
18487 subsequently passes through other routers that have their own &%errors_to%&
18488 settings, or if the message is delivered by a transport with a &%return_path%&
18489 setting.
18490
18491 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18492 the expansion fails to verify, the errors address associated with the incoming
18493 address is used. At top level, this is the envelope sender. A non-forced
18494 expansion failure causes delivery to be deferred.
18495
18496 If an address for which &%errors_to%& has been set ends up being delivered over
18497 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18498 any bounces that are generated by other MTAs on the delivery route are also
18499 sent there. You can set &%errors_to%& to the empty string by either of these
18500 settings:
18501 .code
18502 errors_to =
18503 errors_to = ""
18504 .endd
18505 An expansion item that yields an empty string has the same effect. If you do
18506 this, a locally detected delivery error for addresses processed by this router
18507 no longer gives rise to a bounce message; the error is discarded. If the
18508 address is delivered to a remote host, the return path is set to &`<>`&, unless
18509 overridden by the &%return_path%& option on the transport.
18510
18511 .vindex "&$address_data$&"
18512 If for some reason you want to discard local errors, but use a non-empty
18513 MAIL command for remote delivery, you can preserve the original return
18514 path in &$address_data$& in the router, and reinstate it in the transport by
18515 setting &%return_path%&.
18516
18517 The most common use of &%errors_to%& is to direct mailing list bounces to the
18518 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18519 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18520
18521
18522
18523 .option expn routers&!? boolean true
18524 .cindex "address" "testing"
18525 .cindex "testing" "addresses"
18526 .cindex "EXPN" "router skipping"
18527 .cindex "router" "skipping for EXPN"
18528 If this option is turned off, the router is skipped when testing an address
18529 as a result of processing an SMTP EXPN command. You might, for example,
18530 want to turn it off on a router for users' &_.forward_& files, while leaving it
18531 on for the system alias file.
18532 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18533 are evaluated.
18534
18535 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18536 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18537 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18538
18539
18540
18541 .option fail_verify routers boolean false
18542 .cindex "router" "forcing verification failure"
18543 Setting this option has the effect of setting both &%fail_verify_sender%& and
18544 &%fail_verify_recipient%& to the same value.
18545
18546
18547
18548 .option fail_verify_recipient routers boolean false
18549 If this option is true and an address is accepted by this router when
18550 verifying a recipient, verification fails.
18551
18552
18553
18554 .option fail_verify_sender routers boolean false
18555 If this option is true and an address is accepted by this router when
18556 verifying a sender, verification fails.
18557
18558
18559
18560 .option fallback_hosts routers "string list" unset
18561 .cindex "router" "fallback hosts"
18562 .cindex "fallback" "hosts specified on router"
18563 String expansion is not applied to this option. The argument must be a
18564 colon-separated list of host names or IP addresses. The list separator can be
18565 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
18566 each name or address. In fact, the format of each item is exactly the same as
18567 defined for the list of hosts in a &(manualroute)& router (see section
18568 &<<SECTformatonehostitem>>&).
18569
18570 If a router queues an address for a remote transport, this host list is
18571 associated with the address, and used instead of the transport's fallback host
18572 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18573 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18574 transport for further details.
18575
18576
18577 .option group routers string&!! "see below"
18578 .cindex "gid (group id)" "local delivery"
18579 .cindex "local transports" "uid and gid"
18580 .cindex "transport" "local"
18581 .cindex "router" "setting group"
18582 When a router queues an address for a transport, and the transport does not
18583 specify a group, the group given here is used when running the delivery
18584 process.
18585 The group may be specified numerically or by name. If expansion fails, the
18586 error is logged and delivery is deferred.
18587 The default is unset, unless &%check_local_user%& is set, when the default
18588 is taken from the password information. See also &%initgroups%& and &%user%&
18589 and the discussion in chapter &<<CHAPenvironment>>&.
18590
18591
18592
18593 .option headers_add routers list&!! unset
18594 .cindex "header lines" "adding"
18595 .cindex "router" "adding header lines"
18596 This option specifies a list of text headers,
18597 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18598 that is associated with any addresses that are accepted by the router.
18599 Each item is separately expanded, at routing time.  However, this
18600 option has no effect when an address is just being verified. The way in which
18601 the text is used to add header lines at transport time is described in section
18602 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18603 message is in the process of being transported. This means that references to
18604 header lines in string expansions in the transport's configuration do not
18605 &"see"& the added header lines.
18606
18607 The &%headers_add%& option is expanded after &%errors_to%&, but before
18608 &%headers_remove%& and &%transport%&. If an item is empty, or if
18609 an item expansion is forced to fail, the item has no effect. Other expansion
18610 failures are treated as configuration errors.
18611
18612 Unlike most options, &%headers_add%& can be specified multiple times
18613 for a router; all listed headers are added.
18614
18615 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
18616 router that has the &%one_time%& option set.
18617
18618 .cindex "duplicate addresses"
18619 .oindex "&%unseen%&"
18620 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18621 additions are deleted when the address is passed on to subsequent routers.
18622 For a &%redirect%& router, if a generated address is the same as the incoming
18623 address, this can lead to duplicate addresses with different header
18624 modifications. Exim does not do duplicate deliveries (except, in certain
18625 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
18626 which of the duplicates is discarded, so this ambiguous situation should be
18627 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
18628
18629
18630
18631 .option headers_remove routers list&!! unset
18632 .cindex "header lines" "removing"
18633 .cindex "router" "removing header lines"
18634 This option specifies a list of text headers,
18635 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18636 that is associated with any addresses that are accepted by the router.
18637 Each item is separately expanded, at routing time.  However, this
18638 option has no effect when an address is just being verified. The way in which
18639 the text is used to remove header lines at transport time is described in
18640 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
18641 the message is in the process of being transported. This means that references
18642 to header lines in string expansions in the transport's configuration still
18643 &"see"& the original header lines.
18644
18645 The &%headers_remove%& option is expanded after &%errors_to%& and
18646 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
18647 the item has no effect. Other expansion failures are treated as configuration
18648 errors.
18649
18650 Unlike most options, &%headers_remove%& can be specified multiple times
18651 for a router; all listed headers are removed.
18652
18653 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
18654 router that has the &%one_time%& option set.
18655
18656 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18657 removal requests are deleted when the address is passed on to subsequent
18658 routers, and this can lead to problems with duplicates -- see the similar
18659 warning for &%headers_add%& above.
18660
18661 &*Warning 3*&: Because of the separate expansion of the list items,
18662 items that contain a list separator must have it doubled.
18663 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18664
18665
18666
18667 .option ignore_target_hosts routers "host list&!!" unset
18668 .cindex "IP address" "discarding"
18669 .cindex "router" "discarding IP addresses"
18670 Although this option is a host list, it should normally contain IP address
18671 entries rather than names. If any host that is looked up by the router has an
18672 IP address that matches an item in this list, Exim behaves as if that IP
18673 address did not exist. This option allows you to cope with rogue DNS entries
18674 like
18675 .code
18676 remote.domain.example.  A  127.0.0.1
18677 .endd
18678 by setting
18679 .code
18680 ignore_target_hosts = 127.0.0.1
18681 .endd
18682 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18683 discarded in this way, the router declines. In a conventional configuration, an
18684 attempt to mail to such a domain would normally provoke the &"unrouteable
18685 domain"& error, and an attempt to verify an address in the domain would fail.
18686 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18687 router declines if presented with one of the listed addresses.
18688
18689 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18690 means of the first or the second of the following settings, respectively:
18691 .code
18692 ignore_target_hosts = 0.0.0.0/0
18693 ignore_target_hosts = <; 0::0/0
18694 .endd
18695 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18696 in the second line matches all IPv6 addresses.
18697
18698 This option may also be useful for ignoring link-local and site-local IPv6
18699 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18700 is expanded before use as a list, it is possible to make it dependent on the
18701 domain that is being routed.
18702
18703 .vindex "&$host_address$&"
18704 During its expansion, &$host_address$& is set to the IP address that is being
18705 checked.
18706
18707 .option initgroups routers boolean false
18708 .cindex "additional groups"
18709 .cindex "groups" "additional"
18710 .cindex "local transports" "uid and gid"
18711 .cindex "transport" "local"
18712 If the router queues an address for a transport, and this option is true, and
18713 the uid supplied by the router is not overridden by the transport, the
18714 &[initgroups()]& function is called when running the transport to ensure that
18715 any additional groups associated with the uid are set up. See also &%group%&
18716 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18717
18718
18719
18720 .option local_part_prefix routers&!? "string list" unset
18721 .cindex affix "router precondition"
18722 .cindex "router" "prefix for local part"
18723 .cindex "prefix" "for local part, used in router"
18724 If this option is set, the router is skipped unless the local part starts with
18725 one of the given strings, or &%local_part_prefix_optional%& is true. See
18726 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18727 evaluated.
18728
18729 The list is scanned from left to right, and the first prefix that matches is
18730 used. A limited form of wildcard is available; if the prefix begins with an
18731 asterisk, it matches the longest possible sequence of arbitrary characters at
18732 the start of the local part. An asterisk should therefore always be followed by
18733 some character that does not occur in normal local parts.
18734 .cindex "multiple mailboxes"
18735 .cindex "mailbox" "multiple"
18736 Wildcarding can be used to set up multiple user mailboxes, as described in
18737 section &<<SECTmulbox>>&.
18738
18739 .vindex "&$local_part$&"
18740 .vindex "&$local_part_prefix$&"
18741 During the testing of the &%local_parts%& option, and while the router is
18742 running, the prefix is removed from the local part, and is available in the
18743 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18744 the router accepts the address, this remains true during subsequent delivery by
18745 a transport. In particular, the local part that is transmitted in the RCPT
18746 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18747 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18748 the relevant transport.
18749
18750 When an address is being verified, &%local_part_prefix%& affects only the
18751 behaviour of the router. If the callout feature of verification is in use, this
18752 means that the full address, including the prefix, will be used during the
18753 callout.
18754
18755 The prefix facility is commonly used to handle local parts of the form
18756 &%owner-something%&. Another common use is to support local parts of the form
18757 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18758 to tell a user their forwarding is broken &-- by placing a router like this one
18759 immediately before the router that handles &_.forward_& files:
18760 .code
18761 real_localuser:
18762   driver = accept
18763   local_part_prefix = real-
18764   check_local_user
18765   transport = local_delivery
18766 .endd
18767 For security, it would probably be a good idea to restrict the use of this
18768 router to locally-generated messages, using a condition such as this:
18769 .code
18770   condition = ${if match {$sender_host_address}\
18771                          {\N^(|127\.0\.0\.1)$\N}}
18772 .endd
18773
18774 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18775 both conditions must be met if not optional. Care must be taken if wildcards
18776 are used in both a prefix and a suffix on the same router. Different
18777 separator characters must be used to avoid ambiguity.
18778
18779
18780 .option local_part_prefix_optional routers boolean false
18781 See &%local_part_prefix%& above.
18782
18783
18784
18785 .option local_part_suffix routers&!? "string list" unset
18786 .cindex "router" "suffix for local part"
18787 .cindex "suffix for local part" "used in router"
18788 This option operates in the same way as &%local_part_prefix%&, except that the
18789 local part must end (rather than start) with the given string, the
18790 &%local_part_suffix_optional%& option determines whether the suffix is
18791 mandatory, and the wildcard * character, if present, must be the last
18792 character of the suffix. This option facility is commonly used to handle local
18793 parts of the form &%something-request%& and multiple user mailboxes of the form
18794 &%username-foo%&.
18795
18796
18797 .option local_part_suffix_optional routers boolean false
18798 See &%local_part_suffix%& above.
18799
18800
18801
18802 .option local_parts routers&!? "local part list&!!" unset
18803 .cindex "router" "restricting to specific local parts"
18804 .cindex "local part" "checking in router"
18805 The router is run only if the local part of the address matches the list.
18806 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18807 are evaluated, and
18808 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18809 string is expanded, it is possible to make it depend on the domain, for
18810 example:
18811 .code
18812 local_parts = dbm;/usr/local/specials/$domain
18813 .endd
18814 .vindex "&$local_part_data$&"
18815 If the match is achieved by a lookup, the data that the lookup returned
18816 for the local part is placed in the variable &$local_part_data$& for use in
18817 expansions of the router's private options. You might use this option, for
18818 example, if you have a large number of local virtual domains, and you want to
18819 send all postmaster mail to the same place without having to set up an alias in
18820 each virtual domain:
18821 .code
18822 postmaster:
18823   driver = redirect
18824   local_parts = postmaster
18825   data = postmaster@real.domain.example
18826 .endd
18827
18828
18829 .option log_as_local routers boolean "see below"
18830 .cindex "log" "delivery line"
18831 .cindex "delivery" "log line format"
18832 Exim has two logging styles for delivery, the idea being to make local
18833 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18834 recipient address is given just as the local part, without a domain. The use of
18835 this style is controlled by this option. It defaults to true for the &(accept)&
18836 router, and false for all the others. This option applies only when a
18837 router assigns an address to a transport. It has no effect on routers that
18838 redirect addresses.
18839
18840
18841
18842 .option more routers boolean&!! true
18843 The result of string expansion for this option must be a valid boolean value,
18844 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18845 result causes an error, and delivery is deferred. If the expansion is forced to
18846 fail, the default value for the option (true) is used. Other failures cause
18847 delivery to be deferred.
18848
18849 If this option is set false, and the router declines to handle the address, no
18850 further routers are tried, routing fails, and the address is bounced.
18851 .oindex "&%self%&"
18852 However, if the router explicitly passes an address to the following router by
18853 means of the setting
18854 .code
18855 self = pass
18856 .endd
18857 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18858 does not affect the behaviour if one of the precondition tests fails. In that
18859 case, the address is always passed to the next router.
18860
18861 Note that &%address_data%& is not considered to be a precondition. If its
18862 expansion is forced to fail, the router declines, and the value of &%more%&
18863 controls what happens next.
18864
18865
18866 .option pass_on_timeout routers boolean false
18867 .cindex "timeout" "of router"
18868 .cindex "router" "timeout"
18869 If a router times out during a host lookup, it normally causes deferral of the
18870 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18871 router, overriding &%no_more%&. This may be helpful for systems that are
18872 intermittently connected to the Internet, or those that want to pass to a smart
18873 host any messages that cannot immediately be delivered.
18874
18875 There are occasional other temporary errors that can occur while doing DNS
18876 lookups. They are treated in the same way as a timeout, and this option
18877 applies to all of them.
18878
18879
18880
18881 .option pass_router routers string unset
18882 .cindex "router" "go to after &""pass""&"
18883 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18884 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18885 routing to continue, and overriding a false setting of &%more%&. When one of
18886 these routers returns &"pass"&, the address is normally handed on to the next
18887 router in sequence. This can be changed by setting &%pass_router%& to the name
18888 of another router. However (unlike &%redirect_router%&) the named router must
18889 be below the current router, to avoid loops. Note that this option applies only
18890 to the special case of &"pass"&. It does not apply when a router returns
18891 &"decline"& because it cannot handle an address.
18892
18893
18894
18895 .option redirect_router routers string unset
18896 .cindex "router" "start at after redirection"
18897 Sometimes an administrator knows that it is pointless to reprocess addresses
18898 generated from alias or forward files with the same router again. For
18899 example, if an alias file translates real names into login ids there is no
18900 point searching the alias file a second time, especially if it is a large file.
18901
18902 The &%redirect_router%& option can be set to the name of any router instance.
18903 It causes the routing of any generated addresses to start at the named router
18904 instead of at the first router. This option has no effect if the router in
18905 which it is set does not generate new addresses.
18906
18907
18908
18909 .option require_files routers&!? "string list&!!" unset
18910 .cindex "file" "requiring for router"
18911 .cindex "router" "requiring file existence"
18912 This option provides a general mechanism for predicating the running of a
18913 router on the existence or non-existence of certain files or directories.
18914 Before running a router, as one of its precondition tests, Exim works its way
18915 through the &%require_files%& list, expanding each item separately.
18916
18917 Because the list is split before expansion, any colons in expansion items must
18918 be doubled, or the facility for using a different list separator must be used
18919 (&<<SECTlistsepchange>>&).
18920 If any expansion is forced to fail, the item is ignored. Other expansion
18921 failures cause routing of the address to be deferred.
18922
18923 If any expanded string is empty, it is ignored. Otherwise, except as described
18924 below, each string must be a fully qualified file path, optionally preceded by
18925 &"!"&. The paths are passed to the &[stat()]& function to test for the
18926 existence of the files or directories. The router is skipped if any paths not
18927 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18928
18929 .cindex "NFS"
18930 If &[stat()]& cannot determine whether a file exists or not, delivery of
18931 the message is deferred. This can happen when NFS-mounted filesystems are
18932 unavailable.
18933
18934 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18935 options, so you cannot use it to check for the existence of a file in which to
18936 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18937 full list of the order in which preconditions are evaluated.) However, as
18938 these options are all expanded, you can use the &%exists%& expansion condition
18939 to make such tests. The &%require_files%& option is intended for checking files
18940 that the router may be going to use internally, or which are needed by a
18941 transport (e.g., &_.procmailrc_&).
18942
18943 During delivery, the &[stat()]& function is run as root, but there is a
18944 facility for some checking of the accessibility of a file by another user.
18945 This is not a proper permissions check, but just a &"rough"& check that
18946 operates as follows:
18947
18948 If an item in a &%require_files%& list does not contain any forward slash
18949 characters, it is taken to be the user (and optional group, separated by a
18950 comma) to be checked for subsequent files in the list. If no group is specified
18951 but the user is specified symbolically, the gid associated with the uid is
18952 used. For example:
18953 .code
18954 require_files = mail:/some/file
18955 require_files = $local_part:$home/.procmailrc
18956 .endd
18957 If a user or group name in a &%require_files%& list does not exist, the
18958 &%require_files%& condition fails.
18959
18960 Exim performs the check by scanning along the components of the file path, and
18961 checking the access for the given uid and gid. It checks for &"x"& access on
18962 directories, and &"r"& access on the final file. Note that this means that file
18963 access control lists, if the operating system has them, are ignored.
18964
18965 &*Warning 1*&: When the router is being run to verify addresses for an
18966 incoming SMTP message, Exim is not running as root, but under its own uid. This
18967 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18968 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18969 user is not permitted to read one of the directories on the file's path.
18970
18971 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18972 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18973 without root access. In this case, if a check for access by a particular user
18974 is requested, Exim creates a subprocess that runs as that user, and tries the
18975 check again in that process.
18976
18977 The default action for handling an unresolved EACCES is to consider it to
18978 be caused by a configuration error, and routing is deferred because the
18979 existence or non-existence of the file cannot be determined. However, in some
18980 circumstances it may be desirable to treat this condition as if the file did
18981 not exist. If the filename (or the exclamation mark that precedes the filename
18982 for non-existence) is preceded by a plus sign, the EACCES error is treated
18983 as if the file did not exist. For example:
18984 .code
18985 require_files = +/some/file
18986 .endd
18987 If the router is not an essential part of verification (for example, it
18988 handles users' &_.forward_& files), another solution is to set the &%verify%&
18989 option false so that the router is skipped when verifying.
18990
18991
18992
18993 .option retry_use_local_part routers boolean "see below"
18994 .cindex "hints database" "retry keys"
18995 .cindex "local part" "in retry keys"
18996 When a delivery suffers a temporary routing failure, a retry record is created
18997 in Exim's hints database. For addresses whose routing depends only on the
18998 domain, the key for the retry record should not involve the local part, but for
18999 other addresses, both the domain and the local part should be included.
19000 Usually, remote routing is of the former kind, and local routing is of the
19001 latter kind.
19002
19003 This option controls whether the local part is used to form the key for retry
19004 hints for addresses that suffer temporary errors while being handled by this
19005 router. The default value is true for any router that has any of
19006 &%check_local_user%&,
19007 &%local_parts%&,
19008 &%condition%&,
19009 &%local_part_prefix%&,
19010 &%local_part_suffix%&,
19011 &%senders%& or
19012 &%require_files%&
19013 set, and false otherwise. Note that this option does not apply to hints keys
19014 for transport delays; they are controlled by a generic transport option of the
19015 same name.
19016
19017 Failing to set this option when it is needed
19018 (because a remote router handles only some of the local-parts for a domain)
19019 can result in incorrect error messages being generated.
19020
19021 The setting of &%retry_use_local_part%& applies only to the router on which it
19022 appears. If the router generates child addresses, they are routed
19023 independently; this setting does not become attached to them.
19024
19025
19026
19027 .option router_home_directory routers string&!! unset
19028 .cindex "router" "home directory for"
19029 .cindex "home directory" "for router"
19030 .vindex "&$home$&"
19031 This option sets a home directory for use while the router is running. (Compare
19032 &%transport_home_directory%&, which sets a home directory for later
19033 transporting.) In particular, if used on a &(redirect)& router, this option
19034 sets a value for &$home$& while a filter is running. The value is expanded;
19035 forced expansion failure causes the option to be ignored &-- other failures
19036 cause the router to defer.
19037
19038 Expansion of &%router_home_directory%& happens immediately after the
19039 &%check_local_user%& test (if configured), before any further expansions take
19040 place.
19041 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19042 are evaluated.)
19043 While the router is running, &%router_home_directory%& overrides the value of
19044 &$home$& that came from &%check_local_user%&.
19045
19046 When a router accepts an address and assigns it to a local transport (including
19047 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19048 delivery), the home directory setting for the transport is taken from the first
19049 of these values that is set:
19050
19051 .ilist
19052 The &%home_directory%& option on the transport;
19053 .next
19054 The &%transport_home_directory%& option on the router;
19055 .next
19056 The password data if &%check_local_user%& is set on the router;
19057 .next
19058 The &%router_home_directory%& option on the router.
19059 .endlist
19060
19061 In other words, &%router_home_directory%& overrides the password data for the
19062 router, but not for the transport.
19063
19064
19065
19066 .option self routers string freeze
19067 .cindex "MX record" "pointing to local host"
19068 .cindex "local host" "MX pointing to"
19069 This option applies to those routers that use a recipient address to find a
19070 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19071 and &(manualroute)& routers.
19072 Certain configurations of the &(queryprogram)& router can also specify a list
19073 of remote hosts.
19074 Usually such routers are configured to send the message to a remote host via an
19075 &(smtp)& transport. The &%self%& option specifies what happens when the first
19076 host on the list turns out to be the local host.
19077 The way in which Exim checks for the local host is described in section
19078 &<<SECTreclocipadd>>&.
19079
19080 Normally this situation indicates either an error in Exim's configuration (for
19081 example, the router should be configured not to process this domain), or an
19082 error in the DNS (for example, the MX should not point to this host). For this
19083 reason, the default action is to log the incident, defer the address, and
19084 freeze the message. The following alternatives are provided for use in special
19085 cases:
19086
19087 .vlist
19088 .vitem &%defer%&
19089 Delivery of the message is tried again later, but the message is not frozen.
19090
19091 .vitem "&%reroute%&: <&'domain'&>"
19092 The domain is changed to the given domain, and the address is passed back to
19093 be reprocessed by the routers. No rewriting of headers takes place. This
19094 behaviour is essentially a redirection.
19095
19096 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19097 The domain is changed to the given domain, and the address is passed back to be
19098 reprocessed by the routers. Any headers that contain the original domain are
19099 rewritten.
19100
19101 .vitem &%pass%&
19102 .oindex "&%more%&"
19103 .vindex "&$self_hostname$&"
19104 The router passes the address to the next router, or to the router named in the
19105 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19106 subsequent routing and delivery, the variable &$self_hostname$& contains the
19107 name of the local host that the router encountered. This can be used to
19108 distinguish between different cases for hosts with multiple names. The
19109 combination
19110 .code
19111 self = pass
19112 no_more
19113 .endd
19114 ensures that only those addresses that routed to the local host are passed on.
19115 Without &%no_more%&, addresses that were declined for other reasons would also
19116 be passed to the next router.
19117
19118 .vitem &%fail%&
19119 Delivery fails and an error report is generated.
19120
19121 .vitem &%send%&
19122 .cindex "local host" "sending to"
19123 The anomaly is ignored and the address is queued for the transport. This
19124 setting should be used with extreme caution. For an &(smtp)& transport, it
19125 makes sense only in cases where the program that is listening on the SMTP port
19126 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19127 different configuration file that handles the domain in another way.
19128 .endlist
19129
19130
19131
19132 .option senders routers&!? "address list&!!" unset
19133 .cindex "router" "checking senders"
19134 If this option is set, the router is skipped unless the message's sender
19135 address matches something on the list.
19136 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19137 are evaluated.
19138
19139 There are issues concerning verification when the running of routers is
19140 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19141 setting, it sets the sender to the null string. When using the &%-bt%& option
19142 to check a configuration file, it is necessary also to use the &%-f%& option to
19143 set an appropriate sender. For incoming mail, the sender is unset when
19144 verifying the sender, but is available when verifying any recipients. If the
19145 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19146 matters.
19147
19148
19149 .option set routers "string list" unset
19150 .cindex router variables
19151 This option may be used multiple times on a router;
19152 because of this the list aspect is mostly irrelevant.
19153 The list separator is a semicolon but can be changed in the
19154 usual way.
19155
19156 Each list-element given must be of the form &"name = value"&
19157 and the names used must start with the string &"r_"&.
19158 Values containing a list-separator should have them doubled.
19159 When a router runs, the strings are evaluated in order,
19160 to create variables which are added to the set associated with
19161 the address.
19162 The variable is set with the expansion of the value.
19163 The variables can be used by the router options
19164 (not including any preconditions)
19165 and by the transport.
19166 Later definitions of a given named variable will override former ones.
19167 Variable use is via the usual &$r_...$& syntax.
19168
19169 This is similar to the &%address_data%& option, except that
19170 many independent variables can be used, with choice of naming.
19171
19172
19173 .option translate_ip_address routers string&!! unset
19174 .cindex "IP address" "translating"
19175 .cindex "packet radio"
19176 .cindex "router" "IP address translation"
19177 There exist some rare networking situations (for example, packet radio) where
19178 it is helpful to be able to translate IP addresses generated by normal routing
19179 mechanisms into other IP addresses, thus performing a kind of manual IP
19180 routing. This should be done only if the normal IP routing of the TCP/IP stack
19181 is inadequate or broken. Because this is an extremely uncommon requirement, the
19182 code to support this option is not included in the Exim binary unless
19183 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19184
19185 .vindex "&$host_address$&"
19186 The &%translate_ip_address%& string is expanded for every IP address generated
19187 by the router, with the generated address set in &$host_address$&. If the
19188 expansion is forced to fail, no action is taken.
19189 For any other expansion error, delivery of the message is deferred.
19190 If the result of the expansion is an IP address, that replaces the original
19191 address; otherwise the result is assumed to be a host name &-- this is looked
19192 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19193 produce one or more replacement IP addresses. For example, to subvert all IP
19194 addresses in some specific networks, this could be added to a router:
19195 .code
19196 translate_ip_address = \
19197   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19198     {$value}fail}}
19199 .endd
19200 The file would contain lines like
19201 .code
19202 10.2.3.128/26    some.host
19203 10.8.4.34/26     10.44.8.15
19204 .endd
19205 You should not make use of this facility unless you really understand what you
19206 are doing.
19207
19208
19209
19210 .option transport routers string&!! unset
19211 This option specifies the transport to be used when a router accepts an address
19212 and sets it up for delivery. A transport is never needed if a router is used
19213 only for verification. The value of the option is expanded at routing time,
19214 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19215 and result must be the name of one of the configured transports. If it is not,
19216 delivery is deferred.
19217
19218 The &%transport%& option is not used by the &(redirect)& router, but it does
19219 have some private options that set up transports for pipe and file deliveries
19220 (see chapter &<<CHAPredirect>>&).
19221
19222
19223
19224 .option transport_current_directory routers string&!! unset
19225 .cindex "current directory for local transport"
19226 This option associates a current directory with any address that is routed
19227 to a local transport. This can happen either because a transport is
19228 explicitly configured for the router, or because it generates a delivery to a
19229 file or a pipe. During the delivery process (that is, at transport time), this
19230 option string is expanded and is set as the current directory, unless
19231 overridden by a setting on the transport.
19232 If the expansion fails for any reason, including forced failure, an error is
19233 logged, and delivery is deferred.
19234 See chapter &<<CHAPenvironment>>& for details of the local delivery
19235 environment.
19236
19237
19238
19239
19240 .option transport_home_directory routers string&!! "see below"
19241 .cindex "home directory" "for local transport"
19242 This option associates a home directory with any address that is routed to a
19243 local transport. This can happen either because a transport is explicitly
19244 configured for the router, or because it generates a delivery to a file or a
19245 pipe. During the delivery process (that is, at transport time), the option
19246 string is expanded and is set as the home directory, unless overridden by a
19247 setting of &%home_directory%& on the transport.
19248 If the expansion fails for any reason, including forced failure, an error is
19249 logged, and delivery is deferred.
19250
19251 If the transport does not specify a home directory, and
19252 &%transport_home_directory%& is not set for the router, the home directory for
19253 the transport is taken from the password data if &%check_local_user%& is set for
19254 the router. Otherwise it is taken from &%router_home_directory%& if that option
19255 is set; if not, no home directory is set for the transport.
19256
19257 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19258 environment.
19259
19260
19261
19262
19263 .option unseen routers boolean&!! false
19264 .cindex "router" "carrying on after success"
19265 The result of string expansion for this option must be a valid boolean value,
19266 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19267 result causes an error, and delivery is deferred. If the expansion is forced to
19268 fail, the default value for the option (false) is used. Other failures cause
19269 delivery to be deferred.
19270
19271 When this option is set true, routing does not cease if the router accepts the
19272 address. Instead, a copy of the incoming address is passed to the next router,
19273 overriding a false setting of &%more%&. There is little point in setting
19274 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19275 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19276 sometimes true and sometimes false).
19277
19278 .cindex "copy of message (&%unseen%& option)"
19279 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19280 qualifier in filter files. It can be used to cause copies of messages to be
19281 delivered to some other destination, while also carrying out a normal delivery.
19282 In effect, the current address is made into a &"parent"& that has two children
19283 &-- one that is delivered as specified by this router, and a clone that goes on
19284 to be routed further. For this reason, &%unseen%& may not be combined with the
19285 &%one_time%& option in a &(redirect)& router.
19286
19287 &*Warning*&: Header lines added to the address (or specified for removal) by
19288 this router or by previous routers affect the &"unseen"& copy of the message
19289 only. The clone that continues to be processed by further routers starts with
19290 no added headers and none specified for removal. For a &%redirect%& router, if
19291 a generated address is the same as the incoming address, this can lead to
19292 duplicate addresses with different header modifications. Exim does not do
19293 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19294 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19295 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19296 &%redirect%& router may be of help.
19297
19298 Unlike the handling of header modifications, any data that was set by the
19299 &%address_data%& option in the current or previous routers &'is'& passed on to
19300 subsequent routers.
19301
19302
19303 .option user routers string&!! "see below"
19304 .cindex "uid (user id)" "local delivery"
19305 .cindex "local transports" "uid and gid"
19306 .cindex "transport" "local"
19307 .cindex "router" "user for filter processing"
19308 .cindex "filter" "user for processing"
19309 When a router queues an address for a transport, and the transport does not
19310 specify a user, the user given here is used when running the delivery process.
19311 The user may be specified numerically or by name. If expansion fails, the
19312 error is logged and delivery is deferred.
19313 This user is also used by the &(redirect)& router when running a filter file.
19314 The default is unset, except when &%check_local_user%& is set. In this case,
19315 the default is taken from the password information. If the user is specified as
19316 a name, and &%group%& is not set, the group associated with the user is used.
19317 See also &%initgroups%& and &%group%& and the discussion in chapter
19318 &<<CHAPenvironment>>&.
19319
19320
19321
19322 .option verify routers&!? boolean true
19323 Setting this option has the effect of setting &%verify_sender%& and
19324 &%verify_recipient%& to the same value.
19325
19326
19327 .option verify_only routers&!? boolean false
19328 .cindex "EXPN" "with &%verify_only%&"
19329 .oindex "&%-bv%&"
19330 .cindex "router" "used only when verifying"
19331 If this option is set, the router is used only when verifying an address,
19332 delivering in cutthrough mode or
19333 testing with the &%-bv%& option, not when actually doing a delivery, testing
19334 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19335 restricted to verifying only senders or recipients by means of
19336 &%verify_sender%& and &%verify_recipient%&.
19337
19338 &*Warning*&: When the router is being run to verify addresses for an incoming
19339 SMTP message, Exim is not running as root, but under its own uid. If the router
19340 accesses any files, you need to make sure that they are accessible to the Exim
19341 user or group.
19342
19343
19344 .option verify_recipient routers&!? boolean true
19345 If this option is false, the router is skipped when verifying recipient
19346 addresses,
19347 delivering in cutthrough mode
19348 or testing recipient verification using &%-bv%&.
19349 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19350 are evaluated.
19351 See also the &$verify_mode$& variable.
19352
19353
19354 .option verify_sender routers&!? boolean true
19355 If this option is false, the router is skipped when verifying sender addresses
19356 or testing sender verification using &%-bvs%&.
19357 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19358 are evaluated.
19359 See also the &$verify_mode$& variable.
19360 .ecindex IIDgenoprou1
19361 .ecindex IIDgenoprou2
19362
19363
19364
19365
19366
19367
19368 . ////////////////////////////////////////////////////////////////////////////
19369 . ////////////////////////////////////////////////////////////////////////////
19370
19371 .chapter "The accept router" "CHID4"
19372 .cindex "&(accept)& router"
19373 .cindex "routers" "&(accept)&"
19374 The &(accept)& router has no private options of its own. Unless it is being
19375 used purely for verification (see &%verify_only%&) a transport is required to
19376 be defined by the generic &%transport%& option. If the preconditions that are
19377 specified by generic options are met, the router accepts the address and queues
19378 it for the given transport. The most common use of this router is for setting
19379 up deliveries to local mailboxes. For example:
19380 .code
19381 localusers:
19382   driver = accept
19383   domains = mydomain.example
19384   check_local_user
19385   transport = local_delivery
19386 .endd
19387 The &%domains%& condition in this example checks the domain of the address, and
19388 &%check_local_user%& checks that the local part is the login of a local user.
19389 When both preconditions are met, the &(accept)& router runs, and queues the
19390 address for the &(local_delivery)& transport.
19391
19392
19393
19394
19395
19396
19397 . ////////////////////////////////////////////////////////////////////////////
19398 . ////////////////////////////////////////////////////////////////////////////
19399
19400 .chapter "The dnslookup router" "CHAPdnslookup"
19401 .scindex IIDdnsrou1 "&(dnslookup)& router"
19402 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19403 The &(dnslookup)& router looks up the hosts that handle mail for the
19404 recipient's domain in the DNS. A transport must always be set for this router,
19405 unless &%verify_only%& is set.
19406
19407 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19408 SRV records. If none are found, or if SRV support is not configured,
19409 MX records are looked up. If no MX records exist, address records are sought.
19410 However, &%mx_domains%& can be set to disable the direct use of address
19411 records.
19412
19413 MX records of equal priority are sorted by Exim into a random order. Exim then
19414 looks for address records for the host names obtained from MX or SRV records.
19415 When a host has more than one IP address, they are sorted into a random order,
19416 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19417 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19418 generic option, the router declines.
19419
19420 Unless they have the highest priority (lowest MX value), MX records that point
19421 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19422 are discarded, together with any other MX records of equal or lower priority.
19423
19424 .cindex "MX record" "pointing to local host"
19425 .cindex "local host" "MX pointing to"
19426 .oindex "&%self%&" "in &(dnslookup)& router"
19427 If the host pointed to by the highest priority MX record, or looked up as an
19428 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19429 happens is controlled by the generic &%self%& option.
19430
19431
19432 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19433 There have been problems with DNS servers when SRV records are looked up.
19434 Some misbehaving servers return a DNS error or timeout when a non-existent
19435 SRV record is sought. Similar problems have in the past been reported for
19436 MX records. The global &%dns_again_means_nonexist%& option can help with this
19437 problem, but it is heavy-handed because it is a global option.
19438
19439 For this reason, there are two options, &%srv_fail_domains%& and
19440 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19441 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19442 an attempt to look up an SRV or MX record causes one of these results, and the
19443 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19444 such record"&. In the case of an SRV lookup, this means that the router
19445 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19446 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19447 case routing fails.
19448
19449
19450 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19451 .cindex "&(dnslookup)& router" "declines"
19452 There are a few cases where a &(dnslookup)& router will decline to accept
19453 an address; if such a router is expected to handle "all remaining non-local
19454 domains", then it is important to set &%no_more%&.
19455
19456 The router will defer rather than decline if the domain
19457 is found in the &%fail_defer_domains%& router option.
19458
19459 Reasons for a &(dnslookup)& router to decline currently include:
19460 .ilist
19461 The domain does not exist in DNS
19462 .next
19463 The domain exists but the MX record's host part is just "."; this is a common
19464 convention (borrowed from SRV) used to indicate that there is no such service
19465 for this domain and to not fall back to trying A/AAAA records.
19466 .next
19467 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19468 .next
19469 MX record points to a non-existent host.
19470 .next
19471 MX record points to an IP address and the main section option
19472 &%allow_mx_to_ip%& is not set.
19473 .next
19474 MX records exist and point to valid hosts, but all hosts resolve only to
19475 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19476 .next
19477 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19478 &%dns_check_names_pattern%& for handling one variant of this)
19479 .next
19480 &%check_secondary_mx%& is set on this router but the local host can
19481 not be found in the MX records (see below)
19482 .endlist
19483
19484
19485
19486
19487 .section "Private options for dnslookup" "SECID118"
19488 .cindex "options" "&(dnslookup)& router"
19489 The private options for the &(dnslookup)& router are as follows:
19490
19491 .option check_secondary_mx dnslookup boolean false
19492 .cindex "MX record" "checking for secondary"
19493 If this option is set, the router declines unless the local host is found in
19494 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19495 process domains for which the local host is a secondary mail exchanger
19496 differently to other domains. The way in which Exim decides whether a host is
19497 the local host is described in section &<<SECTreclocipadd>>&.
19498
19499
19500 .option check_srv dnslookup string&!! unset
19501 .cindex "SRV record" "enabling use of"
19502 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19503 addition to MX and address records. The support is disabled by default. To
19504 enable SRV support, set the &%check_srv%& option to the name of the service
19505 required. For example,
19506 .code
19507 check_srv = smtp
19508 .endd
19509 looks for SRV records that refer to the normal smtp service. The option is
19510 expanded, so the service name can vary from message to message or address
19511 to address. This might be helpful if SRV records are being used for a
19512 submission service. If the expansion is forced to fail, the &%check_srv%&
19513 option is ignored, and the router proceeds to look for MX records in the
19514 normal way.
19515
19516 When the expansion succeeds, the router searches first for SRV records for
19517 the given service (it assumes TCP protocol). A single SRV record with a
19518 host name that consists of just a single dot indicates &"no such service for
19519 this domain"&; if this is encountered, the router declines. If other kinds of
19520 SRV record are found, they are used to construct a host list for delivery
19521 according to the rules of RFC 2782. MX records are not sought in this case.
19522
19523 When no SRV records are found, MX records (and address records) are sought in
19524 the traditional way. In other words, SRV records take precedence over MX
19525 records, just as MX records take precedence over address records. Note that
19526 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19527 defined it. It is apparently believed that MX records are sufficient for email
19528 and that SRV records should not be used for this purpose. However, SRV records
19529 have an additional &"weight"& feature which some people might find useful when
19530 trying to split an SMTP load between hosts of different power.
19531
19532 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19533 when there is a DNS lookup error.
19534
19535
19536
19537
19538 .option fail_defer_domains dnslookup "domain list&!!" unset
19539 .cindex "MX record" "not found"
19540 DNS lookups for domains matching &%fail_defer_domains%&
19541 which find no matching record will cause the router to defer
19542 rather than the default behaviour of decline.
19543 This maybe be useful for queueing messages for a newly created
19544 domain while the DNS configuration is not ready.
19545 However, it will result in any message with mistyped domains
19546 also being queued.
19547
19548
19549 .option ipv4_only "string&!!" unset
19550 .cindex IPv6 disabling
19551 .cindex DNS "IPv6 disabling"
19552 The string is expanded, and if the result is anything but a forced failure,
19553 or an empty string, or one of the strings “0” or “no” or “false”
19554 (checked without regard to the case of the letters),
19555 only A records are used.
19556
19557 .option ipv4_prefer "string&!!" unset
19558 .cindex IPv4 preference
19559 .cindex DNS "IPv4 preference"
19560 The string is expanded, and if the result is anything but a forced failure,
19561 or an empty string, or one of the strings “0” or “no” or “false”
19562 (checked without regard to the case of the letters),
19563 A records are sorted before AAAA records (inverting the default).
19564
19565 .option mx_domains dnslookup "domain list&!!" unset
19566 .cindex "MX record" "required to exist"
19567 .cindex "SRV record" "required to exist"
19568 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19569 record in order to be recognized. (The name of this option could be improved.)
19570 For example, if all the mail hosts in &'fict.example'& are known to have MX
19571 records, except for those in &'discworld.fict.example'&, you could use this
19572 setting:
19573 .code
19574 mx_domains = ! *.discworld.fict.example : *.fict.example
19575 .endd
19576 This specifies that messages addressed to a domain that matches the list but
19577 has no MX record should be bounced immediately instead of being routed using
19578 the address record.
19579
19580
19581 .option mx_fail_domains dnslookup "domain list&!!" unset
19582 If the DNS lookup for MX records for one of the domains in this list causes a
19583 DNS lookup error, Exim behaves as if no MX records were found. See section
19584 &<<SECTprowitdnsloo>>& for more discussion.
19585
19586
19587
19588
19589 .option qualify_single dnslookup boolean true
19590 .cindex "DNS" "resolver options"
19591 .cindex "DNS" "qualifying single-component names"
19592 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19593 lookups. Typically, but not standardly, this causes the resolver to qualify
19594 single-component names with the default domain. For example, on a machine
19595 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
19596 &'thesaurus.ref.example'& inside the resolver. For details of what your
19597 resolver actually does, consult your man pages for &'resolver'& and
19598 &'resolv.conf'&.
19599
19600
19601
19602 .option rewrite_headers dnslookup boolean true
19603 .cindex "rewriting" "header lines"
19604 .cindex "header lines" "rewriting"
19605 If the domain name in the address that is being processed is not fully
19606 qualified, it may be expanded to its full form by a DNS lookup. For example, if
19607 an address is specified as &'dormouse@teaparty'&, the domain might be
19608 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
19609 occur as a result of setting the &%widen_domains%& option. If
19610 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
19611 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
19612 header lines of the message are rewritten with the full domain name.
19613
19614 This option should be turned off only when it is known that no message is
19615 ever going to be sent outside an environment where the abbreviation makes
19616 sense.
19617
19618 When an MX record is looked up in the DNS and matches a wildcard record, name
19619 servers normally return a record containing the name that has been looked up,
19620 making it impossible to detect whether a wildcard was present or not. However,
19621 some name servers have recently been seen to return the wildcard entry. If the
19622 name returned by a DNS lookup begins with an asterisk, it is not used for
19623 header rewriting.
19624
19625
19626 .option same_domain_copy_routing dnslookup boolean false
19627 .cindex "address" "copying routing"
19628 Addresses with the same domain are normally routed by the &(dnslookup)& router
19629 to the same list of hosts. However, this cannot be presumed, because the router
19630 options and preconditions may refer to the local part of the address. By
19631 default, therefore, Exim routes each address in a message independently. DNS
19632 servers run caches, so repeated DNS lookups are not normally expensive, and in
19633 any case, personal messages rarely have more than a few recipients.
19634
19635 If you are running mailing lists with large numbers of subscribers at the same
19636 domain, and you are using a &(dnslookup)& router which is independent of the
19637 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19638 lookups for identical domains in one message. In this case, when &(dnslookup)&
19639 routes an address to a remote transport, any other unrouted addresses in the
19640 message that have the same domain are automatically given the same routing
19641 without processing them independently,
19642 provided the following conditions are met:
19643
19644 .ilist
19645 No router that processed the address specified &%headers_add%& or
19646 &%headers_remove%&.
19647 .next
19648 The router did not change the address in any way, for example, by &"widening"&
19649 the domain.
19650 .endlist
19651
19652
19653
19654
19655 .option search_parents dnslookup boolean false
19656 .cindex "DNS" "resolver options"
19657 When this option is true, the resolver option RES_DNSRCH is set for DNS
19658 lookups. This is different from the &%qualify_single%& option in that it
19659 applies to domains containing dots. Typically, but not standardly, it causes
19660 the resolver to search for the name in the current domain and in parent
19661 domains. For example, on a machine in the &'fict.example'& domain, if looking
19662 up &'teaparty.wonderland'& failed, the resolver would try
19663 &'teaparty.wonderland.fict.example'&. For details of what your resolver
19664 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
19665
19666 Setting this option true can cause problems in domains that have a wildcard MX
19667 record, because any domain that does not have its own MX record matches the
19668 local wildcard.
19669
19670
19671
19672 .option srv_fail_domains dnslookup "domain list&!!" unset
19673 If the DNS lookup for SRV records for one of the domains in this list causes a
19674 DNS lookup error, Exim behaves as if no SRV records were found. See section
19675 &<<SECTprowitdnsloo>>& for more discussion.
19676
19677
19678
19679
19680 .option widen_domains dnslookup "string list" unset
19681 .cindex "domain" "partial; widening"
19682 If a DNS lookup fails and this option is set, each of its strings in turn is
19683 added onto the end of the domain, and the lookup is tried again. For example,
19684 if
19685 .code
19686 widen_domains = fict.example:ref.example
19687 .endd
19688 is set and a lookup of &'klingon.dictionary'& fails,
19689 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
19690 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
19691 and &%search_parents%& options can cause some widening to be undertaken inside
19692 the DNS resolver. &%widen_domains%& is not applied to sender addresses
19693 when verifying, unless &%rewrite_headers%& is false (not the default).
19694
19695
19696 .section "Effect of qualify_single and search_parents" "SECID119"
19697 When a domain from an envelope recipient is changed by the resolver as a result
19698 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
19699 corresponding address in the message's header lines unless &%rewrite_headers%&
19700 is set false. Exim then re-routes the address, using the full domain.
19701
19702 These two options affect only the DNS lookup that takes place inside the router
19703 for the domain of the address that is being routed. They do not affect lookups
19704 such as that implied by
19705 .code
19706 domains = @mx_any
19707 .endd
19708 that may happen while processing a router precondition before the router is
19709 entered. No widening ever takes place for these lookups.
19710 .ecindex IIDdnsrou1
19711 .ecindex IIDdnsrou2
19712
19713
19714
19715
19716
19717
19718
19719
19720
19721 . ////////////////////////////////////////////////////////////////////////////
19722 . ////////////////////////////////////////////////////////////////////////////
19723
19724 .chapter "The ipliteral router" "CHID5"
19725 .cindex "&(ipliteral)& router"
19726 .cindex "domain literal" "routing"
19727 .cindex "routers" "&(ipliteral)&"
19728 This router has no private options. Unless it is being used purely for
19729 verification (see &%verify_only%&) a transport is required to be defined by the
19730 generic &%transport%& option. The router accepts the address if its domain part
19731 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
19732 router handles the address
19733 .code
19734 root@[192.168.1.1]
19735 .endd
19736 by setting up delivery to the host with that IP address. IPv4 domain literals
19737 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19738 are similar, but the address is preceded by &`ipv6:`&. For example:
19739 .code
19740 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19741 .endd
19742 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19743 grounds that sooner or later somebody will try it.
19744
19745 .oindex "&%self%&" "in &(ipliteral)& router"
19746 If the IP address matches something in &%ignore_target_hosts%&, the router
19747 declines. If an IP literal turns out to refer to the local host, the generic
19748 &%self%& option determines what happens.
19749
19750 The RFCs require support for domain literals; however, their use is
19751 controversial in today's Internet. If you want to use this router, you must
19752 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19753 Exim will not recognize the domain literal syntax in addresses.
19754
19755
19756
19757 . ////////////////////////////////////////////////////////////////////////////
19758 . ////////////////////////////////////////////////////////////////////////////
19759
19760 .chapter "The iplookup router" "CHID6"
19761 .cindex "&(iplookup)& router"
19762 .cindex "routers" "&(iplookup)&"
19763 The &(iplookup)& router was written to fulfil a specific requirement in
19764 Cambridge University (which in fact no longer exists). For this reason, it is
19765 not included in the binary of Exim by default. If you want to include it, you
19766 must set
19767 .code
19768 ROUTER_IPLOOKUP=yes
19769 .endd
19770 in your &_Local/Makefile_& configuration file.
19771
19772 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19773 connection to one or more specific hosts. The host can then return the same or
19774 a different address &-- in effect rewriting the recipient address in the
19775 message's envelope. The new address is then passed on to subsequent routers. If
19776 this process fails, the address can be passed on to other routers, or delivery
19777 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19778 must not be specified for it.
19779
19780 .cindex "options" "&(iplookup)& router"
19781 .option hosts iplookup string unset
19782 This option must be supplied. Its value is a colon-separated list of host
19783 names. The hosts are looked up using &[gethostbyname()]&
19784 (or &[getipnodebyname()]& when available)
19785 and are tried in order until one responds to the query. If none respond, what
19786 happens is controlled by &%optional%&.
19787
19788
19789 .option optional iplookup boolean false
19790 If &%optional%& is true, if no response is obtained from any host, the address
19791 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19792 delivery to the address is deferred.
19793
19794
19795 .option port iplookup integer 0
19796 .cindex "port" "&(iplookup)& router"
19797 This option must be supplied. It specifies the port number for the TCP or UDP
19798 call.
19799
19800
19801 .option protocol iplookup string udp
19802 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19803 protocols is to be used.
19804
19805
19806 .option query iplookup string&!! "see below"
19807 This defines the content of the query that is sent to the remote hosts. The
19808 default value is:
19809 .code
19810 $local_part@$domain $local_part@$domain
19811 .endd
19812 The repetition serves as a way of checking that a response is to the correct
19813 query in the default case (see &%response_pattern%& below).
19814
19815
19816 .option reroute iplookup string&!! unset
19817 If this option is not set, the rerouted address is precisely the byte string
19818 returned by the remote host, up to the first white space, if any. If set, the
19819 string is expanded to form the rerouted address. It can include parts matched
19820 in the response by &%response_pattern%& by means of numeric variables such as
19821 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19822 whether or not a pattern is in use. In all cases, the rerouted address must end
19823 up in the form &'local_part@domain'&.
19824
19825
19826 .option response_pattern iplookup string unset
19827 This option can be set to a regular expression that is applied to the string
19828 returned from the remote host. If the pattern does not match the response, the
19829 router declines. If &%response_pattern%& is not set, no checking of the
19830 response is done, unless the query was defaulted, in which case there is a
19831 check that the text returned after the first white space is the original
19832 address. This checks that the answer that has been received is in response to
19833 the correct question. For example, if the response is just a new domain, the
19834 following could be used:
19835 .code
19836 response_pattern = ^([^@]+)$
19837 reroute = $local_part@$1
19838 .endd
19839
19840 .option timeout iplookup time 5s
19841 This specifies the amount of time to wait for a response from the remote
19842 machine. The same timeout is used for the &[connect()]& function for a TCP
19843 call. It does not apply to UDP.
19844
19845
19846
19847
19848 . ////////////////////////////////////////////////////////////////////////////
19849 . ////////////////////////////////////////////////////////////////////////////
19850
19851 .chapter "The manualroute router" "CHID7"
19852 .scindex IIDmanrou1 "&(manualroute)& router"
19853 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19854 .cindex "domain" "manually routing"
19855 The &(manualroute)& router is so-called because it provides a way of manually
19856 routing an address according to its domain. It is mainly used when you want to
19857 route addresses to remote hosts according to your own rules, bypassing the
19858 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19859 route to local transports, a facility that may be useful if you want to save
19860 messages for dial-in hosts in local files.
19861
19862 The &(manualroute)& router compares a list of domain patterns with the domain
19863 it is trying to route. If there is no match, the router declines. Each pattern
19864 has associated with it a list of hosts and some other optional data, which may
19865 include a transport. The combination of a pattern and its data is called a
19866 &"routing rule"&. For patterns that do not have an associated transport, the
19867 generic &%transport%& option must specify a transport, unless the router is
19868 being used purely for verification (see &%verify_only%&).
19869
19870 .vindex "&$host$&"
19871 In the case of verification, matching the domain pattern is sufficient for the
19872 router to accept the address. When actually routing an address for delivery,
19873 an address that matches a domain pattern is queued for the associated
19874 transport. If the transport is not a local one, a host list must be associated
19875 with the pattern; IP addresses are looked up for the hosts, and these are
19876 passed to the transport along with the mail address. For local transports, a
19877 host list is optional. If it is present, it is passed in &$host$& as a single
19878 text string.
19879
19880 The list of routing rules can be provided as an inline string in
19881 &%route_list%&, or the data can be obtained by looking up the domain in a file
19882 or database by setting &%route_data%&. Only one of these settings may appear in
19883 any one instance of &(manualroute)&. The format of routing rules is described
19884 below, following the list of private options.
19885
19886
19887 .section "Private options for manualroute" "SECTprioptman"
19888
19889 .cindex "options" "&(manualroute)& router"
19890 The private options for the &(manualroute)& router are as follows:
19891
19892 .option host_all_ignored manualroute string defer
19893 See &%host_find_failed%&.
19894
19895 .option host_find_failed manualroute string freeze
19896 This option controls what happens when &(manualroute)& tries to find an IP
19897 address for a host, and the host does not exist. The option can be set to one
19898 of the following values:
19899 .code
19900 decline
19901 defer
19902 fail
19903 freeze
19904 ignore
19905 pass
19906 .endd
19907 The default (&"freeze"&) assumes that this state is a serious configuration
19908 error. The difference between &"pass"& and &"decline"& is that the former
19909 forces the address to be passed to the next router (or the router defined by
19910 &%pass_router%&),
19911 .oindex "&%more%&"
19912 overriding &%no_more%&, whereas the latter passes the address to the next
19913 router only if &%more%& is true.
19914
19915 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19916 cannot be found. If all the hosts in the list are ignored, the behaviour is
19917 controlled by the &%host_all_ignored%& option. This takes the same values
19918 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19919
19920 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19921 state; if a host lookup gets a temporary error, delivery is deferred unless the
19922 generic &%pass_on_timeout%& option is set.
19923
19924
19925 .option hosts_randomize manualroute boolean false
19926 .cindex "randomized host list"
19927 .cindex "host" "list of; randomized"
19928 If this option is set, the order of the items in a host list in a routing rule
19929 is randomized each time the list is used, unless an option in the routing rule
19930 overrides (see below). Randomizing the order of a host list can be used to do
19931 crude load sharing. However, if more than one mail address is routed by the
19932 same router to the same host list, the host lists are considered to be the same
19933 (even though they may be randomized into different orders) for the purpose of
19934 deciding whether to batch the deliveries into a single SMTP transaction.
19935
19936 When &%hosts_randomize%& is true, a host list may be split
19937 into groups whose order is separately randomized. This makes it possible to
19938 set up MX-like behaviour. The boundaries between groups are indicated by an
19939 item that is just &`+`& in the host list. For example:
19940 .code
19941 route_list = * host1:host2:host3:+:host4:host5
19942 .endd
19943 The order of the first three hosts and the order of the last two hosts is
19944 randomized for each use, but the first three always end up before the last two.
19945 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19946 randomized host list is passed to an &(smtp)& transport that also has
19947 &%hosts_randomize set%&, the list is not re-randomized.
19948
19949
19950 .option route_data manualroute string&!! unset
19951 If this option is set, it must expand to yield the data part of a routing rule.
19952 Typically, the expansion string includes a lookup based on the domain. For
19953 example:
19954 .code
19955 route_data = ${lookup{$domain}dbm{/etc/routes}}
19956 .endd
19957 If the expansion is forced to fail, or the result is an empty string, the
19958 router declines. Other kinds of expansion failure cause delivery to be
19959 deferred.
19960
19961
19962 .option route_list manualroute "string list" unset
19963 This string is a list of routing rules, in the form defined below. Note that,
19964 unlike most string lists, the items are separated by semicolons. This is so
19965 that they may contain colon-separated host lists.
19966
19967
19968 .option same_domain_copy_routing manualroute boolean false
19969 .cindex "address" "copying routing"
19970 Addresses with the same domain are normally routed by the &(manualroute)&
19971 router to the same list of hosts. However, this cannot be presumed, because the
19972 router options and preconditions may refer to the local part of the address. By
19973 default, therefore, Exim routes each address in a message independently. DNS
19974 servers run caches, so repeated DNS lookups are not normally expensive, and in
19975 any case, personal messages rarely have more than a few recipients.
19976
19977 If you are running mailing lists with large numbers of subscribers at the same
19978 domain, and you are using a &(manualroute)& router which is independent of the
19979 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19980 lookups for identical domains in one message. In this case, when
19981 &(manualroute)& routes an address to a remote transport, any other unrouted
19982 addresses in the message that have the same domain are automatically given the
19983 same routing without processing them independently. However, this is only done
19984 if &%headers_add%& and &%headers_remove%& are unset.
19985
19986
19987
19988
19989 .section "Routing rules in route_list" "SECID120"
19990 The value of &%route_list%& is a string consisting of a sequence of routing
19991 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19992 entered as two semicolons. Alternatively, the list separator can be changed as
19993 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19994 Empty rules are ignored. The format of each rule is
19995 .display
19996 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19997 .endd
19998 The following example contains two rules, each with a simple domain pattern and
19999 no options:
20000 .code
20001 route_list = \
20002   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20003   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20004 .endd
20005 The three parts of a rule are separated by white space. The pattern and the
20006 list of hosts can be enclosed in quotes if necessary, and if they are, the
20007 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20008 single domain pattern, which is the only mandatory item in the rule. The
20009 pattern is in the same format as one item in a domain list (see section
20010 &<<SECTdomainlist>>&),
20011 except that it may not be the name of an interpolated file.
20012 That is, it may be wildcarded, or a regular expression, or a file or database
20013 lookup (with semicolons doubled, because of the use of semicolon as a separator
20014 in a &%route_list%&).
20015
20016 The rules in &%route_list%& are searched in order until one of the patterns
20017 matches the domain that is being routed. The list of hosts and then options are
20018 then used as described below. If there is no match, the router declines. When
20019 &%route_list%& is set, &%route_data%& must not be set.
20020
20021
20022
20023 .section "Routing rules in route_data" "SECID121"
20024 The use of &%route_list%& is convenient when there are only a small number of
20025 routing rules. For larger numbers, it is easier to use a file or database to
20026 hold the routing information, and use the &%route_data%& option instead.
20027 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20028 Most commonly, &%route_data%& is set as a string that contains an
20029 expansion lookup. For example, suppose we place two routing rules in a file
20030 like this:
20031 .code
20032 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20033 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20034 .endd
20035 This data can be accessed by setting
20036 .code
20037 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20038 .endd
20039 Failure of the lookup results in an empty string, causing the router to
20040 decline. However, you do not have to use a lookup in &%route_data%&. The only
20041 requirement is that the result of expanding the string is a list of hosts,
20042 possibly followed by options, separated by white space. The list of hosts must
20043 be enclosed in quotes if it contains white space.
20044
20045
20046
20047
20048 .section "Format of the list of hosts" "SECID122"
20049 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20050 always separately expanded before use. If the expansion fails, the router
20051 declines. The result of the expansion must be a colon-separated list of names
20052 and/or IP addresses, optionally also including ports.
20053 If the list is written with spaces, it must be protected with quotes.
20054 The format of each item
20055 in the list is described in the next section. The list separator can be changed
20056 as described in section &<<SECTlistsepchange>>&.
20057
20058 If the list of hosts was obtained from a &%route_list%& item, the following
20059 variables are set during its expansion:
20060
20061 .ilist
20062 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20063 If the domain was matched against a regular expression, the numeric variables
20064 &$1$&, &$2$&, etc. may be set. For example:
20065 .code
20066 route_list = ^domain(\d+)   host-$1.text.example
20067 .endd
20068 .next
20069 &$0$& is always set to the entire domain.
20070 .next
20071 &$1$& is also set when partial matching is done in a file lookup.
20072
20073 .next
20074 .vindex "&$value$&"
20075 If the pattern that matched the domain was a lookup item, the data that was
20076 looked up is available in the expansion variable &$value$&. For example:
20077 .code
20078 route_list = lsearch;;/some/file.routes  $value
20079 .endd
20080 .endlist
20081
20082 Note the doubling of the semicolon in the pattern that is necessary because
20083 semicolon is the default route list separator.
20084
20085
20086
20087 .section "Format of one host item" "SECTformatonehostitem"
20088 Each item in the list of hosts is either a host name or an IP address,
20089 optionally with an attached port number. When no port is given, an IP address
20090 is not enclosed in brackets. When a port is specified, it overrides the port
20091 specification on the transport. The port is separated from the name or address
20092 by a colon. This leads to some complications:
20093
20094 .ilist
20095 Because colon is the default separator for the list of hosts, either
20096 the colon that specifies a port must be doubled, or the list separator must
20097 be changed. The following two examples have the same effect:
20098 .code
20099 route_list = * "host1.tld::1225 : host2.tld::1226"
20100 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20101 .endd
20102 .next
20103 When IPv6 addresses are involved, it gets worse, because they contain
20104 colons of their own. To make this case easier, it is permitted to
20105 enclose an IP address (either v4 or v6) in square brackets if a port
20106 number follows. For example:
20107 .code
20108 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20109 .endd
20110 .endlist
20111
20112 .section "How the list of hosts is used" "SECThostshowused"
20113 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20114 the hosts is tried, in the order specified, when carrying out the SMTP
20115 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20116 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20117 transport.
20118
20119 Hosts may be listed by name or by IP address. An unadorned name in the list of
20120 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20121 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20122 records in the DNS. For example:
20123 .code
20124 route_list = *  x.y.z:p.q.r/MX:e.f.g
20125 .endd
20126 If this feature is used with a port specifier, the port must come last. For
20127 example:
20128 .code
20129 route_list = *  dom1.tld/mx::1225
20130 .endd
20131 If the &%hosts_randomize%& option is set, the order of the items in the list is
20132 randomized before any lookups are done. Exim then scans the list; for any name
20133 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20134 be an interface on the local host and the item is not the first in the list,
20135 Exim discards it and any subsequent items. If it is the first item, what
20136 happens is controlled by the
20137 .oindex "&%self%&" "in &(manualroute)& router"
20138 &%self%& option of the router.
20139
20140 A name on the list that is followed by &`/MX`& is replaced with the list of
20141 hosts obtained by looking up MX records for the name. This is always a DNS
20142 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20143 below) are not relevant here. The order of these hosts is determined by the
20144 preference values in the MX records, according to the usual rules. Because
20145 randomizing happens before the MX lookup, it does not affect the order that is
20146 defined by MX preferences.
20147
20148 If the local host is present in the sublist obtained from MX records, but is
20149 not the most preferred host in that list, it and any equally or less
20150 preferred hosts are removed before the sublist is inserted into the main list.
20151
20152 If the local host is the most preferred host in the MX list, what happens
20153 depends on where in the original list of hosts the &`/MX`& item appears. If it
20154 is not the first item (that is, there are previous hosts in the main list),
20155 Exim discards this name and any subsequent items in the main list.
20156
20157 If the MX item is first in the list of hosts, and the local host is the
20158 most preferred host, what happens is controlled by the &%self%& option of the
20159 router.
20160
20161 DNS failures when lookup up the MX records are treated in the same way as DNS
20162 failures when looking up IP addresses: &%pass_on_timeout%& and
20163 &%host_find_failed%& are used when relevant.
20164
20165 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20166 whether obtained from an MX lookup or not.
20167
20168
20169
20170 .section "How the options are used" "SECThowoptused"
20171 The options are a sequence of words, space-separated.
20172 One of the words can be the name of a transport; this overrides the
20173 &%transport%& option on the router for this particular routing rule only. The
20174 other words (if present) control randomization of the list of hosts on a
20175 per-rule basis, and how the IP addresses of the hosts are to be found when
20176 routing to a remote transport. These options are as follows:
20177
20178 .ilist
20179 &%randomize%&: randomize the order of the hosts in this list, overriding the
20180 setting of &%hosts_randomize%& for this routing rule only.
20181 .next
20182 &%no_randomize%&: do not randomize the order of the hosts in this list,
20183 overriding the setting of &%hosts_randomize%& for this routing rule only.
20184 .next
20185 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20186 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20187 also look in &_/etc/hosts_& or other sources of information.
20188 .next
20189 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20190 no address records are found. If there is a temporary DNS error (such as a
20191 timeout), delivery is deferred.
20192 .next
20193 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20194 .next
20195 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20196 .endlist
20197
20198 For example:
20199 .code
20200 route_list = domain1  host1:host2:host3  randomize bydns;\
20201              domain2  host4:host5
20202 .endd
20203 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20204 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20205 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20206 or &[gethostbyname()]&, and the result of the lookup is the result of that
20207 call.
20208
20209 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20210 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20211 instead of TRY_AGAIN. That is why the default action is to try a DNS
20212 lookup first. Only if that gives a definite &"no such host"& is the local
20213 function called.
20214
20215 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20216 inadvertent constraint that a transport name as an option had to be the last
20217 option specified.
20218
20219
20220
20221 If no IP address for a host can be found, what happens is controlled by the
20222 &%host_find_failed%& option.
20223
20224 .vindex "&$host$&"
20225 When an address is routed to a local transport, IP addresses are not looked up.
20226 The host list is passed to the transport in the &$host$& variable.
20227
20228
20229
20230 .section "Manualroute examples" "SECID123"
20231 In some of the examples that follow, the presence of the &%remote_smtp%&
20232 transport, as defined in the default configuration file, is assumed:
20233
20234 .ilist
20235 .cindex "smart host" "example router"
20236 The &(manualroute)& router can be used to forward all external mail to a
20237 &'smart host'&. If you have set up, in the main part of the configuration, a
20238 named domain list that contains your local domains, for example:
20239 .code
20240 domainlist local_domains = my.domain.example
20241 .endd
20242 You can arrange for all other domains to be routed to a smart host by making
20243 your first router something like this:
20244 .code
20245 smart_route:
20246   driver = manualroute
20247   domains = !+local_domains
20248   transport = remote_smtp
20249   route_list = * smarthost.ref.example
20250 .endd
20251 This causes all non-local addresses to be sent to the single host
20252 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20253 they are tried in order
20254 (but you can use &%hosts_randomize%& to vary the order each time).
20255 Another way of configuring the same thing is this:
20256 .code
20257 smart_route:
20258   driver = manualroute
20259   transport = remote_smtp
20260   route_list = !+local_domains  smarthost.ref.example
20261 .endd
20262 There is no difference in behaviour between these two routers as they stand.
20263 However, they behave differently if &%no_more%& is added to them. In the first
20264 example, the router is skipped if the domain does not match the &%domains%&
20265 precondition; the following router is always tried. If the router runs, it
20266 always matches the domain and so can never decline. Therefore, &%no_more%&
20267 would have no effect. In the second case, the router is never skipped; it
20268 always runs. However, if it doesn't match the domain, it declines. In this case
20269 &%no_more%& would prevent subsequent routers from running.
20270
20271 .next
20272 .cindex "mail hub example"
20273 A &'mail hub'& is a host which receives mail for a number of domains via MX
20274 records in the DNS and delivers it via its own private routing mechanism. Often
20275 the final destinations are behind a firewall, with the mail hub being the one
20276 machine that can connect to machines both inside and outside the firewall. The
20277 &(manualroute)& router is usually used on a mail hub to route incoming messages
20278 to the correct hosts. For a small number of domains, the routing can be inline,
20279 using the &%route_list%& option, but for a larger number a file or database
20280 lookup is easier to manage.
20281
20282 If the domain names are in fact the names of the machines to which the mail is
20283 to be sent by the mail hub, the configuration can be quite simple. For
20284 example:
20285 .code
20286 hub_route:
20287   driver = manualroute
20288   transport = remote_smtp
20289   route_list = *.rhodes.tvs.example  $domain
20290 .endd
20291 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20292 whose names are the same as the mail domains. A similar approach can be taken
20293 if the host name can be obtained from the domain name by a string manipulation
20294 that the expansion facilities can handle. Otherwise, a lookup based on the
20295 domain can be used to find the host:
20296 .code
20297 through_firewall:
20298   driver = manualroute
20299   transport = remote_smtp
20300   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20301 .endd
20302 The result of the lookup must be the name or IP address of the host (or
20303 hosts) to which the address is to be routed. If the lookup fails, the route
20304 data is empty, causing the router to decline. The address then passes to the
20305 next router.
20306
20307 .next
20308 .cindex "batched SMTP output example"
20309 .cindex "SMTP" "batched outgoing; example"
20310 You can use &(manualroute)& to deliver messages to pipes or files in batched
20311 SMTP format for onward transportation by some other means. This is one way of
20312 storing mail for a dial-up host when it is not connected. The route list entry
20313 can be as simple as a single domain name in a configuration like this:
20314 .code
20315 save_in_file:
20316   driver = manualroute
20317   transport = batchsmtp_appendfile
20318   route_list = saved.domain.example
20319 .endd
20320 though often a pattern is used to pick up more than one domain. If there are
20321 several domains or groups of domains with different transport requirements,
20322 different transports can be listed in the routing information:
20323 .code
20324 save_in_file:
20325   driver = manualroute
20326   route_list = \
20327     *.saved.domain1.example  $domain  batch_appendfile; \
20328     *.saved.domain2.example  \
20329       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20330       batch_pipe
20331 .endd
20332 .vindex "&$domain$&"
20333 .vindex "&$host$&"
20334 The first of these just passes the domain in the &$host$& variable, which
20335 doesn't achieve much (since it is also in &$domain$&), but the second does a
20336 file lookup to find a value to pass, causing the router to decline to handle
20337 the address if the lookup fails.
20338
20339 .next
20340 .cindex "UUCP" "example of router for"
20341 Routing mail directly to UUCP software is a specific case of the use of
20342 &(manualroute)& in a gateway to another mail environment. This is an example of
20343 one way it can be done:
20344 .code
20345 # Transport
20346 uucp:
20347   driver = pipe
20348   user = nobody
20349   command = /usr/local/bin/uux -r - \
20350     ${substr_-5:$host}!rmail ${local_part}
20351   return_fail_output = true
20352
20353 # Router
20354 uucphost:
20355   transport = uucp
20356   driver = manualroute
20357   route_data = \
20358     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20359 .endd
20360 The file &_/usr/local/exim/uucphosts_& contains entries like
20361 .code
20362 darksite.ethereal.example:           darksite.UUCP
20363 .endd
20364 It can be set up more simply without adding and removing &".UUCP"& but this way
20365 makes clear the distinction between the domain name
20366 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20367 .endlist
20368 .ecindex IIDmanrou1
20369 .ecindex IIDmanrou2
20370
20371
20372
20373
20374
20375
20376
20377
20378 . ////////////////////////////////////////////////////////////////////////////
20379 . ////////////////////////////////////////////////////////////////////////////
20380
20381 .chapter "The queryprogram router" "CHAPdriverlast"
20382 .scindex IIDquerou1 "&(queryprogram)& router"
20383 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20384 .cindex "routing" "by external program"
20385 The &(queryprogram)& router routes an address by running an external command
20386 and acting on its output. This is an expensive way to route, and is intended
20387 mainly for use in lightly-loaded systems, or for performing experiments.
20388 However, if it is possible to use the precondition options (&%domains%&,
20389 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20390 be used in special cases, even on a busy host. There are the following private
20391 options:
20392 .cindex "options" "&(queryprogram)& router"
20393
20394 .option command queryprogram string&!! unset
20395 This option must be set. It specifies the command that is to be run. The
20396 command is split up into a command name and arguments, and then each is
20397 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20398 &<<CHAPpipetransport>>&).
20399
20400
20401 .option command_group queryprogram string unset
20402 .cindex "gid (group id)" "in &(queryprogram)& router"
20403 This option specifies a gid to be set when running the command while routing an
20404 address for deliver. It must be set if &%command_user%& specifies a numerical
20405 uid. If it begins with a digit, it is interpreted as the numerical value of the
20406 gid. Otherwise it is looked up using &[getgrnam()]&.
20407
20408
20409 .option command_user queryprogram string unset
20410 .cindex "uid (user id)" "for &(queryprogram)&"
20411 This option must be set. It specifies the uid which is set when running the
20412 command while routing an address for delivery. If the value begins with a digit,
20413 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20414 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20415 not set, a value for the gid also.
20416
20417 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20418 root, which it does during a normal delivery in a conventional configuration.
20419 However, when an address is being verified during message reception, Exim is
20420 usually running as the Exim user, not as root. If the &(queryprogram)& router
20421 is called from a non-root process, Exim cannot change uid or gid before running
20422 the command. In this circumstance the command runs under the current uid and
20423 gid.
20424
20425
20426 .option current_directory queryprogram string /
20427 This option specifies an absolute path which is made the current directory
20428 before running the command.
20429
20430
20431 .option timeout queryprogram time 1h
20432 If the command does not complete within the timeout period, its process group
20433 is killed and the message is frozen. A value of zero time specifies no
20434 timeout.
20435
20436
20437 The standard output of the command is connected to a pipe, which is read when
20438 the command terminates. It should consist of a single line of output,
20439 containing up to five fields, separated by white space. The maximum length of
20440 the line is 1023 characters. Longer lines are silently truncated. The first
20441 field is one of the following words (case-insensitive):
20442
20443 .ilist
20444 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20445 below).
20446 .next
20447 &'Decline'&: the router declines; pass the address to the next router, unless
20448 &%no_more%& is set.
20449 .next
20450 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20451 subsequent text on the line is an error message. If the router is run as part
20452 of address verification during an incoming SMTP message, the message is
20453 included in the SMTP response.
20454 .next
20455 &'Defer'&: routing could not be completed at this time; try again later. Any
20456 subsequent text on the line is an error message which is logged. It is not
20457 included in any SMTP response.
20458 .next
20459 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20460 .next
20461 &'Pass'&: pass the address to the next router (or the router specified by
20462 &%pass_router%&), overriding &%no_more%&.
20463 .next
20464 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20465 new addresses, which are routed independently, starting with the first router,
20466 or the router specified by &%redirect_router%&, if set.
20467 .endlist
20468
20469 When the first word is &'accept'&, the remainder of the line consists of a
20470 number of keyed data values, as follows (split into two lines here, to fit on
20471 the page):
20472 .code
20473 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20474 LOOKUP=byname|bydns DATA=<text>
20475 .endd
20476 The data items can be given in any order, and all are optional. If no transport
20477 is included, the transport specified by the generic &%transport%& option is
20478 used. The list of hosts and the lookup type are needed only if the transport is
20479 an &(smtp)& transport that does not itself supply a list of hosts.
20480
20481 The format of the list of hosts is the same as for the &(manualroute)& router.
20482 As well as host names and IP addresses with optional port numbers, as described
20483 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20484 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20485 (see section &<<SECThostshowused>>&).
20486
20487 If the lookup type is not specified, Exim behaves as follows when trying to
20488 find an IP address for each host: First, a DNS lookup is done. If this yields
20489 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20490 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20491 result of the lookup is the result of that call.
20492
20493 .vindex "&$address_data$&"
20494 If the DATA field is set, its value is placed in the &$address_data$&
20495 variable. For example, this return line
20496 .code
20497 accept hosts=x1.y.example:x2.y.example data="rule1"
20498 .endd
20499 routes the address to the default transport, passing a list of two hosts. When
20500 the transport runs, the string &"rule1"& is in &$address_data$&.
20501 .ecindex IIDquerou1
20502 .ecindex IIDquerou2
20503
20504
20505
20506
20507 . ////////////////////////////////////////////////////////////////////////////
20508 . ////////////////////////////////////////////////////////////////////////////
20509
20510 .chapter "The redirect router" "CHAPredirect"
20511 .scindex IIDredrou1 "&(redirect)& router"
20512 .scindex IIDredrou2 "routers" "&(redirect)&"
20513 .cindex "alias file" "in a &(redirect)& router"
20514 .cindex "address redirection" "&(redirect)& router"
20515 The &(redirect)& router handles several kinds of address redirection. Its most
20516 common uses are for resolving local part aliases from a central alias file
20517 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20518 files, but it has many other potential uses. The incoming address can be
20519 redirected in several different ways:
20520
20521 .ilist
20522 It can be replaced by one or more new addresses which are themselves routed
20523 independently.
20524 .next
20525 It can be routed to be delivered to a given file or directory.
20526 .next
20527 It can be routed to be delivered to a specified pipe command.
20528 .next
20529 It can cause an automatic reply to be generated.
20530 .next
20531 It can be forced to fail, optionally with a custom error message.
20532 .next
20533 It can be temporarily deferred, optionally with a custom message.
20534 .next
20535 It can be discarded.
20536 .endlist
20537
20538 The generic &%transport%& option must not be set for &(redirect)& routers.
20539 However, there are some private options which define transports for delivery to
20540 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20541 &%pipe_transport%& and &%reply_transport%& descriptions below.
20542
20543 If success DSNs have been requested
20544 .cindex "DSN" "success"
20545 .cindex "Delivery Status Notification" "success"
20546 redirection triggers one and the DSN options are not passed any further.
20547
20548
20549
20550 .section "Redirection data" "SECID124"
20551 The router operates by interpreting a text string which it obtains either by
20552 expanding the contents of the &%data%& option, or by reading the entire
20553 contents of a file whose name is given in the &%file%& option. These two
20554 options are mutually exclusive. The first is commonly used for handling system
20555 aliases, in a configuration like this:
20556 .code
20557 system_aliases:
20558   driver = redirect
20559   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20560 .endd
20561 If the lookup fails, the expanded string in this example is empty. When the
20562 expansion of &%data%& results in an empty string, the router declines. A forced
20563 expansion failure also causes the router to decline; other expansion failures
20564 cause delivery to be deferred.
20565
20566 A configuration using &%file%& is commonly used for handling users'
20567 &_.forward_& files, like this:
20568 .code
20569 userforward:
20570   driver = redirect
20571   check_local_user
20572   file = $home/.forward
20573   no_verify
20574 .endd
20575 If the file does not exist, or causes no action to be taken (for example, it is
20576 empty or consists only of comments), the router declines. &*Warning*&: This
20577 is not the case when the file contains syntactically valid items that happen to
20578 yield empty addresses, for example, items containing only RFC 2822 address
20579 comments.
20580
20581 .new
20582 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
20583 directly for redirection,
20584 as they are provided by a potential attacker.
20585 In the examples above, &$local_part$& is used for looking up data held locally
20586 on the system, and not used directly (the second example derives &$home$& via
20587 the passsword file or database, using &$local_part$&).
20588 .wen
20589
20590
20591
20592 .section "Forward files and address verification" "SECID125"
20593 .cindex "address redirection" "while verifying"
20594 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
20595 &_.forward_& files, as in the example above. There are two reasons for this:
20596
20597 .ilist
20598 When Exim is receiving an incoming SMTP message from a remote host, it is
20599 running under the Exim uid, not as root. Exim is unable to change uid to read
20600 the file as the user, and it may not be able to read it as the Exim user. So in
20601 practice the router may not be able to operate.
20602 .next
20603 However, even when the router can operate, the existence of a &_.forward_& file
20604 is unimportant when verifying an address. What should be checked is whether the
20605 local part is a valid user name or not. Cutting out the redirection processing
20606 saves some resources.
20607 .endlist
20608
20609
20610
20611
20612
20613
20614 .section "Interpreting redirection data" "SECID126"
20615 .cindex "Sieve filter" "specifying in redirection data"
20616 .cindex "filter" "specifying in redirection data"
20617 The contents of the data string, whether obtained from &%data%& or &%file%&,
20618 can be interpreted in two different ways:
20619
20620 .ilist
20621 If the &%allow_filter%& option is set true, and the data begins with the text
20622 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
20623 &'filtering'& instructions in the form of an Exim or Sieve filter file,
20624 respectively. Details of the syntax and semantics of filter files are described
20625 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
20626 document is intended for use by end users.
20627 .next
20628 Otherwise, the data must be a comma-separated list of redirection items, as
20629 described in the next section.
20630 .endlist
20631
20632 When a message is redirected to a file (a &"mail folder"&), the filename given
20633 in a non-filter redirection list must always be an absolute path. A filter may
20634 generate a relative path &-- how this is handled depends on the transport's
20635 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
20636 for the &(appendfile)& transport.
20637
20638
20639
20640 .section "Items in a non-filter redirection list" "SECTitenonfilred"
20641 .cindex "address redirection" "non-filter list items"
20642 When the redirection data is not an Exim or Sieve filter, for example, if it
20643 comes from a conventional alias or forward file, it consists of a list of
20644 addresses, filenames, pipe commands, or certain special items (see section
20645 &<<SECTspecitredli>>& below). The special items can be individually enabled or
20646 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
20647 depending on their default values. The items in the list are separated by
20648 commas or newlines.
20649 If a comma is required in an item, the entire item must be enclosed in double
20650 quotes.
20651
20652 Lines starting with a # character are comments, and are ignored, and # may
20653 also appear following a comma, in which case everything between the # and the
20654 next newline character is ignored.
20655
20656 If an item is entirely enclosed in double quotes, these are removed. Otherwise
20657 double quotes are retained because some forms of mail address require their use
20658 (but never to enclose the entire address). In the following description,
20659 &"item"& refers to what remains after any surrounding double quotes have been
20660 removed.
20661
20662 .vindex "&$local_part$&"
20663 &*Warning*&: If you use an Exim expansion to construct a redirection address,
20664 and the expansion contains a reference to &$local_part$&, you should make use
20665 of the &%quote_local_part%& expansion operator, in case the local part contains
20666 special characters. For example, to redirect all mail for the domain
20667 &'obsolete.example'&, retaining the existing local part, you could use this
20668 setting:
20669 .code
20670 data = ${quote_local_part:$local_part}@newdomain.example
20671 .endd
20672
20673
20674 .section "Redirecting to a local mailbox" "SECTredlocmai"
20675 .cindex "routing" "loops in"
20676 .cindex "loop" "while routing, avoidance of"
20677 .cindex "address redirection" "to local mailbox"
20678 A redirection item may safely be the same as the address currently under
20679 consideration. This does not cause a routing loop, because a router is
20680 automatically skipped if any ancestor of the address that is being processed
20681 is the same as the current address and was processed by the current router.
20682 Such an address is therefore passed to the following routers, so it is handled
20683 as if there were no redirection. When making this loop-avoidance test, the
20684 complete local part, including any prefix or suffix, is used.
20685
20686 .cindex "address redirection" "local part without domain"
20687 Specifying the same local part without a domain is a common usage in personal
20688 filter files when the user wants to have messages delivered to the local
20689 mailbox and also forwarded elsewhere. For example, the user whose login is
20690 &'cleo'& might have a &_.forward_& file containing this:
20691 .code
20692 cleo, cleopatra@egypt.example
20693 .endd
20694 .cindex "backslash in alias file"
20695 .cindex "alias file" "backslash in"
20696 For compatibility with other MTAs, such unqualified local parts may be
20697 preceded by &"\"&, but this is not a requirement for loop prevention. However,
20698 it does make a difference if more than one domain is being handled
20699 synonymously.
20700
20701 If an item begins with &"\"& and the rest of the item parses as a valid RFC
20702 2822 address that does not include a domain, the item is qualified using the
20703 domain of the incoming address. In the absence of a leading &"\"&, unqualified
20704 addresses are qualified using the value in &%qualify_recipient%&, but you can
20705 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
20706
20707 Care must be taken if there are alias names for local users.
20708 Consider an MTA handling a single local domain where the system alias file
20709 contains:
20710 .code
20711 Sam.Reman: spqr
20712 .endd
20713 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
20714 messages in the local mailbox, and also forward copies elsewhere. He creates
20715 this forward file:
20716 .code
20717 Sam.Reman, spqr@reme.elsewhere.example
20718 .endd
20719 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
20720 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
20721 second time round, because it has previously routed it,
20722 and the following routers presumably cannot handle the alias. The forward file
20723 should really contain
20724 .code
20725 spqr, spqr@reme.elsewhere.example
20726 .endd
20727 but because this is such a common error, the &%check_ancestor%& option (see
20728 below) exists to provide a way to get round it. This is normally set on a
20729 &(redirect)& router that is handling users' &_.forward_& files.
20730
20731
20732
20733 .section "Special items in redirection lists" "SECTspecitredli"
20734 In addition to addresses, the following types of item may appear in redirection
20735 lists (that is, in non-filter redirection data):
20736
20737 .ilist
20738 .cindex "pipe" "in redirection list"
20739 .cindex "address redirection" "to pipe"
20740 An item is treated as a pipe command if it begins with &"|"& and does not parse
20741 as a valid RFC 2822 address that includes a domain. A transport for running the
20742 command must be specified by the &%pipe_transport%& option.
20743 Normally, either the router or the transport specifies a user and a group under
20744 which to run the delivery. The default is to use the Exim user and group.
20745
20746 Single or double quotes can be used for enclosing the individual arguments of
20747 the pipe command; no interpretation of escapes is done for single quotes. If
20748 the command contains a comma character, it is necessary to put the whole item
20749 in double quotes, for example:
20750 .code
20751 "|/some/command ready,steady,go"
20752 .endd
20753 since items in redirection lists are terminated by commas. Do not, however,
20754 quote just the command. An item such as
20755 .code
20756 |"/some/command ready,steady,go"
20757 .endd
20758 is interpreted as a pipe with a rather strange command name, and no arguments.
20759
20760 Note that the above example assumes that the text comes from a lookup source
20761 of some sort, so that the quotes are part of the data.  If composing a
20762 redirect router with a &%data%& option directly specifying this command, the
20763 quotes will be used by the configuration parser to define the extent of one
20764 string, but will not be passed down into the redirect router itself.  There
20765 are two main approaches to get around this: escape quotes to be part of the
20766 data itself, or avoid using this mechanism and instead create a custom
20767 transport with the &%command%& option set and reference that transport from
20768 an &%accept%& router.
20769
20770 .next
20771 .cindex "file" "in redirection list"
20772 .cindex "address redirection" "to file"
20773 An item is interpreted as a path name if it begins with &"/"& and does not
20774 parse as a valid RFC 2822 address that includes a domain. For example,
20775 .code
20776 /home/world/minbari
20777 .endd
20778 is treated as a filename, but
20779 .code
20780 /s=molari/o=babylon/@x400gate.way
20781 .endd
20782 is treated as an address. For a filename, a transport must be specified using
20783 the &%file_transport%& option. However, if the generated path name ends with a
20784 forward slash character, it is interpreted as a directory name rather than a
20785 filename, and &%directory_transport%& is used instead.
20786
20787 Normally, either the router or the transport specifies a user and a group under
20788 which to run the delivery. The default is to use the Exim user and group.
20789
20790 .cindex "&_/dev/null_&"
20791 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20792 bypassed at a high level, and the log entry shows &"**bypassed**"&
20793 instead of a transport name. In this case the user and group are not used.
20794
20795 .next
20796 .cindex "included address list"
20797 .cindex "address redirection" "included external list"
20798 If an item is of the form
20799 .code
20800 :include:<path name>
20801 .endd
20802 a list of further items is taken from the given file and included at that
20803 point. &*Note*&: Such a file can not be a filter file; it is just an
20804 out-of-line addition to the list. The items in the included list are separated
20805 by commas or newlines and are not subject to expansion. If this is the first
20806 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20807 the alias name. This example is incorrect:
20808 .code
20809 list1    :include:/opt/lists/list1
20810 .endd
20811 It must be given as
20812 .code
20813 list1:   :include:/opt/lists/list1
20814 .endd
20815 .next
20816 .cindex "address redirection" "to black hole"
20817 .cindex "delivery" "discard"
20818 .cindex "delivery" "blackhole"
20819 .cindex "black hole"
20820 .cindex "abandoning mail"
20821 Sometimes you want to throw away mail to a particular local part.  Making the
20822 &%data%& option expand to an empty string does not work, because that causes
20823 the router to decline. Instead, the alias item
20824 .code
20825 :blackhole:
20826 .endd
20827 can be used. It does what its name implies. No delivery is
20828 done, and no error message is generated. This has the same effect as specifying
20829 &_/dev/null_& as a destination, but it can be independently disabled.
20830
20831 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20832 delivery is done for the original local part, even if other redirection items
20833 are present. If you are generating a multi-item list (for example, by reading a
20834 database) and need the ability to provide a no-op item, you must use
20835 &_/dev/null_&.
20836
20837 .next
20838 .cindex "delivery" "forcing failure"
20839 .cindex "delivery" "forcing deferral"
20840 .cindex "failing delivery" "forcing"
20841 .cindex "deferred delivery, forcing"
20842 .cindex "customizing" "failure message"
20843 An attempt to deliver a particular address can be deferred or forced to fail by
20844 redirection items of the form
20845 .code
20846 :defer:
20847 :fail:
20848 .endd
20849 respectively. When a redirection list contains such an item, it applies
20850 to the entire redirection; any other items in the list are ignored. Any
20851 text following &':fail:'& or &':defer:'& is placed in the error text
20852 associated with the failure. For example, an alias file might contain:
20853 .code
20854 X.Employee:  :fail: Gone away, no forwarding address
20855 .endd
20856 In the case of an address that is being verified from an ACL or as the subject
20857 of a
20858 .cindex "VRFY" "error text, display of"
20859 VRFY command, the text is included in the SMTP error response by
20860 default.
20861 .cindex "EXPN" "error text, display of"
20862 The text is not included in the response to an EXPN command. In non-SMTP cases
20863 the text is included in the error message that Exim generates.
20864
20865 .cindex "SMTP" "error codes"
20866 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20867 &':fail:'&. However, if the message starts with three digits followed by a
20868 space, optionally followed by an extended code of the form &'n.n.n'&, also
20869 followed by a space, and the very first digit is the same as the default error
20870 code, the code from the message is used instead. If the very first digit is
20871 incorrect, a panic error is logged, and the default code is used. You can
20872 suppress the use of the supplied code in a redirect router by setting the
20873 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20874 ignored.
20875
20876 .vindex "&$acl_verify_message$&"
20877 In an ACL, an explicitly provided message overrides the default, but the
20878 default message is available in the variable &$acl_verify_message$& and can
20879 therefore be included in a custom message if this is desired.
20880
20881 Normally the error text is the rest of the redirection list &-- a comma does
20882 not terminate it &-- but a newline does act as a terminator. Newlines are not
20883 normally present in alias expansions. In &(lsearch)& lookups they are removed
20884 as part of the continuation process, but they may exist in other kinds of
20885 lookup and in &':include:'& files.
20886
20887 During routing for message delivery (as opposed to verification), a redirection
20888 containing &':fail:'& causes an immediate failure of the incoming address,
20889 whereas &':defer:'& causes the message to remain in the queue so that a
20890 subsequent delivery attempt can happen at a later time. If an address is
20891 deferred for too long, it will ultimately fail, because the normal retry
20892 rules still apply.
20893
20894 .next
20895 .cindex "alias file" "exception to default"
20896 Sometimes it is useful to use a single-key search type with a default (see
20897 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20898 for exceptions to the default. These can be handled by aliasing them to
20899 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20900 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20901 results in an empty redirection list has the same effect.
20902 .endlist
20903
20904
20905 .section "Duplicate addresses" "SECTdupaddr"
20906 .cindex "duplicate addresses"
20907 .cindex "address duplicate, discarding"
20908 .cindex "pipe" "duplicated"
20909 Exim removes duplicate addresses from the list to which it is delivering, so as
20910 to deliver just one copy to each address. This does not apply to deliveries
20911 routed to pipes by different immediate parent addresses, but an indirect
20912 aliasing scheme of the type
20913 .code
20914 pipe:       |/some/command $local_part
20915 localpart1: pipe
20916 localpart2: pipe
20917 .endd
20918 does not work with a message that is addressed to both local parts, because
20919 when the second is aliased to the intermediate local part &"pipe"& it gets
20920 discarded as being the same as a previously handled address. However, a scheme
20921 such as
20922 .code
20923 localpart1: |/some/command $local_part
20924 localpart2: |/some/command $local_part
20925 .endd
20926 does result in two different pipe deliveries, because the immediate parents of
20927 the pipes are distinct.
20928
20929
20930
20931 .section "Repeated redirection expansion" "SECID128"
20932 .cindex "repeated redirection expansion"
20933 .cindex "address redirection" "repeated for each delivery attempt"
20934 When a message cannot be delivered to all of its recipients immediately,
20935 leading to two or more delivery attempts, redirection expansion is carried out
20936 afresh each time for those addresses whose children were not all previously
20937 delivered. If redirection is being used as a mailing list, this can lead to new
20938 members of the list receiving copies of old messages. The &%one_time%& option
20939 can be used to avoid this.
20940
20941
20942 .section "Errors in redirection lists" "SECID129"
20943 .cindex "address redirection" "errors"
20944 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20945 error is skipped, and an entry is written to the main log. This may be useful
20946 for mailing lists that are automatically managed. Otherwise, if an error is
20947 detected while generating the list of new addresses, the original address is
20948 deferred. See also &%syntax_errors_to%&.
20949
20950
20951
20952 .section "Private options for the redirect router" "SECID130"
20953
20954 .cindex "options" "&(redirect)& router"
20955 The private options for the &(redirect)& router are as follows:
20956
20957
20958 .option allow_defer redirect boolean false
20959 Setting this option allows the use of &':defer:'& in non-filter redirection
20960 data, or the &%defer%& command in an Exim filter file.
20961
20962
20963 .option allow_fail redirect boolean false
20964 .cindex "failing delivery" "from filter"
20965 If this option is true, the &':fail:'& item can be used in a redirection list,
20966 and the &%fail%& command may be used in an Exim filter file.
20967
20968
20969 .option allow_filter redirect boolean false
20970 .cindex "filter" "enabling use of"
20971 .cindex "Sieve filter" "enabling use of"
20972 Setting this option allows Exim to interpret redirection data that starts with
20973 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20974 are some features of Exim filter files that some administrators may wish to
20975 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20976
20977 It is also possible to lock out Exim filters or Sieve filters while allowing
20978 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20979
20980
20981 The filter is run using the uid and gid set by the generic &%user%& and
20982 &%group%& options. These take their defaults from the password data if
20983 &%check_local_user%& is set, so in the normal case of users' personal filter
20984 files, the filter is run as the relevant user. When &%allow_filter%& is set
20985 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20986
20987
20988
20989 .option allow_freeze redirect boolean false
20990 .cindex "freezing messages" "allowing in filter"
20991 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20992 This command is more normally encountered in system filters, and is disabled by
20993 default for redirection filters because it isn't something you usually want to
20994 let ordinary users do.
20995
20996
20997
20998 .option check_ancestor redirect boolean false
20999 This option is concerned with handling generated addresses that are the same
21000 as some address in the list of redirection ancestors of the current address.
21001 Although it is turned off by default in the code, it is set in the default
21002 configuration file for handling users' &_.forward_& files. It is recommended
21003 for this use of the &(redirect)& router.
21004
21005 When &%check_ancestor%& is set, if a generated address (including the domain)
21006 is the same as any ancestor of the current address, it is replaced by a copy of
21007 the current address. This helps in the case where local part A is aliased to B,
21008 and B has a &_.forward_& file pointing back to A. For example, within a single
21009 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21010 &_&~jb/.forward_& contains:
21011 .code
21012 \Joe.Bloggs, <other item(s)>
21013 .endd
21014 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21015 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21016 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21017 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21018 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21019 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21020 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21021 original address. See also the &%repeat_use%& option below.
21022
21023
21024 .option check_group redirect boolean "see below"
21025 When the &%file%& option is used, the group owner of the file is checked only
21026 when this option is set. The permitted groups are those listed in the
21027 &%owngroups%& option, together with the user's default group if
21028 &%check_local_user%& is set. If the file has the wrong group, routing is
21029 deferred. The default setting for this option is true if &%check_local_user%&
21030 is set and the &%modemask%& option permits the group write bit, or if the
21031 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21032
21033
21034
21035 .option check_owner redirect boolean "see below"
21036 When the &%file%& option is used, the owner of the file is checked only when
21037 this option is set. If &%check_local_user%& is set, the local user is
21038 permitted; otherwise the owner must be one of those listed in the &%owners%&
21039 option. The default value for this option is true if &%check_local_user%& or
21040 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21041
21042
21043 .option data redirect string&!! unset
21044 This option is mutually exclusive with &%file%&. One or other of them must be
21045 set, but not both. The contents of &%data%& are expanded, and then used as the
21046 list of forwarding items, or as a set of filtering instructions. If the
21047 expansion is forced to fail, or the result is an empty string or a string that
21048 has no effect (consists entirely of comments), the router declines.
21049
21050 When filtering instructions are used, the string must begin with &"#Exim
21051 filter"&, and all comments in the string, including this initial one, must be
21052 terminated with newline characters. For example:
21053 .code
21054 data = #Exim filter\n\
21055        if $h_to: contains Exim then save $home/mail/exim endif
21056 .endd
21057 If you are reading the data from a database where newlines cannot be included,
21058 you can use the &${sg}$& expansion item to turn the escape string of your
21059 choice into a newline.
21060
21061
21062 .option directory_transport redirect string&!! unset
21063 A &(redirect)& router sets up a direct delivery to a directory when a path name
21064 ending with a slash is specified as a new &"address"&. The transport used is
21065 specified by this option, which, after expansion, must be the name of a
21066 configured transport. This should normally be an &(appendfile)& transport.
21067
21068
21069 .option file redirect string&!! unset
21070 This option specifies the name of a file that contains the redirection data. It
21071 is mutually exclusive with the &%data%& option. The string is expanded before
21072 use; if the expansion is forced to fail, the router declines. Other expansion
21073 failures cause delivery to be deferred. The result of a successful expansion
21074 must be an absolute path. The entire file is read and used as the redirection
21075 data. If the data is an empty string or a string that has no effect (consists
21076 entirely of comments), the router declines.
21077
21078 .cindex "NFS" "checking for file existence"
21079 If the attempt to open the file fails with a &"does not exist"& error, Exim
21080 runs a check on the containing directory,
21081 unless &%ignore_enotdir%& is true (see below).
21082 If the directory does not appear to exist, delivery is deferred. This can
21083 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21084 is a mount problem. If the containing directory does exist, but the file does
21085 not, the router declines.
21086
21087
21088 .option file_transport redirect string&!! unset
21089 .vindex "&$address_file$&"
21090 A &(redirect)& router sets up a direct delivery to a file when a path name not
21091 ending in a slash is specified as a new &"address"&. The transport used is
21092 specified by this option, which, after expansion, must be the name of a
21093 configured transport. This should normally be an &(appendfile)& transport. When
21094 it is running, the filename is in &$address_file$&.
21095
21096
21097 .option filter_prepend_home redirect boolean true
21098 When this option is true, if a &(save)& command in an Exim filter specifies a
21099 relative path, and &$home$& is defined, it is automatically prepended to the
21100 relative path. If this option is set false, this action does not happen. The
21101 relative path is then passed to the transport unmodified.
21102
21103
21104 .option forbid_blackhole redirect boolean false
21105 .cindex "restricting access to features"
21106 .cindex "filter" "locking out certain features"
21107 If this option is true, the &':blackhole:'& item may not appear in a
21108 redirection list.
21109
21110
21111 .option forbid_exim_filter redirect boolean false
21112 .cindex "restricting access to features"
21113 .cindex "filter" "locking out certain features"
21114 If this option is set true, only Sieve filters are permitted when
21115 &%allow_filter%& is true.
21116
21117
21118
21119
21120 .option forbid_file redirect boolean false
21121 .cindex "restricting access to features"
21122 .cindex "delivery" "to file; forbidding"
21123 .cindex "filter" "locking out certain features"
21124 .cindex "Sieve filter" "forbidding delivery to a file"
21125 .cindex "Sieve filter" "&""keep""& facility; disabling"
21126 If this option is true, this router may not generate a new address that
21127 specifies delivery to a local file or directory, either from a filter or from a
21128 conventional forward file. This option is forced to be true if &%one_time%& is
21129 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21130 locks out the Sieve's &"keep"& facility.
21131
21132
21133 .option forbid_filter_dlfunc redirect boolean false
21134 .cindex "restricting access to features"
21135 .cindex "filter" "locking out certain features"
21136 If this option is true, string expansions in Exim filters are not allowed to
21137 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21138 functions.
21139
21140 .option forbid_filter_existstest redirect boolean false
21141 .cindex "restricting access to features"
21142 .cindex "filter" "locking out certain features"
21143 .cindex "expansion" "statting a file"
21144 If this option is true, string expansions in Exim filters are not allowed to
21145 make use of the &%exists%& condition or the &%stat%& expansion item.
21146
21147 .option forbid_filter_logwrite redirect boolean false
21148 .cindex "restricting access to features"
21149 .cindex "filter" "locking out certain features"
21150 If this option is true, use of the logging facility in Exim filters is not
21151 permitted. Logging is in any case available only if the filter is being run
21152 under some unprivileged uid (which is normally the case for ordinary users'
21153 &_.forward_& files).
21154
21155
21156 .option forbid_filter_lookup redirect boolean false
21157 .cindex "restricting access to features"
21158 .cindex "filter" "locking out certain features"
21159 If this option is true, string expansions in Exim filter files are not allowed
21160 to make use of &%lookup%& items.
21161
21162
21163 .option forbid_filter_perl redirect boolean false
21164 .cindex "restricting access to features"
21165 .cindex "filter" "locking out certain features"
21166 This option has an effect only if Exim is built with embedded Perl support. If
21167 it is true, string expansions in Exim filter files are not allowed to make use
21168 of the embedded Perl support.
21169
21170
21171 .option forbid_filter_readfile redirect boolean false
21172 .cindex "restricting access to features"
21173 .cindex "filter" "locking out certain features"
21174 If this option is true, string expansions in Exim filter files are not allowed
21175 to make use of &%readfile%& items.
21176
21177
21178 .option forbid_filter_readsocket redirect boolean false
21179 .cindex "restricting access to features"
21180 .cindex "filter" "locking out certain features"
21181 If this option is true, string expansions in Exim filter files are not allowed
21182 to make use of &%readsocket%& items.
21183
21184
21185 .option forbid_filter_reply redirect boolean false
21186 .cindex "restricting access to features"
21187 .cindex "filter" "locking out certain features"
21188 If this option is true, this router may not generate an automatic reply
21189 message. Automatic replies can be generated only from Exim or Sieve filter
21190 files, not from traditional forward files. This option is forced to be true if
21191 &%one_time%& is set.
21192
21193
21194 .option forbid_filter_run redirect boolean false
21195 .cindex "restricting access to features"
21196 .cindex "filter" "locking out certain features"
21197 If this option is true, string expansions in Exim filter files are not allowed
21198 to make use of &%run%& items.
21199
21200
21201 .option forbid_include redirect boolean false
21202 .cindex "restricting access to features"
21203 .cindex "filter" "locking out certain features"
21204 If this option is true, items of the form
21205 .code
21206 :include:<path name>
21207 .endd
21208 are not permitted in non-filter redirection lists.
21209
21210
21211 .option forbid_pipe redirect boolean false
21212 .cindex "restricting access to features"
21213 .cindex "filter" "locking out certain features"
21214 .cindex "delivery" "to pipe; forbidding"
21215 If this option is true, this router may not generate a new address which
21216 specifies delivery to a pipe, either from an Exim filter or from a conventional
21217 forward file. This option is forced to be true if &%one_time%& is set.
21218
21219
21220 .option forbid_sieve_filter redirect boolean false
21221 .cindex "restricting access to features"
21222 .cindex "filter" "locking out certain features"
21223 If this option is set true, only Exim filters are permitted when
21224 &%allow_filter%& is true.
21225
21226
21227 .cindex "SMTP" "error codes"
21228 .option forbid_smtp_code redirect boolean false
21229 If this option is set true, any SMTP error codes that are present at the start
21230 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21231 the default codes (451 and 550, respectively) are always used.
21232
21233
21234
21235
21236 .option hide_child_in_errmsg redirect boolean false
21237 .cindex "bounce message" "redirection details; suppressing"
21238 If this option is true, it prevents Exim from quoting a child address if it
21239 generates a bounce or delay message for it. Instead it says &"an address
21240 generated from <&'the top level address'&>"&. Of course, this applies only to
21241 bounces generated locally. If a message is forwarded to another host, &'its'&
21242 bounce may well quote the generated address.
21243
21244
21245 .option ignore_eacces redirect boolean false
21246 .cindex "EACCES"
21247 If this option is set and an attempt to open a redirection file yields the
21248 EACCES error (permission denied), the &(redirect)& router behaves as if the
21249 file did not exist.
21250
21251
21252 .option ignore_enotdir redirect boolean false
21253 .cindex "ENOTDIR"
21254 If this option is set and an attempt to open a redirection file yields the
21255 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21256 router behaves as if the file did not exist.
21257
21258 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21259 router that has the &%file%& option set discovers that the file does not exist
21260 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21261 against unmounted NFS directories. If the parent can not be statted, delivery
21262 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21263 is set, because that option tells Exim to ignore &"something on the path is not
21264 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21265 that some operating systems give ENOENT where others give ENOTDIR.
21266
21267
21268
21269 .option include_directory redirect string unset
21270 If this option is set, the path names of any &':include:'& items in a
21271 redirection list must start with this directory.
21272
21273
21274 .option modemask redirect "octal integer" 022
21275 This specifies mode bits which must not be set for a file specified by the
21276 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21277
21278
21279 .option one_time redirect boolean false
21280 .cindex "one-time aliasing/forwarding expansion"
21281 .cindex "alias file" "one-time expansion"
21282 .cindex "forward file" "one-time expansion"
21283 .cindex "mailing lists" "one-time expansion"
21284 .cindex "address redirection" "one-time expansion"
21285 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21286 files each time it tries to deliver a message causes a problem when one or more
21287 of the generated addresses fails be delivered at the first attempt. The problem
21288 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21289 but of what happens when the redirection list changes during the time that the
21290 message is on Exim's queue. This is particularly true in the case of mailing
21291 lists, where new subscribers might receive copies of messages that were posted
21292 before they subscribed.
21293
21294 If &%one_time%& is set and any addresses generated by the router fail to
21295 deliver at the first attempt, the failing addresses are added to the message as
21296 &"top level"& addresses, and the parent address that generated them is marked
21297 &"delivered"&. Thus, redirection does not happen again at the next delivery
21298 attempt.
21299
21300 &*Warning 1*&: Any header line addition or removal that is specified by this
21301 router would be lost if delivery did not succeed at the first attempt. For this
21302 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21303 permitted when &%one_time%& is set.
21304
21305 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21306 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21307 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21308
21309 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21310 &%one_time%&.
21311
21312 The original top-level address is remembered with each of the generated
21313 addresses, and is output in any log messages. However, any intermediate parent
21314 addresses are not recorded. This makes a difference to the log only if
21315 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21316 typically be used for mailing lists, where there is normally just one level of
21317 expansion.
21318
21319
21320 .option owners redirect "string list" unset
21321 .cindex "ownership" "alias file"
21322 .cindex "ownership" "forward file"
21323 .cindex "alias file" "ownership"
21324 .cindex "forward file" "ownership"
21325 This specifies a list of permitted owners for the file specified by &%file%&.
21326 This list is in addition to the local user when &%check_local_user%& is set.
21327 See &%check_owner%& above.
21328
21329
21330 .option owngroups redirect "string list" unset
21331 This specifies a list of permitted groups for the file specified by &%file%&.
21332 The list is in addition to the local user's primary group when
21333 &%check_local_user%& is set. See &%check_group%& above.
21334
21335
21336 .option pipe_transport redirect string&!! unset
21337 .vindex "&$address_pipe$&"
21338 A &(redirect)& router sets up a direct delivery to a pipe when a string
21339 starting with a vertical bar character is specified as a new &"address"&. The
21340 transport used is specified by this option, which, after expansion, must be the
21341 name of a configured transport. This should normally be a &(pipe)& transport.
21342 When the transport is run, the pipe command is in &$address_pipe$&.
21343
21344
21345 .option qualify_domain redirect string&!! unset
21346 .vindex "&$qualify_recipient$&"
21347 If this option is set, and an unqualified address (one without a domain) is
21348 generated, and that address would normally be qualified by the global setting
21349 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21350 expanding this string. If the expansion fails, the router declines. If you want
21351 to revert to the default, you can have the expansion generate
21352 &$qualify_recipient$&.
21353
21354 This option applies to all unqualified addresses generated by Exim filters,
21355 but for traditional &_.forward_& files, it applies only to addresses that are
21356 not preceded by a backslash. Sieve filters cannot generate unqualified
21357 addresses.
21358
21359 .option qualify_preserve_domain redirect boolean false
21360 .cindex "domain" "in redirection; preserving"
21361 .cindex "preserving domain in redirection"
21362 .cindex "address redirection" "domain; preserving"
21363 If this option is set, the router's local &%qualify_domain%& option must not be
21364 set (a configuration error occurs if it is). If an unqualified address (one
21365 without a domain) is generated, it is qualified with the domain of the parent
21366 address (the immediately preceding ancestor) instead of the global
21367 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21368 this applies whether or not the address is preceded by a backslash.
21369
21370
21371 .option repeat_use redirect boolean true
21372 If this option is set false, the router is skipped for a child address that has
21373 any ancestor that was routed by this router. This test happens before any of
21374 the other preconditions are tested. Exim's default anti-looping rules skip
21375 only when the ancestor is the same as the current address. See also
21376 &%check_ancestor%& above and the generic &%redirect_router%& option.
21377
21378
21379 .option reply_transport redirect string&!! unset
21380 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21381 &%vacation%& command is used in a filter file. The transport used is specified
21382 by this option, which, after expansion, must be the name of a configured
21383 transport. This should normally be an &(autoreply)& transport. Other transports
21384 are unlikely to do anything sensible or useful.
21385
21386
21387 .option rewrite redirect boolean true
21388 .cindex "address redirection" "disabling rewriting"
21389 If this option is set false, addresses generated by the router are not
21390 subject to address rewriting. Otherwise, they are treated like new addresses
21391 and are rewritten according to the global rewriting rules.
21392
21393
21394 .option sieve_subaddress redirect string&!! unset
21395 The value of this option is passed to a Sieve filter to specify the
21396 :subaddress part of an address.
21397
21398 .option sieve_useraddress redirect string&!! unset
21399 The value of this option is passed to a Sieve filter to specify the :user part
21400 of an address. However, if it is unset, the entire original local part
21401 (including any prefix or suffix) is used for :user.
21402
21403
21404 .option sieve_vacation_directory redirect string&!! unset
21405 .cindex "Sieve filter" "vacation directory"
21406 To enable the &"vacation"& extension for Sieve filters, you must set
21407 &%sieve_vacation_directory%& to the directory where vacation databases are held
21408 (do not put anything else in that directory), and ensure that the
21409 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21410 needs their own directory; Exim will create it if necessary.
21411
21412
21413
21414 .option skip_syntax_errors redirect boolean false
21415 .cindex "forward file" "broken"
21416 .cindex "address redirection" "broken files"
21417 .cindex "alias file" "broken"
21418 .cindex "broken alias or forward files"
21419 .cindex "ignoring faulty addresses"
21420 .cindex "skipping faulty addresses"
21421 .cindex "error" "skipping bad syntax"
21422 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21423 non-filter redirection data are skipped, and each failing address is logged. If
21424 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21425 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21426 are expanded and placed at the head of the error message generated by
21427 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21428 be the same address as the generic &%errors_to%& option. The
21429 &%skip_syntax_errors%& option is often used when handling mailing lists.
21430
21431 If all the addresses in a redirection list are skipped because of syntax
21432 errors, the router declines to handle the original address, and it is passed to
21433 the following routers.
21434
21435 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21436 error in the filter causes filtering to be abandoned without any action being
21437 taken. The incident is logged, and the router declines to handle the address,
21438 so it is passed to the following routers.
21439
21440 .cindex "Sieve filter" "syntax errors in"
21441 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21442 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21443 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21444
21445 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21446 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21447 option, used with an address that does not get redirected, can be used to
21448 notify users of these errors, by means of a router like this:
21449 .code
21450 userforward:
21451   driver = redirect
21452   allow_filter
21453   check_local_user
21454   file = $home/.forward
21455   file_transport = address_file
21456   pipe_transport = address_pipe
21457   reply_transport = address_reply
21458   no_verify
21459   skip_syntax_errors
21460   syntax_errors_to = real-$local_part@$domain
21461   syntax_errors_text = \
21462    This is an automatically generated message. An error has\n\
21463    been found in your .forward file. Details of the error are\n\
21464    reported below. While this error persists, you will receive\n\
21465    a copy of this message for every message that is addressed\n\
21466    to you. If your .forward file is a filter file, or if it is\n\
21467    a non-filter file containing no valid forwarding addresses,\n\
21468    a copy of each incoming message will be put in your normal\n\
21469    mailbox. If a non-filter file contains at least one valid\n\
21470    forwarding address, forwarding to the valid addresses will\n\
21471    happen, and those will be the only deliveries that occur.
21472 .endd
21473 You also need a router to ensure that local addresses that are prefixed by
21474 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21475 put this immediately before the &(userforward)& router:
21476 .code
21477 real_localuser:
21478   driver = accept
21479   check_local_user
21480   local_part_prefix = real-
21481   transport = local_delivery
21482 .endd
21483 For security, it would probably be a good idea to restrict the use of this
21484 router to locally-generated messages, using a condition such as this:
21485 .code
21486   condition = ${if match {$sender_host_address}\
21487                          {\N^(|127\.0\.0\.1)$\N}}
21488 .endd
21489
21490
21491 .option syntax_errors_text redirect string&!! unset
21492 See &%skip_syntax_errors%& above.
21493
21494
21495 .option syntax_errors_to redirect string unset
21496 See &%skip_syntax_errors%& above.
21497 .ecindex IIDredrou1
21498 .ecindex IIDredrou2
21499
21500
21501
21502
21503
21504
21505 . ////////////////////////////////////////////////////////////////////////////
21506 . ////////////////////////////////////////////////////////////////////////////
21507
21508 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21509          "Environment for local transports"
21510 .scindex IIDenvlotra1 "local transports" "environment for"
21511 .scindex IIDenvlotra2 "environment" "local transports"
21512 .scindex IIDenvlotra3 "transport" "local; environment for"
21513 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21514 transport can be thought of as similar to a pipe.) Exim always runs transports
21515 in subprocesses, under specified uids and gids. Typical deliveries to local
21516 mailboxes run under the uid and gid of the local user.
21517
21518 Exim also sets a specific current directory while running the transport; for
21519 some transports a home directory setting is also relevant. The &(pipe)&
21520 transport is the only one that sets up environment variables; see section
21521 &<<SECTpipeenv>>& for details.
21522
21523 The values used for the uid, gid, and the directories may come from several
21524 different places. In many cases, the router that handles the address associates
21525 settings with that address as a result of its &%check_local_user%&, &%group%&,
21526 or &%user%& options. However, values may also be given in the transport's own
21527 configuration, and these override anything that comes from the router.
21528
21529
21530
21531 .section "Concurrent deliveries" "SECID131"
21532 .cindex "concurrent deliveries"
21533 .cindex "simultaneous deliveries"
21534 If two different messages for the same local recipient arrive more or less
21535 simultaneously, the two delivery processes are likely to run concurrently. When
21536 the &(appendfile)& transport is used to write to a file, Exim applies locking
21537 rules to stop concurrent processes from writing to the same file at the same
21538 time.
21539
21540 However, when you use a &(pipe)& transport, it is up to you to arrange any
21541 locking that is needed. Here is a silly example:
21542 .code
21543 my_transport:
21544   driver = pipe
21545   command = /bin/sh -c 'cat >>/some/file'
21546 .endd
21547 This is supposed to write the message at the end of the file. However, if two
21548 messages arrive at the same time, the file will be scrambled. You can use the
21549 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21550 file using the same algorithm that Exim itself uses.
21551
21552
21553
21554
21555 .section "Uids and gids" "SECTenvuidgid"
21556 .cindex "local transports" "uid and gid"
21557 .cindex "transport" "local; uid and gid"
21558 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21559 overrides any group that the router set in the address, even if &%user%& is not
21560 set for the transport. This makes it possible, for example, to run local mail
21561 delivery under the uid of the recipient (set by the router), but in a special
21562 group (set by the transport). For example:
21563 .code
21564 # Routers ...
21565 # User/group are set by check_local_user in this router
21566 local_users:
21567   driver = accept
21568   check_local_user
21569   transport = group_delivery
21570
21571 # Transports ...
21572 # This transport overrides the group
21573 group_delivery:
21574   driver = appendfile
21575   file = /var/spool/mail/$local_part
21576   group = mail
21577 .endd
21578 If &%user%& is set for a transport, its value overrides what is set in the
21579 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21580 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21581 set.
21582
21583 .oindex "&%initgroups%&"
21584 When the uid is taken from the transport's configuration, the &[initgroups()]&
21585 function is called for the groups associated with that uid if the
21586 &%initgroups%& option is set for the transport. When the uid is not specified
21587 by the transport, but is associated with the address by a router, the option
21588 for calling &[initgroups()]& is taken from the router configuration.
21589
21590 .cindex "&(pipe)& transport" "uid for"
21591 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
21592 is set and &%user%& is not set, the uid of the process that called Exim to
21593 receive the message is used, and if &%group%& is not set, the corresponding
21594 original gid is also used.
21595
21596 This is the detailed preference order for obtaining a gid; the first of the
21597 following that is set is used:
21598
21599 .ilist
21600 A &%group%& setting of the transport;
21601 .next
21602 A &%group%& setting of the router;
21603 .next
21604 A gid associated with a user setting of the router, either as a result of
21605 &%check_local_user%& or an explicit non-numeric &%user%& setting;
21606 .next
21607 The group associated with a non-numeric &%user%& setting of the transport;
21608 .next
21609 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
21610 the uid is the creator's uid;
21611 .next
21612 The Exim gid if the Exim uid is being used as a default.
21613 .endlist
21614
21615 If, for example, the user is specified numerically on the router and there are
21616 no group settings, no gid is available. In this situation, an error occurs.
21617 This is different for the uid, for which there always is an ultimate default.
21618 The first of the following that is set is used:
21619
21620 .ilist
21621 A &%user%& setting of the transport;
21622 .next
21623 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
21624 .next
21625 A &%user%& setting of the router;
21626 .next
21627 A &%check_local_user%& setting of the router;
21628 .next
21629 The Exim uid.
21630 .endlist
21631
21632 Of course, an error will still occur if the uid that is chosen is on the
21633 &%never_users%& list.
21634
21635
21636
21637
21638
21639 .section "Current and home directories" "SECID132"
21640 .cindex "current directory for local transport"
21641 .cindex "home directory" "for local transport"
21642 .cindex "transport" "local; home directory for"
21643 .cindex "transport" "local; current directory for"
21644 Routers may set current and home directories for local transports by means of
21645 the &%transport_current_directory%& and &%transport_home_directory%& options.
21646 However, if the transport's &%current_directory%& or &%home_directory%& options
21647 are set, they override the router's values. In detail, the home directory
21648 for a local transport is taken from the first of these values that is set:
21649
21650 .ilist
21651 The &%home_directory%& option on the transport;
21652 .next
21653 The &%transport_home_directory%& option on the router;
21654 .next
21655 The password data if &%check_local_user%& is set on the router;
21656 .next
21657 The &%router_home_directory%& option on the router.
21658 .endlist
21659
21660 The current directory is taken from the first of these values that is set:
21661
21662 .ilist
21663 The &%current_directory%& option on the transport;
21664 .next
21665 The &%transport_current_directory%& option on the router.
21666 .endlist
21667
21668
21669 If neither the router nor the transport sets a current directory, Exim uses the
21670 value of the home directory, if it is set. Otherwise it sets the current
21671 directory to &_/_& before running a local transport.
21672
21673
21674
21675 .section "Expansion variables derived from the address" "SECID133"
21676 .vindex "&$domain$&"
21677 .vindex "&$local_part$&"
21678 .vindex "&$original_domain$&"
21679 Normally a local delivery is handling a single address, and in that case the
21680 variables such as &$domain$& and &$local_part$& are set during local
21681 deliveries. However, in some circumstances more than one address may be handled
21682 at once (for example, while writing batch SMTP for onward transmission by some
21683 other means). In this case, the variables associated with the local part are
21684 never set, &$domain$& is set only if all the addresses have the same domain,
21685 and &$original_domain$& is never set.
21686 .ecindex IIDenvlotra1
21687 .ecindex IIDenvlotra2
21688 .ecindex IIDenvlotra3
21689
21690
21691
21692
21693
21694
21695
21696 . ////////////////////////////////////////////////////////////////////////////
21697 . ////////////////////////////////////////////////////////////////////////////
21698
21699 .chapter "Generic options for transports" "CHAPtransportgeneric"
21700 .scindex IIDgenoptra1 "generic options" "transport"
21701 .scindex IIDgenoptra2 "options" "generic; for transports"
21702 .scindex IIDgenoptra3 "transport" "generic options for"
21703 The following generic options apply to all transports:
21704
21705
21706 .option body_only transports boolean false
21707 .cindex "transport" "body only"
21708 .cindex "message" "transporting body only"
21709 .cindex "body of message" "transporting"
21710 If this option is set, the message's headers are not transported. It is
21711 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
21712 or &(pipe)& transports, the settings of &%message_prefix%& and
21713 &%message_suffix%& should be checked, because this option does not
21714 automatically suppress them.
21715
21716
21717 .option current_directory transports string&!! unset
21718 .cindex "transport" "current directory for"
21719 This specifies the current directory that is to be set while running the
21720 transport, overriding any value that may have been set by the router.
21721 If the expansion fails for any reason, including forced failure, an error is
21722 logged, and delivery is deferred.
21723
21724
21725 .option disable_logging transports boolean false
21726 If this option is set true, nothing is logged for any
21727 deliveries by the transport or for any
21728 transport errors. You should not set this option unless you really, really know
21729 what you are doing.
21730
21731
21732 .option debug_print transports string&!! unset
21733 .cindex "testing" "variables in drivers"
21734 If this option is set and debugging is enabled (see the &%-d%& command line
21735 option), the string is expanded and included in the debugging output when the
21736 transport is run.
21737 If expansion of the string fails, the error message is written to the debugging
21738 output, and Exim carries on processing.
21739 This facility is provided to help with checking out the values of variables and
21740 so on when debugging driver configurations. For example, if a &%headers_add%&
21741 option is not working properly, &%debug_print%& could be used to output the
21742 variables it references. A newline is added to the text if it does not end with
21743 one.
21744 The variables &$transport_name$& and &$router_name$& contain the name of the
21745 transport and the router that called it.
21746
21747 .option delivery_date_add transports boolean false
21748 .cindex "&'Delivery-date:'& header line"
21749 If this option is true, a &'Delivery-date:'& header is added to the message.
21750 This gives the actual time the delivery was made. As this is not a standard
21751 header, Exim has a configuration option (&%delivery_date_remove%&) which
21752 requests its removal from incoming messages, so that delivered messages can
21753 safely be resent to other recipients.
21754
21755
21756 .option driver transports string unset
21757 This specifies which of the available transport drivers is to be used.
21758 There is no default, and this option must be set for every transport.
21759
21760
21761 .option envelope_to_add transports boolean false
21762 .cindex "&'Envelope-to:'& header line"
21763 If this option is true, an &'Envelope-to:'& header is added to the message.
21764 This gives the original address(es) in the incoming envelope that caused this
21765 delivery to happen. More than one address may be present if the transport is
21766 configured to handle several addresses at once, or if more than one original
21767 address was redirected to the same final address. As this is not a standard
21768 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21769 its removal from incoming messages, so that delivered messages can safely be
21770 resent to other recipients.
21771
21772
21773 .option event_action transports string&!! unset
21774 .cindex events
21775 This option declares a string to be expanded for Exim's events mechanism.
21776 For details see chapter &<<CHAPevents>>&.
21777
21778
21779 .option group transports string&!! "Exim group"
21780 .cindex "transport" "group; specifying"
21781 This option specifies a gid for running the transport process, overriding any
21782 value that the router supplies, and also overriding any value associated with
21783 &%user%& (see below).
21784
21785
21786 .option headers_add transports list&!! unset
21787 .cindex "header lines" "adding in transport"
21788 .cindex "transport" "header lines; adding"
21789 This option specifies a list of text headers,
21790 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
21791 which are (separately) expanded and added to the header
21792 portion of a message as it is transported, as described in section
21793 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
21794 routers. If the result of the expansion is an empty string, or if the expansion
21795 is forced to fail, no action is taken. Other expansion failures are treated as
21796 errors and cause the delivery to be deferred.
21797
21798 Unlike most options, &%headers_add%& can be specified multiple times
21799 for a transport; all listed headers are added.
21800
21801
21802 .option headers_only transports boolean false
21803 .cindex "transport" "header lines only"
21804 .cindex "message" "transporting headers only"
21805 .cindex "header lines" "transporting"
21806 If this option is set, the message's body is not transported. It is mutually
21807 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
21808 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
21809 checked, since this option does not automatically suppress them.
21810
21811
21812 .option headers_remove transports list&!! unset
21813 .cindex "header lines" "removing"
21814 .cindex "transport" "header lines; removing"
21815 This option specifies a list of header names,
21816 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&);
21817 these headers are omitted from the message as it is transported, as described
21818 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21819 routers.
21820 Each list item is separately expanded.
21821 If the result of the expansion is an empty string, or if the expansion
21822 is forced to fail, no action is taken. Other expansion failures are treated as
21823 errors and cause the delivery to be deferred.
21824
21825 Unlike most options, &%headers_remove%& can be specified multiple times
21826 for a transport; all listed headers are removed.
21827
21828 &*Warning*&: Because of the separate expansion of the list items,
21829 items that contain a list separator must have it doubled.
21830 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21831
21832
21833
21834 .option headers_rewrite transports string unset
21835 .cindex "transport" "header lines; rewriting"
21836 .cindex "rewriting" "at transport time"
21837 This option allows addresses in header lines to be rewritten at transport time,
21838 that is, as the message is being copied to its destination. The contents of the
21839 option are a colon-separated list of rewriting rules. Each rule is in exactly
21840 the same form as one of the general rewriting rules that are applied when a
21841 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21842 example,
21843 .code
21844 headers_rewrite = a@b c@d f : \
21845                   x@y w@z
21846 .endd
21847 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21848 &'w@z'& in all address-bearing header lines. The rules are applied to the
21849 header lines just before they are written out at transport time, so they affect
21850 only those copies of the message that pass through the transport. However, only
21851 the message's original header lines, and any that were added by a system
21852 filter, are rewritten. If a router or transport adds header lines, they are not
21853 affected by this option. These rewriting rules are &'not'& applied to the
21854 envelope. You can change the return path using &%return_path%&, but you cannot
21855 change envelope recipients at this time.
21856
21857
21858 .option home_directory transports string&!! unset
21859 .cindex "transport" "home directory for"
21860 .vindex "&$home$&"
21861 This option specifies a home directory setting for a local transport,
21862 overriding any value that may be set by the router. The home directory is
21863 placed in &$home$& while expanding the transport's private options. It is also
21864 used as the current directory if no current directory is set by the
21865 &%current_directory%& option on the transport or the
21866 &%transport_current_directory%& option on the router. If the expansion fails
21867 for any reason, including forced failure, an error is logged, and delivery is
21868 deferred.
21869
21870
21871 .option initgroups transports boolean false
21872 .cindex "additional groups"
21873 .cindex "groups" "additional"
21874 .cindex "transport" "group; additional"
21875 If this option is true and the uid for the delivery process is provided by the
21876 transport, the &[initgroups()]& function is called when running the transport
21877 to ensure that any additional groups associated with the uid are set up.
21878
21879
21880 .option max_parallel transports integer&!! unset
21881 .cindex limit "transport parallelism"
21882 .cindex transport "parallel processes"
21883 .cindex transport "concurrency limit"
21884 .cindex "delivery" "parallelism for transport"
21885 If this option is set and expands to an integer greater than zero
21886 it limits the number of concurrent runs of the transport.
21887 The control does not apply to shadow transports.
21888
21889 .cindex "hints database" "transport concurrency control"
21890 Exim implements this control by means of a hints database in which a record is
21891 incremented whenever a transport process is being created. The record
21892 is decremented and possibly removed when the process terminates.
21893 Obviously there is scope for
21894 records to get left lying around if there is a system or program crash. To
21895 guard against this, Exim ignores any records that are more than six hours old.
21896
21897 If you use this option, you should also arrange to delete the
21898 relevant hints database whenever your system reboots. The names of the files
21899 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21900 may be one or two files, depending on the type of DBM in use. The same files
21901 are used for ETRN and smtp transport serialization.
21902
21903
21904 .option message_size_limit transports string&!! 0
21905 .cindex "limit" "message size per transport"
21906 .cindex "size" "of message, limit"
21907 .cindex "transport" "message size; limiting"
21908 This option controls the size of messages passed through the transport. It is
21909 expanded before use; the result of the expansion must be a sequence of decimal
21910 digits, optionally followed by K or M. If the expansion fails for any reason,
21911 including forced failure, or if the result is not of the required form,
21912 delivery is deferred. If the value is greater than zero and the size of a
21913 message exceeds this limit, the address is failed. If there is any chance that
21914 the resulting bounce message could be routed to the same transport, you should
21915 ensure that &%return_size_limit%& is less than the transport's
21916 &%message_size_limit%&, as otherwise the bounce message will fail to get
21917 delivered.
21918
21919
21920
21921 .option rcpt_include_affixes transports boolean false
21922 .cindex "prefix" "for local part, including in envelope"
21923 .cindex "suffix for local part" "including in envelope"
21924 .cindex "local part" "prefix"
21925 .cindex "local part" "suffix"
21926 When this option is false (the default), and an address that has had any
21927 affixes (prefixes or suffixes) removed from the local part is delivered by any
21928 form of SMTP or LMTP, the affixes are not included. For example, if a router
21929 that contains
21930 .code
21931 local_part_prefix = *-
21932 .endd
21933 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21934 is delivered with
21935 .code
21936 RCPT TO:<xyz@some.domain>
21937 .endd
21938 This is also the case when an ACL-time callout is being used to verify a
21939 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21940 whole local part is included in the RCPT command. This option applies to BSMTP
21941 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21942 &(lmtp)& and &(smtp)& transports.
21943
21944
21945 .option retry_use_local_part transports boolean "see below"
21946 .cindex "hints database" "retry keys"
21947 When a delivery suffers a temporary failure, a retry record is created
21948 in Exim's hints database. For remote deliveries, the key for the retry record
21949 is based on the name and/or IP address of the failing remote host. For local
21950 deliveries, the key is normally the entire address, including both the local
21951 part and the domain. This is suitable for most common cases of local delivery
21952 temporary failure &-- for example, exceeding a mailbox quota should delay only
21953 deliveries to that mailbox, not to the whole domain.
21954
21955 However, in some special cases you may want to treat a temporary local delivery
21956 as a failure associated with the domain, and not with a particular local part.
21957 (For example, if you are storing all mail for some domain in files.) You can do
21958 this by setting &%retry_use_local_part%& false.
21959
21960 For all the local transports, its default value is true. For remote transports,
21961 the default value is false for tidiness, but changing the value has no effect
21962 on a remote transport in the current implementation.
21963
21964
21965 .option return_path transports string&!! unset
21966 .cindex "envelope sender"
21967 .cindex "envelope from"
21968 .cindex "transport" "return path; changing"
21969 .cindex "return path" "changing in transport"
21970 If this option is set, the string is expanded at transport time and replaces
21971 the existing return path (envelope sender) value in the copy of the message
21972 that is being delivered. An empty return path is permitted. This feature is
21973 designed for remote deliveries, where the value of this option is used in the
21974 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21975 only effect is to change the address that is placed in the &'Return-path:'&
21976 header line, if one is added to the message (see the next option).
21977
21978 &*Note:*& A changed return path is not logged unless you add
21979 &%return_path_on_delivery%& to the log selector.
21980
21981 .vindex "&$return_path$&"
21982 The expansion can refer to the existing value via &$return_path$&. This is
21983 either the message's envelope sender, or an address set by the
21984 &%errors_to%& option on a router. If the expansion is forced to fail, no
21985 replacement occurs; if it fails for another reason, delivery is deferred. This
21986 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21987 section &<<SECTverp>>&.
21988
21989 &*Note*&: If a delivery error is detected locally, including the case when a
21990 remote server rejects a message at SMTP time, the bounce message is not sent to
21991 the value of this option. It is sent to the previously set errors address.
21992 This defaults to the incoming sender address, but can be changed by setting
21993 &%errors_to%& in a router.
21994
21995
21996
21997 .option return_path_add transports boolean false
21998 .cindex "&'Return-path:'& header line"
21999 If this option is true, a &'Return-path:'& header is added to the message.
22000 Although the return path is normally available in the prefix line of BSD
22001 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22002 have easy access to it.
22003
22004 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22005 the delivery SMTP server makes the final delivery"&. This implies that this
22006 header should not be present in incoming messages. Exim has a configuration
22007 option, &%return_path_remove%&, which requests removal of this header from
22008 incoming messages, so that delivered messages can safely be resent to other
22009 recipients.
22010
22011
22012 .option shadow_condition transports string&!! unset
22013 See &%shadow_transport%& below.
22014
22015
22016 .option shadow_transport transports string unset
22017 .cindex "shadow transport"
22018 .cindex "transport" "shadow"
22019 A local transport may set the &%shadow_transport%& option to the name of
22020 another local transport. Shadow remote transports are not supported.
22021
22022 Whenever a delivery to the main transport succeeds, and either
22023 &%shadow_condition%& is unset, or its expansion does not result in the empty
22024 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22025 passed to the shadow transport, with the same delivery address or addresses. If
22026 expansion fails, no action is taken except that non-forced expansion failures
22027 cause a log line to be written.
22028
22029 The result of the shadow transport is discarded and does not affect the
22030 subsequent processing of the message. Only a single level of shadowing is
22031 provided; the &%shadow_transport%& option is ignored on any transport when it
22032 is running as a shadow. Options concerned with output from pipes are also
22033 ignored. The log line for the successful delivery has an item added on the end,
22034 of the form
22035 .code
22036 ST=<shadow transport name>
22037 .endd
22038 If the shadow transport did not succeed, the error message is put in
22039 parentheses afterwards. Shadow transports can be used for a number of different
22040 purposes, including keeping more detailed log information than Exim normally
22041 provides, and implementing automatic acknowledgment policies based on message
22042 headers that some sites insist on.
22043
22044
22045 .option transport_filter transports string&!! unset
22046 .cindex "transport" "filter"
22047 .cindex "filter" "transport filter"
22048 This option sets up a filtering (in the Unix shell sense) process for messages
22049 at transport time. It should not be confused with mail filtering as set up by
22050 individual users or via a system filter.
22051 If unset, or expanding to an empty string, no filtering is done.
22052
22053 When the message is about to be written out, the command specified by
22054 &%transport_filter%& is started up in a separate, parallel process, and
22055 the entire message, including the header lines, is passed to it on its standard
22056 input (this in fact is done from a third process, to avoid deadlock). The
22057 command must be specified as an absolute path.
22058
22059 The lines of the message that are written to the transport filter are
22060 terminated by newline (&"\n"&). The message is passed to the filter before any
22061 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22062 lines beginning with a dot, and also before any processing implied by the
22063 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22064 &(pipe)& transports.
22065
22066 The standard error for the filter process is set to the same destination as its
22067 standard output; this is read and written to the message's ultimate
22068 destination. The process that writes the message to the filter, the
22069 filter itself, and the original process that reads the result and delivers it
22070 are all run in parallel, like a shell pipeline.
22071
22072 The filter can perform any transformations it likes, but of course should take
22073 care not to break RFC 2822 syntax. Exim does not check the result, except to
22074 test for a final newline when SMTP is in use. All messages transmitted over
22075 SMTP must end with a newline, so Exim supplies one if it is missing.
22076
22077 .cindex "content scanning" "per user"
22078 A transport filter can be used to provide content-scanning on a per-user basis
22079 at delivery time if the only required effect of the scan is to modify the
22080 message. For example, a content scan could insert a new header line containing
22081 a spam score. This could be interpreted by a filter in the user's MUA. It is
22082 not possible to discard a message at this stage.
22083
22084 .cindex "SMTP" "SIZE"
22085 A problem might arise if the filter increases the size of a message that is
22086 being sent down an SMTP connection. If the receiving SMTP server has indicated
22087 support for the SIZE parameter, Exim will have sent the size of the message
22088 at the start of the SMTP session. If what is actually sent is substantially
22089 more, the server might reject the message. This can be worked round by setting
22090 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22091 additions to the message, or to disable the use of SIZE altogether.
22092
22093 .vindex "&$pipe_addresses$&"
22094 The value of the &%transport_filter%& option is the command string for starting
22095 the filter, which is run directly from Exim, not under a shell. The string is
22096 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22097 Exim breaks it up into arguments and then expands each argument separately (see
22098 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22099 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22100 of arguments, one for each address that applies to this delivery. (This isn't
22101 an ideal name for this feature here, but as it was already implemented for the
22102 &(pipe)& transport, it seemed sensible not to change it.)
22103
22104 .vindex "&$host$&"
22105 .vindex "&$host_address$&"
22106 The expansion variables &$host$& and &$host_address$& are available when the
22107 transport is a remote one. They contain the name and IP address of the host to
22108 which the message is being sent. For example:
22109 .code
22110 transport_filter = /some/directory/transport-filter.pl \
22111   $host $host_address $sender_address $pipe_addresses
22112 .endd
22113
22114 Two problems arise if you want to use more complicated expansion items to
22115 generate transport filter commands, both of which due to the fact that the
22116 command is split up &'before'& expansion.
22117 .ilist
22118 If an expansion item contains white space, you must quote it, so that it is all
22119 part of the same command item. If the entire option setting is one such
22120 expansion item, you have to take care what kind of quoting you use. For
22121 example:
22122 .code
22123 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22124 .endd
22125 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22126 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22127 stripped by Exim when it read the option's value. When the value is used, if
22128 the single quotes were missing, the line would be split into two items,
22129 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22130 Exim tried to expand the first one.
22131 .next
22132 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22133 expansion cannot generate multiple arguments, or a command name followed by
22134 arguments. Consider this example:
22135 .code
22136 transport_filter = ${lookup{$host}lsearch{/a/file}\
22137                     {$value}{/bin/cat}}
22138 .endd
22139 The result of the lookup is interpreted as the name of the command, even
22140 if it contains white space. The simplest way round this is to use a shell:
22141 .code
22142 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22143                                {$value}{/bin/cat}}
22144 .endd
22145 .endlist
22146
22147 The filter process is run under the same uid and gid as the normal delivery.
22148 For remote deliveries this is the Exim uid/gid by default. The command should
22149 normally yield a zero return code. Transport filters are not supposed to fail.
22150 A non-zero code is taken to mean that the transport filter encountered some
22151 serious problem. Delivery of the message is deferred; the message remains on
22152 the queue and is tried again later. It is not possible to cause a message to be
22153 bounced from a transport filter.
22154
22155 If a transport filter is set on an autoreply transport, the original message is
22156 passed through the filter as it is being copied into the newly generated
22157 message, which happens if the &%return_message%& option is set.
22158
22159
22160 .option transport_filter_timeout transports time 5m
22161 .cindex "transport" "filter, timeout"
22162 When Exim is reading the output of a transport filter, it applies a timeout
22163 that can be set by this option. Exceeding the timeout is normally treated as a
22164 temporary delivery failure. However, if a transport filter is used with a
22165 &(pipe)& transport, a timeout in the transport filter is treated in the same
22166 way as a timeout in the pipe command itself. By default, a timeout is a hard
22167 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22168 becomes a temporary error.
22169
22170
22171 .option user transports string&!! "Exim user"
22172 .cindex "uid (user id)" "local delivery"
22173 .cindex "transport" "user, specifying"
22174 This option specifies the user under whose uid the delivery process is to be
22175 run, overriding any uid that may have been set by the router. If the user is
22176 given as a name, the uid is looked up from the password data, and the
22177 associated group is taken as the value of the gid to be used if the &%group%&
22178 option is not set.
22179
22180 For deliveries that use local transports, a user and group are normally
22181 specified explicitly or implicitly (for example, as a result of
22182 &%check_local_user%&) by the router or transport.
22183
22184 .cindex "hints database" "access by remote transport"
22185 For remote transports, you should leave this option unset unless you really are
22186 sure you know what you are doing. When a remote transport is running, it needs
22187 to be able to access Exim's hints databases, because each host may have its own
22188 retry data.
22189 .ecindex IIDgenoptra1
22190 .ecindex IIDgenoptra2
22191 .ecindex IIDgenoptra3
22192
22193
22194
22195
22196
22197
22198 . ////////////////////////////////////////////////////////////////////////////
22199 . ////////////////////////////////////////////////////////////////////////////
22200
22201 .chapter "Address batching in local transports" "CHAPbatching" &&&
22202          "Address batching"
22203 .cindex "transport" "local; address batching in"
22204 The only remote transport (&(smtp)&) is normally configured to handle more than
22205 one address at a time, so that when several addresses are routed to the same
22206 remote host, just one copy of the message is sent. Local transports, however,
22207 normally handle one address at a time. That is, a separate instance of the
22208 transport is run for each address that is routed to the transport. A separate
22209 copy of the message is delivered each time.
22210
22211 .cindex "batched local delivery"
22212 .oindex "&%batch_max%&"
22213 .oindex "&%batch_id%&"
22214 In special cases, it may be desirable to handle several addresses at once in a
22215 local transport, for example:
22216
22217 .ilist
22218 In an &(appendfile)& transport, when storing messages in files for later
22219 delivery by some other means, a single copy of the message with multiple
22220 recipients saves space.
22221 .next
22222 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22223 a single copy saves time, and is the normal way LMTP is expected to work.
22224 .next
22225 In a &(pipe)& transport, when passing the message
22226 to a scanner program or
22227 to some other delivery mechanism such as UUCP, multiple recipients may be
22228 acceptable.
22229 .endlist
22230
22231 These three local transports all have the same options for controlling multiple
22232 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22233 repeating the information for each transport, these options are described here.
22234
22235 The &%batch_max%& option specifies the maximum number of addresses that can be
22236 delivered together in a single run of the transport. Its default value is one
22237 (no batching). When more than one address is routed to a transport that has a
22238 &%batch_max%& value greater than one, the addresses are delivered in a batch
22239 (that is, in a single run of the transport with multiple recipients), subject
22240 to certain conditions:
22241
22242 .ilist
22243 .vindex "&$local_part$&"
22244 If any of the transport's options contain a reference to &$local_part$&, no
22245 batching is possible.
22246 .next
22247 .vindex "&$domain$&"
22248 If any of the transport's options contain a reference to &$domain$&, only
22249 addresses with the same domain are batched.
22250 .next
22251 .cindex "customizing" "batching condition"
22252 If &%batch_id%& is set, it is expanded for each address, and only those
22253 addresses with the same expanded value are batched. This allows you to specify
22254 customized batching conditions. Failure of the expansion for any reason,
22255 including forced failure, disables batching, but it does not stop the delivery
22256 from taking place.
22257 .next
22258 Batched addresses must also have the same errors address (where to send
22259 delivery errors), the same header additions and removals, the same user and
22260 group for the transport, and if a host list is present, the first host must
22261 be the same.
22262 .endlist
22263
22264 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22265 both when the file or pipe command is specified in the transport, and when it
22266 is specified by a &(redirect)& router, but all the batched addresses must of
22267 course be routed to the same file or pipe command. These two transports have an
22268 option called &%use_bsmtp%&, which causes them to deliver the message in
22269 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22270 &%check_string%& and &%escape_string%& options are forced to the values
22271 .code
22272 check_string = "."
22273 escape_string = ".."
22274 .endd
22275 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22276 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22277 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22278
22279 .cindex "&'Envelope-to:'& header line"
22280 If the generic &%envelope_to_add%& option is set for a batching transport, the
22281 &'Envelope-to:'& header that is added to the message contains all the addresses
22282 that are being processed together. If you are using a batching &(appendfile)&
22283 transport without &%use_bsmtp%&, the only way to preserve the recipient
22284 addresses is to set the &%envelope_to_add%& option.
22285
22286 .cindex "&(pipe)& transport" "with multiple addresses"
22287 .vindex "&$pipe_addresses$&"
22288 If you are using a &(pipe)& transport without BSMTP, and setting the
22289 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22290 the command. This is not a true variable; it is a bit of magic that causes each
22291 of the recipient addresses to be inserted into the command as a separate
22292 argument. This provides a way of accessing all the addresses that are being
22293 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22294 are specified by a &(redirect)& router.
22295
22296
22297
22298
22299 . ////////////////////////////////////////////////////////////////////////////
22300 . ////////////////////////////////////////////////////////////////////////////
22301
22302 .chapter "The appendfile transport" "CHAPappendfile"
22303 .scindex IIDapptra1 "&(appendfile)& transport"
22304 .scindex IIDapptra2 "transports" "&(appendfile)&"
22305 .cindex "directory creation"
22306 .cindex "creating directories"
22307 The &(appendfile)& transport delivers a message by appending it to an existing
22308 file, or by creating an entirely new file in a specified directory. Single
22309 files to which messages are appended can be in the traditional Unix mailbox
22310 format, or optionally in the MBX format supported by the Pine MUA and
22311 University of Washington IMAP daemon, &'inter alia'&. When each message is
22312 being delivered as a separate file, &"maildir"& format can optionally be used
22313 to give added protection against failures that happen part-way through the
22314 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22315 supported. For all file formats, Exim attempts to create as many levels of
22316 directory as necessary, provided that &%create_directory%& is set.
22317
22318 The code for the optional formats is not included in the Exim binary by
22319 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22320 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22321 included.
22322
22323 .cindex "quota" "system"
22324 Exim recognizes system quota errors, and generates an appropriate message. Exim
22325 also supports its own quota control within the transport, for use when the
22326 system facility is unavailable or cannot be used for some reason.
22327
22328 If there is an error while appending to a file (for example, quota exceeded or
22329 partition filled), Exim attempts to reset the file's length and last
22330 modification time back to what they were before. If there is an error while
22331 creating an entirely new file, the new file is removed.
22332
22333 Before appending to a file, a number of security checks are made, and the
22334 file is locked. A detailed description is given below, after the list of
22335 private options.
22336
22337 The &(appendfile)& transport is most commonly used for local deliveries to
22338 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22339 putting messages into files for remote delivery by some means other than Exim.
22340 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22341 option).
22342
22343
22344
22345 .section "The file and directory options" "SECTfildiropt"
22346 The &%file%& option specifies a single file, to which the message is appended;
22347 the &%directory%& option specifies a directory, in which a new file containing
22348 the message is created. Only one of these two options can be set, and for
22349 normal deliveries to mailboxes, one of them &'must'& be set.
22350
22351 .vindex "&$address_file$&"
22352 .vindex "&$local_part$&"
22353 However, &(appendfile)& is also used for delivering messages to files or
22354 directories whose names (or parts of names) are obtained from alias,
22355 forwarding, or filtering operations (for example, a &%save%& command in a
22356 user's Exim filter). When such a transport is running, &$local_part$& contains
22357 the local part that was aliased or forwarded, and &$address_file$& contains the
22358 name (or partial name) of the file or directory generated by the redirection
22359 operation. There are two cases:
22360
22361 .ilist
22362 If neither &%file%& nor &%directory%& is set, the redirection operation
22363 must specify an absolute path (one that begins with &`/`&). This is the most
22364 common case when users with local accounts use filtering to sort mail into
22365 different folders. See for example, the &(address_file)& transport in the
22366 default configuration. If the path ends with a slash, it is assumed to be the
22367 name of a directory. A delivery to a directory can also be forced by setting
22368 &%maildir_format%& or &%mailstore_format%&.
22369 .next
22370 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22371 used to determine the file or directory name for the delivery. Normally, the
22372 contents of &$address_file$& are used in some way in the string expansion.
22373 .endlist
22374 .new
22375 .cindex "tainted data" "in filenames"
22376 .cindex appendfile "tainted data"
22377 Tainted data may not be used for a file or directory name.
22378 This means that, for instance, &$local_part$& cannot be used directly
22379 as a component of a path.  It can however be used as the key for a lookup
22380 which returns a path (or component).
22381 .wen
22382
22383
22384 .cindex "Sieve filter" "configuring &(appendfile)&"
22385 .cindex "Sieve filter" "relative mailbox path handling"
22386 As an example of the second case, consider an environment where users do not
22387 have home directories. They may be permitted to use Exim filter commands of the
22388 form:
22389 .code
22390 save folder23
22391 .endd
22392 or Sieve filter commands of the form:
22393 .code
22394 require "fileinto";
22395 fileinto "folder23";
22396 .endd
22397 In this situation, the expansion of &%file%& or &%directory%& in the transport
22398 must transform the relative path into an appropriate absolute filename. In the
22399 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22400 is used as a result of a &"keep"& action in the filter. This example shows one
22401 way of handling this requirement:
22402 .code
22403 file = ${if eq{$address_file}{inbox} \
22404             {/var/mail/$local_part} \
22405             {${if eq{${substr_0_1:$address_file}}{/} \
22406                   {$address_file} \
22407                   {$home/mail/$address_file} \
22408             }} \
22409        }
22410 .endd
22411 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22412 location, absolute paths are used without change, and other folders are in the
22413 &_mail_& directory within the home directory.
22414
22415 &*Note 1*&: While processing an Exim filter, a relative path such as
22416 &_folder23_& is turned into an absolute path if a home directory is known to
22417 the router. In particular, this is the case if &%check_local_user%& is set. If
22418 you want to prevent this happening at routing time, you can set
22419 &%router_home_directory%& empty. This forces the router to pass the relative
22420 path to the transport.
22421
22422 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22423 the &%file%& or &%directory%& option is still used if it is set.
22424
22425
22426
22427
22428 .section "Private options for appendfile" "SECID134"
22429 .cindex "options" "&(appendfile)& transport"
22430
22431
22432
22433 .option allow_fifo appendfile boolean false
22434 .cindex "fifo (named pipe)"
22435 .cindex "named pipe (fifo)"
22436 .cindex "pipe" "named (fifo)"
22437 Setting this option permits delivery to named pipes (FIFOs) as well as to
22438 regular files. If no process is reading the named pipe at delivery time, the
22439 delivery is deferred.
22440
22441
22442 .option allow_symlink appendfile boolean false
22443 .cindex "symbolic link" "to mailbox"
22444 .cindex "mailbox" "symbolic link"
22445 By default, &(appendfile)& will not deliver if the path name for the file is
22446 that of a symbolic link. Setting this option relaxes that constraint, but there
22447 are security issues involved in the use of symbolic links. Be sure you know
22448 what you are doing if you set this. Details of exactly what this option affects
22449 are included in the discussion which follows this list of options.
22450
22451
22452 .option batch_id appendfile string&!! unset
22453 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22454 However, batching is automatically disabled for &(appendfile)& deliveries that
22455 happen as a result of forwarding or aliasing or other redirection directly to a
22456 file.
22457
22458
22459 .option batch_max appendfile integer 1
22460 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22461
22462
22463 .option check_group appendfile boolean false
22464 When this option is set, the group owner of the file defined by the &%file%&
22465 option is checked to see that it is the same as the group under which the
22466 delivery process is running. The default setting is false because the default
22467 file mode is 0600, which means that the group is irrelevant.
22468
22469
22470 .option check_owner appendfile boolean true
22471 When this option is set, the owner of the file defined by the &%file%& option
22472 is checked to ensure that it is the same as the user under which the delivery
22473 process is running.
22474
22475
22476 .option check_string appendfile string "see below"
22477 .cindex "&""From""& line"
22478 As &(appendfile)& writes the message, the start of each line is tested for
22479 matching &%check_string%&, and if it does, the initial matching characters are
22480 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22481 a literal string, not a regular expression, and the case of any letters it
22482 contains is significant.
22483
22484 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22485 are forced to &"."& and &".."& respectively, and any settings in the
22486 configuration are ignored. Otherwise, they default to &"From&~"& and
22487 &">From&~"& when the &%file%& option is set, and unset when any of the
22488 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22489
22490 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22491 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22492 &"From&~"& indicates the start of a new message. All four options need changing
22493 if another format is used. For example, to deliver to mailboxes in MMDF format:
22494 .cindex "MMDF format mailbox"
22495 .cindex "mailbox" "MMDF format"
22496 .code
22497 check_string = "\1\1\1\1\n"
22498 escape_string = "\1\1\1\1 \n"
22499 message_prefix = "\1\1\1\1\n"
22500 message_suffix = "\1\1\1\1\n"
22501 .endd
22502 .option create_directory appendfile boolean true
22503 .cindex "directory creation"
22504 When this option is true, Exim attempts to create any missing superior
22505 directories for the file that it is about to write. A created directory's mode
22506 is given by the &%directory_mode%& option.
22507
22508 The group ownership of a newly created directory is highly dependent on the
22509 operating system (and possibly the file system) that is being used. For
22510 example, in Solaris, if the parent directory has the setgid bit set, its group
22511 is propagated to the child; if not, the currently set group is used. However,
22512 in FreeBSD, the parent's group is always used.
22513
22514
22515
22516 .option create_file appendfile string anywhere
22517 This option constrains the location of files and directories that are created
22518 by this transport. It applies to files defined by the &%file%& option and
22519 directories defined by the &%directory%& option. In the case of maildir
22520 delivery, it applies to the top level directory, not the maildir directories
22521 beneath.
22522
22523 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22524 &"belowhome"&. In the second and third cases, a home directory must have been
22525 set for the transport. This option is not useful when an explicit filename is
22526 given for normal mailbox deliveries. It is intended for the case when filenames
22527 are generated from users' &_.forward_& files. These are usually handled
22528 by an &(appendfile)& transport called &%address_file%&. See also
22529 &%file_must_exist%&.
22530
22531
22532 .option directory appendfile string&!! unset
22533 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22534 or &%directory%& must be set, unless the delivery is the direct result of a
22535 redirection (see section &<<SECTfildiropt>>&).
22536
22537 When &%directory%& is set, the string is expanded, and the message is delivered
22538 into a new file or files in or below the given directory, instead of being
22539 appended to a single mailbox file. A number of different formats are provided
22540 (see &%maildir_format%& and &%mailstore_format%&), and see section
22541 &<<SECTopdir>>& for further details of this form of delivery.
22542
22543
22544 .option directory_file appendfile string&!! "see below"
22545 .cindex "base62"
22546 .vindex "&$inode$&"
22547 When &%directory%& is set, but neither &%maildir_format%& nor
22548 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22549 whose name is obtained by expanding this string. The default value is:
22550 .code
22551 q${base62:$tod_epoch}-$inode
22552 .endd
22553 This generates a unique name from the current time, in base 62 form, and the
22554 inode of the file. The variable &$inode$& is available only when expanding this
22555 option.
22556
22557
22558 .option directory_mode appendfile "octal integer" 0700
22559 If &(appendfile)& creates any directories as a result of the
22560 &%create_directory%& option, their mode is specified by this option.
22561
22562
22563 .option escape_string appendfile string "see description"
22564 See &%check_string%& above.
22565
22566
22567 .option file appendfile string&!! unset
22568 This option is mutually exclusive with the &%directory%& option, but one of
22569 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22570 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22571 specifies a single file, to which the message is appended. One or more of
22572 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22573 &%file%&.
22574
22575 .cindex "NFS" "lock file"
22576 .cindex "locking files"
22577 .cindex "lock files"
22578 If you are using more than one host to deliver over NFS into the same
22579 mailboxes, you should always use lock files.
22580
22581 The string value is expanded for each delivery, and must yield an absolute
22582 path. The most common settings of this option are variations on one of these
22583 examples:
22584 .code
22585 file = /var/spool/mail/$local_part
22586 file = /home/$local_part/inbox
22587 file = $home/inbox
22588 .endd
22589 .cindex "&""sticky""& bit"
22590 In the first example, all deliveries are done into the same directory. If Exim
22591 is configured to use lock files (see &%use_lockfile%& below) it must be able to
22592 create a file in the directory, so the &"sticky"& bit must be turned on for
22593 deliveries to be possible, or alternatively the &%group%& option can be used to
22594 run the delivery under a group id which has write access to the directory.
22595
22596
22597
22598 .option file_format appendfile string unset
22599 .cindex "file" "mailbox; checking existing format"
22600 This option requests the transport to check the format of an existing file
22601 before adding to it. The check consists of matching a specific string at the
22602 start of the file. The value of the option consists of an even number of
22603 colon-separated strings. The first of each pair is the test string, and the
22604 second is the name of a transport. If the transport associated with a matched
22605 string is not the current transport, control is passed over to the other
22606 transport. For example, suppose the standard &(local_delivery)& transport has
22607 this added to it:
22608 .code
22609 file_format = "From       : local_delivery :\
22610                \1\1\1\1\n : local_mmdf_delivery"
22611 .endd
22612 Mailboxes that begin with &"From"& are still handled by this transport, but if
22613 a mailbox begins with four binary ones followed by a newline, control is passed
22614 to a transport called &%local_mmdf_delivery%&, which presumably is configured
22615 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
22616 is assumed to match the current transport. If the start of a mailbox doesn't
22617 match any string, or if the transport named for a given string is not defined,
22618 delivery is deferred.
22619
22620
22621 .option file_must_exist appendfile boolean false
22622 If this option is true, the file specified by the &%file%& option must exist.
22623 A temporary error occurs if it does not, causing delivery to be deferred.
22624 If this option is false, the file is created if it does not exist.
22625
22626
22627 .option lock_fcntl_timeout appendfile time 0s
22628 .cindex "timeout" "mailbox locking"
22629 .cindex "mailbox" "locking, blocking and non-blocking"
22630 .cindex "locking files"
22631 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
22632 when locking an open mailbox file. If the call fails, the delivery process
22633 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
22634 Non-blocking calls are used so that the file is not kept open during the wait
22635 for the lock; the reason for this is to make it as safe as possible for
22636 deliveries over NFS in the case when processes might be accessing an NFS
22637 mailbox without using a lock file. This should not be done, but
22638 misunderstandings and hence misconfigurations are not unknown.
22639
22640 On a busy system, however, the performance of a non-blocking lock approach is
22641 not as good as using a blocking lock with a timeout. In this case, the waiting
22642 is done inside the system call, and Exim's delivery process acquires the lock
22643 and can proceed as soon as the previous lock holder releases it.
22644
22645 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
22646 timeout, are used. There may still be some retrying: the maximum number of
22647 retries is
22648 .code
22649 (lock_retries * lock_interval) / lock_fcntl_timeout
22650 .endd
22651 rounded up to the next whole number. In other words, the total time during
22652 which &(appendfile)& is trying to get a lock is roughly the same, unless
22653 &%lock_fcntl_timeout%& is set very large.
22654
22655 You should consider setting this option if you are getting a lot of delayed
22656 local deliveries because of errors of the form
22657 .code
22658 failed to lock mailbox /some/file (fcntl)
22659 .endd
22660
22661 .option lock_flock_timeout appendfile time 0s
22662 This timeout applies to file locking when using &[flock()]& (see
22663 &%use_flock%&); the timeout operates in a similar manner to
22664 &%lock_fcntl_timeout%&.
22665
22666
22667 .option lock_interval appendfile time 3s
22668 This specifies the time to wait between attempts to lock the file. See below
22669 for details of locking.
22670
22671
22672 .option lock_retries appendfile integer 10
22673 This specifies the maximum number of attempts to lock the file. A value of zero
22674 is treated as 1. See below for details of locking.
22675
22676
22677 .option lockfile_mode appendfile "octal integer" 0600
22678 This specifies the mode of the created lock file, when a lock file is being
22679 used (see &%use_lockfile%& and &%use_mbx_lock%&).
22680
22681
22682 .option lockfile_timeout appendfile time 30m
22683 .cindex "timeout" "mailbox locking"
22684 When a lock file is being used (see &%use_lockfile%&), if a lock file already
22685 exists and is older than this value, it is assumed to have been left behind by
22686 accident, and Exim attempts to remove it.
22687
22688
22689 .option mailbox_filecount appendfile string&!! unset
22690 .cindex "mailbox" "specifying size of"
22691 .cindex "size" "of mailbox"
22692 If this option is set, it is expanded, and the result is taken as the current
22693 number of files in the mailbox. It must be a decimal number, optionally
22694 followed by K or M. This provides a way of obtaining this information from an
22695 external source that maintains the data.
22696
22697
22698 .option mailbox_size appendfile string&!! unset
22699 .cindex "mailbox" "specifying size of"
22700 .cindex "size" "of mailbox"
22701 If this option is set, it is expanded, and the result is taken as the current
22702 size the mailbox. It must be a decimal number, optionally followed by K or M.
22703 This provides a way of obtaining this information from an external source that
22704 maintains the data. This is likely to be helpful for maildir deliveries where
22705 it is computationally expensive to compute the size of a mailbox.
22706
22707
22708
22709 .option maildir_format appendfile boolean false
22710 .cindex "maildir format" "specifying"
22711 If this option is set with the &%directory%& option, the delivery is into a new
22712 file, in the &"maildir"& format that is used by other mail software. When the
22713 transport is activated directly from a &(redirect)& router (for example, the
22714 &(address_file)& transport in the default configuration), setting
22715 &%maildir_format%& causes the path received from the router to be treated as a
22716 directory, whether or not it ends with &`/`&. This option is available only if
22717 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
22718 &<<SECTmaildirdelivery>>& below for further details.
22719
22720
22721 .option maildir_quota_directory_regex appendfile string "See below"
22722 .cindex "maildir format" "quota; directories included in"
22723 .cindex "quota" "maildir; directories included in"
22724 This option is relevant only when &%maildir_use_size_file%& is set. It defines
22725 a regular expression for specifying directories, relative to the quota
22726 directory (see &%quota_directory%&), that should be included in the quota
22727 calculation. The default value is:
22728 .code
22729 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
22730 .endd
22731 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
22732 (directories whose names begin with a dot). If you want to exclude the
22733 &_Trash_&
22734 folder from the count (as some sites do), you need to change this setting to
22735 .code
22736 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
22737 .endd
22738 This uses a negative lookahead in the regular expression to exclude the
22739 directory whose name is &_.Trash_&. When a directory is excluded from quota
22740 calculations, quota processing is bypassed for any messages that are delivered
22741 directly into that directory.
22742
22743
22744 .option maildir_retries appendfile integer 10
22745 This option specifies the number of times to retry when writing a file in
22746 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
22747
22748
22749 .option maildir_tag appendfile string&!! unset
22750 This option applies only to deliveries in maildir format, and is described in
22751 section &<<SECTmaildirdelivery>>& below.
22752
22753
22754 .option maildir_use_size_file appendfile&!! boolean false
22755 .cindex "maildir format" "&_maildirsize_& file"
22756 The result of string expansion for this option must be a valid boolean value.
22757 If it is true, it enables support for &_maildirsize_& files. Exim
22758 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
22759 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
22760 value is zero. See &%maildir_quota_directory_regex%& above and section
22761 &<<SECTmaildirdelivery>>& below for further details.
22762
22763 .option maildirfolder_create_regex appendfile string unset
22764 .cindex "maildir format" "&_maildirfolder_& file"
22765 .cindex "&_maildirfolder_&, creating"
22766 The value of this option is a regular expression. If it is unset, it has no
22767 effect. Otherwise, before a maildir delivery takes place, the pattern is
22768 matched against the name of the maildir directory, that is, the directory
22769 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22770 delivery. If there is a match, Exim checks for the existence of a file called
22771 &_maildirfolder_& in the directory, and creates it if it does not exist.
22772 See section &<<SECTmaildirdelivery>>& for more details.
22773
22774
22775 .option mailstore_format appendfile boolean false
22776 .cindex "mailstore format" "specifying"
22777 If this option is set with the &%directory%& option, the delivery is into two
22778 new files in  &"mailstore"& format. The option is available only if
22779 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
22780 below for further details.
22781
22782
22783 .option mailstore_prefix appendfile string&!! unset
22784 This option applies only to deliveries in mailstore format, and is described in
22785 section &<<SECTopdir>>& below.
22786
22787
22788 .option mailstore_suffix appendfile string&!! unset
22789 This option applies only to deliveries in mailstore format, and is described in
22790 section &<<SECTopdir>>& below.
22791
22792
22793 .option mbx_format appendfile boolean false
22794 .cindex "locking files"
22795 .cindex "file" "locking"
22796 .cindex "file" "MBX format"
22797 .cindex "MBX format, specifying"
22798 This option is available only if Exim has been compiled with SUPPORT_MBX
22799 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
22800 the message is appended to the mailbox file in MBX format instead of
22801 traditional Unix format. This format is supported by Pine4 and its associated
22802 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
22803
22804 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
22805 automatically changed by the use of &%mbx_format%&. They should normally be set
22806 empty when using MBX format, so this option almost always appears in this
22807 combination:
22808 .code
22809 mbx_format = true
22810 message_prefix =
22811 message_suffix =
22812 .endd
22813 If none of the locking options are mentioned in the configuration,
22814 &%use_mbx_lock%& is assumed and the other locking options default to false. It
22815 is possible to specify the other kinds of locking with &%mbx_format%&, but
22816 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
22817 interworks with &'c-client'&, providing for shared access to the mailbox. It
22818 should not be used if any program that does not use this form of locking is
22819 going to access the mailbox, nor should it be used if the mailbox file is NFS
22820 mounted, because it works only when the mailbox is accessed from a single host.
22821
22822 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22823 the standard version of &'c-client'&, because as long as it has a mailbox open
22824 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22825 append messages to it.
22826
22827
22828 .option message_prefix appendfile string&!! "see below"
22829 .cindex "&""From""& line"
22830 The string specified here is expanded and output at the start of every message.
22831 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22832 in which case it is:
22833 .code
22834 message_prefix = "From ${if def:return_path{$return_path}\
22835   {MAILER-DAEMON}} $tod_bsdinbox\n"
22836 .endd
22837 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22838 &`\n`& to &`\r\n`& in &%message_prefix%&.
22839
22840 .option message_suffix appendfile string&!! "see below"
22841 The string specified here is expanded and output at the end of every message.
22842 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22843 in which case it is a single newline character. The suffix can be suppressed by
22844 setting
22845 .code
22846 message_suffix =
22847 .endd
22848 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22849 &`\n`& to &`\r\n`& in &%message_suffix%&.
22850
22851 .option mode appendfile "octal integer" 0600
22852 If the output file is created, it is given this mode. If it already exists and
22853 has wider permissions, they are reduced to this mode. If it has narrower
22854 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22855 if the delivery is the result of a &%save%& command in a filter file specifying
22856 a particular mode, the mode of the output file is always forced to take that
22857 value, and this option is ignored.
22858
22859
22860 .option mode_fail_narrower appendfile boolean true
22861 This option applies in the case when an existing mailbox file has a narrower
22862 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22863 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22864 continues with the delivery attempt, using the existing mode of the file.
22865
22866
22867 .option notify_comsat appendfile boolean false
22868 If this option is true, the &'comsat'& daemon is notified after every
22869 successful delivery to a user mailbox. This is the daemon that notifies logged
22870 on users about incoming mail.
22871
22872
22873 .option quota appendfile string&!! unset
22874 .cindex "quota" "imposed by Exim"
22875 This option imposes a limit on the size of the file to which Exim is appending,
22876 or to the total space used in the directory tree when the &%directory%& option
22877 is set. In the latter case, computation of the space used is expensive, because
22878 all the files in the directory (and any sub-directories) have to be
22879 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22880 &%maildir_use_size_file%& for ways to avoid this in environments where users
22881 have no shell access to their mailboxes).
22882
22883 As there is no interlock against two simultaneous deliveries into a
22884 multi-file mailbox, it is possible for the quota to be overrun in this case.
22885 For single-file mailboxes, of course, an interlock is a necessity.
22886
22887 A file's size is taken as its &'used'& value. Because of blocking effects, this
22888 may be a lot less than the actual amount of disk space allocated to the file.
22889 If the sizes of a number of files are being added up, the rounding effect can
22890 become quite noticeable, especially on systems that have large block sizes.
22891 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22892 the obvious value which users understand most easily.
22893
22894 The value of the option is expanded, and must then be a numerical value
22895 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22896 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
22897 and further option modifiers. If Exim is running on a system with
22898 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22899 be handled.
22900
22901 The option modifier &%no_check%& can be used to force delivery even if the over
22902 quota condition is met. The quota gets updated as usual.
22903
22904 &*Note*&: A value of zero is interpreted as &"no quota"&.
22905
22906 The expansion happens while Exim is running as root, before it changes uid for
22907 the delivery. This means that files that are inaccessible to the end user can
22908 be used to hold quota values that are looked up in the expansion. When delivery
22909 fails because this quota is exceeded, the handling of the error is as for
22910 system quota failures.
22911
22912 By default, Exim's quota checking mimics system quotas, and restricts the
22913 mailbox to the specified maximum size, though the value is not accurate to the
22914 last byte, owing to separator lines and additional headers that may get added
22915 during message delivery. When a mailbox is nearly full, large messages may get
22916 refused even though small ones are accepted, because the size of the current
22917 message is added to the quota when the check is made. This behaviour can be
22918 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22919 for exceeding the quota does not include the current message. Thus, deliveries
22920 continue until the quota has been exceeded; thereafter, no further messages are
22921 delivered. See also &%quota_warn_threshold%&.
22922
22923
22924 .option quota_directory appendfile string&!! unset
22925 This option defines the directory to check for quota purposes when delivering
22926 into individual files. The default is the delivery directory, or, if a file
22927 called &_maildirfolder_& exists in a maildir directory, the parent of the
22928 delivery directory.
22929
22930
22931 .option quota_filecount appendfile string&!! 0
22932 This option applies when the &%directory%& option is set. It limits the total
22933 number of files in the directory (compare the inode limit in system quotas). It
22934 can only be used if &%quota%& is also set. The value is expanded; an expansion
22935 failure causes delivery to be deferred. A value of zero is interpreted as
22936 &"no quota"&.
22937
22938 The option modifier &%no_check%& can be used to force delivery even if the over
22939 quota condition is met. The quota gets updated as usual.
22940
22941 .option quota_is_inclusive appendfile boolean true
22942 See &%quota%& above.
22943
22944
22945 .option quota_size_regex appendfile string unset
22946 This option applies when one of the delivery modes that writes a separate file
22947 for each message is being used. When Exim wants to find the size of one of
22948 these files in order to test the quota, it first checks &%quota_size_regex%&.
22949 If this is set to a regular expression that matches the filename, and it
22950 captures one string, that string is interpreted as a representation of the
22951 file's size. The value of &%quota_size_regex%& is not expanded.
22952
22953 This feature is useful only when users have no shell access to their mailboxes
22954 &-- otherwise they could defeat the quota simply by renaming the files. This
22955 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22956 the file length to the filename. For example:
22957 .code
22958 maildir_tag = ,S=$message_size
22959 quota_size_regex = ,S=(\d+)
22960 .endd
22961 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22962 number of lines in the message.
22963
22964 The regular expression should not assume that the length is at the end of the
22965 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
22966 sometimes add other information onto the ends of message filenames.
22967
22968 Section &<<SECID136>>& contains further information.
22969
22970 This option should not be used when other message-handling software
22971 may duplicate messages by making hardlinks to the files.  When that is done Exim
22972 will count the message size once for each filename, in contrast with the actual
22973 disk usage.  When the option is not set, calculating total usage requires
22974 a system-call per file to get the size; the number of links is then available also
22975 as is used to adjust the effective size.
22976
22977
22978 .option quota_warn_message appendfile string&!! "see below"
22979 See below for the use of this option. If it is not set when
22980 &%quota_warn_threshold%& is set, it defaults to
22981 .code
22982 quota_warn_message = "\
22983   To: $local_part@$domain\n\
22984   Subject: Your mailbox\n\n\
22985   This message is automatically created \
22986   by mail delivery software.\n\n\
22987   The size of your mailbox has exceeded \
22988   a warning threshold that is\n\
22989   set by the system administrator.\n"
22990 .endd
22991
22992
22993 .option quota_warn_threshold appendfile string&!! 0
22994 .cindex "quota" "warning threshold"
22995 .cindex "mailbox" "size warning"
22996 .cindex "size" "of mailbox"
22997 This option is expanded in the same way as &%quota%& (see above). If the
22998 resulting value is greater than zero, and delivery of the message causes the
22999 size of the file or total space in the directory tree to cross the given
23000 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23001 may be specified as a percentage of it by following the value with a percent
23002 sign. For example:
23003 .code
23004 quota = 10M
23005 quota_warn_threshold = 75%
23006 .endd
23007 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23008 percent sign is ignored.
23009
23010 The warning message itself is specified by the &%quota_warn_message%& option,
23011 and it must start with a &'To:'& header line containing the recipient(s) of the
23012 warning message. These do not necessarily have to include the recipient(s) of
23013 the original message. A &'Subject:'& line should also normally be supplied. You
23014 can include any other header lines that you want. If you do not include a
23015 &'From:'& line, the default is:
23016 .code
23017 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23018 .endd
23019 .oindex &%errors_reply_to%&
23020 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23021 option.
23022
23023 The &%quota%& option does not have to be set in order to use this option; they
23024 are independent of one another except when the threshold is specified as a
23025 percentage.
23026
23027
23028 .option use_bsmtp appendfile boolean false
23029 .cindex "envelope from"
23030 .cindex "envelope sender"
23031 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23032 format, with the envelope sender and recipient(s) included as SMTP commands. If
23033 you want to include a leading HELO command with such messages, you can do
23034 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23035 for details of batch SMTP.
23036
23037
23038 .option use_crlf appendfile boolean false
23039 .cindex "carriage return"
23040 .cindex "linefeed"
23041 This option causes lines to be terminated with the two-character CRLF sequence
23042 (carriage return, linefeed) instead of just a linefeed character. In the case
23043 of batched SMTP, the byte sequence written to the file is then an exact image
23044 of what would be sent down a real SMTP connection.
23045
23046 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23047 (which are used to supply the traditional &"From&~"& and blank line separators
23048 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23049 carriage return characters if these are needed. In cases where these options
23050 have non-empty defaults, the values end with a single linefeed, so they must be
23051 changed to end with &`\r\n`& if &%use_crlf%& is set.
23052
23053
23054 .option use_fcntl_lock appendfile boolean "see below"
23055 This option controls the use of the &[fcntl()]& function to lock a file for
23056 exclusive use when a message is being appended. It is set by default unless
23057 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23058 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23059 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23060
23061
23062 .option use_flock_lock appendfile boolean false
23063 This option is provided to support the use of &[flock()]& for file locking, for
23064 the few situations where it is needed. Most modern operating systems support
23065 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23066 each other. Exim uses &[fcntl()]& locking by default.
23067
23068 This option is required only if you are using an operating system where
23069 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23070 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23071 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23072
23073 .cindex "Solaris" "&[flock()]& support"
23074 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23075 have it (and some, I think, provide a not quite right version built on top of
23076 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23077 the ability to use it, and any attempt to do so will cause a configuration
23078 error.
23079
23080 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23081 is just being mapped onto &[fcntl()]& by the OS).
23082
23083
23084 .option use_lockfile appendfile boolean "see below"
23085 If this option is turned off, Exim does not attempt to create a lock file when
23086 appending to a mailbox file. In this situation, the only locking is by
23087 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23088 sure that every MUA that is ever going to look at your users' mailboxes uses
23089 &[fcntl()]& rather than a lock file, and even then only when you are not
23090 delivering over NFS from more than one host.
23091
23092 .cindex "NFS" "lock file"
23093 In order to append to an NFS file safely from more than one host, it is
23094 necessary to take out a lock &'before'& opening the file, and the lock file
23095 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23096 file corruption.
23097
23098 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23099 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23100 except when &%mbx_format%& is set.
23101
23102
23103 .option use_mbx_lock appendfile boolean "see below"
23104 This option is available only if Exim has been compiled with SUPPORT_MBX
23105 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23106 locking rules be used. It is set by default if &%mbx_format%& is set and none
23107 of the locking options are mentioned in the configuration. The locking rules
23108 are the same as are used by the &'c-client'& library that underlies Pine and
23109 the IMAP4 and POP daemons that come with it (see the discussion below). The
23110 rules allow for shared access to the mailbox. However, this kind of locking
23111 does not work when the mailbox is NFS mounted.
23112
23113 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23114 &%use_flock_lock%& to control what kind of locking is used in implementing the
23115 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23116 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23117
23118
23119
23120
23121 .section "Operational details for appending" "SECTopappend"
23122 .cindex "appending to a file"
23123 .cindex "file" "appending"
23124 Before appending to a file, the following preparations are made:
23125
23126 .ilist
23127 If the name of the file is &_/dev/null_&, no action is taken, and a success
23128 return is given.
23129
23130 .next
23131 .cindex "directory creation"
23132 If any directories on the file's path are missing, Exim creates them if the
23133 &%create_directory%& option is set. A created directory's mode is given by the
23134 &%directory_mode%& option.
23135
23136 .next
23137 If &%file_format%& is set, the format of an existing file is checked. If this
23138 indicates that a different transport should be used, control is passed to that
23139 transport.
23140
23141 .next
23142 .cindex "file" "locking"
23143 .cindex "locking files"
23144 .cindex "NFS" "lock file"
23145 If &%use_lockfile%& is set, a lock file is built in a way that will work
23146 reliably over NFS, as follows:
23147
23148 .olist
23149 Create a &"hitching post"& file whose name is that of the lock file with the
23150 current time, primary host name, and process id added, by opening for writing
23151 as a new file. If this fails with an access error, delivery is deferred.
23152 .next
23153 Close the hitching post file, and hard link it to the lock filename.
23154 .next
23155 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23156 Unlink the hitching post name.
23157 .next
23158 Otherwise, use &[stat()]& to get information about the hitching post file, and
23159 then unlink hitching post name. If the number of links is exactly two, creation
23160 of the lock file succeeded but something (for example, an NFS server crash and
23161 restart) caused this fact not to be communicated to the &[link()]& call.
23162 .next
23163 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23164 up to &%lock_retries%& times. However, since any program that writes to a
23165 mailbox should complete its task very quickly, it is reasonable to time out old
23166 lock files that are normally the result of user agent and system crashes. If an
23167 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23168 it before trying again.
23169 .endlist olist
23170
23171 .next
23172 A call is made to &[lstat()]& to discover whether the main file exists, and if
23173 so, what its characteristics are. If &[lstat()]& fails for any reason other
23174 than non-existence, delivery is deferred.
23175
23176 .next
23177 .cindex "symbolic link" "to mailbox"
23178 .cindex "mailbox" "symbolic link"
23179 If the file does exist and is a symbolic link, delivery is deferred, unless the
23180 &%allow_symlink%& option is set, in which case the ownership of the link is
23181 checked, and then &[stat()]& is called to find out about the real file, which
23182 is then subjected to the checks below. The check on the top-level link
23183 ownership prevents one user creating a link for another's mailbox in a sticky
23184 directory, though allowing symbolic links in this case is definitely not a good
23185 idea. If there is a chain of symbolic links, the intermediate ones are not
23186 checked.
23187
23188 .next
23189 If the file already exists but is not a regular file, or if the file's owner
23190 and group (if the group is being checked &-- see &%check_group%& above) are
23191 different from the user and group under which the delivery is running,
23192 delivery is deferred.
23193
23194 .next
23195 If the file's permissions are more generous than specified, they are reduced.
23196 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23197 is set false, in which case the delivery is tried using the existing
23198 permissions.
23199
23200 .next
23201 The file's inode number is saved, and the file is then opened for appending.
23202 If this fails because the file has vanished, &(appendfile)& behaves as if it
23203 hadn't existed (see below). For any other failures, delivery is deferred.
23204
23205 .next
23206 If the file is opened successfully, check that the inode number hasn't
23207 changed, that it is still a regular file, and that the owner and permissions
23208 have not changed. If anything is wrong, defer delivery and freeze the message.
23209
23210 .next
23211 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23212 option is set. Otherwise, check that the file is being created in a permitted
23213 directory if the &%create_file%& option is set (deferring on failure), and then
23214 open for writing as a new file, with the O_EXCL and O_CREAT options,
23215 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23216 set). In this case, which can happen if the link points to a non-existent file,
23217 the file is opened for writing using O_CREAT but not O_EXCL, because
23218 that prevents link following.
23219
23220 .next
23221 .cindex "loop" "while file testing"
23222 If opening fails because the file exists, obey the tests given above for
23223 existing files. However, to avoid looping in a situation where the file is
23224 being continuously created and destroyed, the exists/not-exists loop is broken
23225 after 10 repetitions, and the message is then frozen.
23226
23227 .next
23228 If opening fails with any other error, defer delivery.
23229
23230 .next
23231 .cindex "file" "locking"
23232 .cindex "locking files"
23233 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23234 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23235 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23236 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23237 file, and an exclusive lock on the file whose name is
23238 .code
23239 /tmp/.<device-number>.<inode-number>
23240 .endd
23241 using the device and inode numbers of the open mailbox file, in accordance with
23242 the MBX locking rules. This file is created with a mode that is specified by
23243 the &%lockfile_mode%& option.
23244
23245 If Exim fails to lock the file, there are two possible courses of action,
23246 depending on the value of the locking timeout. This is obtained from
23247 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23248
23249 If the timeout value is zero, the file is closed, Exim waits for
23250 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23251 to lock it again. This happens up to &%lock_retries%& times, after which the
23252 delivery is deferred.
23253
23254 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23255 &[flock()]& are used (with the given timeout), so there has already been some
23256 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23257 immediately. It retries up to
23258 .code
23259 (lock_retries * lock_interval) / <timeout>
23260 .endd
23261 times (rounded up).
23262 .endlist
23263
23264 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23265 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23266
23267
23268 .section "Operational details for delivery to a new file" "SECTopdir"
23269 .cindex "delivery" "to single file"
23270 .cindex "&""From""& line"
23271 When the &%directory%& option is set instead of &%file%&, each message is
23272 delivered into a newly-created file or set of files. When &(appendfile)& is
23273 activated directly from a &(redirect)& router, neither &%file%& nor
23274 &%directory%& is normally set, because the path for delivery is supplied by the
23275 router. (See for example, the &(address_file)& transport in the default
23276 configuration.) In this case, delivery is to a new file if either the path name
23277 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23278
23279 No locking is required while writing the message to a new file, so the various
23280 locking options of the transport are ignored. The &"From"& line that by default
23281 separates messages in a single file is not normally needed, nor is the escaping
23282 of message lines that start with &"From"&, and there is no need to ensure a
23283 newline at the end of each message. Consequently, the default values for
23284 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23285 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23286
23287 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23288 the files in the delivery directory by default. However, you can specify a
23289 different directory by setting &%quota_directory%&. Also, for maildir
23290 deliveries (see below) the &_maildirfolder_& convention is honoured.
23291
23292
23293 .cindex "maildir format"
23294 .cindex "mailstore format"
23295 There are three different ways in which delivery to individual files can be
23296 done, controlled by the settings of the &%maildir_format%& and
23297 &%mailstore_format%& options. Note that code to support maildir or mailstore
23298 formats is not included in the binary unless SUPPORT_MAILDIR or
23299 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23300
23301 .cindex "directory creation"
23302 In all three cases an attempt is made to create the directory and any necessary
23303 sub-directories if they do not exist, provided that the &%create_directory%&
23304 option is set (the default). The location of a created directory can be
23305 constrained by setting &%create_file%&. A created directory's mode is given by
23306 the &%directory_mode%& option. If creation fails, or if the
23307 &%create_directory%& option is not set when creation is required, delivery is
23308 deferred.
23309
23310
23311
23312 .section "Maildir delivery" "SECTmaildirdelivery"
23313 .cindex "maildir format" "description of"
23314 If the &%maildir_format%& option is true, Exim delivers each message by writing
23315 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23316 directory that is defined by the &%directory%& option (the &"delivery
23317 directory"&). If the delivery is successful, the file is renamed into the
23318 &_new_& subdirectory.
23319
23320 In the filename, <&'stime'&> is the current time of day in seconds, and
23321 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23322 Exim checks that the time-of-day clock has moved on by at least one microsecond
23323 before terminating the delivery process. This guarantees uniqueness for the
23324 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23325 opening it. If any response other than ENOENT (does not exist) is given,
23326 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23327
23328 Before Exim carries out a maildir delivery, it ensures that subdirectories
23329 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23330 do not exist, Exim tries to create them and any superior directories in their
23331 path, subject to the &%create_directory%& and &%create_file%& options. If the
23332 &%maildirfolder_create_regex%& option is set, and the regular expression it
23333 contains matches the delivery directory, Exim also ensures that a file called
23334 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23335 &_maildirfolder_& file cannot be created, delivery is deferred.
23336
23337 These features make it possible to use Exim to create all the necessary files
23338 and directories in a maildir mailbox, including subdirectories for maildir++
23339 folders. Consider this example:
23340 .code
23341 maildir_format = true
23342 directory = /var/mail/$local_part\
23343            ${if eq{$local_part_suffix}{}{}\
23344            {/.${substr_1:$local_part_suffix}}}
23345 maildirfolder_create_regex = /\.[^/]+$
23346 .endd
23347 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23348 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23349 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23350 not match this name, so Exim will not look for or create the file
23351 &_/var/mail/pimbo/maildirfolder_&, though it will create
23352 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23353
23354 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23355 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23356 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23357 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23358 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23359
23360 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23361 not inadvertently match the toplevel maildir directory, because a
23362 &_maildirfolder_& file at top level would completely break quota calculations.
23363
23364 .cindex "quota" "in maildir delivery"
23365 .cindex "maildir++"
23366 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23367 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23368 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23369 Exim assumes the directory is a maildir++ folder directory, which is one level
23370 down from the user's top level mailbox directory. This causes it to start at
23371 the parent directory instead of the current directory when calculating the
23372 amount of space used.
23373
23374 One problem with delivering into a multi-file mailbox is that it is
23375 computationally expensive to compute the size of the mailbox for quota
23376 checking. Various approaches have been taken to reduce the amount of work
23377 needed. The next two sections describe two of them. A third alternative is to
23378 use some external process for maintaining the size data, and use the expansion
23379 of the &%mailbox_size%& option as a way of importing it into Exim.
23380
23381
23382
23383
23384 .section "Using tags to record message sizes" "SECID135"
23385 If &%maildir_tag%& is set, the string is expanded for each delivery.
23386 When the maildir file is renamed into the &_new_& sub-directory, the
23387 tag is added to its name. However, if adding the tag takes the length of the
23388 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23389 the tag is dropped and the maildir file is created with no tag.
23390
23391
23392 .vindex "&$message_size$&"
23393 Tags can be used to encode the size of files in their names; see
23394 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23395 happens after the message has been written. The value of the &$message_size$&
23396 variable is set to the number of bytes actually written. If the expansion is
23397 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23398 be deferred. The expanded tag may contain any printing characters except &"/"&.
23399 Non-printing characters in the string are ignored; if the resulting string is
23400 empty, it is ignored. If it starts with an alphanumeric character, a leading
23401 colon is inserted; this default has not proven to be the path that popular
23402 maildir implementations have chosen (but changing it in Exim would break
23403 backwards compatibility).
23404
23405 For one common implementation, you might set:
23406 .code
23407 maildir_tag = ,S=${message_size}
23408 .endd
23409 but you should check the documentation of the other software to be sure.
23410
23411 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23412 as this allows Exim to extract the size from your tag, instead of having to
23413 &[stat()]& each message file.
23414
23415
23416 .section "Using a maildirsize file" "SECID136"
23417 .cindex "quota" "in maildir delivery"
23418 .cindex "maildir format" "&_maildirsize_& file"
23419 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23420 storing quota and message size information in a file called &_maildirsize_&
23421 within the toplevel maildir directory. If this file does not exist, Exim
23422 creates it, setting the quota from the &%quota%& option of the transport. If
23423 the maildir directory itself does not exist, it is created before any attempt
23424 to write a &_maildirsize_& file.
23425
23426 The &_maildirsize_& file is used to hold information about the sizes of
23427 messages in the maildir, thus speeding up quota calculations. The quota value
23428 in the file is just a cache; if the quota is changed in the transport, the new
23429 value overrides the cached value when the next message is delivered. The cache
23430 is maintained for the benefit of other programs that access the maildir and
23431 need to know the quota.
23432
23433 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23434 file is maintained (with a zero quota setting), but no quota is imposed.
23435
23436 A regular expression is available for controlling which directories in the
23437 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23438 See the description of the &%maildir_quota_directory_regex%& option above for
23439 details.
23440
23441
23442 .section "Mailstore delivery" "SECID137"
23443 .cindex "mailstore format" "description of"
23444 If the &%mailstore_format%& option is true, each message is written as two
23445 files in the given directory. A unique base name is constructed from the
23446 message id and the current delivery process, and the files that are written use
23447 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23448 contains the message's envelope, and the &_.msg_& file contains the message
23449 itself. The base name is placed in the variable &$mailstore_basename$&.
23450
23451 During delivery, the envelope is first written to a file with the suffix
23452 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23453 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23454 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23455 file before accessing either of them. An alternative approach is to wait for
23456 the absence of a &_.tmp_& file.
23457
23458 The envelope file starts with any text defined by the &%mailstore_prefix%&
23459 option, expanded and terminated by a newline if there isn't one. Then follows
23460 the sender address on one line, then all the recipient addresses, one per line.
23461 There can be more than one recipient only if the &%batch_max%& option is set
23462 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23463 appended to the file, followed by a newline if it does not end with one.
23464
23465 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23466 failure, it is ignored. Other expansion errors are treated as serious
23467 configuration errors, and delivery is deferred. The variable
23468 &$mailstore_basename$& is available for use during these expansions.
23469
23470
23471 .section "Non-special new file delivery" "SECID138"
23472 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23473 file is created directly in the named directory. For example, when delivering
23474 messages into files in batched SMTP format for later delivery to some host (see
23475 section &<<SECTbatchSMTP>>&), a setting such as
23476 .code
23477 directory = /var/bsmtp/$host
23478 .endd
23479 might be used. A message is written to a file with a temporary name, which is
23480 then renamed when the delivery is complete. The final name is obtained by
23481 expanding the contents of the &%directory_file%& option.
23482 .ecindex IIDapptra1
23483 .ecindex IIDapptra2
23484
23485
23486
23487
23488
23489
23490 . ////////////////////////////////////////////////////////////////////////////
23491 . ////////////////////////////////////////////////////////////////////////////
23492
23493 .chapter "The autoreply transport" "CHID8"
23494 .scindex IIDauttra1 "transports" "&(autoreply)&"
23495 .scindex IIDauttra2 "&(autoreply)& transport"
23496 The &(autoreply)& transport is not a true transport in that it does not cause
23497 the message to be transmitted. Instead, it generates a new mail message as an
23498 automatic reply to the incoming message. &'References:'& and
23499 &'Auto-Submitted:'& header lines are included. These are constructed according
23500 to the rules in RFCs 2822 and 3834, respectively.
23501
23502 If the router that passes the message to this transport does not have the
23503 &%unseen%& option set, the original message (for the current recipient) is not
23504 delivered anywhere. However, when the &%unseen%& option is set on the router
23505 that passes the message to this transport, routing of the address continues, so
23506 another router can set up a normal message delivery.
23507
23508
23509 The &(autoreply)& transport is usually run as the result of mail filtering, a
23510 &"vacation"& message being the standard example. However, it can also be run
23511 directly from a router like any other transport. To reduce the possibility of
23512 message cascades, messages created by the &(autoreply)& transport always have
23513 empty envelope sender addresses, like bounce messages.
23514
23515 The parameters of the message to be sent can be specified in the configuration
23516 by options described below. However, these are used only when the address
23517 passed to the transport does not contain its own reply information. When the
23518 transport is run as a consequence of a
23519 &%mail%&
23520 or &%vacation%& command in a filter file, the parameters of the message are
23521 supplied by the filter, and passed with the address. The transport's options
23522 that define the message are then ignored (so they are not usually set in this
23523 case). The message is specified entirely by the filter or by the transport; it
23524 is never built from a mixture of options. However, the &%file_optional%&,
23525 &%mode%&, and &%return_message%& options apply in all cases.
23526
23527 &(Autoreply)& is implemented as a local transport. When used as a result of a
23528 command in a user's filter file, &(autoreply)& normally runs under the uid and
23529 gid of the user, and with appropriate current and home directories (see chapter
23530 &<<CHAPenvironment>>&).
23531
23532 There is a subtle difference between routing a message to a &(pipe)& transport
23533 that generates some text to be returned to the sender, and routing it to an
23534 &(autoreply)& transport. This difference is noticeable only if more than one
23535 address from the same message is so handled. In the case of a pipe, the
23536 separate outputs from the different addresses are gathered up and returned to
23537 the sender in a single message, whereas if &(autoreply)& is used, a separate
23538 message is generated for each address that is passed to it.
23539
23540 Non-printing characters are not permitted in the header lines generated for the
23541 message that &(autoreply)& creates, with the exception of newlines that are
23542 immediately followed by white space. If any non-printing characters are found,
23543 the transport defers.
23544 Whether characters with the top bit set count as printing characters or not is
23545 controlled by the &%print_topbitchars%& global option.
23546
23547 If any of the generic options for manipulating headers (for example,
23548 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23549 of the original message that is included in the generated message when
23550 &%return_message%& is set. They do not apply to the generated message itself.
23551
23552 .vindex "&$sender_address$&"
23553 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23554 the message, indicating that there were no recipients, it does not treat this
23555 as an error. This means that autoreplies sent to &$sender_address$& when this
23556 is empty (because the incoming message is a bounce message) do not cause
23557 problems. They are just discarded.
23558
23559
23560
23561 .section "Private options for autoreply" "SECID139"
23562 .cindex "options" "&(autoreply)& transport"
23563
23564 .option bcc autoreply string&!! unset
23565 This specifies the addresses that are to receive &"blind carbon copies"& of the
23566 message when the message is specified by the transport.
23567
23568
23569 .option cc autoreply string&!! unset
23570 This specifies recipients of the message and the contents of the &'Cc:'& header
23571 when the message is specified by the transport.
23572
23573
23574 .option file autoreply string&!! unset
23575 The contents of the file are sent as the body of the message when the message
23576 is specified by the transport. If both &%file%& and &%text%& are set, the text
23577 string comes first.
23578
23579
23580 .option file_expand autoreply boolean false
23581 If this is set, the contents of the file named by the &%file%& option are
23582 subjected to string expansion as they are added to the message.
23583
23584
23585 .option file_optional autoreply boolean false
23586 If this option is true, no error is generated if the file named by the &%file%&
23587 option or passed with the address does not exist or cannot be read.
23588
23589
23590 .option from autoreply string&!! unset
23591 This specifies the contents of the &'From:'& header when the message is
23592 specified by the transport.
23593
23594
23595 .option headers autoreply string&!! unset
23596 This specifies additional RFC 2822 headers that are to be added to the message
23597 when the message is specified by the transport. Several can be given by using
23598 &"\n"& to separate them. There is no check on the format.
23599
23600
23601 .option log autoreply string&!! unset
23602 This option names a file in which a record of every message sent is logged when
23603 the message is specified by the transport.
23604
23605
23606 .option mode autoreply "octal integer" 0600
23607 If either the log file or the &"once"& file has to be created, this mode is
23608 used.
23609
23610
23611 .option never_mail autoreply "address list&!!" unset
23612 If any run of the transport creates a message with a recipient that matches any
23613 item in the list, that recipient is quietly discarded. If all recipients are
23614 discarded, no message is created. This applies both when the recipients are
23615 generated by a filter and when they are specified in the transport.
23616
23617
23618
23619 .option once autoreply string&!! unset
23620 This option names a file or DBM database in which a record of each &'To:'&
23621 recipient is kept when the message is specified by the transport. &*Note*&:
23622 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
23623
23624 If &%once%& is unset, or is set to an empty string, the message is always sent.
23625 By default, if &%once%& is set to a non-empty filename, the message
23626 is not sent if a potential recipient is already listed in the database.
23627 However, if the &%once_repeat%& option specifies a time greater than zero, the
23628 message is sent if that much time has elapsed since a message was last sent to
23629 this recipient. A setting of zero time for &%once_repeat%& (the default)
23630 prevents a message from being sent a second time &-- in this case, zero means
23631 infinity.
23632
23633 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
23634 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
23635 greater than zero, it changes the way Exim implements the &%once%& option.
23636 Instead of using a DBM file to record every recipient it sends to, it uses a
23637 regular file, whose size will never get larger than the given value.
23638
23639 In the file, Exim keeps a linear list of recipient addresses and the times at
23640 which they were sent messages. If the file is full when a new address needs to
23641 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
23642 means that a given recipient may receive multiple messages, but at
23643 unpredictable intervals that depend on the rate of turnover of addresses in the
23644 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
23645
23646
23647 .option once_file_size autoreply integer 0
23648 See &%once%& above.
23649
23650
23651 .option once_repeat autoreply time&!! 0s
23652 See &%once%& above.
23653 After expansion, the value of this option must be a valid time value.
23654
23655
23656 .option reply_to autoreply string&!! unset
23657 This specifies the contents of the &'Reply-To:'& header when the message is
23658 specified by the transport.
23659
23660
23661 .option return_message autoreply boolean false
23662 If this is set, a copy of the original message is returned with the new
23663 message, subject to the maximum size set in the &%return_size_limit%& global
23664 configuration option.
23665
23666
23667 .option subject autoreply string&!! unset
23668 This specifies the contents of the &'Subject:'& header when the message is
23669 specified by the transport. It is tempting to quote the original subject in
23670 automatic responses. For example:
23671 .code
23672 subject = Re: $h_subject:
23673 .endd
23674 There is a danger in doing this, however. It may allow a third party to
23675 subscribe your users to an opt-in mailing list, provided that the list accepts
23676 bounce messages as subscription confirmations. Well-managed lists require a
23677 non-bounce message to confirm a subscription, so the danger is relatively
23678 small.
23679
23680
23681
23682 .option text autoreply string&!! unset
23683 This specifies a single string to be used as the body of the message when the
23684 message is specified by the transport. If both &%text%& and &%file%& are set,
23685 the text comes first.
23686
23687
23688 .option to autoreply string&!! unset
23689 This specifies recipients of the message and the contents of the &'To:'& header
23690 when the message is specified by the transport.
23691 .ecindex IIDauttra1
23692 .ecindex IIDauttra2
23693
23694
23695
23696
23697 . ////////////////////////////////////////////////////////////////////////////
23698 . ////////////////////////////////////////////////////////////////////////////
23699
23700 .chapter "The lmtp transport" "CHAPLMTP"
23701 .cindex "transports" "&(lmtp)&"
23702 .cindex "&(lmtp)& transport"
23703 .cindex "LMTP" "over a pipe"
23704 .cindex "LMTP" "over a socket"
23705 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
23706 specified command
23707 or by interacting with a Unix domain socket.
23708 This transport is something of a cross between the &(pipe)& and &(smtp)&
23709 transports. Exim also has support for using LMTP over TCP/IP; this is
23710 implemented as an option for the &(smtp)& transport. Because LMTP is expected
23711 to be of minority interest, the default build-time configure in &_src/EDITME_&
23712 has it commented out. You need to ensure that
23713 .code
23714 TRANSPORT_LMTP=yes
23715 .endd
23716 .cindex "options" "&(lmtp)& transport"
23717 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
23718 included in the Exim binary. The private options of the &(lmtp)& transport are
23719 as follows:
23720
23721 .option batch_id lmtp string&!! unset
23722 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23723
23724
23725 .option batch_max lmtp integer 1
23726 This limits the number of addresses that can be handled in a single delivery.
23727 Most LMTP servers can handle several addresses at once, so it is normally a
23728 good idea to increase this value. See the description of local delivery
23729 batching in chapter &<<CHAPbatching>>&.
23730
23731
23732 .option command lmtp string&!! unset
23733 This option must be set if &%socket%& is not set. The string is a command which
23734 is run in a separate process. It is split up into a command name and list of
23735 arguments, each of which is separately expanded (so expansion cannot change the
23736 number of arguments). The command is run directly, not via a shell. The message
23737 is passed to the new process using the standard input and output to operate the
23738 LMTP protocol.
23739
23740 .option ignore_quota lmtp boolean false
23741 .cindex "LMTP" "ignoring quota errors"
23742 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
23743 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
23744 in its response to the LHLO command.
23745
23746 .option socket lmtp string&!! unset
23747 This option must be set if &%command%& is not set. The result of expansion must
23748 be the name of a Unix domain socket. The transport connects to the socket and
23749 delivers the message to it using the LMTP protocol.
23750
23751
23752 .option timeout lmtp time 5m
23753 The transport is aborted if the created process or Unix domain socket does not
23754 respond to LMTP commands or message input within this timeout. Delivery
23755 is deferred, and will be tried again later. Here is an example of a typical
23756 LMTP transport:
23757 .code
23758 lmtp:
23759   driver = lmtp
23760   command = /some/local/lmtp/delivery/program
23761   batch_max = 20
23762   user = exim
23763 .endd
23764 This delivers up to 20 addresses at a time, in a mixture of domains if
23765 necessary, running as the user &'exim'&.
23766
23767
23768
23769 . ////////////////////////////////////////////////////////////////////////////
23770 . ////////////////////////////////////////////////////////////////////////////
23771
23772 .chapter "The pipe transport" "CHAPpipetransport"
23773 .scindex IIDpiptra1 "transports" "&(pipe)&"
23774 .scindex IIDpiptra2 "&(pipe)& transport"
23775 The &(pipe)& transport is used to deliver messages via a pipe to a command
23776 running in another process. One example is the use of &(pipe)& as a
23777 pseudo-remote transport for passing messages to some other delivery mechanism
23778 (such as UUCP). Another is the use by individual users to automatically process
23779 their incoming messages. The &(pipe)& transport can be used in one of the
23780 following ways:
23781
23782 .ilist
23783 .vindex "&$local_part$&"
23784 A router routes one address to a transport in the normal way, and the
23785 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
23786 contains the local part of the address (as usual), and the command that is run
23787 is specified by the &%command%& option on the transport.
23788 .next
23789 .vindex "&$pipe_addresses$&"
23790 If the &%batch_max%& option is set greater than 1 (the default is 1), the
23791 transport can handle more than one address in a single run. In this case, when
23792 more than one address is routed to the transport, &$local_part$& is not set
23793 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
23794 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
23795 that are routed to the transport.
23796 .next
23797 .vindex "&$address_pipe$&"
23798 A router redirects an address directly to a pipe command (for example, from an
23799 alias or forward file). In this case, &$address_pipe$& contains the text of the
23800 pipe command, and the &%command%& option on the transport is ignored unless
23801 &%force_command%& is set. If only one address is being transported
23802 (&%batch_max%& is not greater than one, or only one address was redirected to
23803 this pipe command), &$local_part$& contains the local part that was redirected.
23804 .endlist
23805
23806
23807 The &(pipe)& transport is a non-interactive delivery method. Exim can also
23808 deliver messages over pipes using the LMTP interactive protocol. This is
23809 implemented by the &(lmtp)& transport.
23810
23811 In the case when &(pipe)& is run as a consequence of an entry in a local user's
23812 &_.forward_& file, the command runs under the uid and gid of that user. In
23813 other cases, the uid and gid have to be specified explicitly, either on the
23814 transport or on the router that handles the address. Current and &"home"&
23815 directories are also controllable. See chapter &<<CHAPenvironment>>& for
23816 details of the local delivery environment and chapter &<<CHAPbatching>>&
23817 for a discussion of local delivery batching.
23818
23819
23820 .section "Concurrent delivery" "SECID140"
23821 If two messages arrive at almost the same time, and both are routed to a pipe
23822 delivery, the two pipe transports may be run concurrently. You must ensure that
23823 any pipe commands you set up are robust against this happening. If the commands
23824 write to a file, the &%exim_lock%& utility might be of use.
23825 Alternatively the &%max_parallel%& option could be used with a value
23826 of "1" to enforce serialization.
23827
23828
23829
23830
23831 .section "Returned status and data" "SECID141"
23832 .cindex "&(pipe)& transport" "returned data"
23833 If the command exits with a non-zero return code, the delivery is deemed to
23834 have failed, unless either the &%ignore_status%& option is set (in which case
23835 the return code is treated as zero), or the return code is one of those listed
23836 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23837 later"&. In this case, delivery is deferred. Details of a permanent failure are
23838 logged, but are not included in the bounce message, which merely contains
23839 &"local delivery failed"&.
23840
23841 If the command exits on a signal and the &%freeze_signal%& option is set then
23842 the message will be frozen in the queue. If that option is not set, a bounce
23843 will be sent as normal.
23844
23845 If the return code is greater than 128 and the command being run is a shell
23846 script, it normally means that the script was terminated by a signal whose
23847 value is the return code minus 128. The &%freeze_signal%& option does not
23848 apply in this case.
23849
23850 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23851 return code is set to 127. This is the value that a shell returns if it is
23852 asked to run a non-existent command. The wording for the log line suggests that
23853 a non-existent command may be the problem.
23854
23855 The &%return_output%& option can affect the result of a pipe delivery. If it is
23856 set and the command produces any output on its standard output or standard
23857 error streams, the command is considered to have failed, even if it gave a zero
23858 return code or if &%ignore_status%& is set. The output from the command is
23859 included as part of the bounce message. The &%return_fail_output%& option is
23860 similar, except that output is returned only when the command exits with a
23861 failure return code, that is, a value other than zero or a code that matches
23862 &%temp_errors%&.
23863
23864
23865
23866 .section "How the command is run" "SECThowcommandrun"
23867 .cindex "&(pipe)& transport" "path for command"
23868 The command line is (by default) broken down into a command name and arguments
23869 by the &(pipe)& transport itself. The &%allow_commands%& and
23870 &%restrict_to_path%& options can be used to restrict the commands that may be
23871 run.
23872
23873 .cindex "quoting" "in pipe command"
23874 Unquoted arguments are delimited by white space. If an argument appears in
23875 double quotes, backslash is interpreted as an escape character in the usual
23876 way. If an argument appears in single quotes, no escaping is done.
23877
23878 String expansion is applied to the command line except when it comes from a
23879 traditional &_.forward_& file (commands from a filter file are expanded). The
23880 expansion is applied to each argument in turn rather than to the whole line.
23881 For this reason, any string expansion item that contains white space must be
23882 quoted so as to be contained within a single argument. A setting such as
23883 .code
23884 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23885 .endd
23886 will not work, because the expansion item gets split between several
23887 arguments. You have to write
23888 .code
23889 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23890 .endd
23891 to ensure that it is all in one argument. The expansion is done in this way,
23892 argument by argument, so that the number of arguments cannot be changed as a
23893 result of expansion, and quotes or backslashes in inserted variables do not
23894 interact with external quoting. However, this leads to problems if you want to
23895 generate multiple arguments (or the command name plus arguments) from a single
23896 expansion. In this situation, the simplest solution is to use a shell. For
23897 example:
23898 .code
23899 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23900 .endd
23901
23902 .cindex "transport" "filter"
23903 .cindex "filter" "transport filter"
23904 .vindex "&$pipe_addresses$&"
23905 Special handling takes place when an argument consists of precisely the text
23906 &`$pipe_addresses`& (no quotes).
23907 This is not a general expansion variable; the only
23908 place this string is recognized is when it appears as an argument for a pipe or
23909 transport filter command. It causes each address that is being handled to be
23910 inserted in the argument list at that point &'as a separate argument'&. This
23911 avoids any problems with spaces or shell metacharacters, and is of use when a
23912 &(pipe)& transport is handling groups of addresses in a batch.
23913
23914 If &%force_command%& is enabled on the transport, special handling takes place
23915 for an argument that consists of precisely the text &`$address_pipe`&.  It
23916 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23917 argument is inserted in the argument list at that point
23918 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23919 the only item in the argument; in fact, if it were then &%force_command%&
23920 should behave as a no-op.  Rather, it should be used to adjust the command
23921 run while preserving the argument vector separation.
23922
23923 After splitting up into arguments and expansion, the resulting command is run
23924 in a subprocess directly from the transport, &'not'& under a shell. The
23925 message that is being delivered is supplied on the standard input, and the
23926 standard output and standard error are both connected to a single pipe that is
23927 read by Exim. The &%max_output%& option controls how much output the command
23928 may produce, and the &%return_output%& and &%return_fail_output%& options
23929 control what is done with it.
23930
23931 Not running the command under a shell (by default) lessens the security risks
23932 in cases when a command from a user's filter file is built out of data that was
23933 taken from an incoming message. If a shell is required, it can of course be
23934 explicitly specified as the command to be run. However, there are circumstances
23935 where existing commands (for example, in &_.forward_& files) expect to be run
23936 under a shell and cannot easily be modified. To allow for these cases, there is
23937 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23938 works. Instead of breaking up the command line as just described, it expands it
23939 as a single string and passes the result to &_/bin/sh_&. The
23940 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23941 with &%use_shell%&, and the whole mechanism is inherently less secure.
23942
23943
23944
23945 .section "Environment variables" "SECTpipeenv"
23946 .cindex "&(pipe)& transport" "environment for command"
23947 .cindex "environment" "&(pipe)& transport"
23948 The environment variables listed below are set up when the command is invoked.
23949 This list is a compromise for maximum compatibility with other MTAs. Note that
23950 the &%environment%& option can be used to add additional variables to this
23951 environment. The environment for the &(pipe)& transport is not subject
23952 to the &%add_environment%& and &%keep_environment%& main config options.
23953 .display
23954 &`DOMAIN            `&   the domain of the address
23955 &`HOME              `&   the home directory, if set
23956 &`HOST              `&   the host name when called from a router (see below)
23957 &`LOCAL_PART        `&   see below
23958 &`LOCAL_PART_PREFIX `&   see below
23959 &`LOCAL_PART_SUFFIX `&   see below
23960 &`LOGNAME           `&   see below
23961 &`MESSAGE_ID        `&   Exim's local ID for the message
23962 &`PATH              `&   as specified by the &%path%& option below
23963 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23964 &`RECIPIENT         `&   the complete recipient address
23965 &`SENDER            `&   the sender of the message (empty if a bounce)
23966 &`SHELL             `&   &`/bin/sh`&
23967 &`TZ                `&   the value of the &%timezone%& option, if set
23968 &`USER              `&   see below
23969 .endd
23970 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23971 router, LOCAL_PART is set to the local part of the address. When it is
23972 called as a result of a forward or alias expansion, LOCAL_PART is set to
23973 the local part of the address that was expanded. In both cases, any affixes are
23974 removed from the local part, and made available in LOCAL_PART_PREFIX and
23975 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23976 same value as LOCAL_PART for compatibility with other MTAs.
23977
23978 .cindex "HOST"
23979 HOST is set only when a &(pipe)& transport is called from a router that
23980 associates hosts with an address, typically when using &(pipe)& as a
23981 pseudo-remote transport. HOST is set to the first host name specified by
23982 the router.
23983
23984 .cindex "HOME"
23985 If the transport's generic &%home_directory%& option is set, its value is used
23986 for the HOME environment variable. Otherwise, a home directory may be set
23987 by the router's &%transport_home_directory%& option, which defaults to the
23988 user's home directory if &%check_local_user%& is set.
23989
23990
23991 .section "Private options for pipe" "SECID142"
23992 .cindex "options" "&(pipe)& transport"
23993
23994
23995
23996 .option allow_commands pipe "string list&!!" unset
23997 .cindex "&(pipe)& transport" "permitted commands"
23998 The string is expanded, and is then interpreted as a colon-separated list of
23999 permitted commands. If &%restrict_to_path%& is not set, the only commands
24000 permitted are those in the &%allow_commands%& list. They need not be absolute
24001 paths; the &%path%& option is still used for relative paths. If
24002 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24003 in the &%allow_commands%& list, or a name without any slashes that is found on
24004 the path. In other words, if neither &%allow_commands%& nor
24005 &%restrict_to_path%& is set, there is no restriction on the command, but
24006 otherwise only commands that are permitted by one or the other are allowed. For
24007 example, if
24008 .code
24009 allow_commands = /usr/bin/vacation
24010 .endd
24011 and &%restrict_to_path%& is not set, the only permitted command is
24012 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24013 &%use_shell%& is set.
24014
24015
24016 .option batch_id pipe string&!! unset
24017 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24018
24019
24020 .option batch_max pipe integer 1
24021 This limits the number of addresses that can be handled in a single delivery.
24022 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24023
24024
24025 .option check_string pipe string unset
24026 As &(pipe)& writes the message, the start of each line is tested for matching
24027 &%check_string%&, and if it does, the initial matching characters are replaced
24028 by the contents of &%escape_string%&, provided both are set. The value of
24029 &%check_string%& is a literal string, not a regular expression, and the case of
24030 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24031 of &%check_string%& and &%escape_string%& are forced to values that implement
24032 the SMTP escaping protocol. Any settings made in the configuration file are
24033 ignored.
24034
24035
24036 .option command pipe string&!! unset
24037 This option need not be set when &(pipe)& is being used to deliver to pipes
24038 obtained directly from address redirections. In other cases, the option must be
24039 set, to provide a command to be run. It need not yield an absolute path (see
24040 the &%path%& option below). The command is split up into separate arguments by
24041 Exim, and each argument is separately expanded, as described in section
24042 &<<SECThowcommandrun>>& above.
24043
24044
24045 .option environment pipe string&!! unset
24046 .cindex "&(pipe)& transport" "environment for command"
24047 .cindex "environment" "&(pipe)& transport"
24048 This option is used to add additional variables to the environment in which the
24049 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24050 a string which is expanded, and then interpreted as a colon-separated list of
24051 environment settings of the form <&'name'&>=<&'value'&>.
24052
24053
24054 .option escape_string pipe string unset
24055 See &%check_string%& above.
24056
24057
24058 .option freeze_exec_fail pipe boolean false
24059 .cindex "exec failure"
24060 .cindex "failure of exec"
24061 .cindex "&(pipe)& transport" "failure of exec"
24062 Failure to exec the command in a pipe transport is by default treated like
24063 any other failure while running the command. However, if &%freeze_exec_fail%&
24064 is set, failure to exec is treated specially, and causes the message to be
24065 frozen, whatever the setting of &%ignore_status%&.
24066
24067
24068 .option freeze_signal pipe boolean false
24069 .cindex "signal exit"
24070 .cindex "&(pipe)& transport", "signal exit"
24071 Normally if the process run by a command in a pipe transport exits on a signal,
24072 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24073 frozen in Exim's queue instead.
24074
24075
24076 .option force_command pipe boolean false
24077 .cindex "force command"
24078 .cindex "&(pipe)& transport", "force command"
24079 Normally when a router redirects an address directly to a pipe command
24080 the &%command%& option on the transport is ignored.  If &%force_command%&
24081 is set, the &%command%& option will used. This is especially
24082 useful for forcing a wrapper or additional argument to be added to the
24083 command. For example:
24084 .code
24085 command = /usr/bin/remote_exec myhost -- $address_pipe
24086 force_command
24087 .endd
24088
24089 Note that &$address_pipe$& is handled specially in &%command%& when
24090 &%force_command%& is set, expanding out to the original argument vector as
24091 separate items, similarly to a Unix shell &`"$@"`& construct.
24092
24093
24094 .option ignore_status pipe boolean false
24095 If this option is true, the status returned by the subprocess that is set up to
24096 run the command is ignored, and Exim behaves as if zero had been returned.
24097 Otherwise, a non-zero status or termination by signal causes an error return
24098 from the transport unless the status value is one of those listed in
24099 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24100
24101 &*Note*&: This option does not apply to timeouts, which do not return a status.
24102 See the &%timeout_defer%& option for how timeouts are handled.
24103
24104
24105 .option log_defer_output pipe boolean false
24106 .cindex "&(pipe)& transport" "logging output"
24107 If this option is set, and the status returned by the command is
24108 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24109 and any output was produced on stdout or stderr, the first line of it is
24110 written to the main log.
24111
24112
24113 .option log_fail_output pipe boolean false
24114 If this option is set, and the command returns any output on stdout or
24115 stderr, and also ends with a return code that is neither zero nor one of
24116 the return codes listed in &%temp_errors%& (that is, the delivery
24117 failed), the first line of output is written to the main log. This
24118 option and &%log_output%& are mutually exclusive.  Only one of them may
24119 be set.
24120
24121
24122 .option log_output pipe boolean false
24123 If this option is set and the command returns any output on stdout or
24124 stderr, the first line of output is written to the main log, whatever
24125 the return code. This option and &%log_fail_output%& are mutually
24126 exclusive. Only one of them may be set.
24127
24128
24129 .option max_output pipe integer 20K
24130 This specifies the maximum amount of output that the command may produce on its
24131 standard output and standard error file combined. If the limit is exceeded, the
24132 process running the command is killed. This is intended as a safety measure to
24133 catch runaway processes. The limit is applied independently of the settings of
24134 the options that control what is done with such output (for example,
24135 &%return_output%&). Because of buffering effects, the amount of output may
24136 exceed the limit by a small amount before Exim notices.
24137
24138
24139 .option message_prefix pipe string&!! "see below"
24140 The string specified here is expanded and output at the start of every message.
24141 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24142 .code
24143 message_prefix = \
24144   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24145   ${tod_bsdinbox}\n
24146 .endd
24147 .cindex "Cyrus"
24148 .cindex "&%tmail%&"
24149 .cindex "&""From""& line"
24150 This is required by the commonly used &_/usr/bin/vacation_& program.
24151 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24152 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24153 setting
24154 .code
24155 message_prefix =
24156 .endd
24157 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24158 &`\n`& to &`\r\n`& in &%message_prefix%&.
24159
24160
24161 .option message_suffix pipe string&!! "see below"
24162 The string specified here is expanded and output at the end of every message.
24163 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24164 The suffix can be suppressed by setting
24165 .code
24166 message_suffix =
24167 .endd
24168 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24169 &`\n`& to &`\r\n`& in &%message_suffix%&.
24170
24171
24172 .option path pipe string&!! "/bin:/usr/bin"
24173 This option is expanded and
24174 specifies the string that is set up in the PATH environment
24175 variable of the subprocess.
24176 If the &%command%& option does not yield an absolute path name, the command is
24177 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24178 apply to a command specified as a transport filter.
24179
24180
24181 .option permit_coredump pipe boolean false
24182 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24183 a core-dump of a pipe command, enable this command.  This enables core-dumps
24184 during delivery and affects both the Exim binary and the pipe command run.
24185 It is recommended that this option remain off unless and until you have a need
24186 for it and that this only be enabled when needed, as the risk of excessive
24187 resource consumption can be quite high.  Note also that Exim is typically
24188 installed as a setuid binary and most operating systems will inhibit coredumps
24189 of these by default, so further OS-specific action may be required.
24190
24191
24192 .option pipe_as_creator pipe boolean false
24193 .cindex "uid (user id)" "local delivery"
24194 If the generic &%user%& option is not set and this option is true, the delivery
24195 process is run under the uid that was in force when Exim was originally called
24196 to accept the message. If the group id is not otherwise set (via the generic
24197 &%group%& option), the gid that was in force when Exim was originally called to
24198 accept the message is used.
24199
24200
24201 .option restrict_to_path pipe boolean false
24202 When this option is set, any command name not listed in &%allow_commands%& must
24203 contain no slashes. The command is searched for only in the directories listed
24204 in the &%path%& option. This option is intended for use in the case when a pipe
24205 command has been generated from a user's &_.forward_& file. This is usually
24206 handled by a &(pipe)& transport called &%address_pipe%&.
24207
24208
24209 .option return_fail_output pipe boolean false
24210 If this option is true, and the command produced any output and ended with a
24211 return code other than zero or one of the codes listed in &%temp_errors%& (that
24212 is, the delivery failed), the output is returned in the bounce message.
24213 However, if the message has a null sender (that is, it is itself a bounce
24214 message), output from the command is discarded. This option and
24215 &%return_output%& are mutually exclusive. Only one of them may be set.
24216
24217
24218
24219 .option return_output pipe boolean false
24220 If this option is true, and the command produced any output, the delivery is
24221 deemed to have failed whatever the return code from the command, and the output
24222 is returned in the bounce message. Otherwise, the output is just discarded.
24223 However, if the message has a null sender (that is, it is a bounce message),
24224 output from the command is always discarded, whatever the setting of this
24225 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24226 of them may be set.
24227
24228
24229
24230 .option temp_errors pipe "string list" "see below"
24231 .cindex "&(pipe)& transport" "temporary failure"
24232 This option contains either a colon-separated list of numbers, or a single
24233 asterisk. If &%ignore_status%& is false
24234 and &%return_output%& is not set,
24235 and the command exits with a non-zero return code, the failure is treated as
24236 temporary and the delivery is deferred if the return code matches one of the
24237 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24238 codes are treated as permanent errors. The default setting contains the codes
24239 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24240 compiled on a system that does not define these macros, it assumes values of 75
24241 and 73, respectively.
24242
24243
24244 .option timeout pipe time 1h
24245 If the command fails to complete within this time, it is killed. This normally
24246 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24247 specifies no timeout. In order to ensure that any subprocesses created by the
24248 command are also killed, Exim makes the initial process a process group leader,
24249 and kills the whole process group on a timeout. However, this can be defeated
24250 if one of the processes starts a new process group.
24251
24252 .option timeout_defer pipe boolean false
24253 A timeout in a &(pipe)& transport, either in the command that the transport
24254 runs, or in a transport filter that is associated with it, is by default
24255 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24256 is set true, both kinds of timeout become temporary errors, causing the
24257 delivery to be deferred.
24258
24259 .option umask pipe "octal integer" 022
24260 This specifies the umask setting for the subprocess that runs the command.
24261
24262
24263 .option use_bsmtp pipe boolean false
24264 .cindex "envelope sender"
24265 If this option is set true, the &(pipe)& transport writes messages in &"batch
24266 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24267 commands. If you want to include a leading HELO command with such messages,
24268 you can do so by setting the &%message_prefix%& option. See section
24269 &<<SECTbatchSMTP>>& for details of batch SMTP.
24270
24271 .option use_classresources pipe boolean false
24272 .cindex "class resources (BSD)"
24273 This option is available only when Exim is running on FreeBSD, NetBSD, or
24274 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24275 resource limits when a &(pipe)& transport is run to perform a delivery. The
24276 limits for the uid under which the pipe is to run are obtained from the login
24277 class database.
24278
24279
24280 .option use_crlf pipe boolean false
24281 .cindex "carriage return"
24282 .cindex "linefeed"
24283 This option causes lines to be terminated with the two-character CRLF sequence
24284 (carriage return, linefeed) instead of just a linefeed character. In the case
24285 of batched SMTP, the byte sequence written to the pipe is then an exact image
24286 of what would be sent down a real SMTP connection.
24287
24288 The contents of the &%message_prefix%& and &%message_suffix%& options are
24289 written verbatim, so must contain their own carriage return characters if these
24290 are needed. When &%use_bsmtp%& is not set, the default values for both
24291 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24292 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24293
24294
24295 .option use_shell pipe boolean false
24296 .vindex "&$pipe_addresses$&"
24297 If this option is set, it causes the command to be passed to &_/bin/sh_&
24298 instead of being run directly from the transport, as described in section
24299 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24300 where the command is expected to be run under a shell and cannot easily be
24301 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24302 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24303 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24304 its &%-c%& option.
24305
24306
24307
24308 .section "Using an external local delivery agent" "SECID143"
24309 .cindex "local delivery" "using an external agent"
24310 .cindex "&'procmail'&"
24311 .cindex "external local delivery"
24312 .cindex "delivery" "&'procmail'&"
24313 .cindex "delivery" "by external agent"
24314 The &(pipe)& transport can be used to pass all messages that require local
24315 delivery to a separate local delivery agent such as &%procmail%&. When doing
24316 this, care must be taken to ensure that the pipe is run under an appropriate
24317 uid and gid. In some configurations one wants this to be a uid that is trusted
24318 by the delivery agent to supply the correct sender of the message. It may be
24319 necessary to recompile or reconfigure the delivery agent so that it trusts an
24320 appropriate user. The following is an example transport and router
24321 configuration for &%procmail%&:
24322 .code
24323 # transport
24324 procmail_pipe:
24325   driver = pipe
24326   command = /usr/local/bin/procmail -d $local_part
24327   return_path_add
24328   delivery_date_add
24329   envelope_to_add
24330   check_string = "From "
24331   escape_string = ">From "
24332   umask = 077
24333   user = $local_part
24334   group = mail
24335
24336 # router
24337 procmail:
24338   driver = accept
24339   check_local_user
24340   transport = procmail_pipe
24341 .endd
24342 In this example, the pipe is run as the local user, but with the group set to
24343 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24344 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24345 user to supply a correct sender address. If you do not specify either a
24346 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24347 home directory is the user's home directory by default.
24348
24349 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24350 .code
24351 IFS=" "
24352 .endd
24353 as shown in some &%procmail%& documentation, because Exim does not by default
24354 use a shell to run pipe commands.
24355
24356 .cindex "Cyrus"
24357 The next example shows a transport and a router for a system where local
24358 deliveries are handled by the Cyrus IMAP server.
24359 .code
24360 # transport
24361 local_delivery_cyrus:
24362   driver = pipe
24363   command = /usr/cyrus/bin/deliver \
24364             -m ${substr_1:$local_part_suffix} -- $local_part
24365   user = cyrus
24366   group = mail
24367   return_output
24368   log_output
24369   message_prefix =
24370   message_suffix =
24371
24372 # router
24373 local_user_cyrus:
24374   driver = accept
24375   check_local_user
24376   local_part_suffix = .*
24377   transport = local_delivery_cyrus
24378 .endd
24379 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24380 &%return_output%& to cause any text written by Cyrus to be returned to the
24381 sender.
24382 .ecindex IIDpiptra1
24383 .ecindex IIDpiptra2
24384
24385
24386 . ////////////////////////////////////////////////////////////////////////////
24387 . ////////////////////////////////////////////////////////////////////////////
24388
24389 .chapter "The smtp transport" "CHAPsmtptrans"
24390 .scindex IIDsmttra1 "transports" "&(smtp)&"
24391 .scindex IIDsmttra2 "&(smtp)& transport"
24392 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24393 or LMTP protocol. The list of hosts to try can either be taken from the address
24394 that is being processed (having been set up by the router), or specified
24395 explicitly for the transport. Timeout and retry processing (see chapter
24396 &<<CHAPretry>>&) is applied to each IP address independently.
24397
24398
24399 .section "Multiple messages on a single connection" "SECID144"
24400 The sending of multiple messages over a single TCP/IP connection can arise in
24401 two ways:
24402
24403 .ilist
24404 If a message contains more than &%max_rcpt%& (see below) addresses that are
24405 routed to the same host, more than one copy of the message has to be sent to
24406 that host. In this situation, multiple copies may be sent in a single run of
24407 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24408 does when it has too many addresses to send in one message also depends on the
24409 value of the global &%remote_max_parallel%& option. Details are given in
24410 section &<<SECToutSMTPTCP>>&.)
24411 .next
24412 .cindex "hints database" "remembering routing"
24413 When a message has been successfully delivered over a TCP/IP connection, Exim
24414 looks in its hints database to see if there are any other messages awaiting a
24415 connection to the same host. If there are, a new delivery process is started
24416 for one of them, and the current TCP/IP connection is passed on to it. The new
24417 process may in turn send multiple copies and possibly create yet another
24418 process.
24419 .endlist
24420
24421
24422 For each copy sent over the same TCP/IP connection, a sequence counter is
24423 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24424 no further messages are sent over that connection.
24425
24426
24427
24428 .section "Use of the $host and $host_address variables" "SECID145"
24429 .vindex "&$host$&"
24430 .vindex "&$host_address$&"
24431 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24432 &$host_address$& are the name and IP address of the first host on the host list
24433 passed by the router. However, when the transport is about to connect to a
24434 specific host, and while it is connected to that host, &$host$& and
24435 &$host_address$& are set to the values for that host. These are the values
24436 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24437 &%serialize_hosts%&, and the various TLS options are expanded.
24438
24439
24440 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24441 .vindex &$tls_bits$&
24442 .vindex &$tls_cipher$&
24443 .vindex &$tls_peerdn$&
24444 .vindex &$tls_sni$&
24445 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24446 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24447 are the values that were set when the message was received.
24448 These are the values that are used for options that are expanded before any
24449 SMTP connections are made. Just before each connection is made, these four
24450 variables are emptied. If TLS is subsequently started, they are set to the
24451 appropriate values for the outgoing connection, and these are the values that
24452 are in force when any authenticators are run and when the
24453 &%authenticated_sender%& option is expanded.
24454
24455 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24456 and will be removed in a future release.
24457
24458
24459 .section "Private options for smtp" "SECID146"
24460 .cindex "options" "&(smtp)& transport"
24461 The private options of the &(smtp)& transport are as follows:
24462
24463
24464 .option address_retry_include_sender smtp boolean true
24465 .cindex "4&'xx'& responses" "retrying after"
24466 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24467 is the combination of sender and recipient that is delayed in subsequent queue
24468 runs until the retry time is reached. You can delay the recipient without
24469 reference to the sender (which is what earlier versions of Exim did), by
24470 setting &%address_retry_include_sender%& false. However, this can lead to
24471 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24472
24473 .option allow_localhost smtp boolean false
24474 .cindex "local host" "sending to"
24475 .cindex "fallback" "hosts specified on transport"
24476 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24477 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24478 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24479 the delivery anyway. This should be used only in special cases when the
24480 configuration ensures that no looping will result (for example, a differently
24481 configured Exim is listening on the port to which the message is sent).
24482
24483
24484 .option authenticated_sender smtp string&!! unset
24485 .cindex "Cyrus"
24486 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24487 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24488 overriding any existing authenticated sender value. If the string expansion is
24489 forced to fail, the option is ignored. Other expansion failures cause delivery
24490 to be deferred. If the result of expansion is an empty string, that is also
24491 ignored.
24492
24493 The expansion happens after the outgoing connection has been made and TLS
24494 started, if required. This means that the &$host$&, &$host_address$&,
24495 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24496 particular connection.
24497
24498 If the SMTP session is not authenticated, the expansion of
24499 &%authenticated_sender%& still happens (and can cause the delivery to be
24500 deferred if it fails), but no AUTH= item is added to MAIL commands
24501 unless &%authenticated_sender_force%& is true.
24502
24503 This option allows you to use the &(smtp)& transport in LMTP mode to
24504 deliver mail to Cyrus IMAP and provide the proper local part as the
24505 &"authenticated sender"&, via a setting such as:
24506 .code
24507 authenticated_sender = $local_part
24508 .endd
24509 This removes the need for IMAP subfolders to be assigned special ACLs to
24510 allow direct delivery to those subfolders.
24511
24512 Because of expected uses such as that just described for Cyrus (when no
24513 domain is involved), there is no checking on the syntax of the provided
24514 value.
24515
24516
24517 .option authenticated_sender_force smtp boolean false
24518 If this option is set true, the &%authenticated_sender%& option's value
24519 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24520 authenticated as a client.
24521
24522
24523 .option command_timeout smtp time 5m
24524 This sets a timeout for receiving a response to an SMTP command that has been
24525 sent out. It is also used when waiting for the initial banner line from the
24526 remote host. Its value must not be zero.
24527
24528
24529 .option connect_timeout smtp time 5m
24530 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24531 to a remote host. A setting of zero allows the system timeout (typically
24532 several minutes) to act. To have any effect, the value of this option must be
24533 less than the system timeout. However, it has been observed that on some
24534 systems there is no system timeout, which is why the default value for this
24535 option is 5 minutes, a value recommended by RFC 1123.
24536
24537
24538 .option connection_max_messages smtp integer 500
24539 .cindex "SMTP" "passed connection"
24540 .cindex "SMTP" "multiple deliveries"
24541 .cindex "multiple SMTP deliveries"
24542 This controls the maximum number of separate message deliveries that are sent
24543 over a single TCP/IP connection. If the value is zero, there is no limit.
24544 For testing purposes, this value can be overridden by the &%-oB%& command line
24545 option.
24546
24547
24548 .option dane_require_tls_ciphers smtp string&!! unset
24549 .cindex "TLS" "requiring specific ciphers for DANE"
24550 .cindex "cipher" "requiring specific"
24551 .cindex DANE "TLS ciphers"
24552 This option may be used to override &%tls_require_ciphers%& for connections
24553 where DANE has been determined to be in effect.
24554 If not set, then &%tls_require_ciphers%& will be used.
24555 Normal SMTP delivery is not able to make strong demands of TLS cipher
24556 configuration, because delivery will fall back to plaintext.  Once DANE has
24557 been determined to be in effect, there is no plaintext fallback and making the
24558 TLS cipherlist configuration stronger will increase security, rather than
24559 counter-intuitively decreasing it.
24560 If the option expands to be empty or is forced to fail, then it will
24561 be treated as unset and &%tls_require_ciphers%& will be used instead.
24562
24563
24564 .option data_timeout smtp time 5m
24565 This sets a timeout for the transmission of each block in the data portion of
24566 the message. As a result, the overall timeout for a message depends on the size
24567 of the message. Its value must not be zero. See also &%final_timeout%&.
24568
24569
24570 .option dkim_canon smtp string&!! unset
24571 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24572 .option dkim_domain smtp string list&!! unset
24573 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24574 .option dkim_hash smtp string&!! sha256
24575 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24576 .option dkim_identity smtp string&!! unset
24577 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24578 .option dkim_private_key smtp string&!! unset
24579 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24580 .option dkim_selector smtp string&!! unset
24581 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24582 .option dkim_strict smtp string&!! unset
24583 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24584 .option dkim_sign_headers smtp string&!! "per RFC"
24585 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24586 .option dkim_timestamps smtp string&!! unset
24587 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24588
24589
24590 .option delay_after_cutoff smtp boolean true
24591 .cindex "final cutoff" "retries, controlling"
24592 .cindex retry "final cutoff"
24593 This option controls what happens when all remote IP addresses for a given
24594 domain have been inaccessible for so long that they have passed their retry
24595 cutoff times.
24596
24597 In the default state, if the next retry time has not been reached for any of
24598 them, the address is bounced without trying any deliveries. In other words,
24599 Exim delays retrying an IP address after the final cutoff time until a new
24600 retry time is reached, and can therefore bounce an address without ever trying
24601 a delivery, when machines have been down for a long time. Some people are
24602 unhappy at this prospect, so...
24603
24604 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24605 addresses are past their final cutoff time, Exim tries to deliver to those
24606 IP addresses that have not been tried since the message arrived. If there are
24607 none, of if they all fail, the address is bounced. In other words, it does not
24608 delay when a new message arrives, but immediately tries those expired IP
24609 addresses that haven't been tried since the message arrived. If there is a
24610 continuous stream of messages for the dead hosts, unsetting
24611 &%delay_after_cutoff%& means that there will be many more attempts to deliver
24612 to them.
24613
24614
24615 .option dns_qualify_single smtp boolean true
24616 If the &%hosts%& or &%fallback_hosts%& option is being used,
24617 and the &%gethostbyname%& option is false,
24618 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
24619 in chapter &<<CHAPdnslookup>>& for more details.
24620
24621
24622 .option dns_search_parents smtp boolean false
24623 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
24624 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
24625 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
24626 details.
24627
24628
24629 .option dnssec_request_domains smtp "domain list&!!" *
24630 .cindex "MX record" "security"
24631 .cindex "DNSSEC" "MX lookup"
24632 .cindex "security" "MX lookup"
24633 .cindex "DNS" "DNSSEC"
24634 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
24635 the dnssec request bit set. Setting this transport option is only useful if the
24636 transport overrides or sets the host names. See the &%dnssec_request_domains%&
24637 router option.
24638
24639
24640
24641 .option dnssec_require_domains smtp "domain list&!!" unset
24642 .cindex "MX record" "security"
24643 .cindex "DNSSEC" "MX lookup"
24644 .cindex "security" "MX lookup"
24645 .cindex "DNS" "DNSSEC"
24646 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
24647 the dnssec request bit set.  Setting this transport option is only
24648 useful if the transport overrides or sets the host names. See the
24649 &%dnssec_require_domains%& router option.
24650
24651
24652
24653 .option dscp smtp string&!! unset
24654 .cindex "DCSP" "outbound"
24655 This option causes the DSCP value associated with a socket to be set to one
24656 of a number of fixed strings or to numeric value.
24657 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
24658 Common values include &`throughput`&, &`mincost`&, and on newer systems
24659 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
24660
24661 The outbound packets from Exim will be marked with this value in the header
24662 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
24663 that these values will have any effect, not be stripped by networking
24664 equipment, or do much of anything without cooperation with your Network
24665 Engineer and those of all network operators between the source and destination.
24666
24667
24668 .option fallback_hosts smtp "string list" unset
24669 .cindex "fallback" "hosts specified on transport"
24670 String expansion is not applied to this option. The argument must be a
24671 colon-separated list of host names or IP addresses, optionally also including
24672 port numbers, though the separator can be changed, as described in section
24673 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24674 item in a &%route_list%& setting for the &(manualroute)& router, as described
24675 in section &<<SECTformatonehostitem>>&.
24676
24677 Fallback hosts can also be specified on routers, which associate them with the
24678 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
24679 &%fallback_hosts%& specified on the transport is used only if the address does
24680 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
24681 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
24682 However, &%hosts_randomize%& does apply to fallback host lists.
24683
24684 If Exim is unable to deliver to any of the hosts for a particular address, and
24685 the errors are not permanent rejections, the address is put on a separate
24686 transport queue with its host list replaced by the fallback hosts, unless the
24687 address was routed via MX records and the current host was in the original MX
24688 list. In that situation, the fallback host list is not used.
24689
24690 Once normal deliveries are complete, the fallback queue is delivered by
24691 re-running the same transports with the new host lists. If several failing
24692 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
24693 copy of the message is sent.
24694
24695 The resolution of the host names on the fallback list is controlled by the
24696 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
24697 both to cases when the host list comes with the address and when it is taken
24698 from &%hosts%&. This option provides a &"use a smart host only if delivery
24699 fails"& facility.
24700
24701
24702 .option final_timeout smtp time 10m
24703 This is the timeout that applies while waiting for the response to the final
24704 line containing just &"."& that terminates a message. Its value must not be
24705 zero.
24706
24707 .option gethostbyname smtp boolean false
24708 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
24709 being used, names are looked up using &[gethostbyname()]&
24710 (or &[getipnodebyname()]& when available)
24711 instead of using the DNS. Of course, that function may in fact use the DNS, but
24712 it may also consult other sources of information such as &_/etc/hosts_&.
24713
24714 .option gnutls_compat_mode smtp boolean unset
24715 This option controls whether GnuTLS is used in compatibility mode in an Exim
24716 server. This reduces security slightly, but improves interworking with older
24717 implementations of TLS.
24718
24719 .option helo_data smtp string&!! "see below"
24720 .cindex "HELO" "argument, setting"
24721 .cindex "EHLO" "argument, setting"
24722 .cindex "LHLO argument setting"
24723 The value of this option is expanded after a connection to a another host has
24724 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
24725 command that starts the outgoing SMTP or LMTP session. The default value of the
24726 option is:
24727 .code
24728 $primary_hostname
24729 .endd
24730 During the expansion, the variables &$host$& and &$host_address$& are set to
24731 the identity of the remote host, and the variables &$sending_ip_address$& and
24732 &$sending_port$& are set to the local IP address and port number that are being
24733 used. These variables can be used to generate different values for different
24734 servers or different local IP addresses. For example, if you want the string
24735 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
24736 interface address, you could use this:
24737 .code
24738 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
24739   {$primary_hostname}}
24740 .endd
24741 The use of &%helo_data%& applies both to sending messages and when doing
24742 callouts.
24743
24744 .option hosts smtp "string list&!!" unset
24745 Hosts are associated with an address by a router such as &(dnslookup)&, which
24746 finds the hosts by looking up the address domain in the DNS, or by
24747 &(manualroute)&, which has lists of hosts in its configuration. However,
24748 email addresses can be passed to the &(smtp)& transport by any router, and not
24749 all of them can provide an associated list of hosts.
24750
24751 The &%hosts%& option specifies a list of hosts to be used if the address being
24752 processed does not have any hosts associated with it. The hosts specified by
24753 &%hosts%& are also used, whether or not the address has its own hosts, if
24754 &%hosts_override%& is set.
24755
24756 The string is first expanded, before being interpreted as a colon-separated
24757 list of host names or IP addresses, possibly including port numbers. The
24758 separator may be changed to something other than colon, as described in section
24759 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24760 item in a &%route_list%& setting for the &(manualroute)& router, as described
24761 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
24762 of the &(manualroute)& router is not available here.
24763
24764 If the expansion fails, delivery is deferred. Unless the failure was caused by
24765 the inability to complete a lookup, the error is logged to the panic log as
24766 well as the main log. Host names are looked up either by searching directly for
24767 address records in the DNS or by calling &[gethostbyname()]& (or
24768 &[getipnodebyname()]& when available), depending on the setting of the
24769 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
24770 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
24771 address are used.
24772
24773 During delivery, the hosts are tried in order, subject to their retry status,
24774 unless &%hosts_randomize%& is set.
24775
24776
24777 .option hosts_avoid_esmtp smtp "host list&!!" unset
24778 .cindex "ESMTP, avoiding use of"
24779 .cindex "HELO" "forcing use of"
24780 .cindex "EHLO" "avoiding use of"
24781 .cindex "PIPELINING" "avoiding the use of"
24782 This option is for use with broken hosts that announce ESMTP facilities (for
24783 example, PIPELINING) and then fail to implement them properly. When a host
24784 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
24785 start of the SMTP session. This means that it cannot use any of the ESMTP
24786 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
24787
24788
24789 .option hosts_avoid_pipelining smtp "host list&!!" unset
24790 .cindex "PIPELINING" "avoiding the use of"
24791 Exim will not use the SMTP PIPELINING extension when delivering to any host
24792 that matches this list, even if the server host advertises PIPELINING support.
24793
24794 .option hosts_pipe_connect smtp "host list&!!" unset
24795 .cindex "pipelining" "early connection"
24796 .cindex "pipelining" PIPE_CONNECT
24797 If Exim is built with the SUPPORT_PIPE_CONNECT build option
24798 this option controls which to hosts the facility watched for
24799 and recorded, and used for subsequent connections.
24800
24801 The retry hints database is used for the record,
24802 and records are subject to the &%retry_data_expire%& option.
24803 When used, the pipelining saves on roundtrip times.
24804 It also turns SMTP into a client-first protocol
24805 so combines well with TCP Fast Open.
24806
24807 See also the &%pipelining_connect_advertise_hosts%& main option.
24808
24809 Note:
24810 When the facility is used, the transport &%helo_data%& option
24811 will be expanded before the &$sending_ip_address$& variable
24812 is filled in.
24813 A check is made for the use of that variable, without the
24814 presence of a &"def:"& test on it, but suitably complex coding
24815 can avoid the check and produce unexpected results.
24816 You have been warned.
24817
24818
24819 .option hosts_avoid_tls smtp "host list&!!" unset
24820 .cindex "TLS" "avoiding for certain hosts"
24821 Exim will not try to start a TLS session when delivering to any host that
24822 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24823
24824 .option hosts_verify_avoid_tls smtp "host list&!!" unset
24825 .cindex "TLS" "avoiding for certain hosts"
24826 Exim will not try to start a TLS session for a verify callout,
24827 or when delivering in cutthrough mode,
24828 to any host that matches this list.
24829
24830
24831 .option hosts_max_try smtp integer 5
24832 .cindex "host" "maximum number to try"
24833 .cindex "limit" "number of hosts tried"
24834 .cindex "limit" "number of MX tried"
24835 .cindex "MX record" "maximum tried"
24836 This option limits the number of IP addresses that are tried for any one
24837 delivery in cases where there are temporary delivery errors. Section
24838 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
24839
24840
24841 .option hosts_max_try_hardlimit smtp integer 50
24842 This is an additional check on the maximum number of IP addresses that Exim
24843 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
24844 why it exists.
24845
24846
24847
24848 .option hosts_nopass_tls smtp "host list&!!" unset
24849 .cindex "TLS" "passing connection"
24850 .cindex "multiple SMTP deliveries"
24851 .cindex "TLS" "multiple message deliveries"
24852 For any host that matches this list, a connection on which a TLS session has
24853 been started will not be passed to a new delivery process for sending another
24854 message on the same connection. See section &<<SECTmulmessam>>& for an
24855 explanation of when this might be needed.
24856
24857 .option hosts_noproxy_tls smtp "host list&!!" unset
24858 .cindex "TLS" "passing connection"
24859 .cindex "multiple SMTP deliveries"
24860 .cindex "TLS" "multiple message deliveries"
24861 For any host that matches this list, a TLS session which has
24862 been started will not be passed to a new delivery process for sending another
24863 message on the same session.
24864
24865 The traditional implementation closes down TLS and re-starts it in the new
24866 process, on the same open TCP connection, for each successive message
24867 sent.  If permitted by this option a pipe to to the new process is set up
24868 instead, and the original process maintains the TLS connection and proxies
24869 the SMTP connection from and to the new process and any subsequents.
24870 The new process has no access to TLS information, so cannot include it in
24871 logging.
24872
24873
24874
24875 .option hosts_override smtp boolean false
24876 If this option is set and the &%hosts%& option is also set, any hosts that are
24877 attached to the address are ignored, and instead the hosts specified by the
24878 &%hosts%& option are always used. This option does not apply to
24879 &%fallback_hosts%&.
24880
24881
24882 .option hosts_randomize smtp boolean false
24883 .cindex "randomized host list"
24884 .cindex "host" "list of; randomized"
24885 .cindex "fallback" "randomized hosts"
24886 If this option is set, and either the list of hosts is taken from the
24887 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
24888 were not obtained from MX records (this includes fallback hosts from the
24889 router), and were not randomized by the router, the order of trying the hosts
24890 is randomized each time the transport runs. Randomizing the order of a host
24891 list can be used to do crude load sharing.
24892
24893 When &%hosts_randomize%& is true, a host list may be split into groups whose
24894 order is separately randomized. This makes it possible to set up MX-like
24895 behaviour. The boundaries between groups are indicated by an item that is just
24896 &`+`& in the host list. For example:
24897 .code
24898 hosts = host1:host2:host3:+:host4:host5
24899 .endd
24900 The order of the first three hosts and the order of the last two hosts is
24901 randomized for each use, but the first three always end up before the last two.
24902 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24903
24904 .option hosts_require_auth smtp "host list&!!" unset
24905 .cindex "authentication" "required by client"
24906 This option provides a list of servers for which authentication must succeed
24907 before Exim will try to transfer a message. If authentication fails for
24908 servers which are not in this list, Exim tries to send unauthenticated. If
24909 authentication fails for one of these servers, delivery is deferred. This
24910 temporary error is detectable in the retry rules, so it can be turned into a
24911 hard failure if required. See also &%hosts_try_auth%&, and chapter
24912 &<<CHAPSMTPAUTH>>& for details of authentication.
24913
24914
24915 .option hosts_request_ocsp smtp "host list&!!" *
24916 .cindex "TLS" "requiring for certain servers"
24917 Exim will request a Certificate Status on a
24918 TLS session for any host that matches this list.
24919 &%tls_verify_certificates%& should also be set for the transport.
24920
24921 .option hosts_require_dane smtp "host list&!!" unset
24922 .cindex DANE "transport options"
24923 .cindex DANE "requiring for certain servers"
24924 If built with DANE support, Exim  will require that a DNSSEC-validated
24925 TLSA record is present for any host matching the list,
24926 and that a DANE-verified TLS connection is made. See
24927 the &%dnssec_request_domains%& router and transport options.
24928 There will be no fallback to in-clear communication.
24929 See section &<<SECDANE>>&.
24930
24931 .option hosts_require_ocsp smtp "host list&!!" unset
24932 .cindex "TLS" "requiring for certain servers"
24933 Exim will request, and check for a valid Certificate Status being given, on a
24934 TLS session for any host that matches this list.
24935 &%tls_verify_certificates%& should also be set for the transport.
24936
24937 .option hosts_require_tls smtp "host list&!!" unset
24938 .cindex "TLS" "requiring for certain servers"
24939 Exim will insist on using a TLS session when delivering to any host that
24940 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24941 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24942 incoming messages, use an appropriate ACL.
24943
24944 .option hosts_try_auth smtp "host list&!!" unset
24945 .cindex "authentication" "optional in client"
24946 This option provides a list of servers to which, provided they announce
24947 authentication support, Exim will attempt to authenticate as a client when it
24948 connects. If authentication fails, Exim will try to transfer the message
24949 unauthenticated. See also &%hosts_require_auth%&, and chapter
24950 &<<CHAPSMTPAUTH>>& for details of authentication.
24951
24952 .option hosts_try_chunking smtp "host list&!!" *
24953 .cindex CHUNKING "enabling, in client"
24954 .cindex BDAT "SMTP command"
24955 .cindex "RFC 3030" "CHUNKING"
24956 This option provides a list of servers to which, provided they announce
24957 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24958 .new
24959 Unless DKIM signing is being done,
24960 .wen
24961 BDAT will not be used in conjunction with a transport filter.
24962
24963 .option hosts_try_dane smtp "host list&!!" *
24964 .cindex DANE "transport options"
24965 .cindex DANE "attempting for certain servers"
24966 If built with DANE support, Exim  will require that a DNSSEC-validated
24967 TLSA record is present for any host matching the list,
24968 and that a DANE-verified TLS connection is made. See
24969 the &%dnssec_request_domains%& router and transport options.
24970 There will be no fallback to in-clear communication.
24971 See section &<<SECDANE>>&.
24972
24973 .option hosts_try_fastopen smtp "host list&!!" *
24974 .cindex "fast open, TCP" "enabling, in client"
24975 .cindex "TCP Fast Open" "enabling, in client"
24976 .cindex "RFC 7413" "TCP Fast Open"
24977 This option provides a list of servers to which, provided
24978 the facility is supported by this system, Exim will attempt to
24979 perform a TCP Fast Open.
24980 No data is sent on the SYN segment but, if the remote server also
24981 supports the facility, it can send its SMTP banner immediately after
24982 the SYN,ACK segment.  This can save up to one round-trip time.
24983
24984 The facility is only active for previously-contacted servers,
24985 as the initiator must present a cookie in the SYN segment.
24986
24987 On (at least some) current Linux distributions the facility must be enabled
24988 in the kernel by the sysadmin before the support is usable.
24989 There is no option for control of the server side; if the system supports
24990 it it is always enabled.  Note that lengthy operations in the connect ACL,
24991 such as DNSBL lookups, will still delay the emission of the SMTP banner.
24992
24993 .option hosts_try_prdr smtp "host list&!!" *
24994 .cindex "PRDR" "enabling, optional in client"
24995 This option provides a list of servers to which, provided they announce
24996 PRDR support, Exim will attempt to negotiate PRDR
24997 for multi-recipient messages.
24998 The option can usually be left as default.
24999
25000 .option interface smtp "string list&!!" unset
25001 .cindex "bind IP address"
25002 .cindex "IP address" "binding"
25003 .vindex "&$host$&"
25004 .vindex "&$host_address$&"
25005 This option specifies which interface to bind to when making an outgoing SMTP
25006 call. The value is an IP address, not an interface name such as
25007 &`eth0`&. Do not confuse this with the interface address that was used when a
25008 message was received, which is in &$received_ip_address$&, formerly known as
25009 &$interface_address$&. The name was changed to minimize confusion with the
25010 outgoing interface address. There is no variable that contains an outgoing
25011 interface address because, unless it is set by this option, its value is
25012 unknown.
25013
25014 During the expansion of the &%interface%& option the variables &$host$& and
25015 &$host_address$& refer to the host to which a connection is about to be made
25016 during the expansion of the string. Forced expansion failure, or an empty
25017 string result causes the option to be ignored. Otherwise, after expansion, the
25018 string must be a list of IP addresses, colon-separated by default, but the
25019 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25020 For example:
25021 .code
25022 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25023 .endd
25024 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25025 connection. If none of them are the correct type, the option is ignored. If
25026 &%interface%& is not set, or is ignored, the system's IP functions choose which
25027 interface to use if the host has more than one.
25028
25029
25030 .option keepalive smtp boolean true
25031 .cindex "keepalive" "on outgoing connection"
25032 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25033 connections. When set, it causes the kernel to probe idle connections
25034 periodically, by sending packets with &"old"& sequence numbers. The other end
25035 of the connection should send a acknowledgment if the connection is still okay
25036 or a reset if the connection has been aborted. The reason for doing this is
25037 that it has the beneficial effect of freeing up certain types of connection
25038 that can get stuck when the remote host is disconnected without tidying up the
25039 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25040 unreachable hosts.
25041
25042
25043 .option lmtp_ignore_quota smtp boolean false
25044 .cindex "LMTP" "ignoring quota errors"
25045 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25046 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25047 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25048
25049 .option max_rcpt smtp integer 100
25050 .cindex "RCPT" "maximum number of outgoing"
25051 This option limits the number of RCPT commands that are sent in a single
25052 SMTP message transaction. Each set of addresses is treated independently, and
25053 so can cause parallel connections to the same host if &%remote_max_parallel%&
25054 permits this.
25055
25056
25057 .option multi_domain smtp boolean&!! true
25058 .vindex "&$domain$&"
25059 When this option is set, the &(smtp)& transport can handle a number of
25060 addresses containing a mixture of different domains provided they all resolve
25061 to the same list of hosts. Turning the option off restricts the transport to
25062 handling only one domain at a time. This is useful if you want to use
25063 &$domain$& in an expansion for the transport, because it is set only when there
25064 is a single domain involved in a remote delivery.
25065
25066 It is expanded per-address and can depend on any of
25067 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25068 &$host$&, &$host_address$& and &$host_port$&.
25069
25070 .option port smtp string&!! "see below"
25071 .cindex "port" "sending TCP/IP"
25072 .cindex "TCP/IP" "setting outgoing port"
25073 This option specifies the TCP/IP port on the server to which Exim connects.
25074 &*Note:*& Do not confuse this with the port that was used when a message was
25075 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25076 The name was changed to minimize confusion with the outgoing port. There is no
25077 variable that contains an outgoing port.
25078
25079 If the value of this option begins with a digit it is taken as a port number;
25080 otherwise it is looked up using &[getservbyname()]&. The default value is
25081 normally &"smtp"&,
25082 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25083 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25084 If the expansion fails, or if a port number cannot be found, delivery
25085 is deferred.
25086
25087 Note that at least one Linux distribution has been seen failing
25088 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25089
25090
25091
25092 .option protocol smtp string smtp
25093 .cindex "LMTP" "over TCP/IP"
25094 .cindex "ssmtp protocol" "outbound"
25095 .cindex "TLS" "SSL-on-connect outbound"
25096 .vindex "&$port$&"
25097 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25098 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25099 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25100 deliveries into closed message stores. Exim also has support for running LMTP
25101 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25102
25103 If this option is set to &"smtps"&, the default value for the &%port%& option
25104 changes to &"smtps"&, and the transport initiates TLS immediately after
25105 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25106 The Internet standards bodies used to strongly discourage use of this mode,
25107 but as of RFC 8314 it is perferred over STARTTLS for message submission
25108 (as distinct from MTA-MTA communication).
25109
25110
25111 .option retry_include_ip_address smtp boolean&!! true
25112 Exim normally includes both the host name and the IP address in the key it
25113 constructs for indexing retry data after a temporary delivery failure. This
25114 means that when one of several IP addresses for a host is failing, it gets
25115 tried periodically (controlled by the retry rules), but use of the other IP
25116 addresses is not affected.
25117
25118 However, in some dialup environments hosts are assigned a different IP address
25119 each time they connect. In this situation the use of the IP address as part of
25120 the retry key leads to undesirable behaviour. Setting this option false causes
25121 Exim to use only the host name.
25122 Since it is expanded it can be made to depend on the host or domain.
25123
25124
25125 .option serialize_hosts smtp "host list&!!" unset
25126 .cindex "serializing connections"
25127 .cindex "host" "serializing connections"
25128 Because Exim operates in a distributed manner, if several messages for the same
25129 host arrive at around the same time, more than one simultaneous connection to
25130 the remote host can occur. This is not usually a problem except when there is a
25131 slow link between the hosts. In that situation it may be helpful to restrict
25132 Exim to one connection at a time. This can be done by setting
25133 &%serialize_hosts%& to match the relevant hosts.
25134
25135 .cindex "hints database" "serializing deliveries to a host"
25136 Exim implements serialization by means of a hints database in which a record is
25137 written whenever a process connects to one of the restricted hosts. The record
25138 is deleted when the connection is completed. Obviously there is scope for
25139 records to get left lying around if there is a system or program crash. To
25140 guard against this, Exim ignores any records that are more than six hours old.
25141
25142 If you set up this kind of serialization, you should also arrange to delete the
25143 relevant hints database whenever your system reboots. The names of the files
25144 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25145 may be one or two files, depending on the type of DBM in use. The same files
25146 are used for ETRN serialization.
25147
25148 See also the &%max_parallel%& generic transport option.
25149
25150
25151 .option size_addition smtp integer 1024
25152 .cindex "SMTP" "SIZE"
25153 .cindex "message" "size issue for transport filter"
25154 .cindex "size" "of message"
25155 .cindex "transport" "filter"
25156 .cindex "filter" "transport filter"
25157 If a remote SMTP server indicates that it supports the SIZE option of the
25158 MAIL command, Exim uses this to pass over the message size at the start of
25159 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25160 sends, to allow for headers and other text that may be added during delivery by
25161 configuration options or in a transport filter. It may be necessary to increase
25162 this if a lot of text is added to messages.
25163
25164 Alternatively, if the value of &%size_addition%& is set negative, it disables
25165 the use of the SIZE option altogether.
25166
25167
25168 .option socks_proxy smtp string&!! unset
25169 .cindex proxy SOCKS
25170 This option enables use of SOCKS proxies for connections made by the
25171 transport.  For details see section &<<SECTproxySOCKS>>&.
25172
25173
25174 .option tls_certificate smtp string&!! unset
25175 .cindex "TLS" "client certificate, location of"
25176 .cindex "certificate" "client, location of"
25177 .vindex "&$host$&"
25178 .vindex "&$host_address$&"
25179 The value of this option must be the absolute path to a file which contains the
25180 client's certificate, for possible use when sending a message over an encrypted
25181 connection. The values of &$host$& and &$host_address$& are set to the name and
25182 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25183 details of TLS.
25184
25185 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25186 certificate when sending messages as a client. The global option of the same
25187 name specifies the certificate for Exim as a server; it is not automatically
25188 assumed that the same certificate should be used when Exim is operating as a
25189 client.
25190
25191
25192 .option tls_crl smtp string&!! unset
25193 .cindex "TLS" "client certificate revocation list"
25194 .cindex "certificate" "revocation list for client"
25195 This option specifies a certificate revocation list. The expanded value must
25196 be the name of a file that contains a CRL in PEM format.
25197
25198
25199 .option tls_dh_min_bits smtp integer 1024
25200 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25201 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25202 key agreement is negotiated, the server will provide a large prime number
25203 for use.  This option establishes the minimum acceptable size of that number.
25204 If the parameter offered by the server is too small, then the TLS handshake
25205 will fail.
25206
25207 Only supported when using GnuTLS.
25208
25209
25210 .option tls_privatekey smtp string&!! unset
25211 .cindex "TLS" "client private key, location of"
25212 .vindex "&$host$&"
25213 .vindex "&$host_address$&"
25214 The value of this option must be the absolute path to a file which contains the
25215 client's private key. This is used when sending a message over an encrypted
25216 connection using a client certificate. The values of &$host$& and
25217 &$host_address$& are set to the name and address of the server during the
25218 expansion. If this option is unset, or the expansion is forced to fail, or the
25219 result is an empty string, the private key is assumed to be in the same file as
25220 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25221
25222
25223 .option tls_require_ciphers smtp string&!! unset
25224 .cindex "TLS" "requiring specific ciphers"
25225 .cindex "cipher" "requiring specific"
25226 .vindex "&$host$&"
25227 .vindex "&$host_address$&"
25228 The value of this option must be a list of permitted cipher suites, for use
25229 when setting up an outgoing encrypted connection. (There is a global option of
25230 the same name for controlling incoming connections.) The values of &$host$& and
25231 &$host_address$& are set to the name and address of the server during the
25232 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25233 is used in different ways by OpenSSL and GnuTLS (see sections
25234 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25235 ciphers is a preference order.
25236
25237
25238
25239 .option tls_sni smtp string&!! unset
25240 .cindex "TLS" "Server Name Indication"
25241 .vindex "&$tls_sni$&"
25242 If this option is set then it sets the $tls_out_sni variable and causes any
25243 TLS session to pass this value as the Server Name Indication extension to
25244 the remote side, which can be used by the remote side to select an appropriate
25245 certificate and private key for the session.
25246
25247 See &<<SECTtlssni>>& for more information.
25248
25249 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25250 TLS extensions.
25251
25252
25253
25254
25255 .option tls_tempfail_tryclear smtp boolean true
25256 .cindex "4&'xx'& responses" "to STARTTLS"
25257 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25258 setting up a TLS session, this option determines whether or not Exim should try
25259 to deliver the message unencrypted. If it is set false, delivery to the
25260 current host is deferred; if there are other hosts, they are tried. If this
25261 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25262 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25263 TLS negotiation fails, Exim closes the current connection (because it is in an
25264 unknown state), opens a new one to the same host, and then tries the delivery
25265 in clear.
25266
25267
25268 .option tls_try_verify_hosts smtp "host list&!!" *
25269 .cindex "TLS" "server certificate verification"
25270 .cindex "certificate" "verification of server"
25271 This option gives a list of hosts for which, on encrypted connections,
25272 certificate verification will be tried but need not succeed.
25273 The &%tls_verify_certificates%& option must also be set.
25274 Note that unless the host is in this list
25275 TLS connections will be denied to hosts using self-signed certificates
25276 when &%tls_verify_certificates%& is matched.
25277 The &$tls_out_certificate_verified$& variable is set when
25278 certificate verification succeeds.
25279
25280
25281 .option tls_verify_cert_hostnames smtp "host list&!!" *
25282 .cindex "TLS" "server certificate hostname verification"
25283 .cindex "certificate" "verification of server"
25284 This option give a list of hosts for which,
25285 while verifying the server certificate,
25286 checks will be included on the host name
25287 (note that this will generally be the result of a DNS MX lookup)
25288 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25289 limited to being the initial component of a 3-or-more component FQDN.
25290
25291 There is no equivalent checking on client certificates.
25292
25293
25294 .option tls_verify_certificates smtp string&!! system
25295 .cindex "TLS" "server certificate verification"
25296 .cindex "certificate" "verification of server"
25297 .vindex "&$host$&"
25298 .vindex "&$host_address$&"
25299 The value of this option must be either the
25300 word "system"
25301 or the absolute path to
25302 a file or directory containing permitted certificates for servers,
25303 for use when setting up an encrypted connection.
25304
25305 The "system" value for the option will use a location compiled into the SSL library.
25306 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25307 is taken as empty and an explicit location
25308 must be specified.
25309
25310 The use of a directory for the option value is not available for GnuTLS versions
25311 preceding 3.3.6 and a single file must be used.
25312
25313 With OpenSSL the certificates specified
25314 explicitly
25315 either by file or directory
25316 are added to those given by the system default location.
25317
25318 The values of &$host$& and
25319 &$host_address$& are set to the name and address of the server during the
25320 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25321
25322 For back-compatibility,
25323 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25324 (a single-colon empty list counts as being set)
25325 and certificate verification fails the TLS connection is closed.
25326
25327
25328 .option tls_verify_hosts smtp "host list&!!" unset
25329 .cindex "TLS" "server certificate verification"
25330 .cindex "certificate" "verification of server"
25331 This option gives a list of hosts for which, on encrypted connections,
25332 certificate verification must succeed.
25333 The &%tls_verify_certificates%& option must also be set.
25334 If both this option and &%tls_try_verify_hosts%& are unset
25335 operation is as if this option selected all hosts.
25336
25337 .option utf8_downconvert smtp integer!! unset
25338 .cindex utf8 "address downconversion"
25339 .cindex i18n "utf8 address downconversion"
25340 If built with internationalization support,
25341 this option controls conversion of UTF-8 in message addresses
25342 to a-label form.
25343 For details see section &<<SECTi18nMTA>>&.
25344
25345
25346
25347
25348 .section "How the limits for the number of hosts to try are used" &&&
25349          "SECTvalhosmax"
25350 .cindex "host" "maximum number to try"
25351 .cindex "limit" "hosts; maximum number tried"
25352 There are two options that are concerned with the number of hosts that are
25353 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25354 &%hosts_max_try_hardlimit%&.
25355
25356
25357 The &%hosts_max_try%& option limits the number of hosts that are tried
25358 for a single delivery. However, despite the term &"host"& in its name, the
25359 option actually applies to each IP address independently. In other words, a
25360 multihomed host is treated as several independent hosts, just as it is for
25361 retrying.
25362
25363 Many of the larger ISPs have multiple MX records which often point to
25364 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25365 created as a result of routing one of these domains.
25366
25367 Trying every single IP address on such a long list does not seem sensible; if
25368 several at the top of the list fail, it is reasonable to assume there is some
25369 problem that is likely to affect all of them. Roughly speaking, the value of
25370 &%hosts_max_try%& is the maximum number that are tried before deferring the
25371 delivery. However, the logic cannot be quite that simple.
25372
25373 Firstly, IP addresses that are skipped because their retry times have not
25374 arrived do not count, and in addition, addresses that are past their retry
25375 limits are also not counted, even when they are tried. This means that when
25376 some IP addresses are past their retry limits, more than the value of
25377 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25378 that all IP addresses are considered before timing out an email address (but
25379 see below for an exception).
25380
25381 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25382 list to see if there is a subsequent host with a different (higher valued) MX.
25383 If there is, that host is considered next, and the current IP address is used
25384 but not counted. This behaviour helps in the case of a domain with a retry rule
25385 that hardly ever delays any hosts, as is now explained:
25386
25387 Consider the case of a long list of hosts with one MX value, and a few with a
25388 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25389 hosts at the top of the list are tried at first. With the default retry rule,
25390 which specifies increasing retry times, the higher MX hosts are eventually
25391 tried when those at the top of the list are skipped because they have not
25392 reached their retry times.
25393
25394 However, it is common practice to put a fixed short retry time on domains for
25395 large ISPs, on the grounds that their servers are rarely down for very long.
25396 Unfortunately, these are exactly the domains that tend to resolve to long lists
25397 of hosts. The short retry time means that the lowest MX hosts are tried every
25398 time. The attempts may be in a different order because of random sorting, but
25399 without the special MX check, the higher MX hosts would never be tried until
25400 all the lower MX hosts had timed out (which might be several days), because
25401 there are always some lower MX hosts that have reached their retry times. With
25402 the special check, Exim considers at least one IP address from each MX value at
25403 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25404 reached.
25405
25406 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25407 particular, Exim normally eventually tries all the IP addresses before timing
25408 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25409 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25410 been set up with hundreds of IP addresses for some domains. It can
25411 take a very long time indeed for an address to time out in these cases.
25412
25413 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25414 Exim never tries more than this number of IP addresses; if it hits this limit
25415 and they are all timed out, the email address is bounced, even though not all
25416 possible IP addresses have been tried.
25417 .ecindex IIDsmttra1
25418 .ecindex IIDsmttra2
25419
25420
25421
25422
25423
25424 . ////////////////////////////////////////////////////////////////////////////
25425 . ////////////////////////////////////////////////////////////////////////////
25426
25427 .chapter "Address rewriting" "CHAPrewrite"
25428 .scindex IIDaddrew "rewriting" "addresses"
25429 There are some circumstances in which Exim automatically rewrites domains in
25430 addresses. The two most common are when an address is given without a domain
25431 (referred to as an &"unqualified address"&) or when an address contains an
25432 abbreviated domain that is expanded by DNS lookup.
25433
25434 Unqualified envelope addresses are accepted only for locally submitted
25435 messages, or for messages that are received from hosts matching
25436 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25437 appropriate. Unqualified addresses in header lines are qualified if they are in
25438 locally submitted messages, or messages from hosts that are permitted to send
25439 unqualified envelope addresses. Otherwise, unqualified addresses in header
25440 lines are neither qualified nor rewritten.
25441
25442 One situation in which Exim does &'not'& automatically rewrite a domain is
25443 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25444 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25445 do this. The new RFCs do not contain this suggestion.
25446
25447
25448 .section "Explicitly configured address rewriting" "SECID147"
25449 This chapter describes the rewriting rules that can be used in the
25450 main rewrite section of the configuration file, and also in the generic
25451 &%headers_rewrite%& option that can be set on any transport.
25452
25453 Some people believe that configured address rewriting is a Mortal Sin.
25454 Others believe that life is not possible without it. Exim provides the
25455 facility; you do not have to use it.
25456
25457 The main rewriting rules that appear in the &"rewrite"& section of the
25458 configuration file are applied to addresses in incoming messages, both envelope
25459 addresses and addresses in header lines. Each rule specifies the types of
25460 address to which it applies.
25461
25462 Whether or not addresses in header lines are rewritten depends on the origin of
25463 the headers and the type of rewriting. Global rewriting, that is, rewriting
25464 rules from the rewrite section of the configuration file, is applied only to
25465 those headers that were received with the message. Header lines that are added
25466 by ACLs or by a system filter or by individual routers or transports (which
25467 are specific to individual recipient addresses) are not rewritten by the global
25468 rules.
25469
25470 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25471 applies all headers except those added by routers and transports. That is, as
25472 well as the headers that were received with the message, it also applies to
25473 headers that were added by an ACL or a system filter.
25474
25475
25476 In general, rewriting addresses from your own system or domain has some
25477 legitimacy. Rewriting other addresses should be done only with great care and
25478 in special circumstances. The author of Exim believes that rewriting should be
25479 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25480 Although it can sometimes be used as a routing tool, this is very strongly
25481 discouraged.
25482
25483 There are two commonly encountered circumstances where rewriting is used, as
25484 illustrated by these examples:
25485
25486 .ilist
25487 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25488 exchange mail with each other behind a firewall, but there is only a single
25489 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25490 &'hitch.fict.example'& when sending mail off-site.
25491 .next
25492 A host rewrites the local parts of its own users so that, for example,
25493 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25494 .endlist
25495
25496
25497
25498 .section "When does rewriting happen?" "SECID148"
25499 .cindex "rewriting" "timing of"
25500 .cindex "&ACL;" "rewriting addresses in"
25501 Configured address rewriting can take place at several different stages of a
25502 message's processing.
25503
25504 .vindex "&$sender_address$&"
25505 At the start of an ACL for MAIL, the sender address may have been rewritten
25506 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25507 ordinary rewrite rules have yet been applied. If, however, the sender address
25508 is verified in the ACL, it is rewritten before verification, and remains
25509 rewritten thereafter. The subsequent value of &$sender_address$& is the
25510 rewritten address. This also applies if sender verification happens in a
25511 RCPT ACL. Otherwise, when the sender address is not verified, it is
25512 rewritten as soon as a message's header lines have been received.
25513
25514 .vindex "&$domain$&"
25515 .vindex "&$local_part$&"
25516 Similarly, at the start of an ACL for RCPT, the current recipient's address
25517 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25518 rewrite rules have yet been applied to it. However, the behaviour is different
25519 from the sender address when a recipient is verified. The address is rewritten
25520 for the verification, but the rewriting is not remembered at this stage. The
25521 value of &$local_part$& and &$domain$& after verification are always the same
25522 as they were before (that is, they contain the unrewritten &-- except for
25523 SMTP-time rewriting &-- address).
25524
25525 As soon as a message's header lines have been received, all the envelope
25526 recipient addresses are permanently rewritten, and rewriting is also applied to
25527 the addresses in the header lines (if configured). This happens before adding
25528 any header lines that were specified in MAIL or RCPT ACLs, and
25529 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25530 before the DATA ACL and &[local_scan()]& functions are run.
25531
25532 When an address is being routed, either for delivery or for verification,
25533 rewriting is applied immediately to child addresses that are generated by
25534 redirection, unless &%no_rewrite%& is set on the router.
25535
25536 .cindex "envelope from"
25537 .cindex "envelope sender" "rewriting at transport time"
25538 .cindex "rewriting" "at transport time"
25539 .cindex "header lines" "rewriting at transport time"
25540 At transport time, additional rewriting of addresses in header lines can be
25541 specified by setting the generic &%headers_rewrite%& option on a transport.
25542 This option contains rules that are identical in form to those in the rewrite
25543 section of the configuration file. They are applied to the original message
25544 header lines and any that were added by ACLs or a system filter. They are not
25545 applied to header lines that are added by routers or the transport.
25546
25547 The outgoing envelope sender can be rewritten by means of the &%return_path%&
25548 transport option. However, it is not possible to rewrite envelope recipients at
25549 transport time.
25550
25551
25552
25553
25554 .section "Testing the rewriting rules that apply on input" "SECID149"
25555 .cindex "rewriting" "testing"
25556 .cindex "testing" "rewriting"
25557 Exim's input rewriting configuration appears in a part of the runtime
25558 configuration file headed by &"begin rewrite"&. It can be tested by the
25559 &%-brw%& command line option. This takes an address (which can be a full RFC
25560 2822 address) as its argument. The output is a list of how the address would be
25561 transformed by the rewriting rules for each of the different places it might
25562 appear in an incoming message, that is, for each different header and for the
25563 envelope sender and recipient fields. For example,
25564 .code
25565 exim -brw ph10@exim.workshop.example
25566 .endd
25567 might produce the output
25568 .code
25569 sender: Philip.Hazel@exim.workshop.example
25570 from: Philip.Hazel@exim.workshop.example
25571 to: ph10@exim.workshop.example
25572 cc: ph10@exim.workshop.example
25573 bcc: ph10@exim.workshop.example
25574 reply-to: Philip.Hazel@exim.workshop.example
25575 env-from: Philip.Hazel@exim.workshop.example
25576 env-to: ph10@exim.workshop.example
25577 .endd
25578 which shows that rewriting has been set up for that address when used in any of
25579 the source fields, but not when it appears as a recipient address. At the
25580 present time, there is no equivalent way of testing rewriting rules that are
25581 set for a particular transport.
25582
25583
25584 .section "Rewriting rules" "SECID150"
25585 .cindex "rewriting" "rules"
25586 The rewrite section of the configuration file consists of lines of rewriting
25587 rules in the form
25588 .display
25589 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
25590 .endd
25591 Rewriting rules that are specified for the &%headers_rewrite%& generic
25592 transport option are given as a colon-separated list. Each item in the list
25593 takes the same form as a line in the main rewriting configuration (except that
25594 any colons must be doubled, of course).
25595
25596 The formats of source patterns and replacement strings are described below.
25597 Each is terminated by white space, unless enclosed in double quotes, in which
25598 case normal quoting conventions apply inside the quotes. The flags are single
25599 characters which may appear in any order. Spaces and tabs between them are
25600 ignored.
25601
25602 For each address that could potentially be rewritten, the rules are scanned in
25603 order, and replacements for the address from earlier rules can themselves be
25604 replaced by later rules (but see the &"q"& and &"R"& flags).
25605
25606 The order in which addresses are rewritten is undefined, may change between
25607 releases, and must not be relied on, with one exception: when a message is
25608 received, the envelope sender is always rewritten first, before any header
25609 lines are rewritten. For example, the replacement string for a rewrite of an
25610 address in &'To:'& must not assume that the message's address in &'From:'& has
25611 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
25612 that the envelope sender has already been rewritten.
25613
25614 .vindex "&$domain$&"
25615 .vindex "&$local_part$&"
25616 The variables &$local_part$& and &$domain$& can be used in the replacement
25617 string to refer to the address that is being rewritten. Note that lookup-driven
25618 rewriting can be done by a rule of the form
25619 .code
25620 *@*   ${lookup ...
25621 .endd
25622 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
25623 refer to the address that is being rewritten.
25624
25625
25626 .section "Rewriting patterns" "SECID151"
25627 .cindex "rewriting" "patterns"
25628 .cindex "address list" "in a rewriting pattern"
25629 The source pattern in a rewriting rule is any item which may appear in an
25630 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
25631 single-item address list, which means that it is expanded before being tested
25632 against the address. As always, if you use a regular expression as a pattern,
25633 you must take care to escape dollar and backslash characters, or use the &`\N`&
25634 facility to suppress string expansion within the regular expression.
25635
25636 Domains in patterns should be given in lower case. Local parts in patterns are
25637 case-sensitive. If you want to do case-insensitive matching of local parts, you
25638 can use a regular expression that starts with &`^(?i)`&.
25639
25640 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
25641 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
25642 depending on the type of match which occurred. These can be used in the
25643 replacement string to insert portions of the incoming address. &$0$& always
25644 refers to the complete incoming address. When a regular expression is used, the
25645 numerical variables are set from its capturing subexpressions. For other types
25646 of pattern they are set as follows:
25647
25648 .ilist
25649 If a local part or domain starts with an asterisk, the numerical variables
25650 refer to the character strings matched by asterisks, with &$1$& associated with
25651 the first asterisk, and &$2$& with the second, if present. For example, if the
25652 pattern
25653 .code
25654 *queen@*.fict.example
25655 .endd
25656 is matched against the address &'hearts-queen@wonderland.fict.example'& then
25657 .code
25658 $0 = hearts-queen@wonderland.fict.example
25659 $1 = hearts-
25660 $2 = wonderland
25661 .endd
25662 Note that if the local part does not start with an asterisk, but the domain
25663 does, it is &$1$& that contains the wild part of the domain.
25664
25665 .next
25666 If the domain part of the pattern is a partial lookup, the wild and fixed parts
25667 of the domain are placed in the next available numerical variables. Suppose,
25668 for example, that the address &'foo@bar.baz.example'& is processed by a
25669 rewriting rule of the form
25670 .display
25671 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
25672 .endd
25673 and the key in the file that matches the domain is &`*.baz.example`&. Then
25674 .code
25675 $1 = foo
25676 $2 = bar
25677 $3 = baz.example
25678 .endd
25679 If the address &'foo@baz.example'& is looked up, this matches the same
25680 wildcard file entry, and in this case &$2$& is set to the empty string, but
25681 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
25682 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
25683 whole domain. For non-partial domain lookups, no numerical variables are set.
25684 .endlist
25685
25686
25687 .section "Rewriting replacements" "SECID152"
25688 .cindex "rewriting" "replacements"
25689 If the replacement string for a rule is a single asterisk, addresses that
25690 match the pattern and the flags are &'not'& rewritten, and no subsequent
25691 rewriting rules are scanned. For example,
25692 .code
25693 hatta@lookingglass.fict.example  *  f
25694 .endd
25695 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
25696 &'From:'& headers.
25697
25698 .vindex "&$domain$&"
25699 .vindex "&$local_part$&"
25700 If the replacement string is not a single asterisk, it is expanded, and must
25701 yield a fully qualified address. Within the expansion, the variables
25702 &$local_part$& and &$domain$& refer to the address that is being rewritten.
25703 Any letters they contain retain their original case &-- they are not lower
25704 cased. The numerical variables are set up according to the type of pattern that
25705 matched the address, as described above. If the expansion is forced to fail by
25706 the presence of &"fail"& in a conditional or lookup item, rewriting by the
25707 current rule is abandoned, but subsequent rules may take effect. Any other
25708 expansion failure causes the entire rewriting operation to be abandoned, and an
25709 entry written to the panic log.
25710
25711
25712
25713 .section "Rewriting flags" "SECID153"
25714 There are three different kinds of flag that may appear on rewriting rules:
25715
25716 .ilist
25717 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
25718 c, f, h, r, s, t.
25719 .next
25720 A flag that specifies rewriting at SMTP time: S.
25721 .next
25722 Flags that control the rewriting process: Q, q, R, w.
25723 .endlist
25724
25725 For rules that are part of the &%headers_rewrite%& generic transport option,
25726 E, F, T, and S are not permitted.
25727
25728
25729
25730 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
25731          "SECID154"
25732 .cindex "rewriting" "flags"
25733 If none of the following flag letters, nor the &"S"& flag (see section
25734 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
25735 and to both the sender and recipient fields of the envelope, whereas a
25736 transport-time rewriting rule just applies to all headers. Otherwise, the
25737 rewriting rule is skipped unless the relevant addresses are being processed.
25738 .display
25739 &`E`&       rewrite all envelope fields
25740 &`F`&       rewrite the envelope From field
25741 &`T`&       rewrite the envelope To field
25742 &`b`&       rewrite the &'Bcc:'& header
25743 &`c`&       rewrite the &'Cc:'& header
25744 &`f`&       rewrite the &'From:'& header
25745 &`h`&       rewrite all headers
25746 &`r`&       rewrite the &'Reply-To:'& header
25747 &`s`&       rewrite the &'Sender:'& header
25748 &`t`&       rewrite the &'To:'& header
25749 .endd
25750 "All headers" means all of the headers listed above that can be selected
25751 individually, plus their &'Resent-'& versions. It does not include
25752 other headers such as &'Subject:'& etc.
25753
25754 You should be particularly careful about rewriting &'Sender:'& headers, and
25755 restrict this to special known cases in your own domains.
25756
25757
25758 .section "The SMTP-time rewriting flag" "SECTrewriteS"
25759 .cindex "SMTP" "rewriting malformed addresses"
25760 .cindex "RCPT" "rewriting argument of"
25761 .cindex "MAIL" "rewriting argument of"
25762 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
25763 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
25764 before any other processing; even before syntax checking. The pattern is
25765 required to be a regular expression, and it is matched against the whole of the
25766 data for the command, including any surrounding angle brackets.
25767
25768 .vindex "&$domain$&"
25769 .vindex "&$local_part$&"
25770 This form of rewrite rule allows for the handling of addresses that are not
25771 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
25772 input). Because the input is not required to be a syntactically valid address,
25773 the variables &$local_part$& and &$domain$& are not available during the
25774 expansion of the replacement string. The result of rewriting replaces the
25775 original address in the MAIL or RCPT command.
25776
25777
25778 .section "Flags controlling the rewriting process" "SECID155"
25779 There are four flags which control the way the rewriting process works. These
25780 take effect only when a rule is invoked, that is, when the address is of the
25781 correct type (matches the flags) and matches the pattern:
25782
25783 .ilist
25784 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
25785 unqualified local part. It is qualified with &%qualify_recipient%&. In the
25786 absence of &"Q"& the rewritten address must always include a domain.
25787 .next
25788 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
25789 even if no rewriting actually takes place because of a &"fail"& in the
25790 expansion. The &"q"& flag is not effective if the address is of the wrong type
25791 (does not match the flags) or does not match the pattern.
25792 .next
25793 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
25794 address, up to ten times. It can be combined with the &"q"& flag, to stop
25795 rewriting once it fails to match (after at least one successful rewrite).
25796 .next
25797 .cindex "rewriting" "whole addresses"
25798 When an address in a header is rewritten, the rewriting normally applies only
25799 to the working part of the address, with any comments and RFC 2822 &"phrase"&
25800 left unchanged. For example, rewriting might change
25801 .code
25802 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
25803 .endd
25804 into
25805 .code
25806 From: Ford Prefect <prefectf@hitch.fict.example>
25807 .endd
25808 .cindex "RFC 2047"
25809 Sometimes there is a need to replace the whole address item, and this can be
25810 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
25811 causes an address in a header line to be rewritten, the entire address is
25812 replaced, not just the working part. The replacement must be a complete RFC
25813 2822 address, including the angle brackets if necessary. If text outside angle
25814 brackets contains a character whose value is greater than 126 or less than 32
25815 (except for tab), the text is encoded according to RFC 2047. The character set
25816 is taken from &%headers_charset%&, which gets its default at build time.
25817
25818 When the &"w"& flag is set on a rule that causes an envelope address to be
25819 rewritten, all but the working part of the replacement address is discarded.
25820 .endlist
25821
25822
25823 .section "Rewriting examples" "SECID156"
25824 Here is an example of the two common rewriting paradigms:
25825 .code
25826 *@*.hitch.fict.example  $1@hitch.fict.example
25827 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
25828                      {$value}fail}@hitch.fict.example bctfrF
25829 .endd
25830 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
25831 the string expansion to fail if the lookup does not succeed. In this context it
25832 has the effect of leaving the original address unchanged, but Exim goes on to
25833 consider subsequent rewriting rules, if any, because the &"q"& flag is not
25834 present in that rule. An alternative to &"fail"& would be to supply &$1$&
25835 explicitly, which would cause the rewritten address to be the same as before,
25836 at the cost of a small bit of processing. Not supplying either of these is an
25837 error, since the rewritten address would then contain no local part.
25838
25839 The first example above replaces the domain with a superior, more general
25840 domain. This may not be desirable for certain local parts. If the rule
25841 .code
25842 root@*.hitch.fict.example  *
25843 .endd
25844 were inserted before the first rule, rewriting would be suppressed for the
25845 local part &'root'& at any domain ending in &'hitch.fict.example'&.
25846
25847 Rewriting can be made conditional on a number of tests, by making use of
25848 &${if$& in the expansion item. For example, to apply a rewriting rule only to
25849 messages that originate outside the local host:
25850 .code
25851 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
25852                          {$1@hitch.fict.example}fail}"
25853 .endd
25854 The replacement string is quoted in this example because it contains white
25855 space.
25856
25857 .cindex "rewriting" "bang paths"
25858 .cindex "bang paths" "rewriting"
25859 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
25860 an address it treats it as an unqualified local part which it qualifies with
25861 the local qualification domain (if the source of the message is local or if the
25862 remote host is permitted to send unqualified addresses). Rewriting can
25863 sometimes be used to handle simple bang paths with a fixed number of
25864 components. For example, the rule
25865 .code
25866 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
25867 .endd
25868 rewrites a two-component bang path &'host.name!user'& as the domain address
25869 &'user@host.name'&. However, there is a security implication in using this as
25870 a global rewriting rule for envelope addresses. It can provide a backdoor
25871 method for using your system as a relay, because the incoming addresses appear
25872 to be local. If the bang path addresses are received via SMTP, it is safer to
25873 use the &"S"& flag to rewrite them as they are received, so that relay checking
25874 can be done on the rewritten addresses.
25875 .ecindex IIDaddrew
25876
25877
25878
25879
25880
25881 . ////////////////////////////////////////////////////////////////////////////
25882 . ////////////////////////////////////////////////////////////////////////////
25883
25884 .chapter "Retry configuration" "CHAPretry"
25885 .scindex IIDretconf1 "retry" "configuration, description of"
25886 .scindex IIDregconf2 "configuration file" "retry section"
25887 The &"retry"& section of the runtime configuration file contains a list of
25888 retry rules that control how often Exim tries to deliver messages that cannot
25889 be delivered at the first attempt. If there are no retry rules (the section is
25890 empty or not present), there are no retries. In this situation, temporary
25891 errors are treated as permanent. The default configuration contains a single,
25892 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
25893 line option can be used to test which retry rule will be used for a given
25894 address, domain and error.
25895
25896 The most common cause of retries is temporary failure to deliver to a remote
25897 host because the host is down, or inaccessible because of a network problem.
25898 Exim's retry processing in this case is applied on a per-host (strictly, per IP
25899 address) basis, not on a per-message basis. Thus, if one message has recently
25900 been delayed, delivery of a new message to the same host is not immediately
25901 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
25902 log selector is set, the message
25903 .cindex "retry" "time not reached"
25904 &"retry time not reached"& is written to the main log whenever a delivery is
25905 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
25906 the handling of errors during remote deliveries.
25907
25908 Retry processing applies to routing as well as to delivering, except as covered
25909 in the next paragraph. The retry rules do not distinguish between these
25910 actions. It is not possible, for example, to specify different behaviour for
25911 failures to route the domain &'snark.fict.example'& and failures to deliver to
25912 the host &'snark.fict.example'&. I didn't think anyone would ever need this
25913 added complication, so did not implement it. However, although they share the
25914 same retry rule, the actual retry times for routing and transporting a given
25915 domain are maintained independently.
25916
25917 When a delivery is not part of a queue run (typically an immediate delivery on
25918 receipt of a message), the routers are always run, and local deliveries are
25919 always attempted, even if retry times are set for them. This makes for better
25920 behaviour if one particular message is causing problems (for example, causing
25921 quota overflow, or provoking an error in a filter file). If such a delivery
25922 suffers a temporary failure, the retry data is updated as normal, and
25923 subsequent delivery attempts from queue runs occur only when the retry time for
25924 the local address is reached.
25925
25926 .section "Changing retry rules" "SECID157"
25927 If you change the retry rules in your configuration, you should consider
25928 whether or not to delete the retry data that is stored in Exim's spool area in
25929 files with names like &_db/retry_&. Deleting any of Exim's hints files is
25930 always safe; that is why they are called &"hints"&.
25931
25932 The hints retry data contains suggested retry times based on the previous
25933 rules. In the case of a long-running problem with a remote host, it might
25934 record the fact that the host has timed out. If your new rules increase the
25935 timeout time for such a host, you should definitely remove the old retry data
25936 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
25937 messages that it should now be retaining.
25938
25939
25940
25941 .section "Format of retry rules" "SECID158"
25942 .cindex "retry" "rules"
25943 Each retry rule occupies one line and consists of three or four parts,
25944 separated by white space: a pattern, an error name, an optional list of sender
25945 addresses, and a list of retry parameters. The pattern and sender lists must be
25946 enclosed in double quotes if they contain white space. The rules are searched
25947 in order until one is found where the pattern, error name, and sender list (if
25948 present) match the failing host or address, the error that occurred, and the
25949 message's sender, respectively.
25950
25951
25952 The pattern is any single item that may appear in an address list (see section
25953 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
25954 which means that it is expanded before being tested against the address that
25955 has been delayed. A negated address list item is permitted. Address
25956 list processing treats a plain domain name as if it were preceded by &"*@"&,
25957 which makes it possible for many retry rules to start with just a domain. For
25958 example,
25959 .code
25960 lookingglass.fict.example        *  F,24h,30m;
25961 .endd
25962 provides a rule for any address in the &'lookingglass.fict.example'& domain,
25963 whereas
25964 .code
25965 alice@lookingglass.fict.example  *  F,24h,30m;
25966 .endd
25967 applies only to temporary failures involving the local part &%alice%&.
25968 In practice, almost all rules start with a domain name pattern without a local
25969 part.
25970
25971 .cindex "regular expressions" "in retry rules"
25972 &*Warning*&: If you use a regular expression in a retry rule pattern, it
25973 must match a complete address, not just a domain, because that is how regular
25974 expressions work in address lists.
25975 .display
25976 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
25977 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
25978 .endd
25979
25980
25981 .section "Choosing which retry rule to use for address errors" "SECID159"
25982 When Exim is looking for a retry rule after a routing attempt has failed (for
25983 example, after a DNS timeout), each line in the retry configuration is tested
25984 against the complete address only if &%retry_use_local_part%& is set for the
25985 router. Otherwise, only the domain is used, except when matching against a
25986 regular expression, when the local part of the address is replaced with &"*"&.
25987 A domain on its own can match a domain pattern, or a pattern that starts with
25988 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
25989 &%check_local_user%& is true, and false for other routers.
25990
25991 Similarly, when Exim is looking for a retry rule after a local delivery has
25992 failed (for example, after a mailbox full error), each line in the retry
25993 configuration is tested against the complete address only if
25994 &%retry_use_local_part%& is set for the transport (it defaults true for all
25995 local transports).
25996
25997 .cindex "4&'xx'& responses" "retry rules for"
25998 However, when Exim is looking for a retry rule after a remote delivery attempt
25999 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26000 whole address is always used as the key when searching the retry rules. The
26001 rule that is found is used to create a retry time for the combination of the
26002 failing address and the message's sender. It is the combination of sender and
26003 recipient that is delayed in subsequent queue runs until its retry time is
26004 reached. You can delay the recipient without regard to the sender by setting
26005 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26006 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26007 commands.
26008
26009
26010
26011 .section "Choosing which retry rule to use for host and message errors" &&&
26012          "SECID160"
26013 For a temporary error that is not related to an individual address (for
26014 example, a connection timeout), each line in the retry configuration is checked
26015 twice. First, the name of the remote host is used as a domain name (preceded by
26016 &"*@"& when matching a regular expression). If this does not match the line,
26017 the domain from the email address is tried in a similar fashion. For example,
26018 suppose the MX records for &'a.b.c.example'& are
26019 .code
26020 a.b.c.example  MX  5  x.y.z.example
26021                MX  6  p.q.r.example
26022                MX  7  m.n.o.example
26023 .endd
26024 and the retry rules are
26025 .code
26026 p.q.r.example    *      F,24h,30m;
26027 a.b.c.example    *      F,4d,45m;
26028 .endd
26029 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26030 first rule matches neither the host nor the domain, so Exim looks at the second
26031 rule. This does not match the host, but it does match the domain, so it is used
26032 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26033 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26034 first retry rule is used, because it matches the host.
26035
26036 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26037 first rule to determine retry times, but for all the other hosts for the domain
26038 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26039 routing to &'a.b.c.example'& suffers a temporary failure.
26040
26041 &*Note*&: The host name is used when matching the patterns, not its IP address.
26042 However, if a message is routed directly to an IP address without the use of a
26043 host name, for example, if a &(manualroute)& router contains a setting such as:
26044 .code
26045 route_list = *.a.example  192.168.34.23
26046 .endd
26047 then the &"host name"& that is used when searching for a retry rule is the
26048 textual form of the IP address.
26049
26050 .section "Retry rules for specific errors" "SECID161"
26051 .cindex "retry" "specific errors; specifying"
26052 The second field in a retry rule is the name of a particular error, or an
26053 asterisk, which matches any error. The errors that can be tested for are:
26054
26055 .vlist
26056 .vitem &%auth_failed%&
26057 Authentication failed when trying to send to a host in the
26058 &%hosts_require_auth%& list in an &(smtp)& transport.
26059
26060 .vitem &%data_4xx%&
26061 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26062 after the command, or after sending the message's data.
26063
26064 .vitem &%mail_4xx%&
26065 A 4&'xx'& error was received for an outgoing MAIL command.
26066
26067 .vitem &%rcpt_4xx%&
26068 A 4&'xx'& error was received for an outgoing RCPT command.
26069 .endlist
26070
26071 For the three 4&'xx'& errors, either the first or both of the x's can be given
26072 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26073 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26074 and have retries every ten minutes with a one-hour timeout, you could set up a
26075 retry rule of this form:
26076 .code
26077 the.domain.name  rcpt_452   F,1h,10m
26078 .endd
26079 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26080 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26081
26082 .vlist
26083 .vitem &%lost_connection%&
26084 A server unexpectedly closed the SMTP connection. There may, of course,
26085 legitimate reasons for this (host died, network died), but if it repeats a lot
26086 for the same host, it indicates something odd.
26087
26088 .vitem &%lookup%&
26089 A DNS lookup for a host failed.
26090 Note that a &%dnslookup%& router will need to have matched
26091 its &%fail_defer_domains%& option for this retry type to be usable.
26092 Also note that a &%manualroute%& router will probably need
26093 its &%host_find_failed%& option set to &%defer%&.
26094
26095 .vitem &%refused_MX%&
26096 A connection to a host obtained from an MX record was refused.
26097
26098 .vitem &%refused_A%&
26099 A connection to a host not obtained from an MX record was refused.
26100
26101 .vitem &%refused%&
26102 A connection was refused.
26103
26104 .vitem &%timeout_connect_MX%&
26105 A connection attempt to a host obtained from an MX record timed out.
26106
26107 .vitem &%timeout_connect_A%&
26108 A connection attempt to a host not obtained from an MX record timed out.
26109
26110 .vitem &%timeout_connect%&
26111 A connection attempt timed out.
26112
26113 .vitem &%timeout_MX%&
26114 There was a timeout while connecting or during an SMTP session with a host
26115 obtained from an MX record.
26116
26117 .vitem &%timeout_A%&
26118 There was a timeout while connecting or during an SMTP session with a host not
26119 obtained from an MX record.
26120
26121 .vitem &%timeout%&
26122 There was a timeout while connecting or during an SMTP session.
26123
26124 .vitem &%tls_required%&
26125 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26126 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26127 to STARTTLS, or there was a problem setting up the TLS connection.
26128
26129 .vitem &%quota%&
26130 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26131 transport.
26132
26133 .vitem &%quota_%&<&'time'&>
26134 .cindex "quota" "error testing in retry rule"
26135 .cindex "retry" "quota error testing"
26136 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26137 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26138 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26139 for four days.
26140 .endlist
26141
26142 .cindex "mailbox" "time of last read"
26143 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26144 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26145 it should be based on the last time that the user accessed the mailbox.
26146 However, it is not always possible to determine this. Exim uses the following
26147 heuristic rules:
26148
26149 .ilist
26150 If the mailbox is a single file, the time of last access (the &"atime"&) is
26151 used. As no new messages are being delivered (because the mailbox is over
26152 quota), Exim does not access the file, so this is the time of last user access.
26153 .next
26154 .cindex "maildir format" "time of last read"
26155 For a maildir delivery, the time of last modification of the &_new_&
26156 subdirectory is used. As the mailbox is over quota, no new files are created in
26157 the &_new_& subdirectory, because no new messages are being delivered. Any
26158 change to the &_new_& subdirectory is therefore assumed to be the result of an
26159 MUA moving a new message to the &_cur_& directory when it is first read. The
26160 time that is used is therefore the last time that the user read a new message.
26161 .next
26162 For other kinds of multi-file mailbox, the time of last access cannot be
26163 obtained, so a retry rule that uses this type of error field is never matched.
26164 .endlist
26165
26166 The quota errors apply both to system-enforced quotas and to Exim's own quota
26167 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26168 when a local delivery is deferred because a partition is full (the ENOSPC
26169 error).
26170
26171
26172
26173 .section "Retry rules for specified senders" "SECID162"
26174 .cindex "retry" "rules; sender-specific"
26175 You can specify retry rules that apply only when the failing message has a
26176 specific sender. In particular, this can be used to define retry rules that
26177 apply only to bounce messages. The third item in a retry rule can be of this
26178 form:
26179 .display
26180 &`senders=`&<&'address list'&>
26181 .endd
26182 The retry timings themselves are then the fourth item. For example:
26183 .code
26184 *   rcpt_4xx   senders=:   F,1h,30m
26185 .endd
26186 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26187 host. If the address list contains white space, it must be enclosed in quotes.
26188 For example:
26189 .code
26190 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26191 .endd
26192 &*Warning*&: This facility can be unhelpful if it is used for host errors
26193 (which do not depend on the recipient). The reason is that the sender is used
26194 only to match the retry rule. Once the rule has been found for a host error,
26195 its contents are used to set a retry time for the host, and this will apply to
26196 all messages, not just those with specific senders.
26197
26198 When testing retry rules using &%-brt%&, you can supply a sender using the
26199 &%-f%& command line option, like this:
26200 .code
26201 exim -f "" -brt user@dom.ain
26202 .endd
26203 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26204 list is never matched.
26205
26206
26207
26208
26209
26210 .section "Retry parameters" "SECID163"
26211 .cindex "retry" "parameters in rules"
26212 The third (or fourth, if a senders list is present) field in a retry rule is a
26213 sequence of retry parameter sets, separated by semicolons. Each set consists of
26214 .display
26215 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26216 .endd
26217 The letter identifies the algorithm for computing a new retry time; the cutoff
26218 time is the time beyond which this algorithm no longer applies, and the
26219 arguments vary the algorithm's action. The cutoff time is measured from the
26220 time that the first failure for the domain (combined with the local part if
26221 relevant) was detected, not from the time the message was received.
26222
26223 .cindex "retry" "algorithms"
26224 .cindex "retry" "fixed intervals"
26225 .cindex "retry" "increasing intervals"
26226 .cindex "retry" "random intervals"
26227 The available algorithms are:
26228
26229 .ilist
26230 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26231 the interval.
26232 .next
26233 &'G'&: retry at geometrically increasing intervals. The first argument
26234 specifies a starting value for the interval, and the second a multiplier, which
26235 is used to increase the size of the interval at each retry.
26236 .next
26237 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26238 retry, the previous interval is multiplied by the factor in order to get a
26239 maximum for the next interval. The minimum interval is the first argument of
26240 the parameter, and an actual interval is chosen randomly between them. Such a
26241 rule has been found to be helpful in cluster configurations when all the
26242 members of the cluster restart at once, and may therefore synchronize their
26243 queue processing times.
26244 .endlist
26245
26246 When computing the next retry time, the algorithm definitions are scanned in
26247 order until one whose cutoff time has not yet passed is reached. This is then
26248 used to compute a new retry time that is later than the current time. In the
26249 case of fixed interval retries, this simply means adding the interval to the
26250 current time. For geometrically increasing intervals, retry intervals are
26251 computed from the rule's parameters until one that is greater than the previous
26252 interval is found. The main configuration variable
26253 .cindex "limit" "retry interval"
26254 .cindex "retry" "interval, maximum"
26255 .oindex "&%retry_interval_max%&"
26256 &%retry_interval_max%& limits the maximum interval between retries. It
26257 cannot be set greater than &`24h`&, which is its default value.
26258
26259 A single remote domain may have a number of hosts associated with it, and each
26260 host may have more than one IP address. Retry algorithms are selected on the
26261 basis of the domain name, but are applied to each IP address independently. If,
26262 for example, a host has two IP addresses and one is unusable, Exim will
26263 generate retry times for it and will not try to use it until its next retry
26264 time comes. Thus the good IP address is likely to be tried first most of the
26265 time.
26266
26267 .cindex "hints database" "use for retrying"
26268 Retry times are hints rather than promises. Exim does not make any attempt to
26269 run deliveries exactly at the computed times. Instead, a queue runner process
26270 starts delivery processes for delayed messages periodically, and these attempt
26271 new deliveries only for those addresses that have passed their next retry time.
26272 If a new message arrives for a deferred address, an immediate delivery attempt
26273 occurs only if the address has passed its retry time. In the absence of new
26274 messages, the minimum time between retries is the interval between queue runner
26275 processes. There is not much point in setting retry times of five minutes if
26276 your queue runners happen only once an hour, unless there are a significant
26277 number of incoming messages (which might be the case on a system that is
26278 sending everything to a smart host, for example).
26279
26280 The data in the retry hints database can be inspected by using the
26281 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26282 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26283 &'exinext'& utility script can be used to find out what the next retry times
26284 are for the hosts associated with a particular mail domain, and also for local
26285 deliveries that have been deferred.
26286
26287
26288 .section "Retry rule examples" "SECID164"
26289 Here are some example retry rules:
26290 .code
26291 alice@wonderland.fict.example quota_5d  F,7d,3h
26292 wonderland.fict.example       quota_5d
26293 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26294 lookingglass.fict.example     *         F,24h,30m;
26295 *                 refused_A   F,2h,20m;
26296 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26297 .endd
26298 The first rule sets up special handling for mail to
26299 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26300 mailbox has not been read for at least 5 days. Retries continue every three
26301 hours for 7 days. The second rule handles over-quota errors for all other local
26302 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26303 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26304 fail are bounced immediately if the mailbox has not been read for at least 5
26305 days.
26306
26307 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26308 happen every 15 minutes for an hour, then with geometrically increasing
26309 intervals until two days have passed since a delivery first failed. After the
26310 first hour there is a delay of one hour, then two hours, then four hours, and
26311 so on (this is a rather extreme example).
26312
26313 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26314 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26315 all other domains, with special action for connection refusal from hosts that
26316 were not obtained from an MX record.
26317
26318 The final rule in a retry configuration should always have asterisks in the
26319 first two fields so as to provide a general catch-all for any addresses that do
26320 not have their own special handling. This example tries every 15 minutes for 2
26321 hours, then with intervals starting at one hour and increasing by a factor of
26322 1.5 up to 16 hours, then every 8 hours up to 5 days.
26323
26324
26325
26326 .section "Timeout of retry data" "SECID165"
26327 .cindex "timeout" "of retry data"
26328 .oindex "&%retry_data_expire%&"
26329 .cindex "hints database" "data expiry"
26330 .cindex "retry" "timeout of data"
26331 Exim timestamps the data that it writes to its retry hints database. When it
26332 consults the data during a delivery it ignores any that is older than the value
26333 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26334 been tried for 7 days, Exim will try to deliver to it immediately a message
26335 arrives, and if that fails, it will calculate a retry time as if it were
26336 failing for the first time.
26337
26338 This improves the behaviour for messages routed to rarely-used hosts such as MX
26339 backups. If such a host was down at one time, and happens to be down again when
26340 Exim tries a month later, using the old retry data would imply that it had been
26341 down all the time, which is not a justified assumption.
26342
26343 If a host really is permanently dead, this behaviour causes a burst of retries
26344 every now and again, but only if messages routed to it are rare. If there is a
26345 message at least once every 7 days the retry data never expires.
26346
26347
26348
26349
26350 .section "Long-term failures" "SECID166"
26351 .cindex "delivery failure, long-term"
26352 .cindex "retry" "after long-term failure"
26353 Special processing happens when an email address has been failing for so long
26354 that the cutoff time for the last algorithm is reached. For example, using the
26355 default retry rule:
26356 .code
26357 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26358 .endd
26359 the cutoff time is four days. Reaching the retry cutoff is independent of how
26360 long any specific message has been failing; it is the length of continuous
26361 failure for the recipient address that counts.
26362
26363 When the cutoff time is reached for a local delivery, or for all the IP
26364 addresses associated with a remote delivery, a subsequent delivery failure
26365 causes Exim to give up on the address, and a bounce message is generated.
26366 In order to cater for new messages that use the failing address, a next retry
26367 time is still computed from the final algorithm, and is used as follows:
26368
26369 For local deliveries, one delivery attempt is always made for any subsequent
26370 messages. If this delivery fails, the address fails immediately. The
26371 post-cutoff retry time is not used.
26372
26373 .cindex "final cutoff" "retries, controlling"
26374 .cindex retry "final cutoff"
26375 If the delivery is remote, there are two possibilities, controlled by the
26376 .oindex "&%delay_after_cutoff%&"
26377 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26378 default. Until the post-cutoff retry time for one of the IP addresses,
26379 as set by the &%retry_data_expire%& option, is
26380 reached, the failing email address is bounced immediately, without a delivery
26381 attempt taking place. After that time, one new delivery attempt is made to
26382 those IP addresses that are past their retry times, and if that still fails,
26383 the address is bounced and new retry times are computed.
26384
26385 In other words, when all the hosts for a given email address have been failing
26386 for a long time, Exim bounces rather then defers until one of the hosts' retry
26387 times is reached. Then it tries once, and bounces if that attempt fails. This
26388 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26389 to a broken destination, but if the host does recover, Exim will eventually
26390 notice.
26391
26392 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26393 addresses are past their final cutoff time, Exim tries to deliver to those IP
26394 addresses that have not been tried since the message arrived. If there are
26395 no suitable IP addresses, or if they all fail, the address is bounced. In other
26396 words, it does not delay when a new message arrives, but tries the expired
26397 addresses immediately, unless they have been tried since the message arrived.
26398 If there is a continuous stream of messages for the failing domains, setting
26399 &%delay_after_cutoff%& false means that there will be many more attempts to
26400 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26401 true.
26402
26403 .section "Deliveries that work intermittently" "SECID167"
26404 .cindex "retry" "intermittently working deliveries"
26405 Some additional logic is needed to cope with cases where a host is
26406 intermittently available, or when a message has some attribute that prevents
26407 its delivery when others to the same address get through. In this situation,
26408 because some messages are successfully delivered, the &"retry clock"& for the
26409 host or address keeps getting reset by the successful deliveries, and so
26410 failing messages remain in the queue for ever because the cutoff time is never
26411 reached.
26412
26413 Two exceptional actions are applied to prevent this happening. The first
26414 applies to errors that are related to a message rather than a remote host.
26415 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26416 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26417 commands, and quota failures. For this type of error, if a message's arrival
26418 time is earlier than the &"first failed"& time for the error, the earlier time
26419 is used when scanning the retry rules to decide when to try next and when to
26420 time out the address.
26421
26422 The exceptional second action applies in all cases. If a message has been on
26423 the queue for longer than the cutoff time of any applicable retry rule for a
26424 given address, a delivery is attempted for that address, even if it is not yet
26425 time, and if this delivery fails, the address is timed out. A new retry time is
26426 not computed in this case, so that other messages for the same address are
26427 considered immediately.
26428 .ecindex IIDretconf1
26429 .ecindex IIDregconf2
26430
26431
26432
26433
26434
26435
26436 . ////////////////////////////////////////////////////////////////////////////
26437 . ////////////////////////////////////////////////////////////////////////////
26438
26439 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26440 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26441 .scindex IIDauthconf2 "authentication"
26442 The &"authenticators"& section of Exim's runtime configuration is concerned
26443 with SMTP authentication. This facility is an extension to the SMTP protocol,
26444 described in RFC 2554, which allows a client SMTP host to authenticate itself
26445 to a server. This is a common way for a server to recognize clients that are
26446 permitted to use it as a relay. SMTP authentication is not of relevance to the
26447 transfer of mail between servers that have no managerial connection with each
26448 other.
26449
26450 .cindex "AUTH" "description of"
26451 Very briefly, the way SMTP authentication works is as follows:
26452
26453 .ilist
26454 The server advertises a number of authentication &'mechanisms'& in response to
26455 the client's EHLO command.
26456 .next
26457 The client issues an AUTH command, naming a specific mechanism. The command
26458 may, optionally, contain some authentication data.
26459 .next
26460 The server may issue one or more &'challenges'&, to which the client must send
26461 appropriate responses. In simple authentication mechanisms, the challenges are
26462 just prompts for user names and passwords. The server does not have to issue
26463 any challenges &-- in some mechanisms the relevant data may all be transmitted
26464 with the AUTH command.
26465 .next
26466 The server either accepts or denies authentication.
26467 .next
26468 If authentication succeeds, the client may optionally make use of the AUTH
26469 option on the MAIL command to pass an authenticated sender in subsequent
26470 mail transactions. Authentication lasts for the remainder of the SMTP
26471 connection.
26472 .next
26473 If authentication fails, the client may give up, or it may try a different
26474 authentication mechanism, or it may try transferring mail over the
26475 unauthenticated connection.
26476 .endlist
26477
26478 If you are setting up a client, and want to know which authentication
26479 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26480 SMTP port) on the server, and issue an EHLO command. The response to this
26481 includes the list of supported mechanisms. For example:
26482 .display
26483 &`$ `&&*&`telnet server.example 25`&*&
26484 &`Trying 192.168.34.25...`&
26485 &`Connected to server.example.`&
26486 &`Escape character is &#x0027;^]&#x0027;.`&
26487 &`220 server.example ESMTP Exim 4.20 ...`&
26488 &*&`ehlo client.example`&*&
26489 &`250-server.example Hello client.example [10.8.4.5]`&
26490 &`250-SIZE 52428800`&
26491 &`250-PIPELINING`&
26492 &`250-AUTH PLAIN`&
26493 &`250 HELP`&
26494 .endd
26495 The second-last line of this example output shows that the server supports
26496 authentication using the PLAIN mechanism. In Exim, the different authentication
26497 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26498 routers and transports, which authenticators are included in the binary is
26499 controlled by build-time definitions. The following are currently available,
26500 included by setting
26501 .code
26502 AUTH_CRAM_MD5=yes
26503 AUTH_CYRUS_SASL=yes
26504 AUTH_DOVECOT=yes
26505 AUTH_EXTERNAL=yes
26506 AUTH_GSASL=yes
26507 AUTH_HEIMDAL_GSSAPI=yes
26508 AUTH_PLAINTEXT=yes
26509 AUTH_SPA=yes
26510 AUTH_TLS=yes
26511 .endd
26512 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
26513 authentication mechanism (RFC 2195), and the second provides an interface to
26514 the Cyrus SASL authentication library.
26515 The third is an interface to Dovecot's authentication system, delegating the
26516 work via a socket interface.
26517 The fourth provides for negotiation of authentication done via non-SMTP means,
26518 as defined by RFC 4422 Appendix A.
26519 The fifth provides an interface to the GNU SASL authentication library, which
26520 provides mechanisms but typically not data sources.
26521 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26522 supporting setting a server keytab.
26523 The seventh can be configured to support
26524 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26525 not formally documented, but used by several MUAs.
26526 The eighth authenticator
26527 supports Microsoft's &'Secure Password Authentication'& mechanism.
26528 The last is an Exim authenticator but not an SMTP one;
26529 instead it can use information from a TLS negotiation.
26530
26531 The authenticators are configured using the same syntax as other drivers (see
26532 section &<<SECTfordricon>>&). If no authenticators are required, no
26533 authentication section need be present in the configuration file. Each
26534 authenticator can in principle have both server and client functions. When Exim
26535 is receiving SMTP mail, it is acting as a server; when it is sending out
26536 messages over SMTP, it is acting as a client. Authenticator configuration
26537 options are provided for use in both these circumstances.
26538
26539 To make it clear which options apply to which situation, the prefixes
26540 &%server_%& and &%client_%& are used on option names that are specific to
26541 either the server or the client function, respectively. Server and client
26542 functions are disabled if none of their options are set. If an authenticator is
26543 to be used for both server and client functions, a single definition, using
26544 both sets of options, is required. For example:
26545 .code
26546 cram:
26547   driver = cram_md5
26548   public_name = CRAM-MD5
26549   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
26550   client_name = ph10
26551   client_secret = secret2
26552 .endd
26553 The &%server_%& option is used when Exim is acting as a server, and the
26554 &%client_%& options when it is acting as a client.
26555
26556 Descriptions of the individual authenticators are given in subsequent chapters.
26557 The remainder of this chapter covers the generic options for the
26558 authenticators, followed by general discussion of the way authentication works
26559 in Exim.
26560
26561 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
26562 per-mechanism basis.  Please read carefully to determine which variables hold
26563 account labels such as usercodes and which hold passwords or other
26564 authenticating data.
26565
26566 Note that some mechanisms support two different identifiers for accounts: the
26567 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
26568 and &'authz'& are commonly encountered.  The American spelling is standard here.
26569 Conceptually, authentication data such as passwords are tied to the identifier
26570 used to authenticate; servers may have rules to permit one user to act as a
26571 second user, so that after login the session is treated as though that second
26572 user had logged in.  That second user is the &'authorization id'&.  A robust
26573 configuration might confirm that the &'authz'& field is empty or matches the
26574 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
26575 as verified data, the &'authz'& as an unverified request which the server might
26576 choose to honour.
26577
26578 A &'realm'& is a text string, typically a domain name, presented by a server
26579 to a client to help it select an account and credentials to use.  In some
26580 mechanisms, the client and server provably agree on the realm, but clients
26581 typically can not treat the realm as secure data to be blindly trusted.
26582
26583
26584
26585 .section "Generic options for authenticators" "SECID168"
26586 .cindex "authentication" "generic options"
26587 .cindex "options" "generic; for authenticators"
26588
26589 .option client_condition authenticators string&!! unset
26590 When Exim is authenticating as a client, it skips any authenticator whose
26591 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
26592 used, for example, to skip plain text authenticators when the connection is not
26593 encrypted by a setting such as:
26594 .code
26595 client_condition = ${if !eq{$tls_out_cipher}{}}
26596 .endd
26597
26598
26599 .option client_set_id authenticators string&!! unset
26600 When client authentication succeeds, this condition is expanded; the
26601 result is used in the log lines for outbound messages.
26602 Typically it will be the user name used for authentication.
26603
26604
26605 .option driver authenticators string unset
26606 This option must always be set. It specifies which of the available
26607 authenticators is to be used.
26608
26609
26610 .option public_name authenticators string unset
26611 This option specifies the name of the authentication mechanism that the driver
26612 implements, and by which it is known to the outside world. These names should
26613 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
26614 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
26615 defaults to the driver's instance name.
26616
26617
26618 .option server_advertise_condition authenticators string&!! unset
26619 When a server is about to advertise an authentication mechanism, the condition
26620 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
26621 mechanism is not advertised.
26622 If the expansion fails, the mechanism is not advertised. If the failure was not
26623 forced, and was not caused by a lookup defer, the incident is logged.
26624 See section &<<SECTauthexiser>>& below for further discussion.
26625
26626
26627 .option server_condition authenticators string&!! unset
26628 This option must be set for a &%plaintext%& server authenticator, where it
26629 is used directly to control authentication. See section &<<SECTplainserver>>&
26630 for details.
26631
26632 For the &(gsasl)& authenticator, this option is required for various
26633 mechanisms; see chapter &<<CHAPgsasl>>& for details.
26634
26635 For the other authenticators, &%server_condition%& can be used as an additional
26636 authentication or authorization mechanism that is applied after the other
26637 authenticator conditions succeed. If it is set, it is expanded when the
26638 authenticator would otherwise return a success code. If the expansion is forced
26639 to fail, authentication fails. Any other expansion failure causes a temporary
26640 error code to be returned. If the result of a successful expansion is an empty
26641 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26642 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
26643 other result, a temporary error code is returned, with the expanded string as
26644 the error text.
26645
26646
26647 .option server_debug_print authenticators string&!! unset
26648 If this option is set and authentication debugging is enabled (see the &%-d%&
26649 command line option), the string is expanded and included in the debugging
26650 output when the authenticator is run as a server. This can help with checking
26651 out the values of variables.
26652 If expansion of the string fails, the error message is written to the debugging
26653 output, and Exim carries on processing.
26654
26655
26656 .option server_set_id authenticators string&!! unset
26657 .vindex "&$authenticated_id$&"
26658 .vindex "&$authenticated_fail_id$&"
26659 When an Exim server successfully authenticates a client, this string is
26660 expanded using data from the authentication, and preserved for any incoming
26661 messages in the variable &$authenticated_id$&. It is also included in the log
26662 lines for incoming messages. For example, a user/password authenticator
26663 configuration might preserve the user name that was used to authenticate, and
26664 refer to it subsequently during delivery of the message.
26665 On a failing authentication the expansion result is instead saved in
26666 the &$authenticated_fail_id$& variable.
26667 If expansion fails, the option is ignored.
26668
26669
26670 .option server_mail_auth_condition authenticators string&!! unset
26671 This option allows a server to discard authenticated sender addresses supplied
26672 as part of MAIL commands in SMTP connections that are authenticated by the
26673 driver on which &%server_mail_auth_condition%& is set. The option is not used
26674 as part of the authentication process; instead its (unexpanded) value is
26675 remembered for later use.
26676 How it is used is described in the following section.
26677
26678
26679
26680
26681
26682 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
26683 .cindex "authentication" "sender; authenticated"
26684 .cindex "AUTH" "on MAIL command"
26685 When a client supplied an AUTH= item on a MAIL command, Exim applies
26686 the following checks before accepting it as the authenticated sender of the
26687 message:
26688
26689 .ilist
26690 If the connection is not using extended SMTP (that is, HELO was used rather
26691 than EHLO), the use of AUTH= is a syntax error.
26692 .next
26693 If the value of the AUTH= parameter is &"<>"&, it is ignored.
26694 .next
26695 .vindex "&$authenticated_sender$&"
26696 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
26697 running, the value of &$authenticated_sender$& is set to the value obtained
26698 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
26699 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
26700 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
26701 given for the MAIL command.
26702 .next
26703 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
26704 is accepted and placed in &$authenticated_sender$& only if the client has
26705 authenticated.
26706 .next
26707 If the AUTH= value was accepted by either of the two previous rules, and
26708 the client has authenticated, and the authenticator has a setting for the
26709 &%server_mail_auth_condition%&, the condition is checked at this point. The
26710 valued that was saved from the authenticator is expanded. If the expansion
26711 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
26712 &$authenticated_sender$& is deleted. If the expansion yields any other value,
26713 the value of &$authenticated_sender$& is retained and passed on with the
26714 message.
26715 .endlist
26716
26717
26718 When &$authenticated_sender$& is set for a message, it is passed on to other
26719 hosts to which Exim authenticates as a client. Do not confuse this value with
26720 &$authenticated_id$&, which is a string obtained from the authentication
26721 process, and which is not usually a complete email address.
26722
26723 .vindex "&$sender_address$&"
26724 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
26725 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
26726 therefore make use of &$authenticated_sender$&. The converse is not true: the
26727 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
26728 ACL is run.
26729
26730
26731
26732 .section "Authentication on an Exim server" "SECTauthexiser"
26733 .cindex "authentication" "on an Exim server"
26734 When Exim receives an EHLO command, it advertises the public names of those
26735 authenticators that are configured as servers, subject to the following
26736 conditions:
26737
26738 .ilist
26739 The client host must match &%auth_advertise_hosts%& (default *).
26740 .next
26741 It the &%server_advertise_condition%& option is set, its expansion must not
26742 yield the empty string, &"0"&, &"no"&, or &"false"&.
26743 .endlist
26744
26745 The order in which the authenticators are defined controls the order in which
26746 the mechanisms are advertised.
26747
26748 Some mail clients (for example, some versions of Netscape) require the user to
26749 provide a name and password for authentication whenever AUTH is advertised,
26750 even though authentication may not in fact be needed (for example, Exim may be
26751 set up to allow unconditional relaying from the client by an IP address check).
26752 You can make such clients more friendly by not advertising AUTH to them.
26753 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
26754 that runs for RCPT) to relay without authentication, you should set
26755 .code
26756 auth_advertise_hosts = ! 10.9.8.0/24
26757 .endd
26758 so that no authentication mechanisms are advertised to them.
26759
26760 The &%server_advertise_condition%& controls the advertisement of individual
26761 authentication mechanisms. For example, it can be used to restrict the
26762 advertisement of a particular mechanism to encrypted connections, by a setting
26763 such as:
26764 .code
26765 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
26766 .endd
26767 .vindex "&$tls_in_cipher$&"
26768 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
26769 yields &"yes"&, which allows the advertisement to happen.
26770
26771 When an Exim server receives an AUTH command from a client, it rejects it
26772 immediately if AUTH was not advertised in response to an earlier EHLO
26773 command. This is the case if
26774
26775 .ilist
26776 The client host does not match &%auth_advertise_hosts%&; or
26777 .next
26778 No authenticators are configured with server options; or
26779 .next
26780 Expansion of &%server_advertise_condition%& blocked the advertising of all the
26781 server authenticators.
26782 .endlist
26783
26784
26785 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
26786 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
26787 AUTH is accepted from any client host.
26788
26789 If AUTH is not rejected by the ACL, Exim searches its configuration for a
26790 server authentication mechanism that was advertised in response to EHLO and
26791 that matches the one named in the AUTH command. If it finds one, it runs
26792 the appropriate authentication protocol, and authentication either succeeds or
26793 fails. If there is no matching advertised mechanism, the AUTH command is
26794 rejected with a 504 error.
26795
26796 .vindex "&$received_protocol$&"
26797 .vindex "&$sender_host_authenticated$&"
26798 When a message is received from an authenticated host, the value of
26799 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
26800 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
26801 public name) of the authenticator driver that successfully authenticated the
26802 client from which the message was received. This variable is empty if there was
26803 no successful authentication.
26804
26805 .cindex authentication "expansion item"
26806 Successful authentication sets up information used by the
26807 &%authresults%& expansion item.
26808
26809
26810
26811
26812 .section "Testing server authentication" "SECID169"
26813 .cindex "authentication" "testing a server"
26814 .cindex "AUTH" "testing a server"
26815 .cindex "base64 encoding" "creating authentication test data"
26816 Exim's &%-bh%& option can be useful for testing server authentication
26817 configurations. The data for the AUTH command has to be sent using base64
26818 encoding. A quick way to produce such data for testing is the following Perl
26819 script:
26820 .code
26821 use MIME::Base64;
26822 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
26823 .endd
26824 .cindex "binary zero" "in authentication data"
26825 This interprets its argument as a Perl string, and then encodes it. The
26826 interpretation as a Perl string allows binary zeros, which are required for
26827 some kinds of authentication, to be included in the data. For example, a
26828 command line to run this script on such data might be
26829 .code
26830 encode '\0user\0password'
26831 .endd
26832 Note the use of single quotes to prevent the shell interpreting the
26833 backslashes, so that they can be interpreted by Perl to specify characters
26834 whose code value is zero.
26835
26836 &*Warning 1*&: If either of the user or password strings starts with an octal
26837 digit, you must use three zeros instead of one after the leading backslash. If
26838 you do not, the octal digit that starts your string will be incorrectly
26839 interpreted as part of the code for the first character.
26840
26841 &*Warning 2*&: If there are characters in the strings that Perl interprets
26842 specially, you must use a Perl escape to prevent them being misinterpreted. For
26843 example, a command such as
26844 .code
26845 encode '\0user@domain.com\0pas$$word'
26846 .endd
26847 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
26848
26849 If you have the &%mimencode%& command installed, another way to do produce
26850 base64-encoded strings is to run the command
26851 .code
26852 echo -e -n `\0user\0password' | mimencode
26853 .endd
26854 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
26855 in the argument, and the &%-n%& option specifies no newline at the end of its
26856 output. However, not all versions of &%echo%& recognize these options, so you
26857 should check your version before relying on this suggestion.
26858
26859
26860
26861 .section "Authentication by an Exim client" "SECID170"
26862 .cindex "authentication" "on an Exim client"
26863 The &(smtp)& transport has two options called &%hosts_require_auth%& and
26864 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
26865 announces support for authentication, and the host matches an entry in either
26866 of these options, Exim (as a client) tries to authenticate as follows:
26867
26868 .ilist
26869 For each authenticator that is configured as a client, in the order in which
26870 they are defined in the configuration, it searches the authentication
26871 mechanisms announced by the server for one whose name matches the public name
26872 of the authenticator.
26873 .next
26874 .vindex "&$host$&"
26875 .vindex "&$host_address$&"
26876 When it finds one that matches, it runs the authenticator's client code. The
26877 variables &$host$& and &$host_address$& are available for any string expansions
26878 that the client might do. They are set to the server's name and IP address. If
26879 any expansion is forced to fail, the authentication attempt is abandoned, and
26880 Exim moves on to the next authenticator. Otherwise an expansion failure causes
26881 delivery to be deferred.
26882 .next
26883 If the result of the authentication attempt is a temporary error or a timeout,
26884 Exim abandons trying to send the message to the host for the moment. It will
26885 try again later. If there are any backup hosts available, they are tried in the
26886 usual way.
26887 .next
26888 If the response to authentication is a permanent error (5&'xx'& code), Exim
26889 carries on searching the list of authenticators and tries another one if
26890 possible. If all authentication attempts give permanent errors, or if there are
26891 no attempts because no mechanisms match (or option expansions force failure),
26892 what happens depends on whether the host matches &%hosts_require_auth%& or
26893 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
26894 delivery is deferred. The error can be detected in the retry rules, and thereby
26895 turned into a permanent error if you wish. In the second case, Exim tries to
26896 deliver the message unauthenticated.
26897 .endlist
26898
26899 Note that the hostlist test for whether to do authentication can be
26900 confused if name-IP lookups change between the time the peer is decided
26901 upon and the time that the transport runs.  For example, with a manualroute
26902 router given a host name, and with DNS "round-robin" used by that name: if
26903 the local resolver cache times out between the router and the transport
26904 running, the transport may get an IP for the name for its authentication
26905 check which does not match the connection peer IP.
26906 No authentication will then be done, despite the names being identical.
26907
26908 For such cases use a separate transport which always authenticates.
26909
26910 .cindex "AUTH" "on MAIL command"
26911 When Exim has authenticated itself to a remote server, it adds the AUTH
26912 parameter to the MAIL commands it sends, if it has an authenticated sender for
26913 the message. If the message came from a remote host, the authenticated sender
26914 is the one that was receiving on an incoming MAIL command, provided that the
26915 incoming connection was authenticated and the &%server_mail_auth%& condition
26916 allowed the authenticated sender to be retained. If a local process calls Exim
26917 to send a message, the sender address that is built from the login name and
26918 &%qualify_domain%& is treated as authenticated. However, if the
26919 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
26920 the authenticated sender that was received with the message.
26921 .ecindex IIDauthconf1
26922 .ecindex IIDauthconf2
26923
26924
26925
26926
26927
26928
26929 . ////////////////////////////////////////////////////////////////////////////
26930 . ////////////////////////////////////////////////////////////////////////////
26931
26932 .chapter "The plaintext authenticator" "CHAPplaintext"
26933 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
26934 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
26935 The &(plaintext)& authenticator can be configured to support the PLAIN and
26936 LOGIN authentication mechanisms, both of which transfer authentication data as
26937 plain (unencrypted) text (though base64 encoded). The use of plain text is a
26938 security risk; you are strongly advised to insist on the use of SMTP encryption
26939 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
26940 use unencrypted plain text, you should not use the same passwords for SMTP
26941 connections as you do for login accounts.
26942
26943 .section "Avoiding cleartext use" "SECTplain_TLS"
26944 The following generic option settings will disable &(plaintext)& authenticators when
26945 TLS is not being used:
26946 .code
26947   server_advertise_condition = ${if def:tls_in_cipher }
26948   client_condition =           ${if def:tls_out_cipher}
26949 .endd
26950
26951 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
26952 but is still vulnerable to a Man In The Middle attack unless certificates
26953 (including their names) have been properly verified.
26954
26955 .section "Plaintext server options" "SECID171"
26956 .cindex "options" "&(plaintext)& authenticator (server)"
26957 When configured as a server, &(plaintext)& uses the following options:
26958
26959 .option server_condition authenticators string&!! unset
26960 This is actually a global authentication option, but it must be set in order to
26961 configure the &(plaintext)& driver as a server. Its use is described below.
26962
26963 .option server_prompts plaintext "string list&!!" unset
26964 The contents of this option, after expansion, must be a colon-separated list of
26965 prompt strings. If expansion fails, a temporary authentication rejection is
26966 given.
26967
26968 .section "Using plaintext in a server" "SECTplainserver"
26969 .cindex "AUTH" "in &(plaintext)& authenticator"
26970 .cindex "binary zero" "in &(plaintext)& authenticator"
26971 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
26972         "in &(plaintext)& authenticator"
26973 .vindex "&$auth1$&, &$auth2$&, etc"
26974 .cindex "base64 encoding" "in &(plaintext)& authenticator"
26975
26976 When running as a server, &(plaintext)& performs the authentication test by
26977 expanding a string. The data sent by the client with the AUTH command, or in
26978 response to subsequent prompts, is base64 encoded, and so may contain any byte
26979 values when decoded. If any data is supplied with the command, it is treated as
26980 a list of strings, separated by NULs (binary zeros), the first three of which
26981 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
26982 (neither LOGIN nor PLAIN uses more than three strings).
26983
26984 For compatibility with previous releases of Exim, the values are also placed in
26985 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
26986 variables for this purpose is now deprecated, as it can lead to confusion in
26987 string expansions that also use them for other things.
26988
26989 If there are more strings in &%server_prompts%& than the number of strings
26990 supplied with the AUTH command, the remaining prompts are used to obtain more
26991 data. Each response from the client may be a list of NUL-separated strings.
26992
26993 .vindex "&$authenticated_id$&"
26994 Once a sufficient number of data strings have been received,
26995 &%server_condition%& is expanded. If the expansion is forced to fail,
26996 authentication fails. Any other expansion failure causes a temporary error code
26997 to be returned. If the result of a successful expansion is an empty string,
26998 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26999 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27000 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27001 For any other result, a temporary error code is returned, with the expanded
27002 string as the error text.
27003
27004 &*Warning*&: If you use a lookup in the expansion to find the user's
27005 password, be sure to make the authentication fail if the user is unknown.
27006 There are good and bad examples at the end of the next section.
27007
27008
27009
27010 .section "The PLAIN authentication mechanism" "SECID172"
27011 .cindex "PLAIN authentication mechanism"
27012 .cindex "authentication" "PLAIN mechanism"
27013 .cindex "binary zero" "in &(plaintext)& authenticator"
27014 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27015 sent as one item of data (that is, one combined string containing two NUL
27016 separators). The data is sent either as part of the AUTH command, or
27017 subsequently in response to an empty prompt from the server.
27018
27019 The second and third strings are a user name and a corresponding password.
27020 Using a single fixed user name and password as an example, this could be
27021 configured as follows:
27022 .code
27023 fixed_plain:
27024   driver = plaintext
27025   public_name = PLAIN
27026   server_prompts = :
27027   server_condition = \
27028     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27029   server_set_id = $auth2
27030 .endd
27031 Note that the default result strings from &%if%& (&"true"& or an empty string)
27032 are exactly what we want here, so they need not be specified. Obviously, if the
27033 password contains expansion-significant characters such as dollar, backslash,
27034 or closing brace, they have to be escaped.
27035
27036 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27037 the end of a string list are ignored). If all the data comes as part of the
27038 AUTH command, as is commonly the case, the prompt is not used. This
27039 authenticator is advertised in the response to EHLO as
27040 .code
27041 250-AUTH PLAIN
27042 .endd
27043 and a client host can authenticate itself by sending the command
27044 .code
27045 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27046 .endd
27047 As this contains three strings (more than the number of prompts), no further
27048 data is required from the client. Alternatively, the client may just send
27049 .code
27050 AUTH PLAIN
27051 .endd
27052 to initiate authentication, in which case the server replies with an empty
27053 prompt. The client must respond with the combined data string.
27054
27055 The data string is base64 encoded, as required by the RFC. This example,
27056 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27057 represents a zero byte. This is split up into three strings, the first of which
27058 is empty. The &%server_condition%& option in the authenticator checks that the
27059 second two are &`username`& and &`mysecret`& respectively.
27060
27061 Having just one fixed user name and password, as in this example, is not very
27062 realistic, though for a small organization with only a handful of
27063 authenticating clients it could make sense.
27064
27065 A more sophisticated instance of this authenticator could use the user name in
27066 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27067 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27068 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27069 This is an incorrect example:
27070 .code
27071 server_condition = \
27072   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27073 .endd
27074 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27075 which it then compares to the supplied password (&$auth3$&). Why is this example
27076 incorrect? It works fine for existing users, but consider what happens if a
27077 non-existent user name is given. The lookup fails, but as no success/failure
27078 strings are given for the lookup, it yields an empty string. Thus, to defeat
27079 the authentication, all a client has to do is to supply a non-existent user
27080 name and an empty password. The correct way of writing this test is:
27081 .code
27082 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27083   {${if eq{$value}{$auth3}}} {false}}
27084 .endd
27085 In this case, if the lookup succeeds, the result is checked; if the lookup
27086 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27087 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27088 always fails if its second argument is empty. However, the second way of
27089 writing the test makes the logic clearer.
27090
27091
27092 .section "The LOGIN authentication mechanism" "SECID173"
27093 .cindex "LOGIN authentication mechanism"
27094 .cindex "authentication" "LOGIN mechanism"
27095 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27096 in a number of programs. No data is sent with the AUTH command. Instead, a
27097 user name and password are supplied separately, in response to prompts. The
27098 plaintext authenticator can be configured to support this as in this example:
27099 .code
27100 fixed_login:
27101   driver = plaintext
27102   public_name = LOGIN
27103   server_prompts = User Name : Password
27104   server_condition = \
27105     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27106   server_set_id = $auth1
27107 .endd
27108 Because of the way plaintext operates, this authenticator accepts data supplied
27109 with the AUTH command (in contravention of the specification of LOGIN), but
27110 if the client does not supply it (as is the case for LOGIN clients), the prompt
27111 strings are used to obtain two data items.
27112
27113 Some clients are very particular about the precise text of the prompts. For
27114 example, Outlook Express is reported to recognize only &"Username:"& and
27115 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27116 strings. It uses the &%ldapauth%& expansion condition to check the user
27117 name and password by binding to an LDAP server:
27118 .code
27119 login:
27120   driver = plaintext
27121   public_name = LOGIN
27122   server_prompts = Username:: : Password::
27123   server_condition = ${if and{{ \
27124     !eq{}{$auth1} }{ \
27125     ldapauth{\
27126       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27127       pass=${quote:$auth2} \
27128       ldap://ldap.example.org/} }} }
27129   server_set_id = uid=$auth1,ou=people,o=example.org
27130 .endd
27131 We have to check that the username is not empty before using it, because LDAP
27132 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27133 operator to correctly quote the DN for authentication. However, the basic
27134 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27135 correct one to use for the password, because quoting is needed only to make
27136 the password conform to the Exim syntax. At the LDAP level, the password is an
27137 uninterpreted string.
27138
27139
27140 .section "Support for different kinds of authentication" "SECID174"
27141 A number of string expansion features are provided for the purpose of
27142 interfacing to different ways of user authentication. These include checking
27143 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27144 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27145 &<<SECTexpcond>>&.
27146
27147
27148
27149
27150 .section "Using plaintext in a client" "SECID175"
27151 .cindex "options" "&(plaintext)& authenticator (client)"
27152 The &(plaintext)& authenticator has two client options:
27153
27154 .option client_ignore_invalid_base64 plaintext boolean false
27155 If the client receives a server prompt that is not a valid base64 string,
27156 authentication is abandoned by default. However, if this option is set true,
27157 the error in the challenge is ignored and the client sends the response as
27158 usual.
27159
27160 .option client_send plaintext string&!! unset
27161 The string is a colon-separated list of authentication data strings. Each
27162 string is independently expanded before being sent to the server. The first
27163 string is sent with the AUTH command; any more strings are sent in response
27164 to prompts from the server. Before each string is expanded, the value of the
27165 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27166 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27167 way. Thus, the prompt that is received in response to sending the first string
27168 (with the AUTH command) can be used in the expansion of the second string, and
27169 so on. If an invalid base64 string is received when
27170 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27171 &$auth$&<&'n'&> variable.
27172
27173 &*Note*&: You cannot use expansion to create multiple strings, because
27174 splitting takes priority and happens first.
27175
27176 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27177 the data, further processing is applied to each string before it is sent. If
27178 there are any single circumflex characters in the string, they are converted to
27179 NULs. Should an actual circumflex be required as data, it must be doubled in
27180 the string.
27181
27182 This is an example of a client configuration that implements the PLAIN
27183 authentication mechanism with a fixed user name and password:
27184 .code
27185 fixed_plain:
27186   driver = plaintext
27187   public_name = PLAIN
27188   client_send = ^username^mysecret
27189 .endd
27190 The lack of colons means that the entire text is sent with the AUTH
27191 command, with the circumflex characters converted to NULs. A similar example
27192 that uses the LOGIN mechanism is:
27193 .code
27194 fixed_login:
27195   driver = plaintext
27196   public_name = LOGIN
27197   client_send = : username : mysecret
27198 .endd
27199 The initial colon means that the first string is empty, so no data is sent with
27200 the AUTH command itself. The remaining strings are sent in response to
27201 prompts.
27202 .ecindex IIDplaiauth1
27203 .ecindex IIDplaiauth2
27204
27205
27206
27207
27208 . ////////////////////////////////////////////////////////////////////////////
27209 . ////////////////////////////////////////////////////////////////////////////
27210
27211 .chapter "The cram_md5 authenticator" "CHID9"
27212 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27213 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27214 .cindex "CRAM-MD5 authentication mechanism"
27215 .cindex "authentication" "CRAM-MD5 mechanism"
27216 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27217 sends a challenge string to the client, and the response consists of a user
27218 name and the CRAM-MD5 digest of the challenge string combined with a secret
27219 string (password) which is known to both server and client. Thus, the secret
27220 is not sent over the network as plain text, which makes this authenticator more
27221 secure than &(plaintext)&. However, the downside is that the secret has to be
27222 available in plain text at either end.
27223
27224
27225 .section "Using cram_md5 as a server" "SECID176"
27226 .cindex "options" "&(cram_md5)& authenticator (server)"
27227 This authenticator has one server option, which must be set to configure the
27228 authenticator as a server:
27229
27230 .option server_secret cram_md5 string&!! unset
27231 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27232 When the server receives the client's response, the user name is placed in
27233 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27234 obtain the password for that user. The server then computes the CRAM-MD5 digest
27235 that the client should have sent, and checks that it received the correct
27236 string. If the expansion of &%server_secret%& is forced to fail, authentication
27237 fails. If the expansion fails for some other reason, a temporary error code is
27238 returned to the client.
27239
27240 For compatibility with previous releases of Exim, the user name is also placed
27241 in &$1$&. However, the use of this variables for this purpose is now
27242 deprecated, as it can lead to confusion in string expansions that also use
27243 numeric variables for other things.
27244
27245 For example, the following authenticator checks that the user name given by the
27246 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27247 user name, authentication fails.
27248 .code
27249 fixed_cram:
27250   driver = cram_md5
27251   public_name = CRAM-MD5
27252   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27253   server_set_id = $auth1
27254 .endd
27255 .vindex "&$authenticated_id$&"
27256 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27257 name in &$authenticated_id$&. A more typical configuration might look up the
27258 secret string in a file, using the user name as the key. For example:
27259 .code
27260 lookup_cram:
27261   driver = cram_md5
27262   public_name = CRAM-MD5
27263   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27264                   {$value}fail}
27265   server_set_id = $auth1
27266 .endd
27267 Note that this expansion explicitly forces failure if the lookup fails
27268 because &$auth1$& contains an unknown user name.
27269
27270 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27271 using the relevant libraries, you need to know the realm to specify in the
27272 lookup and then ask for the &"userPassword"& attribute for that user in that
27273 realm, with:
27274 .code
27275 cyrusless_crammd5:
27276   driver = cram_md5
27277   public_name = CRAM-MD5
27278   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27279                   dbmjz{/etc/sasldb2}{$value}fail}
27280   server_set_id = $auth1
27281 .endd
27282
27283 .section "Using cram_md5 as a client" "SECID177"
27284 .cindex "options" "&(cram_md5)& authenticator (client)"
27285 When used as a client, the &(cram_md5)& authenticator has two options:
27286
27287
27288
27289 .option client_name cram_md5 string&!! "the primary host name"
27290 This string is expanded, and the result used as the user name data when
27291 computing the response to the server's challenge.
27292
27293
27294 .option client_secret cram_md5 string&!! unset
27295 This option must be set for the authenticator to work as a client. Its value is
27296 expanded and the result used as the secret string when computing the response.
27297
27298
27299 .vindex "&$host$&"
27300 .vindex "&$host_address$&"
27301 Different user names and secrets can be used for different servers by referring
27302 to &$host$& or &$host_address$& in the options. Forced failure of either
27303 expansion string is treated as an indication that this authenticator is not
27304 prepared to handle this case. Exim moves on to the next configured client
27305 authenticator. Any other expansion failure causes Exim to give up trying to
27306 send the message to the current server.
27307
27308 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27309 strings, is:
27310 .code
27311 fixed_cram:
27312   driver = cram_md5
27313   public_name = CRAM-MD5
27314   client_name = ph10
27315   client_secret = secret
27316 .endd
27317 .ecindex IIDcramauth1
27318 .ecindex IIDcramauth2
27319
27320
27321
27322 . ////////////////////////////////////////////////////////////////////////////
27323 . ////////////////////////////////////////////////////////////////////////////
27324
27325 .chapter "The cyrus_sasl authenticator" "CHID10"
27326 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27327 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27328 .cindex "Cyrus" "SASL library"
27329 .cindex "Kerberos"
27330 The code for this authenticator was provided by Matthew Byng-Maddick while
27331 at A L Digital Ltd.
27332
27333 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27334 library implementation of the RFC 2222 (&"Simple Authentication and Security
27335 Layer"&). This library supports a number of authentication mechanisms,
27336 including PLAIN and LOGIN, but also several others that Exim does not support
27337 directly. In particular, there is support for Kerberos authentication.
27338
27339 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27340 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27341 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27342 name of the driver to determine which mechanism to support.
27343
27344 Where access to some kind of secret file is required, for example, in GSSAPI
27345 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27346 user, and that the Cyrus SASL library has no way of escalating privileges
27347 by default. You may also find you need to set environment variables,
27348 depending on the driver you are using.
27349
27350 The application name provided by Exim is &"exim"&, so various SASL options may
27351 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27352 Kerberos, note that because of limitations in the GSSAPI interface,
27353 changing the server keytab might need to be communicated down to the Kerberos
27354 layer independently. The mechanism for doing so is dependent upon the Kerberos
27355 implementation.
27356
27357 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27358 may be set to point to an alternative keytab file. Exim will pass this
27359 variable through from its own inherited environment when started as root or the
27360 Exim user. The keytab file needs to be readable by the Exim user.
27361 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27362 environment variable.  In practice, for those releases, the Cyrus authenticator
27363 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27364 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27365
27366
27367 .section "Using cyrus_sasl as a server" "SECID178"
27368 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27369 (on a successful authentication) into &$auth1$&. For compatibility with
27370 previous releases of Exim, the username is also placed in &$1$&. However, the
27371 use of this variable for this purpose is now deprecated, as it can lead to
27372 confusion in string expansions that also use numeric variables for other
27373 things.
27374
27375
27376 .option server_hostname cyrus_sasl string&!! "see below"
27377 This option selects the hostname that is used when communicating with the
27378 library. The default value is &`$primary_hostname`&. It is up to the underlying
27379 SASL plug-in what it does with this data.
27380
27381
27382 .option server_mech cyrus_sasl string "see below"
27383 This option selects the authentication mechanism this driver should use. The
27384 default is the value of the generic &%public_name%& option. This option allows
27385 you to use a different underlying mechanism from the advertised name. For
27386 example:
27387 .code
27388 sasl:
27389   driver = cyrus_sasl
27390   public_name = X-ANYTHING
27391   server_mech = CRAM-MD5
27392   server_set_id = $auth1
27393 .endd
27394
27395 .option server_realm cyrus_sasl string&!! unset
27396 This specifies the SASL realm that the server claims to be in.
27397
27398
27399 .option server_service cyrus_sasl string &`smtp`&
27400 This is the SASL service that the server claims to implement.
27401
27402
27403 For straightforward cases, you do not need to set any of the authenticator's
27404 private options. All you need to do is to specify an appropriate mechanism as
27405 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27406 PLAIN, you could have two authenticators as follows:
27407 .code
27408 sasl_cram_md5:
27409   driver = cyrus_sasl
27410   public_name = CRAM-MD5
27411   server_set_id = $auth1
27412
27413 sasl_plain:
27414   driver = cyrus_sasl
27415   public_name = PLAIN
27416   server_set_id = $auth2
27417 .endd
27418 Cyrus SASL does implement the LOGIN authentication method, even though it is
27419 not a standard method. It is disabled by default in the source distribution,
27420 but it is present in many binary distributions.
27421 .ecindex IIDcyrauth1
27422 .ecindex IIDcyrauth2
27423
27424
27425
27426
27427 . ////////////////////////////////////////////////////////////////////////////
27428 . ////////////////////////////////////////////////////////////////////////////
27429 .chapter "The dovecot authenticator" "CHAPdovecot"
27430 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27431 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27432 This authenticator is an interface to the authentication facility of the
27433 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
27434 Note that Dovecot must be configured to use auth-client not auth-userdb.
27435 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27436 to use the same mechanisms for SMTP authentication. This is a server
27437 authenticator only. There is only one option:
27438
27439 .option server_socket dovecot string unset
27440
27441 This option must specify the UNIX socket that is the interface to Dovecot
27442 authentication. The &%public_name%& option must specify an authentication
27443 mechanism that Dovecot is configured to support. You can have several
27444 authenticators for different mechanisms. For example:
27445 .code
27446 dovecot_plain:
27447   driver = dovecot
27448   public_name = PLAIN
27449   server_socket = /var/run/dovecot/auth-client
27450   server_set_id = $auth1
27451
27452 dovecot_ntlm:
27453   driver = dovecot
27454   public_name = NTLM
27455   server_socket = /var/run/dovecot/auth-client
27456   server_set_id = $auth1
27457 .endd
27458 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27459 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27460 option is passed in the Dovecot authentication command. If, for a TLS
27461 connection, a client certificate has been verified, the &"valid-client-cert"&
27462 option is passed. When authentication succeeds, the identity of the user
27463 who authenticated is placed in &$auth1$&.
27464
27465 .new
27466 The Dovecot configuration to match the above wil look
27467 something like:
27468 .code
27469 conf.d/10-master.conf :-
27470
27471 service auth {
27472 ...
27473 #SASL
27474   unix_listener auth-client {
27475     mode = 0660
27476     user = mail
27477   }
27478 ...
27479 }
27480
27481 conf.d/10-auth.conf :-
27482
27483 auth_mechanisms = plain login ntlm
27484 .endd
27485 .wen
27486
27487 .ecindex IIDdcotauth1
27488 .ecindex IIDdcotauth2
27489
27490
27491 . ////////////////////////////////////////////////////////////////////////////
27492 . ////////////////////////////////////////////////////////////////////////////
27493 .chapter "The gsasl authenticator" "CHAPgsasl"
27494 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27495 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27496 .cindex "authentication" "GNU SASL"
27497 .cindex "authentication" "SASL"
27498 .cindex "authentication" "EXTERNAL"
27499 .cindex "authentication" "ANONYMOUS"
27500 .cindex "authentication" "PLAIN"
27501 .cindex "authentication" "LOGIN"
27502 .cindex "authentication" "DIGEST-MD5"
27503 .cindex "authentication" "CRAM-MD5"
27504 .cindex "authentication" "SCRAM-SHA-1"
27505 .cindex "authentication" "SCRAM-SHA-1-PLUS"
27506 .cindex "authentication" "SCRAM-SHA-256"
27507 .cindex "authentication" "SCRAM-SHA-256-PLUS"
27508 The &(gsasl)& authenticator provides integration for the GNU SASL
27509 library and the mechanisms it provides.  This is new as of the 4.80 release
27510 and there are a few areas where the library does not let Exim smoothly
27511 scale to handle future authentication mechanisms, so no guarantee can be
27512 made that any particular new authentication mechanism will be supported
27513 without code changes in Exim.
27514
27515 .new
27516 The library is expected to add support in an upcoming
27517 realease for the SCRAM-SHA-256 method.
27518 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
27519 when this happens.
27520
27521
27522 .option client_authz gsasl string&!! unset
27523 This option can be used to supply an &'authorization id'&
27524 which is different to the &'authentication_id'& provided
27525 by &%client_username%& option.
27526 If unset or (after expansion) empty it is not used,
27527 which is the common case.
27528
27529 .option client_channelbinding gsasl boolean false
27530 See &%server_channelbinding%& below.
27531
27532 .option client_password gsasl string&!! unset
27533 This option is exapanded before use, and should result in
27534 the password to be used, in clear.
27535
27536 .option client_username gsasl string&!! unset
27537 This option is exapanded before use, and should result in
27538 the account name to be used.
27539 .wen
27540
27541 .option server_channelbinding gsasl boolean false
27542 Do not set this true and rely on the properties
27543 without consulting a cryptographic engineer.
27544
27545 Some authentication mechanisms are able to use external context at both ends
27546 of the session to bind the authentication to that context, and fail the
27547 authentication process if that context differs.  Specifically, some TLS
27548 ciphersuites can provide identifying information about the cryptographic
27549 context.
27550
27551 This should have meant that certificate identity and verification becomes a
27552 non-issue, as a man-in-the-middle attack will cause the correct client and
27553 server to see different identifiers and authentication will fail.
27554
27555 .new
27556 This is
27557 only usable by mechanisms which support "channel binding"; at time of
27558 writing, that's the SCRAM family.
27559 When using this feature the "-PLUS" variants of the method names need to be used.
27560 .wen
27561
27562 This defaults off to ensure smooth upgrade across Exim releases, in case
27563 this option causes some clients to start failing.  Some future release
27564 of Exim might have switched the default to be true.
27565
27566 However, Channel Binding in TLS has proven to be vulnerable in current versions.
27567 Do not plan to rely upon this feature for security, ever, without consulting
27568 with a subject matter expert (a cryptographic engineer).
27569
27570
27571 .option server_hostname gsasl string&!! "see below"
27572 This option selects the hostname that is used when communicating with the
27573 library. The default value is &`$primary_hostname`&.
27574 Some mechanisms will use this data.
27575
27576
27577 .option server_mech gsasl string "see below"
27578 This option selects the authentication mechanism this driver should use. The
27579 default is the value of the generic &%public_name%& option. This option allows
27580 you to use a different underlying mechanism from the advertised name. For
27581 example:
27582 .code
27583 sasl:
27584   driver = gsasl
27585   public_name = X-ANYTHING
27586   server_mech = CRAM-MD5
27587   server_set_id = $auth1
27588 .endd
27589
27590
27591 .option server_password gsasl string&!! unset
27592 Various mechanisms need access to the cleartext password on the server, so
27593 that proof-of-possession can be demonstrated on the wire, without sending
27594 the password itself.
27595
27596 The data available for lookup varies per mechanism.
27597 In all cases, &$auth1$& is set to the &'authentication id'&.
27598 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
27599 if available, else the empty string.
27600 The &$auth3$& variable will always be the &'realm'& if available,
27601 else the empty string.
27602
27603 A forced failure will cause authentication to defer.
27604
27605 If using this option, it may make sense to set the &%server_condition%&
27606 option to be simply "true".
27607
27608
27609 .option server_realm gsasl string&!! unset
27610 This specifies the SASL realm that the server claims to be in.
27611 Some mechanisms will use this data.
27612
27613
27614 .option server_scram_iter gsasl string&!! 4096
27615 This option provides data for the SCRAM family of mechanisms.
27616 .new
27617 The &$auth1$&, &$auth2$& and &$auth3$& variables are available for expansion.
27618
27619 The result of expansion should be a decimal number,
27620 and represents both a lower-bound on the security, and
27621 a compute cost factor imposed on the client
27622 (if it does not cache results, or the server changes
27623 either the iteration count or the salt).
27624 A minimum value of 4096 is required by the standards
27625 for all current CRAM mechanism variants.
27626 .wen
27627
27628
27629 .option server_scram_salt gsasl string&!! unset
27630 This option provides data for the SCRAM family of mechanisms.
27631 .new
27632 The &$auth1$&, &$auth2$& and &$auth3$& variables are available for expansion.
27633 If unset or empty after expansion the library will provides a value for the
27634 protocol conversation.
27635 .wen
27636
27637
27638 .option server_service gsasl string &`smtp`&
27639 This is the SASL service that the server claims to implement.
27640 Some mechanisms will use this data.
27641
27642
27643 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
27644 .vindex "&$auth1$&, &$auth2$&, etc"
27645 These may be set when evaluating specific options, as detailed above.
27646 They will also be set when evaluating &%server_condition%&.
27647
27648 Unless otherwise stated below, the &(gsasl)& integration will use the following
27649 meanings for these variables:
27650
27651 .ilist
27652 .vindex "&$auth1$&"
27653 &$auth1$&: the &'authentication id'&
27654 .next
27655 .vindex "&$auth2$&"
27656 &$auth2$&: the &'authorization id'&
27657 .next
27658 .vindex "&$auth3$&"
27659 &$auth3$&: the &'realm'&
27660 .endlist
27661
27662 On a per-mechanism basis:
27663
27664 .ilist
27665 .cindex "authentication" "EXTERNAL"
27666 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
27667 the &%server_condition%& option must be present.
27668 .next
27669 .cindex "authentication" "ANONYMOUS"
27670 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
27671 the &%server_condition%& option must be present.
27672 .next
27673 .cindex "authentication" "GSSAPI"
27674 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
27675 &$auth2$& will be set to the &'authorization id'&,
27676 the &%server_condition%& option must be present.
27677 .endlist
27678
27679 An &'anonymous token'& is something passed along as an unauthenticated
27680 identifier; this is analogous to FTP anonymous authentication passing an
27681 email address, or software-identifier@, as the "password".
27682
27683
27684 An example showing the password having the realm specified in the callback
27685 and demonstrating a Cyrus SASL to GSASL migration approach is:
27686 .code
27687 gsasl_cyrusless_crammd5:
27688   driver = gsasl
27689   public_name = CRAM-MD5
27690   server_realm = imap.example.org
27691   server_password = ${lookup{$auth1:$auth3:userPassword}\
27692                     dbmjz{/etc/sasldb2}{$value}fail}
27693   server_set_id = ${quote:$auth1}
27694   server_condition = yes
27695 .endd
27696
27697
27698 . ////////////////////////////////////////////////////////////////////////////
27699 . ////////////////////////////////////////////////////////////////////////////
27700
27701 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
27702 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
27703 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
27704 .cindex "authentication" "GSSAPI"
27705 .cindex "authentication" "Kerberos"
27706 The &(heimdal_gssapi)& authenticator provides server integration for the
27707 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
27708 reliably.
27709
27710 .option server_hostname heimdal_gssapi string&!! "see below"
27711 This option selects the hostname that is used, with &%server_service%&,
27712 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
27713 identifier.  The default value is &`$primary_hostname`&.
27714
27715 .option server_keytab heimdal_gssapi string&!! unset
27716 If set, then Heimdal will not use the system default keytab (typically
27717 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
27718 The value should be a pathname, with no &"file:"& prefix.
27719
27720 .option server_service heimdal_gssapi string&!! "smtp"
27721 This option specifies the service identifier used, in conjunction with
27722 &%server_hostname%&, for building the identifier for finding credentials
27723 from the keytab.
27724
27725
27726 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
27727 Beware that these variables will typically include a realm, thus will appear
27728 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
27729 not verified, so a malicious client can set it to anything.
27730
27731 The &$auth1$& field should be safely trustable as a value from the Key
27732 Distribution Center.  Note that these are not quite email addresses.
27733 Each identifier is for a role, and so the left-hand-side may include a
27734 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
27735
27736 .vindex "&$auth1$&, &$auth2$&, etc"
27737 .ilist
27738 .vindex "&$auth1$&"
27739 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
27740 .next
27741 .vindex "&$auth2$&"
27742 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
27743 authentication.  If that was empty, this will also be set to the
27744 GSS Display Name.
27745 .endlist
27746
27747
27748 . ////////////////////////////////////////////////////////////////////////////
27749 . ////////////////////////////////////////////////////////////////////////////
27750
27751 .chapter "The spa authenticator" "CHAPspa"
27752 .scindex IIDspaauth1 "&(spa)& authenticator"
27753 .scindex IIDspaauth2 "authenticators" "&(spa)&"
27754 .cindex "authentication" "Microsoft Secure Password"
27755 .cindex "authentication" "NTLM"
27756 .cindex "Microsoft Secure Password Authentication"
27757 .cindex "NTLM authentication"
27758 The &(spa)& authenticator provides client support for Microsoft's &'Secure
27759 Password Authentication'& mechanism,
27760 which is also sometimes known as NTLM (NT LanMan). The code for client side of
27761 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
27762 taken from the Samba project (&url(https://www.samba.org/)). The code for the
27763 server side was subsequently contributed by Tom Kistner. The mechanism works as
27764 follows:
27765
27766 .ilist
27767 After the AUTH command has been accepted, the client sends an SPA
27768 authentication request based on the user name and optional domain.
27769 .next
27770 The server sends back a challenge.
27771 .next
27772 The client builds a challenge response which makes use of the user's password
27773 and sends it to the server, which then accepts or rejects it.
27774 .endlist
27775
27776 Encryption is used to protect the password in transit.
27777
27778
27779
27780 .section "Using spa as a server" "SECID179"
27781 .cindex "options" "&(spa)& authenticator (server)"
27782 The &(spa)& authenticator has just one server option:
27783
27784 .option server_password spa string&!! unset
27785 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
27786 This option is expanded, and the result must be the cleartext password for the
27787 authenticating user, whose name is at this point in &$auth1$&. For
27788 compatibility with previous releases of Exim, the user name is also placed in
27789 &$1$&. However, the use of this variable for this purpose is now deprecated, as
27790 it can lead to confusion in string expansions that also use numeric variables
27791 for other things. For example:
27792 .code
27793 spa:
27794   driver = spa
27795   public_name = NTLM
27796   server_password = \
27797     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
27798 .endd
27799 If the expansion is forced to fail, authentication fails. Any other expansion
27800 failure causes a temporary error code to be returned.
27801
27802
27803
27804
27805
27806 .section "Using spa as a client" "SECID180"
27807 .cindex "options" "&(spa)& authenticator (client)"
27808 The &(spa)& authenticator has the following client options:
27809
27810
27811
27812 .option client_domain spa string&!! unset
27813 This option specifies an optional domain for the authentication.
27814
27815
27816 .option client_password spa string&!! unset
27817 This option specifies the user's password, and must be set.
27818
27819
27820 .option client_username spa string&!! unset
27821 This option specifies the user name, and must be set. Here is an example of a
27822 configuration of this authenticator for use with the mail servers at
27823 &'msn.com'&:
27824 .code
27825 msn:
27826   driver = spa
27827   public_name = MSN
27828   client_username = msn/msn_username
27829   client_password = msn_plaintext_password
27830   client_domain = DOMAIN_OR_UNSET
27831 .endd
27832 .ecindex IIDspaauth1
27833 .ecindex IIDspaauth2
27834
27835
27836
27837
27838
27839 . ////////////////////////////////////////////////////////////////////////////
27840 . ////////////////////////////////////////////////////////////////////////////
27841
27842 .chapter "The external authenticator" "CHAPexternauth"
27843 .scindex IIDexternauth1 "&(external)& authenticator"
27844 .scindex IIDexternauth2 "authenticators" "&(external)&"
27845 .cindex "authentication" "Client Certificate"
27846 .cindex "authentication" "X509"
27847 .cindex "Certificate-based authentication"
27848 The &(external)& authenticator provides support for
27849 authentication based on non-SMTP information.
27850 The specification is in RFC 4422 Appendix A
27851 (&url(https://tools.ietf.org/html/rfc4422)).
27852 It is only a transport and negotiation mechanism;
27853 the process of authentication is entirely controlled
27854 by the server configuration.
27855
27856 The client presents an identity in-clear.
27857 It is probably wise for a server to only advertise,
27858 and for clients to only attempt,
27859 this authentication method on a secure (eg. under TLS) connection.
27860
27861 One possible use, compatible with the
27862 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
27863 is for using X509 client certificates.
27864
27865 It thus overlaps in function with the TLS authenticator
27866 (see &<<CHAPtlsauth>>&)
27867 but is a full SMTP SASL authenticator
27868 rather than being implicit for TLS-connection carried
27869 client certificates only.
27870
27871 The examples and discussion in this chapter assume that
27872 client-certificate authentication is being done.
27873
27874 The client must present a certificate,
27875 for which it must have been requested via the
27876 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27877 (see &<<CHAPTLS>>&).
27878 For authentication to be effective the certificate should be
27879 verifiable against a trust-anchor certificate known to the server.
27880
27881 .section "External options" "SECTexternsoptions"
27882 .cindex "options" "&(external)& authenticator (server)"
27883 The &(external)& authenticator has two server options:
27884
27885 .option server_param2 external string&!! unset
27886 .option server_param3 external string&!! unset
27887 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
27888 These options are expanded before the &%server_condition%& option
27889 and the result are placed in &$auth2$& and &$auth3$& resectively.
27890 If the expansion is forced to fail, authentication fails. Any other expansion
27891 failure causes a temporary error code to be returned.
27892
27893 They can be used to clarify the coding of a complex &%server_condition%&.
27894
27895 .section "Using external in a server" "SECTexternserver"
27896 .cindex "AUTH" "in &(external)& authenticator"
27897 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27898         "in &(external)& authenticator"
27899 .vindex "&$auth1$&, &$auth2$&, etc"
27900 .cindex "base64 encoding" "in &(external)& authenticator"
27901
27902 When running as a server, &(external)& performs the authentication test by
27903 expanding a string. The data sent by the client with the AUTH command, or in
27904 response to subsequent prompts, is base64 encoded, and so may contain any byte
27905 values when decoded. The decoded value is treated as
27906 an identity for authentication and
27907 placed in the expansion variable &$auth1$&.
27908
27909 For compatibility with previous releases of Exim, the value is also placed in
27910 the expansion variable &$1$&. However, the use of this
27911 variable for this purpose is now deprecated, as it can lead to confusion in
27912 string expansions that also use them for other things.
27913
27914 .vindex "&$authenticated_id$&"
27915 Once an identity has been received,
27916 &%server_condition%& is expanded. If the expansion is forced to fail,
27917 authentication fails. Any other expansion failure causes a temporary error code
27918 to be returned. If the result of a successful expansion is an empty string,
27919 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27920 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27921 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27922 For any other result, a temporary error code is returned, with the expanded
27923 string as the error text.
27924
27925 Example:
27926 .code
27927 ext_ccert_san_mail:
27928   driver =            external
27929   public_name =       EXTERNAL
27930
27931   server_advertise_condition = $tls_in_certificate_verified
27932   server_param2 =     ${certextract {subj_altname,mail,>:} \
27933                                     {$tls_in_peercert}}
27934   server_condition =  ${if forany {$auth2} \
27935                             {eq {$item}{$auth1}}}
27936   server_set_id =     $auth1
27937 .endd
27938 This accepts a client certificate that is verifiable against any
27939 of your configured trust-anchors
27940 (which usually means the full set of public CAs)
27941 and which has a mail-SAN matching the claimed identity sent by the client.
27942
27943 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
27944 The account name is therefore guessable by an opponent.
27945 TLS 1.3 protects both server and client certificates, and is not vulnerable
27946 in this way.
27947
27948
27949 .section "Using external in a client" "SECTexternclient"
27950 .cindex "options" "&(external)& authenticator (client)"
27951 The &(external)& authenticator has one client option:
27952
27953 .option client_send external string&!! unset
27954 This option is expanded and sent with the AUTH command as the
27955 identity being asserted.
27956
27957 Example:
27958 .code
27959 ext_ccert:
27960   driver =      external
27961   public_name = EXTERNAL
27962
27963   client_condition = ${if !eq{$tls_out_cipher}{}}
27964   client_send = myaccount@smarthost.example.net
27965 .endd
27966
27967
27968 .ecindex IIDexternauth1
27969 .ecindex IIDexternauth2
27970
27971
27972
27973
27974
27975 . ////////////////////////////////////////////////////////////////////////////
27976 . ////////////////////////////////////////////////////////////////////////////
27977
27978 .chapter "The tls authenticator" "CHAPtlsauth"
27979 .scindex IIDtlsauth1 "&(tls)& authenticator"
27980 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
27981 .cindex "authentication" "Client Certificate"
27982 .cindex "authentication" "X509"
27983 .cindex "Certificate-based authentication"
27984 The &(tls)& authenticator provides server support for
27985 authentication based on client certificates.
27986
27987 It is not an SMTP authentication mechanism and is not
27988 advertised by the server as part of the SMTP EHLO response.
27989 It is an Exim authenticator in the sense that it affects
27990 the protocol element of the log line, can be tested for
27991 by the &%authenticated%& ACL condition, and can set
27992 the &$authenticated_id$& variable.
27993
27994 The client must present a verifiable certificate,
27995 for which it must have been requested via the
27996 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27997 (see &<<CHAPTLS>>&).
27998
27999 If an authenticator of this type is configured it is
28000 run before any SMTP-level communication is done,
28001 and can authenticate the connection.
28002 If it does, SMTP authentication is not offered.
28003
28004 A maximum of one authenticator of this type may be present.
28005
28006
28007 .cindex "options" "&(tls)& authenticator (server)"
28008 The &(tls)& authenticator has three server options:
28009
28010 .option server_param1 tls string&!! unset
28011 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
28012 This option is expanded after the TLS negotiation and
28013 the result is placed in &$auth1$&.
28014 If the expansion is forced to fail, authentication fails. Any other expansion
28015 failure causes a temporary error code to be returned.
28016
28017 .option server_param2 tls string&!! unset
28018 .option server_param3 tls string&!! unset
28019 As above, for &$auth2$& and &$auth3$&.
28020
28021 &%server_param1%& may also be spelled &%server_param%&.
28022
28023
28024 Example:
28025 .code
28026 tls:
28027   driver = tls
28028   server_param1 =     ${certextract {subj_altname,mail,>:} \
28029                                     {$tls_in_peercert}}
28030   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
28031                                  {forany {$auth1} \
28032                             {!= {0} \
28033                                 {${lookup ldap{ldap:///\
28034                          mailname=${quote_ldap_dn:${lc:$item}},\
28035                          ou=users,LDAP_DC?mailid} {$value}{0} \
28036                        }    }  } }}}
28037   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
28038 .endd
28039 This accepts a client certificate that is verifiable against any
28040 of your configured trust-anchors
28041 (which usually means the full set of public CAs)
28042 and which has a SAN with a good account name.
28043
28044 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
28045 The account name is therefore guessable by an opponent.
28046 TLS 1.3 protects both server and client certificates, and is not vulnerable
28047 in this way.
28048 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
28049
28050 . An alternative might use
28051 . .code
28052 .   server_param1 = ${sha256:$tls_in_peercert}
28053 . .endd
28054 . to require one of a set of specific certs that define a given account
28055 . (the verification is still required, but mostly irrelevant).
28056 . This would help for per-device use.
28057 .
28058 . However, for the future we really need support for checking a
28059 . user cert in LDAP - which probably wants a base-64 DER.
28060
28061 .ecindex IIDtlsauth1
28062 .ecindex IIDtlsauth2
28063
28064
28065 Note that because authentication is traditionally an SMTP operation,
28066 the &%authenticated%& ACL condition cannot be used in
28067 a connect- or helo-ACL.
28068
28069
28070
28071 . ////////////////////////////////////////////////////////////////////////////
28072 . ////////////////////////////////////////////////////////////////////////////
28073
28074 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
28075          "Encrypted SMTP connections"
28076 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
28077 .scindex IIDencsmtp2 "SMTP" "encryption"
28078 .cindex "TLS" "on SMTP connection"
28079 .cindex "OpenSSL"
28080 .cindex "GnuTLS"
28081 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
28082 Sockets Layer), is implemented by making use of the OpenSSL library or the
28083 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
28084 cryptographic code in the Exim distribution itself for implementing TLS. In
28085 order to use this feature you must install OpenSSL or GnuTLS, and then build a
28086 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
28087 You also need to understand the basic concepts of encryption at a managerial
28088 level, and in particular, the way that public keys, private keys, and
28089 certificates are used.
28090
28091 RFC 3207 defines how SMTP connections can make use of encryption. Once a
28092 connection is established, the client issues a STARTTLS command. If the
28093 server accepts this, the client and the server negotiate an encryption
28094 mechanism. If the negotiation succeeds, the data that subsequently passes
28095 between them is encrypted.
28096
28097 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
28098 and if so, what cipher suite is in use, whether the client supplied a
28099 certificate, and whether or not that certificate was verified. This makes it
28100 possible for an Exim server to deny or accept certain commands based on the
28101 encryption state.
28102
28103 &*Warning*&: Certain types of firewall and certain anti-virus products can
28104 disrupt TLS connections. You need to turn off SMTP scanning for these products
28105 in order to get TLS to work.
28106
28107
28108
28109 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
28110          "SECID284"
28111 .cindex "submissions protocol"
28112 .cindex "ssmtp protocol"
28113 .cindex "smtps protocol"
28114 .cindex "SMTP" "submissions protocol"
28115 .cindex "SMTP" "ssmtp protocol"
28116 .cindex "SMTP" "smtps protocol"
28117 The history of port numbers for TLS in SMTP is a little messy and has been
28118 contentious.  As of RFC 8314, the common practice of using the historically
28119 allocated port 465 for "email submission but with TLS immediately upon connect
28120 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28121 by them in preference to STARTTLS.
28122
28123 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28124 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28125 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28126
28127 This approach was, for a while, officially abandoned when encrypted SMTP was
28128 standardized, but many clients kept using it, even as the TCP port number was
28129 reassigned for other use.
28130 Thus you may encounter guidance claiming that you shouldn't enable use of
28131 this port.
28132 In practice, a number of mail-clients have only ever supported submissions,
28133 not submission with STARTTLS upgrade.
28134 Ideally, offer both submission (587) and submissions (465) service.
28135
28136 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28137 global option. Its value must be a list of port numbers;
28138 the most common use is expected to be:
28139 .code
28140 tls_on_connect_ports = 465
28141 .endd
28142 The port numbers specified by this option apply to all SMTP connections, both
28143 via the daemon and via &'inetd'&. You still need to specify all the ports that
28144 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28145 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28146 an extra port &-- rather, it specifies different behaviour on a port that is
28147 defined elsewhere.
28148
28149 There is also a &%-tls-on-connect%& command line option. This overrides
28150 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28151
28152
28153
28154
28155
28156
28157 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28158 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28159 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
28160 To build Exim to use OpenSSL you need to set
28161 .code
28162 USE_OPENSSL=yes
28163 .endd
28164 in Local/Makefile.
28165
28166 To build Exim to use GnuTLS, you need to set
28167 .code
28168 USE_GNUTLS=yes
28169 .endd
28170 in Local/Makefile.
28171
28172 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28173 include files and libraries for GnuTLS can be found.
28174
28175 There are some differences in usage when using GnuTLS instead of OpenSSL:
28176
28177 .ilist
28178 The &%tls_verify_certificates%& option
28179 cannot be the path of a directory
28180 for GnuTLS versions before 3.3.6
28181 (for later versions, or OpenSSL, it can be either).
28182 .next
28183 The default value for &%tls_dhparam%& differs for historical reasons.
28184 .next
28185 .vindex "&$tls_in_peerdn$&"
28186 .vindex "&$tls_out_peerdn$&"
28187 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
28188 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
28189 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
28190 .next
28191 OpenSSL identifies cipher suites using hyphens as separators, for example:
28192 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28193 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28194 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28195 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28196 to handle its own older variants) when processing lists of cipher suites in the
28197 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28198 option).
28199 .next
28200 The &%tls_require_ciphers%& options operate differently, as described in the
28201 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28202 .next
28203 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28204 When using OpenSSL, this option is ignored.
28205 (If an API is found to let OpenSSL be configured in this way,
28206 let the Exim Maintainers know and we'll likely use it).
28207 .next
28208 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28209 main option, it must be ordered to match the &%tls_certificate%& list.
28210 .next
28211 Some other recently added features may only be available in one or the other.
28212 This should be documented with the feature.  If the documentation does not
28213 explicitly state that the feature is infeasible in the other TLS
28214 implementation, then patches are welcome.
28215 .endlist
28216
28217
28218 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28219 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28220 an explicit path; if the latter, then the text about generation still applies,
28221 but not the chosen filename.
28222 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28223 See the documentation of &%tls_dhparam%& for more information.
28224
28225 GnuTLS uses D-H parameters that may take a substantial amount of time
28226 to compute. It is unreasonable to re-compute them for every TLS session.
28227 Therefore, Exim keeps this data in a file in its spool directory, called
28228 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28229 of bits requested.
28230 The file is owned by the Exim user and is readable only by
28231 its owner. Every Exim process that start up GnuTLS reads the D-H
28232 parameters from this file. If the file does not exist, the first Exim process
28233 that needs it computes the data and writes it to a temporary file which is
28234 renamed once it is complete. It does not matter if several Exim processes do
28235 this simultaneously (apart from wasting a few resources). Once a file is in
28236 place, new Exim processes immediately start using it.
28237
28238 For maximum security, the parameters that are stored in this file should be
28239 recalculated periodically, the frequency depending on your paranoia level.
28240 If you are avoiding using the fixed D-H primes published in RFCs, then you
28241 are concerned about some advanced attacks and will wish to do this; if you do
28242 not regenerate then you might as well stick to the standard primes.
28243
28244 Arranging this is easy in principle; just delete the file when you want new
28245 values to be computed. However, there may be a problem. The calculation of new
28246 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28247 If the system is not very active, &_/dev/random_& may delay returning data
28248 until enough randomness (entropy) is available. This may cause Exim to hang for
28249 a substantial amount of time, causing timeouts on incoming connections.
28250
28251 The solution is to generate the parameters externally to Exim. They are stored
28252 in &_gnutls-params-N_& in PEM format, which means that they can be
28253 generated externally using the &(certtool)& command that is part of GnuTLS.
28254
28255 To replace the parameters with new ones, instead of deleting the file
28256 and letting Exim re-create it, you can generate new parameters using
28257 &(certtool)& and, when this has been done, replace Exim's cache file by
28258 renaming. The relevant commands are something like this:
28259 .code
28260 # ls
28261 [ look for file; assume gnutls-params-2236 is the most recent ]
28262 # rm -f new-params
28263 # touch new-params
28264 # chown exim:exim new-params
28265 # chmod 0600 new-params
28266 # certtool --generate-dh-params --bits 2236 >>new-params
28267 # openssl dhparam -noout -text -in new-params | head
28268 [ check the first line, make sure it's not more than 2236;
28269   if it is, then go back to the start ("rm") and repeat
28270   until the size generated is at most the size requested ]
28271 # chmod 0400 new-params
28272 # mv new-params gnutls-params-2236
28273 .endd
28274 If Exim never has to generate the parameters itself, the possibility of
28275 stalling is removed.
28276
28277 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
28278 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
28279 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
28280 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
28281 and Exim does so.  This attempt to remove Exim from TLS policy decisions
28282 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
28283 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
28284 which applies to all D-H usage, client or server.  If the value returned by
28285 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
28286 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
28287 limit, which is still much higher than Exim historically used.
28288
28289 The filename and bits used will change as the GnuTLS maintainers change the
28290 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28291 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28292 2432 bits, while NSS is limited to 2236 bits.
28293
28294 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28295 increase the chance of the generated prime actually being within acceptable
28296 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28297 procedure above.  There is no sane procedure available to Exim to double-check
28298 the size of the generated prime, so it might still be too large.
28299
28300
28301 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28302 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28303 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28304 There is a function in the OpenSSL library that can be passed a list of cipher
28305 suites before the cipher negotiation takes place. This specifies which ciphers
28306 are acceptable for TLS versions prior to 1.3.
28307 The list is colon separated and may contain names like
28308 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28309 directly to this function call.
28310 Many systems will install the OpenSSL manual-pages, so you may have
28311 &'ciphers(1)'& available to you.
28312 The following quotation from the OpenSSL
28313 documentation specifies what forms of item are allowed in the cipher string:
28314
28315 .ilist
28316 It can consist of a single cipher suite such as RC4-SHA.
28317 .next
28318 It can represent a list of cipher suites containing a certain algorithm,
28319 or cipher suites of a certain type. For example SHA1 represents all
28320 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28321 SSL v3 algorithms.
28322 .next
28323 Lists of cipher suites can be combined in a single cipher string using
28324 the + character. This is used as a logical and operation. For example
28325 SHA1+DES represents all cipher suites containing the SHA1 and the DES
28326 algorithms.
28327 .endlist
28328
28329 Each cipher string can be optionally preceded by one of the characters &`!`&,
28330 &`-`& or &`+`&.
28331 .ilist
28332 If &`!`& is used, the ciphers are permanently deleted from the list. The
28333 ciphers deleted can never reappear in the list even if they are explicitly
28334 stated.
28335 .next
28336 If &`-`& is used, the ciphers are deleted from the list, but some or all
28337 of the ciphers can be added again by later options.
28338 .next
28339 If &`+`& is used, the ciphers are moved to the end of the list. This
28340 option does not add any new ciphers; it just moves matching existing ones.
28341 .endlist
28342
28343 If none of these characters is present, the string is interpreted as
28344 a list of ciphers to be appended to the current preference list. If the list
28345 includes any ciphers already present they will be ignored: that is, they will
28346 not be moved to the end of the list.
28347 .endlist
28348
28349 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
28350 string:
28351 .code
28352 # note single-quotes to get ! past any shell history expansion
28353 $ openssl ciphers 'HIGH:!MD5:!SHA1'
28354 .endd
28355
28356 This example will let the library defaults be permitted on the MX port, where
28357 there's probably no identity verification anyway, but ups the ante on the
28358 submission ports where the administrator might have some influence on the
28359 choice of clients used:
28360 .code
28361 # OpenSSL variant; see man ciphers(1)
28362 tls_require_ciphers = ${if =={$received_port}{25}\
28363                            {DEFAULT}\
28364                            {HIGH:!MD5:!SHA1}}
28365 .endd
28366
28367 This example will prefer ECDSA-authenticated ciphers over RSA ones:
28368 .code
28369 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
28370 .endd
28371
28372 For TLS version 1.3 the control available is less fine-grained
28373 and Exim does not provide access to it at present.
28374 The value of the &%tls_require_ciphers%& option is ignored when
28375 TLS version 1.3 is negotiated.
28376
28377 As of writing the library default cipher suite list for TLSv1.3 is
28378 .code
28379 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28380 .endd
28381
28382
28383 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28384          "SECTreqciphgnu"
28385 .cindex "GnuTLS" "specifying parameters for"
28386 .cindex "TLS" "specifying ciphers (GnuTLS)"
28387 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28388 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28389 .cindex "TLS" "specifying protocols (GnuTLS)"
28390 .cindex "TLS" "specifying priority string (GnuTLS)"
28391 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28392 The GnuTLS library allows the caller to provide a "priority string", documented
28393 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28394 ciphersuite specification in OpenSSL.
28395
28396 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28397 and controls both protocols and ciphers.
28398
28399 The &%tls_require_ciphers%& option is available both as an global option,
28400 controlling how Exim behaves as a server, and also as an option of the
28401 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28402 the value is string expanded.  The resulting string is not an Exim list and
28403 the string is given to the GnuTLS library, so that Exim does not need to be
28404 aware of future feature enhancements of GnuTLS.
28405
28406 Documentation of the strings accepted may be found in the GnuTLS manual, under
28407 "Priority strings".  This is online as
28408 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28409 but beware that this relates to GnuTLS 3, which may be newer than the version
28410 installed on your system.  If you are using GnuTLS 3,
28411 then the example code
28412 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28413 on that site can be used to test a given string.
28414
28415 For example:
28416 .code
28417 # Disable older versions of protocols
28418 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28419 .endd
28420
28421 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28422 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28423 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28424
28425 This example will let the library defaults be permitted on the MX port, where
28426 there's probably no identity verification anyway, and lowers security further
28427 by increasing compatibility; but this ups the ante on the submission ports
28428 where the administrator might have some influence on the choice of clients
28429 used:
28430 .code
28431 # GnuTLS variant
28432 tls_require_ciphers = ${if =={$received_port}{25}\
28433                            {NORMAL:%COMPAT}\
28434                            {SECURE128}}
28435 .endd
28436
28437
28438 .section "Configuring an Exim server to use TLS" "SECID182"
28439 .cindex "TLS" "configuring an Exim server"
28440 When Exim has been built with TLS support, it advertises the availability of
28441 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28442 but not to any others. The default value of this option is *, which means
28443 that STARTTLS is always advertised.  Set it to blank to never advertise;
28444 this is reasonable for systems that want to use TLS only as a client.
28445
28446 If STARTTLS is to be used you
28447 need to set some other options in order to make TLS available.
28448
28449 If a client issues a STARTTLS command and there is some configuration
28450 problem in the server, the command is rejected with a 454 error. If the client
28451 persists in trying to issue SMTP commands, all except QUIT are rejected
28452 with the error
28453 .code
28454 554 Security failure
28455 .endd
28456 If a STARTTLS command is issued within an existing TLS session, it is
28457 rejected with a 554 error code.
28458
28459 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
28460 must be set to match some hosts. The default is * which matches all hosts.
28461
28462 If this is all you do, TLS encryption will be enabled but not authentication -
28463 meaning that the peer has no assurance it is actually you he is talking to.
28464 You gain protection from a passive sniffer listening on the wire but not
28465 from someone able to intercept the communication.
28466
28467 Further protection requires some further configuration at the server end.
28468
28469 To make TLS work you need to set, in the server,
28470 .code
28471 tls_certificate = /some/file/name
28472 tls_privatekey = /some/file/name
28473 .endd
28474 These options are, in fact, expanded strings, so you can make them depend on
28475 the identity of the client that is connected if you wish. The first file
28476 contains the server's X509 certificate, and the second contains the private key
28477 that goes with it. These files need to be
28478 PEM format and readable by the Exim user, and must
28479 always be given as full path names.
28480 The key must not be password-protected.
28481 They can be the same file if both the
28482 certificate and the key are contained within it. If &%tls_privatekey%& is not
28483 set, or if its expansion is forced to fail or results in an empty string, this
28484 is assumed to be the case. The certificate file may also contain intermediate
28485 certificates that need to be sent to the client to enable it to authenticate
28486 the server's certificate.
28487
28488 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
28489 colon-separated lists of file paths.  Ciphers using given authentication
28490 algorithms require the presence of a suitable certificate to supply the
28491 public-key.  The server selects among the certificates to present to the
28492 client depending on the selected cipher, hence the priority ordering for
28493 ciphers will affect which certificate is used.
28494
28495 If you do not understand about certificates and keys, please try to find a
28496 source of this background information, which is not Exim-specific. (There are a
28497 few comments below in section &<<SECTcerandall>>&.)
28498
28499 &*Note*&: These options do not apply when Exim is operating as a client &--
28500 they apply only in the case of a server. If you need to use a certificate in an
28501 Exim client, you must set the options of the same names in an &(smtp)&
28502 transport.
28503
28504 With just these options, an Exim server will be able to use TLS. It does not
28505 require the client to have a certificate (but see below for how to insist on
28506 this). There is one other option that may be needed in other situations. If
28507 .code
28508 tls_dhparam = /some/file/name
28509 .endd
28510 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
28511 with the parameters contained in the file.
28512 Set this to &`none`& to disable use of DH entirely, by making no prime
28513 available:
28514 .code
28515 tls_dhparam = none
28516 .endd
28517 This may also be set to a string identifying a standard prime to be used for
28518 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
28519 used is &`ike23`&.  There are a few standard primes available, see the
28520 documentation for &%tls_dhparam%& for the complete list.
28521
28522 See the command
28523 .code
28524 openssl dhparam
28525 .endd
28526 for a way of generating file data.
28527
28528 The strings supplied for these three options are expanded every time a client
28529 host connects. It is therefore possible to use different certificates and keys
28530 for different hosts, if you so wish, by making use of the client's IP address
28531 in &$sender_host_address$& to control the expansion. If a string expansion is
28532 forced to fail, Exim behaves as if the option is not set.
28533
28534 .cindex "cipher" "logging"
28535 .cindex "log" "TLS cipher"
28536 .vindex "&$tls_in_cipher$&"
28537 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
28538 an incoming TLS connection. It is included in the &'Received:'& header of an
28539 incoming message (by default &-- you can, of course, change this), and it is
28540 also included in the log line that records a message's arrival, keyed by
28541 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
28542 condition can be used to test for specific cipher suites in ACLs.
28543
28544 Once TLS has been established, the ACLs that run for subsequent SMTP commands
28545 can check the name of the cipher suite and vary their actions accordingly. The
28546 cipher suite names vary, depending on which TLS library is being used. For
28547 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
28548 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
28549 documentation for more details.
28550
28551 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
28552 (again depending on the &%tls_cipher%& log selector).
28553
28554
28555 .section "Requesting and verifying client certificates" "SECID183"
28556 .cindex "certificate" "verification of client"
28557 .cindex "TLS" "client certificate verification"
28558 If you want an Exim server to request a certificate when negotiating a TLS
28559 session with a client, you must set either &%tls_verify_hosts%& or
28560 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
28561 apply to all TLS connections. For any host that matches one of these options,
28562 Exim requests a certificate as part of the setup of the TLS session. The
28563 contents of the certificate are verified by comparing it with a list of
28564 expected trust-anchors or certificates.
28565 These may be the system default set (depending on library version),
28566 an explicit file or,
28567 depending on library version, a directory, identified by
28568 &%tls_verify_certificates%&.
28569
28570 A file can contain multiple certificates, concatenated end to end. If a
28571 directory is used
28572 (OpenSSL only),
28573 each certificate must be in a separate file, with a name (or a symbolic link)
28574 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
28575 certificate. You can compute the relevant hash by running the command
28576 .code
28577 openssl x509 -hash -noout -in /cert/file
28578 .endd
28579 where &_/cert/file_& contains a single certificate.
28580
28581 There is no checking of names of the client against the certificate
28582 Subject Name or Subject Alternate Names.
28583
28584 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
28585 what happens if the client does not supply a certificate, or if the certificate
28586 does not match any of the certificates in the collection named by
28587 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
28588 attempt to set up a TLS session is aborted, and the incoming connection is
28589 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
28590 session continues. ACLs that run for subsequent SMTP commands can detect the
28591 fact that no certificate was verified, and vary their actions accordingly. For
28592 example, you can insist on a certificate before accepting a message for
28593 relaying, but not when the message is destined for local delivery.
28594
28595 .vindex "&$tls_in_peerdn$&"
28596 When a client supplies a certificate (whether it verifies or not), the value of
28597 the Distinguished Name of the certificate is made available in the variable
28598 &$tls_in_peerdn$& during subsequent processing of the message.
28599
28600 .cindex "log" "distinguished name"
28601 Because it is often a long text string, it is not included in the log line or
28602 &'Received:'& header by default. You can arrange for it to be logged, keyed by
28603 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
28604 &%received_header_text%& to change the &'Received:'& header. When no
28605 certificate is supplied, &$tls_in_peerdn$& is empty.
28606
28607
28608 .section "Revoked certificates" "SECID184"
28609 .cindex "TLS" "revoked certificates"
28610 .cindex "revocation list"
28611 .cindex "certificate" "revocation list"
28612 .cindex "OCSP" "stapling"
28613 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
28614 certificates are revoked. If you have such a list, you can pass it to an Exim
28615 server using the global option called &%tls_crl%& and to an Exim client using
28616 an identically named option for the &(smtp)& transport. In each case, the value
28617 of the option is expanded and must then be the name of a file that contains a
28618 CRL in PEM format.
28619 The downside is that clients have to periodically re-download a potentially huge
28620 file from every certificate authority they know of.
28621
28622 The way with most moving parts at query time is Online Certificate
28623 Status Protocol (OCSP), where the client verifies the certificate
28624 against an OCSP server run by the CA.  This lets the CA track all
28625 usage of the certs.  It requires running software with access to the
28626 private key of the CA, to sign the responses to the OCSP queries.  OCSP
28627 is based on HTTP and can be proxied accordingly.
28628
28629 The only widespread OCSP server implementation (known to this writer)
28630 comes as part of OpenSSL and aborts on an invalid request, such as
28631 connecting to the port and then disconnecting.  This requires
28632 re-entering the passphrase each time some random client does this.
28633
28634 The third way is OCSP Stapling; in this, the server using a certificate
28635 issued by the CA periodically requests an OCSP proof of validity from
28636 the OCSP server, then serves it up inline as part of the TLS
28637 negotiation.   This approach adds no extra round trips, does not let the
28638 CA track users, scales well with number of certs issued by the CA and is
28639 resilient to temporary OCSP server failures, as long as the server
28640 starts retrying to fetch an OCSP proof some time before its current
28641 proof expires.  The downside is that it requires server support.
28642
28643 Unless Exim is built with the support disabled,
28644 or with GnuTLS earlier than version 3.3.16 / 3.4.8
28645 support for OCSP stapling is included.
28646
28647 There is a global option called &%tls_ocsp_file%&.
28648 The file specified therein is expected to be in DER format, and contain
28649 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
28650 option will be re-expanded for SNI, if the &%tls_certificate%& option
28651 contains &`tls_in_sni`&, as per other TLS options.
28652
28653 Exim does not at this time implement any support for fetching a new OCSP
28654 proof.  The burden is on the administrator to handle this, outside of
28655 Exim.  The file specified should be replaced atomically, so that the
28656 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
28657 on each connection, so a new file will be handled transparently on the
28658 next connection.
28659
28660 When built with OpenSSL Exim will check for a valid next update timestamp
28661 in the OCSP proof; if not present, or if the proof has expired, it will be
28662 ignored.
28663
28664 For the client to be able to verify the stapled OCSP the server must
28665 also supply, in its stapled information, any intermediate
28666 certificates for the chain leading to the OCSP proof from the signer
28667 of the server certificate.  There may be zero or one such. These
28668 intermediate certificates should be added to the server OCSP stapling
28669 file named by &%tls_ocsp_file%&.
28670
28671 Note that the proof only covers the terminal server certificate,
28672 not any of the chain from CA to it.
28673
28674 There is no current way to staple a proof for a client certificate.
28675
28676 .code
28677   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
28678   OCSP server is supplied.  The server URL may be included in the
28679   server certificate, if the CA is helpful.
28680
28681   One failure mode seen was the OCSP Signer cert expiring before the end
28682   of validity of the OCSP proof. The checking done by Exim/OpenSSL
28683   noted this as invalid overall, but the re-fetch script did not.
28684 .endd
28685
28686
28687
28688
28689 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
28690 .cindex "cipher" "logging"
28691 .cindex "log" "TLS cipher"
28692 .cindex "log" "distinguished name"
28693 .cindex "TLS" "configuring an Exim client"
28694 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
28695 deliveries as well as to incoming, the latter one causing logging of the
28696 server certificate's DN. The remaining client configuration for TLS is all
28697 within the &(smtp)& transport.
28698
28699 It is not necessary to set any options to have TLS work in the &(smtp)&
28700 transport. If Exim is built with TLS support, and TLS is advertised by a
28701 server, the &(smtp)& transport always tries to start a TLS session. However,
28702 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
28703 transport) to a list of server hosts for which TLS should not be used.
28704
28705 If you do not want Exim to attempt to send messages unencrypted when an attempt
28706 to set up an encrypted connection fails in any way, you can set
28707 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
28708 those hosts, delivery is always deferred if an encrypted connection cannot be
28709 set up. If there are any other hosts for the address, they are tried in the
28710 usual way.
28711
28712 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
28713 the message unencrypted. It always does this if the response to STARTTLS is
28714 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
28715 session after a success response code, what happens is controlled by the
28716 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
28717 delivery to this host is deferred, and other hosts (if available) are tried. If
28718 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
28719 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
28720 negotiation fails, Exim closes the current connection (because it is in an
28721 unknown state), opens a new one to the same host, and then tries the delivery
28722 unencrypted.
28723
28724 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
28725 transport provide the client with a certificate, which is passed to the server
28726 if it requests it. If the server is Exim, it will request a certificate only if
28727 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
28728
28729 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
28730 for client use (they are usable for server use).
28731 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
28732 in failed connections.
28733
28734 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
28735 specifies a collection of expected server certificates.
28736 These may be
28737 the system default set (depending on library version),
28738 a file,
28739 or (depending on library version) a directory.
28740 The client verifies the server's certificate
28741 against this collection, taking into account any revoked certificates that are
28742 in the list defined by &%tls_crl%&.
28743 Failure to verify fails the TLS connection unless either of the
28744 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
28745
28746 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
28747 certificate verification to the listed servers.  Verification either must
28748 or need not succeed respectively.
28749
28750 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
28751 checks are made: that the host name (the one in the DNS A record)
28752 is valid for the certificate.
28753 The option defaults to always checking.
28754
28755 The &(smtp)& transport has two OCSP-related options:
28756 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
28757 is requested and required for the connection to proceed.  The default
28758 value is empty.
28759 &%hosts_request_ocsp%&; a host-list for which (additionally)
28760 a Certificate Status is requested (but not necessarily verified).  The default
28761 value is "*" meaning that requests are made unless configured
28762 otherwise.
28763
28764 The host(s) should also be in &%hosts_require_tls%&, and
28765 &%tls_verify_certificates%& configured for the transport,
28766 for OCSP to be relevant.
28767
28768 If
28769 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
28770 list of permitted cipher suites. If either of these checks fails, delivery to
28771 the current host is abandoned, and the &(smtp)& transport tries to deliver to
28772 alternative hosts, if any.
28773
28774  &*Note*&:
28775 These options must be set in the &(smtp)& transport for Exim to use TLS when it
28776 is operating as a client. Exim does not assume that a server certificate (set
28777 by the global options of the same name) should also be used when operating as a
28778 client.
28779
28780 .vindex "&$host$&"
28781 .vindex "&$host_address$&"
28782 All the TLS options in the &(smtp)& transport are expanded before use, with
28783 &$host$& and &$host_address$& containing the name and address of the server to
28784 which the client is connected. Forced failure of an expansion causes Exim to
28785 behave as if the relevant option were unset.
28786
28787 .vindex &$tls_out_bits$&
28788 .vindex &$tls_out_cipher$&
28789 .vindex &$tls_out_peerdn$&
28790 .vindex &$tls_out_sni$&
28791 Before an SMTP connection is established, the
28792 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
28793 variables are emptied. (Until the first connection, they contain the values
28794 that were set when the message was received.) If STARTTLS is subsequently
28795 successfully obeyed, these variables are set to the relevant values for the
28796 outgoing connection.
28797
28798
28799
28800 .section "Use of TLS Server Name Indication" "SECTtlssni"
28801 .cindex "TLS" "Server Name Indication"
28802 .vindex "&$tls_in_sni$&"
28803 .oindex "&%tls_in_sni%&"
28804 With TLS1.0 or above, there is an extension mechanism by which extra
28805 information can be included at various points in the protocol.  One of these
28806 extensions, documented in RFC 6066 (and before that RFC 4366) is
28807 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
28808 client in the initial handshake, so that the server can examine the servername
28809 within and possibly choose to use different certificates and keys (and more)
28810 for this session.
28811
28812 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
28813 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
28814 address.
28815
28816 With SMTP to MX, there are the same problems here as in choosing the identity
28817 against which to validate a certificate: you can't rely on insecure DNS to
28818 provide the identity which you then cryptographically verify.  So this will
28819 be of limited use in that environment.
28820
28821 With SMTP to Submission, there is a well-defined hostname which clients are
28822 connecting to and can validate certificates against.  Thus clients &*can*&
28823 choose to include this information in the TLS negotiation.  If this becomes
28824 wide-spread, then hosters can choose to present different certificates to
28825 different clients.  Or even negotiate different cipher suites.
28826
28827 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
28828 if not empty, will be sent on a TLS session as part of the handshake.  There's
28829 nothing more to it.  Choosing a sensible value not derived insecurely is the
28830 only point of caution.  The &$tls_out_sni$& variable will be set to this string
28831 for the lifetime of the client connection (including during authentication).
28832
28833 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
28834 received from a client.
28835 It can be logged with the &%log_selector%& item &`+tls_sni`&.
28836
28837 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
28838 option (prior to expansion) then the following options will be re-expanded
28839 during TLS session handshake, to permit alternative values to be chosen:
28840
28841 .ilist
28842 &%tls_certificate%&
28843 .next
28844 &%tls_crl%&
28845 .next
28846 &%tls_privatekey%&
28847 .next
28848 &%tls_verify_certificates%&
28849 .next
28850 &%tls_ocsp_file%&
28851 .endlist
28852
28853 Great care should be taken to deal with matters of case, various injection
28854 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
28855 can always be referenced; it is important to remember that &$tls_in_sni$& is
28856 arbitrary unverified data provided prior to authentication.
28857 Further, the initial certificate is loaded before SNI has arrived, so
28858 an expansion for &%tls_certificate%& must have a default which is used
28859 when &$tls_in_sni$& is empty.
28860
28861 The Exim developers are proceeding cautiously and so far no other TLS options
28862 are re-expanded.
28863
28864 When Exim is built against OpenSSL, OpenSSL must have been built with support
28865 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
28866 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
28867 see &`-servername`& in the output, then OpenSSL has support.
28868
28869 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
28870 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
28871 built, then you have SNI support).
28872
28873
28874
28875 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
28876          "SECTmulmessam"
28877 .cindex "multiple SMTP deliveries with TLS"
28878 .cindex "TLS" "multiple message deliveries"
28879 Exim sends multiple messages down the same TCP/IP connection by starting up
28880 an entirely new delivery process for each message, passing the socket from
28881 one process to the next. This implementation does not fit well with the use
28882 of TLS, because there is quite a lot of state information associated with a TLS
28883 connection, not just a socket identification. Passing all the state information
28884 to a new process is not feasible. Consequently, for sending using TLS Exim
28885 starts an additional proxy process for handling the encryption, piping the
28886 unencrypted data stream from and to the delivery processes.
28887
28888 An older mode of operation can be enabled on a per-host basis by the
28889 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
28890 this list the proxy process described above is not used; instead Exim
28891 shuts down an existing TLS session being run by the delivery process
28892 before passing the socket to a new process. The new process may then
28893 try to start a new TLS session, and if successful, may try to re-authenticate
28894 if AUTH is in use, before sending the next message.
28895
28896 The RFC is not clear as to whether or not an SMTP session continues in clear
28897 after TLS has been shut down, or whether TLS may be restarted again later, as
28898 just described. However, if the server is Exim, this shutdown and
28899 reinitialization works. It is not known which (if any) other servers operate
28900 successfully if the client closes a TLS session and continues with unencrypted
28901 SMTP, but there are certainly some that do not work. For such servers, Exim
28902 should not pass the socket to another process, because the failure of the
28903 subsequent attempt to use it would cause Exim to record a temporary host error,
28904 and delay other deliveries to that host.
28905
28906 To test for this case, Exim sends an EHLO command to the server after
28907 closing down the TLS session. If this fails in any way, the connection is
28908 closed instead of being passed to a new delivery process, but no retry
28909 information is recorded.
28910
28911 There is also a manual override; you can set &%hosts_nopass_tls%& on the
28912 &(smtp)& transport to match those hosts for which Exim should not pass
28913 connections to new processes if TLS has been used.
28914
28915
28916
28917
28918 .section "Certificates and all that" "SECTcerandall"
28919 .cindex "certificate" "references to discussion"
28920 In order to understand fully how TLS works, you need to know about
28921 certificates, certificate signing, and certificate authorities.
28922 This is a large topic and an introductory guide is unsuitable for the Exim
28923 reference manual, so instead we provide pointers to existing documentation.
28924
28925 The Apache web-server was for a long time the canonical guide, so their
28926 documentation is a good place to start; their SSL module's Introduction
28927 document is currently at
28928 .display
28929 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
28930 .endd
28931 and their FAQ is at
28932 .display
28933 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
28934 .endd
28935
28936 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
28937 0-201-61598-3) in 2001, contains both introductory and more in-depth
28938 descriptions.
28939 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
28940 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
28941 Ivan is the author of the popular TLS testing tools at
28942 &url(https://www.ssllabs.com/).
28943
28944
28945 .section "Certificate chains" "SECID186"
28946 The file named by &%tls_certificate%& may contain more than one
28947 certificate. This is useful in the case where the certificate that is being
28948 sent is validated by an intermediate certificate which the other end does
28949 not have. Multiple certificates must be in the correct order in the file.
28950 First the host's certificate itself, then the first intermediate
28951 certificate to validate the issuer of the host certificate, then the next
28952 intermediate certificate to validate the issuer of the first intermediate
28953 certificate, and so on, until finally (optionally) the root certificate.
28954 The root certificate must already be trusted by the recipient for
28955 validation to succeed, of course, but if it's not preinstalled, sending the
28956 root certificate along with the rest makes it available for the user to
28957 install if the receiving end is a client MUA that can interact with a user.
28958
28959 Note that certificates using MD5 are unlikely to work on today's Internet;
28960 even if your libraries allow loading them for use in Exim when acting as a
28961 server, increasingly clients will not accept such certificates.  The error
28962 diagnostics in such a case can be frustratingly vague.
28963
28964
28965
28966 .section "Self-signed certificates" "SECID187"
28967 .cindex "certificate" "self-signed"
28968 You can create a self-signed certificate using the &'req'& command provided
28969 with OpenSSL, like this:
28970 . ==== Do not shorten the duration here without reading and considering
28971 . ==== the text below.  Please leave it at 9999 days.
28972 .code
28973 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
28974             -days 9999 -nodes
28975 .endd
28976 &_file1_& and &_file2_& can be the same file; the key and the certificate are
28977 delimited and so can be identified independently. The &%-days%& option
28978 specifies a period for which the certificate is valid. The &%-nodes%& option is
28979 important: if you do not set it, the key is encrypted with a passphrase
28980 that you are prompted for, and any use that is made of the key causes more
28981 prompting for the passphrase. This is not helpful if you are going to use
28982 this certificate and key in an MTA, where prompting is not possible.
28983
28984 . ==== I expect to still be working 26 years from now.  The less technical
28985 . ==== debt I create, in terms of storing up trouble for my later years, the
28986 . ==== happier I will be then.  We really have reached the point where we
28987 . ==== should start, at the very least, provoking thought and making folks
28988 . ==== pause before proceeding, instead of leaving all the fixes until two
28989 . ==== years before 2^31 seconds after the 1970 Unix epoch.
28990 . ==== -pdp, 2012
28991 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
28992 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
28993 the above command might produce a date in the past.  Think carefully about
28994 the lifetime of the systems you're deploying, and either reduce the duration
28995 of the certificate or reconsider your platform deployment.  (At time of
28996 writing, reducing the duration is the most likely choice, but the inexorable
28997 progression of time takes us steadily towards an era where this will not
28998 be a sensible resolution).
28999
29000 A self-signed certificate made in this way is sufficient for testing, and
29001 may be adequate for all your requirements if you are mainly interested in
29002 encrypting transfers, and not in secure identification.
29003
29004 However, many clients require that the certificate presented by the server be a
29005 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
29006 certificate. In this situation, the self-signed certificate described above
29007 must be installed on the client host as a trusted root &'certification
29008 authority'& (CA), and the certificate used by Exim must be a user certificate
29009 signed with that self-signed certificate.
29010
29011 For information on creating self-signed CA certificates and using them to sign
29012 user certificates, see the &'General implementation overview'& chapter of the
29013 Open-source PKI book, available online at
29014 &url(https://sourceforge.net/projects/ospkibook/).
29015 .ecindex IIDencsmtp1
29016 .ecindex IIDencsmtp2
29017
29018
29019
29020 .section DANE "SECDANE"
29021 .cindex DANE
29022 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
29023 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
29024 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
29025 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
29026 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
29027 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
29028
29029 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
29030 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
29031 by (a) is thought to be smaller than that of the set of root CAs.
29032
29033 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
29034 fail to pass on a server's STARTTLS.
29035
29036 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
29037 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
29038 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
29039
29040 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
29041 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
29042 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
29043 DNSSEC.
29044 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
29045 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
29046
29047 There are no changes to Exim specific to server-side operation of DANE.
29048 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
29049 in &_Local/Makefile_&.
29050 If it has been included, the macro "_HAVE_DANE" will be defined.
29051
29052 A TLSA record consist of 4 fields, the "Certificate Usage", the
29053 "Selector", the "Matching type", and the "Certificate Association Data".
29054 For a detailed description of the TLSA record see
29055 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
29056
29057 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
29058 These are the "Trust Anchor" and "End Entity" variants.
29059 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
29060 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
29061 this is appropriate for a single system, using a self-signed certificate.
29062 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
29063 well-known one.
29064 A private CA at simplest is just a self-signed certificate (with certain
29065 attributes) which is used to sign server certificates, but running one securely
29066 does require careful arrangement.
29067 With DANE-TA, as implemented in Exim and commonly in other MTAs,
29068 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
29069 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
29070 all of which point to a single TLSA record.
29071 DANE-TA and DANE-EE can both be used together.
29072
29073 Our recommendation is to use DANE with a certificate from a public CA,
29074 because this enables a variety of strategies for remote clients to verify
29075 your certificate.
29076 You can then publish information both via DANE and another technology,
29077 "MTA-STS", described below.
29078
29079 When you use DANE-TA to publish trust anchor information, you ask entities
29080 outside your administrative control to trust the Certificate Authority for
29081 connections to you.
29082 If using a private CA then you should expect others to still apply the
29083 technical criteria they'd use for a public CA to your certificates.
29084 In particular, you should probably try to follow current best practices for CA
29085 operation around hash algorithms and key sizes.
29086 Do not expect other organizations to lower their security expectations just
29087 because a particular profile might be reasonable for your own internal use.
29088
29089 When this text was last updated, this in practice means to avoid use of SHA-1
29090 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
29091 than 4096, for interoperability); to use keyUsage fields correctly; to use
29092 random serial numbers.
29093 The list of requirements is subject to change as best practices evolve.
29094 If you're not already using a private CA, or it doesn't meet these
29095 requirements, then we encourage you to avoid all these issues and use a public
29096 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
29097
29098 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
29099 a "Matching Type" (3rd) field of SHA2-512(2).
29100
29101 For the "Certificate Authority Data" (4th) field, commands like
29102
29103 .code
29104   openssl x509 -pubkey -noout <certificate.pem \
29105   | openssl rsa -outform der -pubin 2>/dev/null \
29106   | openssl sha512 \
29107   | awk '{print $2}'
29108 .endd
29109
29110 are workable to create a hash of the certificate's public key.
29111
29112 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
29113
29114 .code
29115   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
29116 .endd
29117
29118 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
29119 is useful for quickly generating TLSA records.
29120
29121
29122 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
29123
29124 The Certificate issued by the CA published in the DANE-TA model should be
29125 issued using a strong hash algorithm.
29126 Exim, and importantly various other MTAs sending to you, will not
29127 re-enable hash algorithms which have been disabled by default in TLS
29128 libraries.
29129 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
29130 interoperability (and probably the maximum too, in 2018).
29131
29132 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
29133 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
29134 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
29135
29136 .code
29137   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
29138                                  {= {4}{$tls_out_tlsa_usage}} } \
29139                          {*}{}}
29140 .endd
29141
29142 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
29143 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
29144 found. If the definition of &%hosts_request_ocsp%& includes the
29145 string "tls_out_tlsa_usage", they are re-expanded in time to
29146 control the OCSP request.
29147
29148 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
29149 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
29150
29151
29152 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
29153 and &%dane_require_tls_ciphers%&.
29154 The &"require"& variant will result in failure if the target host is not
29155 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
29156 the &%dnssec_request_domains%& router or transport option.
29157
29158 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
29159
29160 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
29161 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
29162 will be required for the host.  If it does not, the host will not
29163 be used; there is no fallback to non-DANE or non-TLS.
29164
29165 If DANE is requested and usable, then the TLS cipher list configuration
29166 prefers to use the option &%dane_require_tls_ciphers%& and falls
29167 back to &%tls_require_ciphers%& only if that is unset.
29168 This lets you configure "decent crypto" for DANE and "better than nothing
29169 crypto" as the default.  Note though that while GnuTLS lets the string control
29170 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
29171 limited to ciphersuite constraints.
29172
29173 If DANE is requested and useable (see above) the following transport options are ignored:
29174 .code
29175   hosts_require_tls
29176   tls_verify_hosts
29177   tls_try_verify_hosts
29178   tls_verify_certificates
29179   tls_crl
29180   tls_verify_cert_hostnames
29181 .endd
29182
29183 If DANE is not usable, whether requested or not, and CA-anchored
29184 verification evaluation is wanted, the above variables should be set appropriately.
29185
29186 The router and transport option &%dnssec_request_domains%& must not be
29187 set to &"never"&, and &%dnssec_require_domains%& is ignored.
29188
29189 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
29190
29191 There is a new variable &$tls_out_dane$& which will have "yes" if
29192 verification succeeded using DANE and "no" otherwise (only useful
29193 in combination with events; see &<<CHAPevents>>&),
29194 and a new variable &$tls_out_tlsa_usage$& (detailed above).
29195
29196 .cindex DANE reporting
29197 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
29198 to achieve DANE-verified connection, if one was either requested and offered, or
29199 required.  This is intended to support TLS-reporting as defined in
29200 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
29201 The &$event_data$& will be one of the Result Types defined in
29202 Section 4.3 of that document.
29203
29204 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
29205
29206 DANE is specified in published RFCs and decouples certificate authority trust
29207 selection from a "race to the bottom" of "you must trust everything for mail
29208 to get through".  There is an alternative technology called MTA-STS, which
29209 instead publishes MX trust anchor information on an HTTPS website.  At the
29210 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
29211 Exim has no support for MTA-STS as a client, but Exim mail server operators
29212 can choose to publish information describing their TLS configuration using
29213 MTA-STS to let those clients who do use that protocol derive trust
29214 information.
29215
29216 The MTA-STS design requires a certificate from a public Certificate Authority
29217 which is recognized by clients sending to you.
29218 That selection of which CAs are trusted by others is outside your control.
29219
29220 The most interoperable course of action is probably to use
29221 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
29222 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
29223 records for DANE clients (such as Exim and Postfix) and to publish anchor
29224 information for MTA-STS as well.  This is what is done for the &'exim.org'&
29225 domain itself (with caveats around occasionally broken MTA-STS because of
29226 incompatible specification changes prior to reaching RFC status).
29227
29228
29229
29230 . ////////////////////////////////////////////////////////////////////////////
29231 . ////////////////////////////////////////////////////////////////////////////
29232
29233 .chapter "Access control lists" "CHAPACL"
29234 .scindex IIDacl "&ACL;" "description"
29235 .cindex "control of incoming mail"
29236 .cindex "message" "controlling incoming"
29237 .cindex "policy control" "access control lists"
29238 Access Control Lists (ACLs) are defined in a separate section of the runtime
29239 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
29240 name, terminated by a colon. Here is a complete ACL section that contains just
29241 one very small ACL:
29242 .code
29243 begin acl
29244 small_acl:
29245   accept   hosts = one.host.only
29246 .endd
29247 You can have as many lists as you like in the ACL section, and the order in
29248 which they appear does not matter. The lists are self-terminating.
29249
29250 The majority of ACLs are used to control Exim's behaviour when it receives
29251 certain SMTP commands. This applies both to incoming TCP/IP connections, and
29252 when a local process submits a message using SMTP by specifying the &%-bs%&
29253 option. The most common use is for controlling which recipients are accepted
29254 in incoming messages. In addition, you can define an ACL that is used to check
29255 local non-SMTP messages. The default configuration file contains an example of
29256 a realistic ACL for checking RCPT commands. This is discussed in chapter
29257 &<<CHAPdefconfil>>&.
29258
29259
29260 .section "Testing ACLs" "SECID188"
29261 The &%-bh%& command line option provides a way of testing your ACL
29262 configuration locally by running a fake SMTP session with which you interact.
29263
29264
29265 .section "Specifying when ACLs are used" "SECID189"
29266 .cindex "&ACL;" "options for specifying"
29267 In order to cause an ACL to be used, you have to name it in one of the relevant
29268 options in the main part of the configuration. These options are:
29269 .cindex "AUTH" "ACL for"
29270 .cindex "DATA" "ACLs for"
29271 .cindex "ETRN" "ACL for"
29272 .cindex "EXPN" "ACL for"
29273 .cindex "HELO" "ACL for"
29274 .cindex "EHLO" "ACL for"
29275 .cindex "DKIM" "ACL for"
29276 .cindex "MAIL" "ACL for"
29277 .cindex "QUIT, ACL for"
29278 .cindex "RCPT" "ACL for"
29279 .cindex "STARTTLS, ACL for"
29280 .cindex "VRFY" "ACL for"
29281 .cindex "SMTP" "connection, ACL for"
29282 .cindex "non-SMTP messages" "ACLs for"
29283 .cindex "MIME content scanning" "ACL for"
29284 .cindex "PRDR" "ACL for"
29285
29286 .table2 140pt
29287 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
29288 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
29289 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
29290 .irow &%acl_smtp_auth%&        "ACL for AUTH"
29291 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
29292 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
29293 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
29294 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
29295 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
29296 .irow &%acl_smtp_expn%&        "ACL for EXPN"
29297 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
29298 .irow &%acl_smtp_mail%&        "ACL for MAIL"
29299 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
29300 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
29301 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
29302 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
29303 .irow &%acl_smtp_quit%&        "ACL for QUIT"
29304 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
29305 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
29306 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
29307 .endtable
29308
29309 For example, if you set
29310 .code
29311 acl_smtp_rcpt = small_acl
29312 .endd
29313 the little ACL defined above is used whenever Exim receives a RCPT command
29314 in an SMTP dialogue. The majority of policy tests on incoming messages can be
29315 done when RCPT commands arrive. A rejection of RCPT should cause the
29316 sending MTA to give up on the recipient address contained in the RCPT
29317 command, whereas rejection at other times may cause the client MTA to keep on
29318 trying to deliver the message. It is therefore recommended that you do as much
29319 testing as possible at RCPT time.
29320
29321
29322 .section "The non-SMTP ACLs" "SECID190"
29323 .cindex "non-SMTP messages" "ACLs for"
29324 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
29325 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
29326 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
29327 the state of the SMTP connection such as encryption and authentication) are not
29328 relevant and are forbidden in these ACLs. However, the sender and recipients
29329 are known, so the &%senders%& and &%sender_domains%& conditions and the
29330 &$sender_address$& and &$recipients$& variables can be used. Variables such as
29331 &$authenticated_sender$& are also available. You can specify added header lines
29332 in any of these ACLs.
29333
29334 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
29335 non-SMTP message, before any of the message has been read. (This is the
29336 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
29337 batched SMTP input, it runs after the DATA command has been reached. The
29338 result of this ACL is ignored; it cannot be used to reject a message. If you
29339 really need to, you could set a value in an ACL variable here and reject based
29340 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
29341 controls, and in particular, it can be used to set
29342 .code
29343 control = suppress_local_fixups
29344 .endd
29345 This cannot be used in the other non-SMTP ACLs because by the time they are
29346 run, it is too late.
29347
29348 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
29349 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29350
29351 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
29352 kind of rejection is treated as permanent, because there is no way of sending a
29353 temporary error for these kinds of message.
29354
29355
29356 .section "The SMTP connect ACL" "SECID191"
29357 .cindex "SMTP" "connection, ACL for"
29358 .oindex &%smtp_banner%&
29359 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
29360 session, after the test specified by &%host_reject_connection%& (which is now
29361 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
29362 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
29363 the message override the banner message that is otherwise specified by the
29364 &%smtp_banner%& option.
29365
29366
29367 .section "The EHLO/HELO ACL" "SECID192"
29368 .cindex "EHLO" "ACL for"
29369 .cindex "HELO" "ACL for"
29370 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
29371 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
29372 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
29373 Note that a client may issue more than one EHLO or HELO command in an SMTP
29374 session, and indeed is required to issue a new EHLO or HELO after successfully
29375 setting up encryption following a STARTTLS command.
29376
29377 Note also that a deny neither forces the client to go away nor means that
29378 mail will be refused on the connection.  Consider checking for
29379 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
29380
29381 If the command is accepted by an &%accept%& verb that has a &%message%&
29382 modifier, the message may not contain more than one line (it will be truncated
29383 at the first newline and a panic logged if it does). Such a message cannot
29384 affect the EHLO options that are listed on the second and subsequent lines of
29385 an EHLO response.
29386
29387
29388 .section "The DATA ACLs" "SECID193"
29389 .cindex "DATA" "ACLs for"
29390 Two ACLs are associated with the DATA command, because it is two-stage
29391 command, with two responses being sent to the client.
29392 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
29393 is obeyed. This gives you control after all the RCPT commands, but before
29394 the message itself is received. It offers the opportunity to give a negative
29395 response to the DATA command before the data is transmitted. Header lines
29396 added by MAIL or RCPT ACLs are not visible at this time, but any that
29397 are defined here are visible when the &%acl_smtp_data%& ACL is run.
29398
29399 You cannot test the contents of the message, for example, to verify addresses
29400 in the headers, at RCPT time or when the DATA command is received. Such
29401 tests have to appear in the ACL that is run after the message itself has been
29402 received, before the final response to the DATA command is sent. This is
29403 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
29404 associated with the DATA command.
29405
29406 .cindex CHUNKING "BDAT command"
29407 .cindex BDAT "SMTP command"
29408 .cindex "RFC 3030" CHUNKING
29409 If CHUNKING was advertised and a BDAT command sequence is received,
29410 the &%acl_smtp_predata%& ACL is not run.
29411 . XXX why not?  It should be possible, for the first BDAT.
29412 The &%acl_smtp_data%& is run after the last BDAT command and all of
29413 the data specified is received.
29414
29415 For both of these ACLs, it is not possible to reject individual recipients. An
29416 error response rejects the entire message. Unfortunately, it is known that some
29417 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
29418 before or after the data) correctly &-- they keep the message on their queues
29419 and try again later, but that is their problem, though it does waste some of
29420 your resources.
29421
29422 The &%acl_smtp_data%& ACL is run after
29423 the &%acl_smtp_data_prdr%&,
29424 the &%acl_smtp_dkim%&
29425 and the &%acl_smtp_mime%& ACLs.
29426
29427 .section "The SMTP DKIM ACL" "SECTDKIMACL"
29428 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
29429 enabled (which is the default).
29430
29431 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
29432 received, and is executed for each DKIM signature found in a message.  If not
29433 otherwise specified, the default action is to accept.
29434
29435 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
29436
29437 For details on the operation of DKIM, see section &<<SECDKIM>>&.
29438
29439
29440 .section "The SMTP MIME ACL" "SECID194"
29441 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
29442 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29443
29444 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29445
29446
29447 .section "The SMTP PRDR ACL" "SECTPRDRACL"
29448 .cindex "PRDR" "ACL for"
29449 .oindex "&%prdr_enable%&"
29450 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
29451 with PRDR support enabled (which is the default).
29452 It becomes active only when the PRDR feature is negotiated between
29453 client and server for a message, and more than one recipient
29454 has been accepted.
29455
29456 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
29457 has been received, and is executed once for each recipient of the message
29458 with &$local_part$& and &$domain$& valid.
29459 The test may accept, defer or deny for individual recipients.
29460 The &%acl_smtp_data%& will still be called after this ACL and
29461 can reject the message overall, even if this ACL has accepted it
29462 for some or all recipients.
29463
29464 PRDR may be used to support per-user content filtering.  Without it
29465 one must defer any recipient after the first that has a different
29466 content-filter configuration.  With PRDR, the RCPT-time check
29467 .cindex "PRDR" "variable for"
29468 for this can be disabled when the variable &$prdr_requested$&
29469 is &"yes"&.
29470 Any required difference in behaviour of the main DATA-time
29471 ACL should however depend on the PRDR-time ACL having run, as Exim
29472 will avoid doing so in some situations (e.g. single-recipient mails).
29473
29474 See also the &%prdr_enable%& global option
29475 and the &%hosts_try_prdr%& smtp transport option.
29476
29477 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29478 If the ACL is not defined, processing completes as if
29479 the feature was not requested by the client.
29480
29481 .section "The QUIT ACL" "SECTQUITACL"
29482 .cindex "QUIT, ACL for"
29483 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
29484 does not affect the response code to QUIT, which is always 221. Thus, the ACL
29485 does not in fact control any access.
29486 For this reason, it may only accept
29487 or warn as its final result.
29488
29489 This ACL can be used for tasks such as custom logging at the end of an SMTP
29490 session. For example, you can use ACL variables in other ACLs to count
29491 messages, recipients, etc., and log the totals at QUIT time using one or
29492 more &%logwrite%& modifiers on a &%warn%& verb.
29493
29494 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
29495 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
29496
29497 You do not need to have a final &%accept%&, but if you do, you can use a
29498 &%message%& modifier to specify custom text that is sent as part of the 221
29499 response to QUIT.
29500
29501 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
29502 failure (for example, failure to open a log file, or when Exim is bombing out
29503 because it has detected an unrecoverable error), all SMTP commands from the
29504 client are given temporary error responses until QUIT is received or the
29505 connection is closed. In these special cases, the QUIT ACL does not run.
29506
29507
29508 .section "The not-QUIT ACL" "SECTNOTQUITACL"
29509 .vindex &$acl_smtp_notquit$&
29510 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
29511 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
29512 trouble, such as being unable to write to its log files, this ACL is not run,
29513 because it might try to do things (such as write to log files) that make the
29514 situation even worse.
29515
29516 Like the QUIT ACL, this ACL is provided to make it possible to do customized
29517 logging or to gather statistics, and its outcome is ignored. The &%delay%&
29518 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
29519 and &%warn%&.
29520
29521 .vindex &$smtp_notquit_reason$&
29522 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
29523 to a string that indicates the reason for the termination of the SMTP
29524 connection. The possible values are:
29525 .table2
29526 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
29527 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
29528 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
29529 .irow &`connection-lost`&          "The SMTP connection has been lost"
29530 .irow &`data-timeout`&             "Timeout while reading message data"
29531 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
29532 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
29533 .irow &`signal-exit`&              "SIGTERM or SIGINT"
29534 .irow &`synchronization-error`&    "SMTP synchronization error"
29535 .irow &`tls-failed`&               "TLS failed to start"
29536 .endtable
29537 In most cases when an SMTP connection is closed without having received QUIT,
29538 Exim sends an SMTP response message before actually closing the connection.
29539 With the exception of the &`acl-drop`& case, the default message can be
29540 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
29541 &%drop%& verb in another ACL, it is the message from the other ACL that is
29542 used.
29543
29544
29545 .section "Finding an ACL to use" "SECID195"
29546 .cindex "&ACL;" "finding which to use"
29547 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
29548 you can use different ACLs in different circumstances. For example,
29549 .code
29550 acl_smtp_rcpt = ${if ={25}{$interface_port} \
29551                      {acl_check_rcpt} {acl_check_rcpt_submit} }
29552 .endd
29553 In the default configuration file there are some example settings for
29554 providing an RFC 4409 message &"submission"& service on port 587 and
29555 an RFC 8314 &"submissions"& service on port 465. You can use a string
29556 expansion like this to choose an ACL for MUAs on these ports which is
29557 more appropriate for this purpose than the default ACL on port 25.
29558
29559 The expanded string does not have to be the name of an ACL in the
29560 configuration file; there are other possibilities. Having expanded the
29561 string, Exim searches for an ACL as follows:
29562
29563 .ilist
29564 If the string begins with a slash, Exim uses it as a filename, and reads its
29565 contents as an ACL. The lines are processed in the same way as lines in the
29566 Exim configuration file. In particular, continuation lines are supported, blank
29567 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
29568 If the file does not exist or cannot be read, an error occurs (typically
29569 causing a temporary failure of whatever caused the ACL to be run). For example:
29570 .code
29571 acl_smtp_data = /etc/acls/\
29572   ${lookup{$sender_host_address}lsearch\
29573   {/etc/acllist}{$value}{default}}
29574 .endd
29575 This looks up an ACL file to use on the basis of the host's IP address, falling
29576 back to a default if the lookup fails. If an ACL is successfully read from a
29577 file, it is retained in memory for the duration of the Exim process, so that it
29578 can be re-used without having to re-read the file.
29579 .next
29580 If the string does not start with a slash, and does not contain any spaces,
29581 Exim searches the ACL section of the configuration for an ACL whose name
29582 matches the string.
29583 .next
29584 If no named ACL is found, or if the string contains spaces, Exim parses
29585 the string as an inline ACL. This can save typing in cases where you just
29586 want to have something like
29587 .code
29588 acl_smtp_vrfy = accept
29589 .endd
29590 in order to allow free use of the VRFY command. Such a string may contain
29591 newlines; it is processed in the same way as an ACL that is read from a file.
29592 .endlist
29593
29594
29595
29596
29597 .section "ACL return codes" "SECID196"
29598 .cindex "&ACL;" "return codes"
29599 Except for the QUIT ACL, which does not affect the SMTP return code (see
29600 section &<<SECTQUITACL>>& above), the result of running an ACL is either
29601 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
29602 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
29603 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
29604 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
29605 This also causes a 4&'xx'& return code.
29606
29607 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
29608 &"deny"&, because there is no mechanism for passing temporary errors to the
29609 submitters of non-SMTP messages.
29610
29611
29612 ACLs that are relevant to message reception may also return &"discard"&. This
29613 has the effect of &"accept"&, but causes either the entire message or an
29614 individual recipient address to be discarded. In other words, it is a
29615 blackholing facility. Use it with care.
29616
29617 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
29618 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
29619 RCPT ACL is to discard just the one recipient address. If there are no
29620 recipients left when the message's data is received, the DATA ACL is not
29621 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
29622 remaining recipients. The &"discard"& return is not permitted for the
29623 &%acl_smtp_predata%& ACL.
29624
29625 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
29626 is done on the address and the result determines the SMTP response.
29627
29628
29629 .cindex "&[local_scan()]& function" "when all recipients discarded"
29630 The &[local_scan()]& function is always run, even if there are no remaining
29631 recipients; it may create new recipients.
29632
29633
29634
29635 .section "Unset ACL options" "SECID197"
29636 .cindex "&ACL;" "unset options"
29637 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
29638 all the same. &*Note*&: These defaults apply only when the relevant ACL is
29639 not defined at all. For any defined ACL, the default action when control
29640 reaches the end of the ACL statements is &"deny"&.
29641
29642 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
29643 these two are ACLs that are used only for their side effects. They cannot be
29644 used to accept or reject anything.
29645
29646 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
29647 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
29648 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
29649 when the ACL is not defined is &"accept"&.
29650
29651 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
29652 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
29653 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
29654 messages over an SMTP connection. For an example, see the ACL in the default
29655 configuration file.
29656
29657
29658
29659
29660 .section "Data for message ACLs" "SECID198"
29661 .cindex "&ACL;" "data for message ACL"
29662 .vindex &$domain$&
29663 .vindex &$local_part$&
29664 .vindex &$sender_address$&
29665 .vindex &$sender_host_address$&
29666 .vindex &$smtp_command$&
29667 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
29668 that contain information about the host and the message's sender (for example,
29669 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
29670 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
29671 &$local_part$& are set from the argument address. The entire SMTP command
29672 is available in &$smtp_command$&.
29673
29674 When an ACL for the AUTH parameter of MAIL is running, the variables that
29675 contain information about the host are set, but &$sender_address$& is not yet
29676 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
29677 how it is used.
29678
29679 .vindex "&$message_size$&"
29680 The &$message_size$& variable is set to the value of the SIZE parameter on
29681 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
29682 that parameter is not given. The value is updated to the true message size by
29683 the time the final DATA ACL is run (after the message data has been
29684 received).
29685
29686 .vindex "&$rcpt_count$&"
29687 .vindex "&$recipients_count$&"
29688 The &$rcpt_count$& variable increases by one for each RCPT command received.
29689 The &$recipients_count$& variable increases by one each time a RCPT command is
29690 accepted, so while an ACL for RCPT is being processed, it contains the number
29691 of previously accepted recipients. At DATA time (for both the DATA ACLs),
29692 &$rcpt_count$& contains the total number of RCPT commands, and
29693 &$recipients_count$& contains the total number of accepted recipients.
29694
29695
29696
29697
29698
29699 .section "Data for non-message ACLs" "SECTdatfornon"
29700 .cindex "&ACL;" "data for non-message ACL"
29701 .vindex &$smtp_command_argument$&
29702 .vindex &$smtp_command$&
29703 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
29704 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
29705 and the entire SMTP command is available in &$smtp_command$&.
29706 These variables can be tested using a &%condition%& condition. For example,
29707 here is an ACL for use with AUTH, which insists that either the session is
29708 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
29709 does not permit authentication methods that use cleartext passwords on
29710 unencrypted connections.
29711 .code
29712 acl_check_auth:
29713   accept encrypted = *
29714   accept condition = ${if eq{${uc:$smtp_command_argument}}\
29715                      {CRAM-MD5}}
29716   deny   message   = TLS encryption or CRAM-MD5 required
29717 .endd
29718 (Another way of applying this restriction is to arrange for the authenticators
29719 that use cleartext passwords not to be advertised when the connection is not
29720 encrypted. You can use the generic &%server_advertise_condition%& authenticator
29721 option to do this.)
29722
29723
29724
29725 .section "Format of an ACL" "SECID199"
29726 .cindex "&ACL;" "format of"
29727 .cindex "&ACL;" "verbs, definition of"
29728 An individual ACL consists of a number of statements. Each statement starts
29729 with a verb, optionally followed by a number of conditions and &"modifiers"&.
29730 Modifiers can change the way the verb operates, define error and log messages,
29731 set variables, insert delays, and vary the processing of accepted messages.
29732
29733 If all the conditions are met, the verb is obeyed. The same condition may be
29734 used (with different arguments) more than once in the same statement. This
29735 provides a means of specifying an &"and"& conjunction between conditions. For
29736 example:
29737 .code
29738 deny  dnslists = list1.example
29739       dnslists = list2.example
29740 .endd
29741 If there are no conditions, the verb is always obeyed. Exim stops evaluating
29742 the conditions and modifiers when it reaches a condition that fails. What
29743 happens then depends on the verb (and in one case, on a special modifier). Not
29744 all the conditions make sense at every testing point. For example, you cannot
29745 test a sender address in the ACL that is run for a VRFY command.
29746
29747
29748 .section "ACL verbs" "SECID200"
29749 The ACL verbs are as follows:
29750
29751 .ilist
29752 .cindex "&%accept%& ACL verb"
29753 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
29754 of the conditions are not met, what happens depends on whether &%endpass%&
29755 appears among the conditions (for syntax see below). If the failing condition
29756 is before &%endpass%&, control is passed to the next ACL statement; if it is
29757 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
29758 check a RCPT command:
29759 .code
29760 accept domains = +local_domains
29761        endpass
29762        verify = recipient
29763 .endd
29764 If the recipient domain does not match the &%domains%& condition, control
29765 passes to the next statement. If it does match, the recipient is verified, and
29766 the command is accepted if verification succeeds. However, if verification
29767 fails, the ACL yields &"deny"&, because the failing condition is after
29768 &%endpass%&.
29769
29770 The &%endpass%& feature has turned out to be confusing to many people, so its
29771 use is not recommended nowadays. It is always possible to rewrite an ACL so
29772 that &%endpass%& is not needed, and it is no longer used in the default
29773 configuration.
29774
29775 .cindex "&%message%& ACL modifier" "with &%accept%&"
29776 If a &%message%& modifier appears on an &%accept%& statement, its action
29777 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
29778 (when an &%accept%& verb either accepts or passes control to the next
29779 statement), &%message%& can be used to vary the message that is sent when an
29780 SMTP command is accepted. For example, in a RCPT ACL you could have:
29781 .display
29782 &`accept  `&<&'some conditions'&>
29783 &`        message = OK, I will allow you through today`&
29784 .endd
29785 You can specify an SMTP response code, optionally followed by an &"extended
29786 response code"& at the start of the message, but the first digit must be the
29787 same as would be sent by default, which is 2 for an &%accept%& verb.
29788
29789 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
29790 an error message that is used when access is denied. This behaviour is retained
29791 for backward compatibility, but current &"best practice"& is to avoid the use
29792 of &%endpass%&.
29793
29794
29795 .next
29796 .cindex "&%defer%& ACL verb"
29797 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
29798 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
29799 &%defer%& is the same as &%deny%&, because there is no way of sending a
29800 temporary error. For a RCPT command, &%defer%& is much the same as using a
29801 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
29802 be used in any ACL, and even for a recipient it might be a simpler approach.
29803
29804
29805 .next
29806 .cindex "&%deny%& ACL verb"
29807 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
29808 the conditions are not met, control is passed to the next ACL statement. For
29809 example,
29810 .code
29811 deny dnslists = blackholes.mail-abuse.org
29812 .endd
29813 rejects commands from hosts that are on a DNS black list.
29814
29815
29816 .next
29817 .cindex "&%discard%& ACL verb"
29818 &%discard%&: This verb behaves like &%accept%&, except that it returns
29819 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
29820 that are concerned with receiving messages. When all the conditions are true,
29821 the sending entity receives a &"success"& response. However, &%discard%& causes
29822 recipients to be discarded. If it is used in an ACL for RCPT, just the one
29823 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
29824 message's recipients are discarded. Recipients that are discarded before DATA
29825 do not appear in the log line when the &%received_recipients%& log selector is set.
29826
29827 If the &%log_message%& modifier is set when &%discard%& operates,
29828 its contents are added to the line that is automatically written to the log.
29829 The &%message%& modifier operates exactly as it does for &%accept%&.
29830
29831
29832 .next
29833 .cindex "&%drop%& ACL verb"
29834 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
29835 forcibly closed after the 5&'xx'& error message has been sent. For example:
29836 .code
29837 drop   message   = I don't take more than 20 RCPTs
29838        condition = ${if > {$rcpt_count}{20}}
29839 .endd
29840 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
29841 The connection is always dropped after sending a 550 response.
29842
29843 .next
29844 .cindex "&%require%& ACL verb"
29845 &%require%&: If all the conditions are met, control is passed to the next ACL
29846 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
29847 example, when checking a RCPT command,
29848 .code
29849 require message = Sender did not verify
29850         verify  = sender
29851 .endd
29852 passes control to subsequent statements only if the message's sender can be
29853 verified. Otherwise, it rejects the command. Note the positioning of the
29854 &%message%& modifier, before the &%verify%& condition. The reason for this is
29855 discussed in section &<<SECTcondmodproc>>&.
29856
29857 .next
29858 .cindex "&%warn%& ACL verb"
29859 &%warn%&: If all the conditions are true, a line specified by the
29860 &%log_message%& modifier is written to Exim's main log. Control always passes
29861 to the next ACL statement. If any condition is false, the log line is not
29862 written. If an identical log line is requested several times in the same
29863 message, only one copy is actually written to the log. If you want to force
29864 duplicates to be written, use the &%logwrite%& modifier instead.
29865
29866 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
29867 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
29868 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
29869 first failing condition. There is more about adding header lines in section
29870 &<<SECTaddheadacl>>&.
29871
29872 If any condition on a &%warn%& statement cannot be completed (that is, there is
29873 some sort of defer), the log line specified by &%log_message%& is not written.
29874 This does not include the case of a forced failure from a lookup, which
29875 is considered to be a successful completion. After a defer, no further
29876 conditions or modifiers in the &%warn%& statement are processed. The incident
29877 is logged, and the ACL continues to be processed, from the next statement
29878 onwards.
29879
29880
29881 .vindex "&$acl_verify_message$&"
29882 When one of the &%warn%& conditions is an address verification that fails, the
29883 text of the verification failure message is in &$acl_verify_message$&. If you
29884 want this logged, you must set it up explicitly. For example:
29885 .code
29886 warn   !verify = sender
29887        log_message = sender verify failed: $acl_verify_message
29888 .endd
29889 .endlist
29890
29891 At the end of each ACL there is an implicit unconditional &%deny%&.
29892
29893 As you can see from the examples above, the conditions and modifiers are
29894 written one to a line, with the first one on the same line as the verb, and
29895 subsequent ones on following lines. If you have a very long condition, you can
29896 continue it onto several physical lines by the usual backslash continuation
29897 mechanism. It is conventional to align the conditions vertically.
29898
29899
29900
29901 .section "ACL variables" "SECTaclvariables"
29902 .cindex "&ACL;" "variables"
29903 There are some special variables that can be set during ACL processing. They
29904 can be used to pass information between different ACLs, different invocations
29905 of the same ACL in the same SMTP connection, and between ACLs and the routers,
29906 transports, and filters that are used to deliver a message. The names of these
29907 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
29908 an underscore, but the remainder of the name can be any sequence of
29909 alphanumeric characters and underscores that you choose. There is no limit on
29910 the number of ACL variables. The two sets act as follows:
29911 .ilist
29912 The values of those variables whose names begin with &$acl_c$& persist
29913 throughout an SMTP connection. They are never reset. Thus, a value that is set
29914 while receiving one message is still available when receiving the next message
29915 on the same SMTP connection.
29916 .next
29917 The values of those variables whose names begin with &$acl_m$& persist only
29918 while a message is being received. They are reset afterwards. They are also
29919 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
29920 .endlist
29921
29922 When a message is accepted, the current values of all the ACL variables are
29923 preserved with the message and are subsequently made available at delivery
29924 time. The ACL variables are set by a modifier called &%set%&. For example:
29925 .code
29926 accept hosts = whatever
29927        set acl_m4 = some value
29928 accept authenticated = *
29929        set acl_c_auth = yes
29930 .endd
29931 &*Note*&: A leading dollar sign is not used when naming a variable that is to
29932 be set. If you want to set a variable without taking any action, you can use a
29933 &%warn%& verb without any other modifiers or conditions.
29934
29935 .oindex &%strict_acl_vars%&
29936 What happens if a syntactically valid but undefined ACL variable is
29937 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
29938 false (the default), an empty string is substituted; if it is true, an
29939 error is generated.
29940
29941 Versions of Exim before 4.64 have a limited set of numbered variables, but
29942 their names are compatible, so there is no problem with upgrading.
29943
29944
29945 .section "Condition and modifier processing" "SECTcondmodproc"
29946 .cindex "&ACL;" "conditions; processing"
29947 .cindex "&ACL;" "modifiers; processing"
29948 An exclamation mark preceding a condition negates its result. For example:
29949 .code
29950 deny   domains = *.dom.example
29951       !verify  = recipient
29952 .endd
29953 causes the ACL to return &"deny"& if the recipient domain ends in
29954 &'dom.example'& and the recipient address cannot be verified. Sometimes
29955 negation can be used on the right-hand side of a condition. For example, these
29956 two statements are equivalent:
29957 .code
29958 deny  hosts = !192.168.3.4
29959 deny !hosts =  192.168.3.4
29960 .endd
29961 However, for many conditions (&%verify%& being a good example), only left-hand
29962 side negation of the whole condition is possible.
29963
29964 The arguments of conditions and modifiers are expanded. A forced failure
29965 of an expansion causes a condition to be ignored, that is, it behaves as if the
29966 condition is true. Consider these two statements:
29967 .code
29968 accept  senders = ${lookup{$host_name}lsearch\
29969                   {/some/file}{$value}fail}
29970 accept  senders = ${lookup{$host_name}lsearch\
29971                   {/some/file}{$value}{}}
29972 .endd
29973 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
29974 the returned list is searched, but if the lookup fails the behaviour is
29975 different in the two cases. The &%fail%& in the first statement causes the
29976 condition to be ignored, leaving no further conditions. The &%accept%& verb
29977 therefore succeeds. The second statement, however, generates an empty list when
29978 the lookup fails. No sender can match an empty list, so the condition fails,
29979 and therefore the &%accept%& also fails.
29980
29981 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
29982 specify actions that are taken as the conditions for a statement are checked;
29983 others specify text for messages that are used when access is denied or a
29984 warning is generated. The &%control%& modifier affects the way an incoming
29985 message is handled.
29986
29987 The positioning of the modifiers in an ACL statement is important, because the
29988 processing of a verb ceases as soon as its outcome is known. Only those
29989 modifiers that have already been encountered will take effect. For example,
29990 consider this use of the &%message%& modifier:
29991 .code
29992 require message = Can't verify sender
29993         verify  = sender
29994         message = Can't verify recipient
29995         verify  = recipient
29996         message = This message cannot be used
29997 .endd
29998 If sender verification fails, Exim knows that the result of the statement is
29999 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
30000 so its text is used as the error message. If sender verification succeeds, but
30001 recipient verification fails, the second message is used. If recipient
30002 verification succeeds, the third message becomes &"current"&, but is never used
30003 because there are no more conditions to cause failure.
30004
30005 For the &%deny%& verb, on the other hand, it is always the last &%message%&
30006 modifier that is used, because all the conditions must be true for rejection to
30007 happen. Specifying more than one &%message%& modifier does not make sense, and
30008 the message can even be specified after all the conditions. For example:
30009 .code
30010 deny   hosts = ...
30011       !senders = *@my.domain.example
30012        message = Invalid sender from client host
30013 .endd
30014 The &"deny"& result does not happen until the end of the statement is reached,
30015 by which time Exim has set up the message.
30016
30017
30018
30019 .section "ACL modifiers" "SECTACLmodi"
30020 .cindex "&ACL;" "modifiers; list of"
30021 The ACL modifiers are as follows:
30022
30023 .vlist
30024 .vitem &*add_header*&&~=&~<&'text'&>
30025 This modifier specifies one or more header lines that are to be added to an
30026 incoming message, assuming, of course, that the message is ultimately
30027 accepted. For details, see section &<<SECTaddheadacl>>&.
30028
30029 .vitem &*continue*&&~=&~<&'text'&>
30030 .cindex "&%continue%& ACL modifier"
30031 .cindex "database" "updating in ACL"
30032 This modifier does nothing of itself, and processing of the ACL always
30033 continues with the next condition or modifier. The value of &%continue%& is in
30034 the side effects of expanding its argument. Typically this could be used to
30035 update a database. It is really just a syntactic tidiness, to avoid having to
30036 write rather ugly lines like this:
30037 .display
30038 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
30039 .endd
30040 Instead, all you need is
30041 .display
30042 &`continue = `&<&'some expansion'&>
30043 .endd
30044
30045 .vitem &*control*&&~=&~<&'text'&>
30046 .cindex "&%control%& ACL modifier"
30047 This modifier affects the subsequent processing of the SMTP connection or of an
30048 incoming message that is accepted. The effect of the first type of control
30049 lasts for the duration of the connection, whereas the effect of the second type
30050 lasts only until the current message has been received. The message-specific
30051 controls always apply to the whole message, not to individual recipients,
30052 even if the &%control%& modifier appears in a RCPT ACL.
30053
30054 As there are now quite a few controls that can be applied, they are described
30055 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
30056 in several different ways. For example:
30057
30058 . ==== As this is a nested list, any displays it contains must be indented
30059 . ==== as otherwise they are too far to the left. That comment applies only
30060 . ==== when xmlto and fop are used; formatting with sdop gets it right either
30061 . ==== way.
30062
30063 .ilist
30064 It can be at the end of an &%accept%& statement:
30065 .code
30066     accept  ...some conditions
30067             control = queue_only
30068 .endd
30069 In this case, the control is applied when this statement yields &"accept"&, in
30070 other words, when the conditions are all true.
30071
30072 .next
30073 It can be in the middle of an &%accept%& statement:
30074 .code
30075     accept  ...some conditions...
30076             control = queue_only
30077             ...some more conditions...
30078 .endd
30079 If the first set of conditions are true, the control is applied, even if the
30080 statement does not accept because one of the second set of conditions is false.
30081 In this case, some subsequent statement must yield &"accept"& for the control
30082 to be relevant.
30083
30084 .next
30085 It can be used with &%warn%& to apply the control, leaving the
30086 decision about accepting or denying to a subsequent verb. For
30087 example:
30088 .code
30089     warn    ...some conditions...
30090             control = freeze
30091     accept  ...
30092 .endd
30093 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
30094 &%logwrite%&, so it does not add anything to the message and does not write a
30095 log entry.
30096
30097 .next
30098 If you want to apply a control unconditionally, you can use it with a
30099 &%require%& verb. For example:
30100 .code
30101     require  control = no_multiline_responses
30102 .endd
30103 .endlist
30104
30105 .vitem &*delay*&&~=&~<&'time'&>
30106 .cindex "&%delay%& ACL modifier"
30107 .oindex "&%-bh%&"
30108 This modifier may appear in any ACL except notquit. It causes Exim to wait for
30109 the time interval before proceeding. However, when testing Exim using the
30110 &%-bh%& option, the delay is not actually imposed (an appropriate message is
30111 output instead). The time is given in the usual Exim notation, and the delay
30112 happens as soon as the modifier is processed. In an SMTP session, pending
30113 output is flushed before the delay is imposed.
30114
30115 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
30116 example:
30117 .code
30118 deny    ...some conditions...
30119         delay = 30s
30120 .endd
30121 The delay happens if all the conditions are true, before the statement returns
30122 &"deny"&. Compare this with:
30123 .code
30124 deny    delay = 30s
30125         ...some conditions...
30126 .endd
30127 which waits for 30s before processing the conditions. The &%delay%& modifier
30128 can also be used with &%warn%& and together with &%control%&:
30129 .code
30130 warn    ...some conditions...
30131         delay = 2m
30132         control = freeze
30133 accept  ...
30134 .endd
30135
30136 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
30137 responses to several commands are no longer buffered and sent in one packet (as
30138 they would normally be) because all output is flushed before imposing the
30139 delay. This optimization is disabled so that a number of small delays do not
30140 appear to the client as one large aggregated delay that might provoke an
30141 unwanted timeout. You can, however, disable output flushing for &%delay%& by
30142 using a &%control%& modifier to set &%no_delay_flush%&.
30143
30144
30145 .vitem &*endpass*&
30146 .cindex "&%endpass%& ACL modifier"
30147 This modifier, which has no argument, is recognized only in &%accept%& and
30148 &%discard%& statements. It marks the boundary between the conditions whose
30149 failure causes control to pass to the next statement, and the conditions whose
30150 failure causes the ACL to return &"deny"&. This concept has proved to be
30151 confusing to some people, so the use of &%endpass%& is no longer recommended as
30152 &"best practice"&. See the description of &%accept%& above for more details.
30153
30154
30155 .vitem &*log_message*&&~=&~<&'text'&>
30156 .cindex "&%log_message%& ACL modifier"
30157 This modifier sets up a message that is used as part of the log message if the
30158 ACL denies access or a &%warn%& statement's conditions are true. For example:
30159 .code
30160 require log_message = wrong cipher suite $tls_in_cipher
30161         encrypted   = DES-CBC3-SHA
30162 .endd
30163 &%log_message%& is also used when recipients are discarded by &%discard%&. For
30164 example:
30165 .display
30166 &`discard `&<&'some conditions'&>
30167 &`        log_message = Discarded $local_part@$domain because...`&
30168 .endd
30169 When access is denied, &%log_message%& adds to any underlying error message
30170 that may exist because of a condition failure. For example, while verifying a
30171 recipient address, a &':fail:'& redirection might have already set up a
30172 message.
30173
30174 The message may be defined before the conditions to which it applies, because
30175 the string expansion does not happen until Exim decides that access is to be
30176 denied. This means that any variables that are set by the condition are
30177 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
30178 variables are set after a DNS black list lookup succeeds. If the expansion of
30179 &%log_message%& fails, or if the result is an empty string, the modifier is
30180 ignored.
30181
30182 .vindex "&$acl_verify_message$&"
30183 If you want to use a &%warn%& statement to log the result of an address
30184 verification, you can use &$acl_verify_message$& to include the verification
30185 error message.
30186
30187 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
30188 the start of the logged message. If the same warning log message is requested
30189 more than once while receiving  a single email message, only one copy is
30190 actually logged. If you want to log multiple copies, use &%logwrite%& instead
30191 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
30192 is logged for a successful &%warn%& statement.
30193
30194 If &%log_message%& is not present and there is no underlying error message (for
30195 example, from the failure of address verification), but &%message%& is present,
30196 the &%message%& text is used for logging rejections. However, if any text for
30197 logging contains newlines, only the first line is logged. In the absence of
30198 both &%log_message%& and &%message%&, a default built-in message is used for
30199 logging rejections.
30200
30201
30202 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
30203 .cindex "&%log_reject_target%& ACL modifier"
30204 .cindex "logging in ACL" "specifying which log"
30205 This modifier makes it possible to specify which logs are used for messages
30206 about ACL rejections. Its argument is a colon-separated list of words that can
30207 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
30208 may be empty, in which case a rejection is not logged at all. For example, this
30209 ACL fragment writes no logging information when access is denied:
30210 .display
30211 &`deny `&<&'some conditions'&>
30212 &`     log_reject_target =`&
30213 .endd
30214 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
30215 permanent and temporary rejections. Its effect lasts for the rest of the
30216 current ACL.
30217
30218
30219 .vitem &*logwrite*&&~=&~<&'text'&>
30220 .cindex "&%logwrite%& ACL modifier"
30221 .cindex "logging in ACL" "immediate"
30222 This modifier writes a message to a log file as soon as it is encountered when
30223 processing an ACL. (Compare &%log_message%&, which, except in the case of
30224 &%warn%& and &%discard%&, is used only if the ACL statement denies
30225 access.) The &%logwrite%& modifier can be used to log special incidents in
30226 ACLs. For example:
30227 .display
30228 &`accept `&<&'some special conditions'&>
30229 &`       control  = freeze`&
30230 &`       logwrite = froze message because ...`&
30231 .endd
30232 By default, the message is written to the main log. However, it may begin
30233 with a colon, followed by a comma-separated list of log names, and then
30234 another colon, to specify exactly which logs are to be written. For
30235 example:
30236 .code
30237 logwrite = :main,reject: text for main and reject logs
30238 logwrite = :panic: text for panic log only
30239 .endd
30240
30241
30242 .vitem &*message*&&~=&~<&'text'&>
30243 .cindex "&%message%& ACL modifier"
30244 This modifier sets up a text string that is expanded and used as a response
30245 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
30246 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
30247 there is some complication if &%endpass%& is involved; see the description of
30248 &%accept%& for details.)
30249
30250 The expansion of the message happens at the time Exim decides that the ACL is
30251 to end, not at the time it processes &%message%&. If the expansion fails, or
30252 generates an empty string, the modifier is ignored. Here is an example where
30253 &%message%& must be specified first, because the ACL ends with a rejection if
30254 the &%hosts%& condition fails:
30255 .code
30256 require  message = Host not recognized
30257          hosts = 10.0.0.0/8
30258 .endd
30259 (Once a condition has failed, no further conditions or modifiers are
30260 processed.)
30261
30262 .cindex "SMTP" "error codes"
30263 .oindex "&%smtp_banner%&
30264 For ACLs that are triggered by SMTP commands, the message is returned as part
30265 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
30266 is meaningful only for SMTP, as no message is returned when a non-SMTP message
30267 is accepted. In the case of the connect ACL, accepting with a message modifier
30268 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
30269 accept message may not contain more than one line (otherwise it will be
30270 truncated at the first newline and a panic logged), and it cannot affect the
30271 EHLO options.
30272
30273 When SMTP is involved, the message may begin with an overriding response code,
30274 consisting of three digits optionally followed by an &"extended response code"&
30275 of the form &'n.n.n'&, each code being followed by a space. For example:
30276 .code
30277 deny  message = 599 1.2.3 Host not welcome
30278       hosts = 192.168.34.0/24
30279 .endd
30280 The first digit of the supplied response code must be the same as would be sent
30281 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
30282 access, but for the predata ACL, note that the default success code is 354, not
30283 2&'xx'&.
30284
30285 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
30286 the message modifier cannot override the 221 response code.
30287
30288 The text in a &%message%& modifier is literal; any quotes are taken as
30289 literals, but because the string is expanded, backslash escapes are processed
30290 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
30291 response.
30292
30293 .vindex "&$acl_verify_message$&"
30294 For ACLs that are called by an &%acl =%& ACL condition, the message is
30295 stored in &$acl_verify_message$&, from which the calling ACL may use it.
30296
30297 If &%message%& is used on a statement that verifies an address, the message
30298 specified overrides any message that is generated by the verification process.
30299 However, the original message is available in the variable
30300 &$acl_verify_message$&, so you can incorporate it into your message if you
30301 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
30302 routers to be passed back as part of the SMTP response, you should either not
30303 use a &%message%& modifier, or make use of &$acl_verify_message$&.
30304
30305 For compatibility with previous releases of Exim, a &%message%& modifier that
30306 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
30307 modifier, but this usage is now deprecated. However, &%message%& acts only when
30308 all the conditions are true, wherever it appears in an ACL command, whereas
30309 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
30310 &%warn%& in an ACL that is not concerned with receiving a message, it has no
30311 effect.
30312
30313
30314 .vitem &*queue*&&~=&~<&'text'&>
30315 .cindex "&%queue%& ACL modifier"
30316 .cindex "named queues" "selecting in ACL"
30317 This modifier specifies the use of a named queue for spool files
30318 for the message.
30319 It can only be used before the message is received (i.e. not in
30320 the DATA ACL).
30321 This could be used, for example, for known high-volume burst sources
30322 of traffic, or for quarantine of messages.
30323 Separate queue-runner processes will be needed for named queues.
30324 If the text after expansion is empty, the default queue is used.
30325
30326
30327 .vitem &*remove_header*&&~=&~<&'text'&>
30328 This modifier specifies one or more header names in a colon-separated list
30329  that are to be removed from an incoming message, assuming, of course, that
30330 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
30331
30332
30333 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
30334 .cindex "&%set%& ACL modifier"
30335 This modifier puts a value into one of the ACL variables (see section
30336 &<<SECTaclvariables>>&).
30337
30338
30339 .vitem &*udpsend*&&~=&~<&'parameters'&>
30340 .cindex "UDP communications"
30341 This modifier sends a UDP packet, for purposes such as statistics
30342 collection or behaviour monitoring. The parameters are expanded, and
30343 the result of the expansion must be a colon-separated list consisting
30344 of a destination server, port number, and the packet contents. The
30345 server can be specified as a host name or IPv4 or IPv6 address. The
30346 separator can be changed with the usual angle bracket syntax. For
30347 example, you might want to collect information on which hosts connect
30348 when:
30349 .code
30350 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
30351              $tod_zulu $sender_host_address
30352 .endd
30353 .endlist
30354
30355
30356
30357
30358 .section "Use of the control modifier" "SECTcontrols"
30359 .cindex "&%control%& ACL modifier"
30360 The &%control%& modifier supports the following settings:
30361
30362 .vlist
30363 .vitem &*control&~=&~allow_auth_unadvertised*&
30364 This modifier allows a client host to use the SMTP AUTH command even when it
30365 has not been advertised in response to EHLO. Furthermore, because there are
30366 apparently some really broken clients that do this, Exim will accept AUTH after
30367 HELO (rather than EHLO) when this control is set. It should be used only if you
30368 really need it, and you should limit its use to those broken clients that do
30369 not work without it. For example:
30370 .code
30371 warn hosts   = 192.168.34.25
30372      control = allow_auth_unadvertised
30373 .endd
30374 Normally, when an Exim server receives an AUTH command, it checks the name of
30375 the authentication mechanism that is given in the command to ensure that it
30376 matches an advertised mechanism. When this control is set, the check that a
30377 mechanism has been advertised is bypassed. Any configured mechanism can be used
30378 by the client. This control is permitted only in the connection and HELO ACLs.
30379
30380
30381 .vitem &*control&~=&~caseful_local_part*& &&&
30382        &*control&~=&~caselower_local_part*&
30383 .cindex "&ACL;" "case of local part in"
30384 .cindex "case of local parts"
30385 .vindex "&$local_part$&"
30386 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
30387 (that is, during RCPT processing). By default, the contents of &$local_part$&
30388 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
30389 any uppercase letters in the original local part are restored in &$local_part$&
30390 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
30391 is encountered.
30392
30393 These controls affect only the current recipient. Moreover, they apply only to
30394 local part handling that takes place directly in the ACL (for example, as a key
30395 in lookups). If a test to verify the recipient is obeyed, the case-related
30396 handling of the local part during the verification is controlled by the router
30397 configuration (see the &%caseful_local_part%& generic router option).
30398
30399 This facility could be used, for example, to add a spam score to local parts
30400 containing upper case letters. For example, using &$acl_m4$& to accumulate the
30401 spam score:
30402 .code
30403 warn  control = caseful_local_part
30404       set acl_m4 = ${eval:\
30405                      $acl_m4 + \
30406                      ${if match{$local_part}{[A-Z]}{1}{0}}\
30407                     }
30408       control = caselower_local_part
30409 .endd
30410 Notice that we put back the lower cased version afterwards, assuming that
30411 is what is wanted for subsequent tests.
30412
30413
30414 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
30415 .cindex "&ACL;" "cutthrough routing"
30416 .cindex "cutthrough" "requesting"
30417 This option requests delivery be attempted while the item is being received.
30418
30419 The option is usable in the RCPT ACL.
30420 If enabled for a message received via smtp and routed to an smtp transport,
30421 and only one transport, interface, destination host and port combination
30422 is used for all recipients of the message,
30423 then the delivery connection is made while the receiving connection is open
30424 and data is copied from one to the other.
30425
30426 An attempt to set this option for any recipient but the first
30427 for a mail will be quietly ignored.
30428 If a recipient-verify callout
30429 (with use_sender)
30430 connection is subsequently
30431 requested in the same ACL it is held open and used for
30432 any subsequent recipients and the data,
30433 otherwise one is made after the initial RCPT ACL completes.
30434
30435 Note that routers are used in verify mode,
30436 and cannot depend on content of received headers.
30437 Note also that headers cannot be
30438 modified by any of the post-data ACLs (DATA, MIME and DKIM).
30439 Headers may be modified by routers (subject to the above) and transports.
30440 The &'Received-By:'& header is generated as soon as the body reception starts,
30441 rather than the traditional time after the full message is received;
30442 this will affect the timestamp.
30443
30444 All the usual ACLs are called; if one results in the message being
30445 rejected, all effort spent in delivery (including the costs on
30446 the ultimate destination) will be wasted.
30447 Note that in the case of data-time ACLs this includes the entire
30448 message body.
30449
30450 Cutthrough delivery is not supported via transport-filters or when DKIM signing
30451 of outgoing messages is done, because it sends data to the ultimate destination
30452 before the entire message has been received from the source.
30453 It is not supported for messages received with the SMTP PRDR
30454 or CHUNKING
30455 options in use.
30456
30457 Should the ultimate destination system positively accept or reject the mail,
30458 a corresponding indication is given to the source system and nothing is queued.
30459 If the item is successfully delivered in cutthrough mode
30460 the delivery log lines are tagged with ">>" rather than "=>" and appear
30461 before the acceptance "<=" line.
30462
30463 If there is a temporary error the item is queued for later delivery in the
30464 usual fashion.
30465 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
30466 to the control; the default value is &"spool"& and the alternate value
30467 &"pass"& copies an SMTP defer response from the target back to the initiator
30468 and does not queue the message.
30469 Note that this is independent of any recipient verify conditions in the ACL.
30470
30471 Delivery in this mode avoids the generation of a bounce mail to a
30472 (possibly faked)
30473 sender when the destination system is doing content-scan based rejection.
30474
30475
30476 .vitem &*control&~=&~debug/*&<&'options'&>
30477 .cindex "&ACL;" "enabling debug logging"
30478 .cindex "debugging" "enabling from an ACL"
30479 This control turns on debug logging, almost as though Exim had been invoked
30480 with &`-d`&, with the output going to a new logfile in the usual logs directory,
30481 by default called &'debuglog'&.
30482 The filename can be adjusted with the &'tag'& option, which
30483 may access any variables already defined.  The logging may be adjusted with
30484 the &'opts'& option, which takes the same values as the &`-d`& command-line
30485 option.
30486 Logging started this way may be stopped, and the file removed,
30487 with the &'kill'& option.
30488 Some examples (which depend on variables that don't exist in all
30489 contexts):
30490 .code
30491       control = debug
30492       control = debug/tag=.$sender_host_address
30493       control = debug/opts=+expand+acl
30494       control = debug/tag=.$message_exim_id/opts=+expand
30495       control = debug/kill
30496 .endd
30497
30498
30499 .vitem &*control&~=&~dkim_disable_verify*&
30500 .cindex "disable DKIM verify"
30501 .cindex "DKIM" "disable verify"
30502 This control turns off DKIM verification processing entirely.  For details on
30503 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
30504
30505
30506 .vitem &*control&~=&~dmarc_disable_verify*&
30507 .cindex "disable DMARC verify"
30508 .cindex "DMARC" "disable verify"
30509 This control turns off DMARC verification processing entirely.  For details on
30510 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
30511
30512
30513 .vitem &*control&~=&~dscp/*&<&'value'&>
30514 .cindex "&ACL;" "setting DSCP value"
30515 .cindex "DSCP" "inbound"
30516 This option causes the DSCP value associated with the socket for the inbound
30517 connection to be adjusted to a given value, given as one of a number of fixed
30518 strings or to numeric value.
30519 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
30520 Common values include &`throughput`&, &`mincost`&, and on newer systems
30521 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
30522
30523 The outbound packets from Exim will be marked with this value in the header
30524 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
30525 that these values will have any effect, not be stripped by networking
30526 equipment, or do much of anything without cooperation with your Network
30527 Engineer and those of all network operators between the source and destination.
30528
30529
30530 .vitem &*control&~=&~enforce_sync*& &&&
30531        &*control&~=&~no_enforce_sync*&
30532 .cindex "SMTP" "synchronization checking"
30533 .cindex "synchronization checking in SMTP"
30534 These controls make it possible to be selective about when SMTP synchronization
30535 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
30536 state of the switch (it is true by default). See the description of this option
30537 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
30538
30539 The effect of these two controls lasts for the remainder of the SMTP
30540 connection. They can appear in any ACL except the one for the non-SMTP
30541 messages. The most straightforward place to put them is in the ACL defined by
30542 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
30543 before the first synchronization check. The expected use is to turn off the
30544 synchronization checks for badly-behaved hosts that you nevertheless need to
30545 work with.
30546
30547
30548 .vitem &*control&~=&~fakedefer/*&<&'message'&>
30549 .cindex "fake defer"
30550 .cindex "defer, fake"
30551 This control works in exactly the same way as &%fakereject%& (described below)
30552 except that it causes an SMTP 450 response after the message data instead of a
30553 550 response. You must take care when using &%fakedefer%& because it causes the
30554 messages to be duplicated when the sender retries. Therefore, you should not
30555 use &%fakedefer%& if the message is to be delivered normally.
30556
30557 .vitem &*control&~=&~fakereject/*&<&'message'&>
30558 .cindex "fake rejection"
30559 .cindex "rejection, fake"
30560 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
30561 words, only when an SMTP message is being received. If Exim accepts the
30562 message, instead the final 250 response, a 550 rejection message is sent.
30563 However, Exim proceeds to deliver the message as normal. The control applies
30564 only to the current message, not to any subsequent ones that may be received in
30565 the same SMTP connection.
30566
30567 The text for the 550 response is taken from the &%control%& modifier. If no
30568 message is supplied, the following is used:
30569 .code
30570 550-Your message has been rejected but is being
30571 550-kept for evaluation.
30572 550-If it was a legitimate message, it may still be
30573 550 delivered to the target recipient(s).
30574 .endd
30575 This facility should be used with extreme caution.
30576
30577 .vitem &*control&~=&~freeze*&
30578 .cindex "frozen messages" "forcing in ACL"
30579 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30580 other words, only when a message is being received. If the message is accepted,
30581 it is placed on Exim's queue and frozen. The control applies only to the
30582 current message, not to any subsequent ones that may be received in the same
30583 SMTP connection.
30584
30585 This modifier can optionally be followed by &`/no_tell`&. If the global option
30586 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
30587 is told about the freezing), provided all the &*control=freeze*& modifiers that
30588 are obeyed for the current message have the &`/no_tell`& option.
30589
30590 .vitem &*control&~=&~no_delay_flush*&
30591 .cindex "SMTP" "output flushing, disabling for delay"
30592 Exim normally flushes SMTP output before implementing a delay in an ACL, to
30593 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30594 use. This control, as long as it is encountered before the &%delay%& modifier,
30595 disables such output flushing.
30596
30597 .vitem &*control&~=&~no_callout_flush*&
30598 .cindex "SMTP" "output flushing, disabling for callout"
30599 Exim normally flushes SMTP output before performing a callout in an ACL, to
30600 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30601 use. This control, as long as it is encountered before the &%verify%& condition
30602 that causes the callout, disables such output flushing.
30603
30604 .vitem &*control&~=&~no_mbox_unspool*&
30605 This control is available when Exim is compiled with the content scanning
30606 extension. Content scanning may require a copy of the current message, or parts
30607 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
30608 or spam scanner. Normally, such copies are deleted when they are no longer
30609 needed. If this control is set, the copies are not deleted. The control applies
30610 only to the current message, not to any subsequent ones that may be received in
30611 the same SMTP connection. It is provided for debugging purposes and is unlikely
30612 to be useful in production.
30613
30614 .vitem &*control&~=&~no_multiline_responses*&
30615 .cindex "multiline responses, suppressing"
30616 This control is permitted for any ACL except the one for non-SMTP messages.
30617 It seems that there are broken clients in use that cannot handle multiline
30618 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
30619
30620 If this control is set, multiline SMTP responses from ACL rejections are
30621 suppressed. One way of doing this would have been to put out these responses as
30622 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
30623 (&"use multiline responses for more"& it says &-- ha!), and some of the
30624 responses might get close to that. So this facility, which is after all only a
30625 sop to broken clients, is implemented by doing two very easy things:
30626
30627 .ilist
30628 Extra information that is normally output as part of a rejection caused by
30629 sender verification failure is omitted. Only the final line (typically &"sender
30630 verification failed"&) is sent.
30631 .next
30632 If a &%message%& modifier supplies a multiline response, only the first
30633 line is output.
30634 .endlist
30635
30636 The setting of the switch can, of course, be made conditional on the
30637 calling host. Its effect lasts until the end of the SMTP connection.
30638
30639 .vitem &*control&~=&~no_pipelining*&
30640 .cindex "PIPELINING" "suppressing advertising"
30641 This control turns off the advertising of the PIPELINING extension to SMTP in
30642 the current session. To be useful, it must be obeyed before Exim sends its
30643 response to an EHLO command. Therefore, it should normally appear in an ACL
30644 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
30645 &%pipelining_advertise_hosts%&.
30646
30647 .vitem &*control&~=&~queue_only*&
30648 .oindex "&%queue_only%&"
30649 .cindex "queueing incoming messages"
30650 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30651 other words, only when a message is being received. If the message is accepted,
30652 it is placed on Exim's queue and left there for delivery by a subsequent queue
30653 runner. No immediate delivery process is started. In other words, it has the
30654 effect as the &%queue_only%& global option. However, the control applies only
30655 to the current message, not to any subsequent ones that may be received in the
30656 same SMTP connection.
30657
30658 .vitem &*control&~=&~submission/*&<&'options'&>
30659 .cindex "message" "submission"
30660 .cindex "submission mode"
30661 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
30662 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
30663 the current message is a submission from a local MUA. In this case, Exim
30664 operates in &"submission mode"&, and applies certain fixups to the message if
30665 necessary. For example, it adds a &'Date:'& header line if one is not present.
30666 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
30667 late (the message has already been created).
30668
30669 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
30670 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
30671 submission mode; the available options for this control are described there.
30672 The control applies only to the current message, not to any subsequent ones
30673 that may be received in the same SMTP connection.
30674
30675 .vitem &*control&~=&~suppress_local_fixups*&
30676 .cindex "submission fixups, suppressing"
30677 This control applies to locally submitted (non TCP/IP) messages, and is the
30678 complement of &`control = submission`&. It disables the fixups that are
30679 normally applied to locally-submitted messages. Specifically:
30680
30681 .ilist
30682 Any &'Sender:'& header line is left alone (in this respect, it is a
30683 dynamic version of &%local_sender_retain%&).
30684 .next
30685 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
30686 .next
30687 There is no check that &'From:'& corresponds to the actual sender.
30688 .endlist ilist
30689
30690 This control may be useful when a remotely-originated message is accepted,
30691 passed to some scanning program, and then re-submitted for delivery. It can be
30692 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30693 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
30694 data is read.
30695
30696 &*Note:*& This control applies only to the current message, not to any others
30697 that are being submitted at the same time using &%-bs%& or &%-bS%&.
30698
30699 .vitem &*control&~=&~utf8_downconvert*&
30700 This control enables conversion of UTF-8 in message addresses
30701 to a-label form.
30702 For details see section &<<SECTi18nMTA>>&.
30703 .endlist vlist
30704
30705
30706 .section "Summary of message fixup control" "SECTsummesfix"
30707 All four possibilities for message fixups can be specified:
30708
30709 .ilist
30710 Locally submitted, fixups applied: the default.
30711 .next
30712 Locally submitted, no fixups applied: use
30713 &`control = suppress_local_fixups`&.
30714 .next
30715 Remotely submitted, no fixups applied: the default.
30716 .next
30717 Remotely submitted, fixups applied: use &`control = submission`&.
30718 .endlist
30719
30720
30721
30722 .section "Adding header lines in ACLs" "SECTaddheadacl"
30723 .cindex "header lines" "adding in an ACL"
30724 .cindex "header lines" "position of added lines"
30725 .cindex "&%add_header%& ACL modifier"
30726 The &%add_header%& modifier can be used to add one or more extra header lines
30727 to an incoming message, as in this example:
30728 .code
30729 warn dnslists = sbl.spamhaus.org : \
30730                 dialup.mail-abuse.org
30731      add_header = X-blacklisted-at: $dnslist_domain
30732 .endd
30733 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30734 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30735 receiving a message). The message must ultimately be accepted for
30736 &%add_header%& to have any significant effect. You can use &%add_header%& with
30737 any ACL verb, including &%deny%& (though this is potentially useful only in a
30738 RCPT ACL).
30739
30740 Headers will not be added to the message if the modifier is used in
30741 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30742
30743 Leading and trailing newlines are removed from
30744 the data for the &%add_header%& modifier; if it then
30745 contains one or more newlines that
30746 are not followed by a space or a tab, it is assumed to contain multiple header
30747 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
30748 front of any line that is not a valid header line.
30749
30750 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
30751 They are added to the message before processing the DATA and MIME ACLs.
30752 However, if an identical header line is requested more than once, only one copy
30753 is actually added to the message. Further header lines may be accumulated
30754 during the DATA and MIME ACLs, after which they are added to the message, again
30755 with duplicates suppressed. Thus, it is possible to add two identical header
30756 lines to an SMTP message, but only if one is added before DATA and one after.
30757 In the case of non-SMTP messages, new headers are accumulated during the
30758 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
30759 message is rejected after DATA or by the non-SMTP ACL, all added header lines
30760 are included in the entry that is written to the reject log.
30761
30762 .cindex "header lines" "added; visibility of"
30763 Header lines are not visible in string expansions
30764 of message headers
30765 until they are added to the
30766 message. It follows that header lines defined in the MAIL, RCPT, and predata
30767 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
30768 header lines that are added by the DATA or MIME ACLs are not visible in those
30769 ACLs. Because of this restriction, you cannot use header lines as a way of
30770 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
30771 this, you can use ACL variables, as described in section
30772 &<<SECTaclvariables>>&.
30773
30774 The list of headers yet to be added is given by the &%$headers_added%& variable.
30775
30776 The &%add_header%& modifier acts immediately as it is encountered during the
30777 processing of an ACL. Notice the difference between these two cases:
30778 .display
30779 &`accept add_header = ADDED: some text`&
30780 &`       `&<&'some condition'&>
30781
30782 &`accept `&<&'some condition'&>
30783 &`       add_header = ADDED: some text`&
30784 .endd
30785 In the first case, the header line is always added, whether or not the
30786 condition is true. In the second case, the header line is added only if the
30787 condition is true. Multiple occurrences of &%add_header%& may occur in the same
30788 ACL statement. All those that are encountered before a condition fails are
30789 honoured.
30790
30791 .cindex "&%warn%& ACL verb"
30792 For compatibility with previous versions of Exim, a &%message%& modifier for a
30793 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
30794 effect only if all the conditions are true, even if it appears before some of
30795 them. Furthermore, only the last occurrence of &%message%& is honoured. This
30796 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
30797 are present on a &%warn%& verb, both are processed according to their
30798 specifications.
30799
30800 By default, new header lines are added to a message at the end of the existing
30801 header lines. However, you can specify that any particular header line should
30802 be added right at the start (before all the &'Received:'& lines), immediately
30803 after the first block of &'Received:'& lines, or immediately before any line
30804 that is not a &'Received:'& or &'Resent-something:'& header.
30805
30806 This is done by specifying &":at_start:"&, &":after_received:"&, or
30807 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
30808 header line, respectively. (Header text cannot start with a colon, as there has
30809 to be a header name first.) For example:
30810 .code
30811 warn add_header = \
30812        :after_received:X-My-Header: something or other...
30813 .endd
30814 If more than one header line is supplied in a single &%add_header%& modifier,
30815 each one is treated independently and can therefore be placed differently. If
30816 you add more than one line at the start, or after the Received: block, they end
30817 up in reverse order.
30818
30819 &*Warning*&: This facility currently applies only to header lines that are
30820 added in an ACL. It does NOT work for header lines that are added in a
30821 system filter or in a router or transport.
30822
30823
30824
30825 .section "Removing header lines in ACLs" "SECTremoveheadacl"
30826 .cindex "header lines" "removing in an ACL"
30827 .cindex "header lines" "position of removed lines"
30828 .cindex "&%remove_header%& ACL modifier"
30829 The &%remove_header%& modifier can be used to remove one or more header lines
30830 from an incoming message, as in this example:
30831 .code
30832 warn   message        = Remove internal headers
30833        remove_header  = x-route-mail1 : x-route-mail2
30834 .endd
30835 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30836 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30837 receiving a message). The message must ultimately be accepted for
30838 &%remove_header%& to have any significant effect. You can use &%remove_header%&
30839 with any ACL verb, including &%deny%&, though this is really not useful for
30840 any verb that doesn't result in a delivered message.
30841
30842 Headers will not be removed from the message if the modifier is used in
30843 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30844
30845 More than one header can be removed at the same time by using a colon separated
30846 list of header names. The header matching is case insensitive. Wildcards are
30847 not permitted, nor is list expansion performed, so you cannot use hostlists to
30848 create a list of headers, however both connection and message variable expansion
30849 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
30850 .code
30851 warn   hosts           = +internal_hosts
30852        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
30853 warn   message         = Remove internal headers
30854        remove_header   = $acl_c_ihdrs
30855 .endd
30856 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
30857 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
30858 If multiple header lines match, all are removed.
30859 There is no harm in attempting to remove the same header twice nor in removing
30860 a non-existent header. Further header lines to be removed may be accumulated
30861 during the DATA and MIME ACLs, after which they are removed from the message,
30862 if present. In the case of non-SMTP messages, headers to be removed are
30863 accumulated during the non-SMTP ACLs, and are removed from the message after
30864 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
30865 ACL, there really is no effect because there is no logging of what headers
30866 would have been removed.
30867
30868 .cindex "header lines" "removed; visibility of"
30869 Header lines are not visible in string expansions until the DATA phase when it
30870 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
30871 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
30872 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
30873 this restriction, you cannot use header lines as a way of controlling data
30874 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
30875 you should instead use ACL variables, as described in section
30876 &<<SECTaclvariables>>&.
30877
30878 The &%remove_header%& modifier acts immediately as it is encountered during the
30879 processing of an ACL. Notice the difference between these two cases:
30880 .display
30881 &`accept remove_header = X-Internal`&
30882 &`       `&<&'some condition'&>
30883
30884 &`accept `&<&'some condition'&>
30885 &`       remove_header = X-Internal`&
30886 .endd
30887 In the first case, the header line is always removed, whether or not the
30888 condition is true. In the second case, the header line is removed only if the
30889 condition is true. Multiple occurrences of &%remove_header%& may occur in the
30890 same ACL statement. All those that are encountered before a condition fails
30891 are honoured.
30892
30893 &*Warning*&: This facility currently applies only to header lines that are
30894 present during ACL processing. It does NOT remove header lines that are added
30895 in a system filter or in a router or transport.
30896
30897
30898
30899
30900 .section "ACL conditions" "SECTaclconditions"
30901 .cindex "&ACL;" "conditions; list of"
30902 Some of the conditions listed in this section are available only when Exim is
30903 compiled with the content-scanning extension. They are included here briefly
30904 for completeness. More detailed descriptions can be found in the discussion on
30905 content scanning in chapter &<<CHAPexiscan>>&.
30906
30907 Not all conditions are relevant in all circumstances. For example, testing
30908 senders and recipients does not make sense in an ACL that is being run as the
30909 result of the arrival of an ETRN command, and checks on message headers can be
30910 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
30911 can use the same condition (with different parameters) more than once in the
30912 same ACL statement. This provides a way of specifying an &"and"& conjunction.
30913 The conditions are as follows:
30914
30915
30916 .vlist
30917 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
30918 .cindex "&ACL;" "nested"
30919 .cindex "&ACL;" "indirect"
30920 .cindex "&ACL;" "arguments"
30921 .cindex "&%acl%& ACL condition"
30922 The possible values of the argument are the same as for the
30923 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
30924 &"accept"& the condition is true; if it returns &"deny"& the condition is
30925 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
30926 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
30927 condition false. This means that further processing of the &%warn%& verb
30928 ceases, but processing of the ACL continues.
30929
30930 If the argument is a named ACL, up to nine space-separated optional values
30931 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
30932 and $acl_narg is set to the count of values.
30933 Previous values of these variables are restored after the call returns.
30934 The name and values are expanded separately.
30935 Note that spaces in complex expansions which are used as arguments
30936 will act as argument separators.
30937
30938 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
30939 the connection is dropped. If it returns &"discard"&, the verb must be
30940 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
30941 conditions are tested.
30942
30943 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
30944 loops. This condition allows you to use different ACLs in different
30945 circumstances. For example, different ACLs can be used to handle RCPT commands
30946 for different local users or different local domains.
30947
30948 .vitem &*authenticated&~=&~*&<&'string&~list'&>
30949 .cindex "&%authenticated%& ACL condition"
30950 .cindex "authentication" "ACL checking"
30951 .cindex "&ACL;" "testing for authentication"
30952 If the SMTP connection is not authenticated, the condition is false. Otherwise,
30953 the name of the authenticator is tested against the list. To test for
30954 authentication by any authenticator, you can set
30955 .code
30956 authenticated = *
30957 .endd
30958
30959 .vitem &*condition&~=&~*&<&'string'&>
30960 .cindex "&%condition%& ACL condition"
30961 .cindex "customizing" "ACL condition"
30962 .cindex "&ACL;" "customized test"
30963 .cindex "&ACL;" "testing, customized"
30964 This feature allows you to make up custom conditions. If the result of
30965 expanding the string is an empty string, the number zero, or one of the strings
30966 &"no"& or &"false"&, the condition is false. If the result is any non-zero
30967 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
30968 any other value, some error is assumed to have occurred, and the ACL returns
30969 &"defer"&. However, if the expansion is forced to fail, the condition is
30970 ignored. The effect is to treat it as true, whether it is positive or
30971 negative.
30972
30973 .vitem &*decode&~=&~*&<&'location'&>
30974 .cindex "&%decode%& ACL condition"
30975 This condition is available only when Exim is compiled with the
30976 content-scanning extension, and it is allowed only in the ACL defined by
30977 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
30978 If all goes well, the condition is true. It is false only if there are
30979 problems such as a syntax error or a memory shortage. For more details, see
30980 chapter &<<CHAPexiscan>>&.
30981
30982 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
30983 .cindex "&%dnslists%& ACL condition"
30984 .cindex "DNS list" "in ACL"
30985 .cindex "black list (DNS)"
30986 .cindex "&ACL;" "testing a DNS list"
30987 This condition checks for entries in DNS black lists. These are also known as
30988 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
30989 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
30990 different variants of this condition to describe briefly here. See sections
30991 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
30992
30993 .vitem &*domains&~=&~*&<&'domain&~list'&>
30994 .cindex "&%domains%& ACL condition"
30995 .cindex "domain" "ACL checking"
30996 .cindex "&ACL;" "testing a recipient domain"
30997 .vindex "&$domain_data$&"
30998 This condition is relevant only after a RCPT command. It checks that the domain
30999 of the recipient address is in the domain list. If percent-hack processing is
31000 enabled, it is done before this test is done. If the check succeeds with a
31001 lookup, the result of the lookup is placed in &$domain_data$& until the next
31002 &%domains%& test.
31003
31004 &*Note carefully*& (because many people seem to fall foul of this): you cannot
31005 use &%domains%& in a DATA ACL.
31006
31007
31008 .vitem &*encrypted&~=&~*&<&'string&~list'&>
31009 .cindex "&%encrypted%& ACL condition"
31010 .cindex "encryption" "checking in an ACL"
31011 .cindex "&ACL;" "testing for encryption"
31012 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
31013 name of the cipher suite in use is tested against the list. To test for
31014 encryption without testing for any specific cipher suite(s), set
31015 .code
31016 encrypted = *
31017 .endd
31018
31019
31020 .vitem &*hosts&~=&~*&<&'host&~list'&>
31021 .cindex "&%hosts%& ACL condition"
31022 .cindex "host" "ACL checking"
31023 .cindex "&ACL;" "testing the client host"
31024 This condition tests that the calling host matches the host list. If you have
31025 name lookups or wildcarded host names and IP addresses in the same host list,
31026 you should normally put the IP addresses first. For example, you could have:
31027 .code
31028 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
31029 .endd
31030 The lookup in this example uses the host name for its key. This is implied by
31031 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
31032 and it wouldn't matter which way round you had these two items.)
31033
31034 The reason for the problem with host names lies in the left-to-right way that
31035 Exim processes lists. It can test IP addresses without doing any DNS lookups,
31036 but when it reaches an item that requires a host name, it fails if it cannot
31037 find a host name to compare with the pattern. If the above list is given in the
31038 opposite order, the &%accept%& statement fails for a host whose name cannot be
31039 found, even if its IP address is 10.9.8.7.
31040
31041 If you really do want to do the name check first, and still recognize the IP
31042 address even if the name lookup fails, you can rewrite the ACL like this:
31043 .code
31044 accept hosts = dbm;/etc/friendly/hosts
31045 accept hosts = 10.9.8.7
31046 .endd
31047 The default action on failing to find the host name is to assume that the host
31048 is not in the list, so the first &%accept%& statement fails. The second
31049 statement can then check the IP address.
31050
31051 .vindex "&$host_data$&"
31052 If a &%hosts%& condition is satisfied by means of a lookup, the result
31053 of the lookup is made available in the &$host_data$& variable. This
31054 allows you, for example, to set up a statement like this:
31055 .code
31056 deny  hosts = net-lsearch;/some/file
31057 message = $host_data
31058 .endd
31059 which gives a custom error message for each denied host.
31060
31061 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
31062 .cindex "&%local_parts%& ACL condition"
31063 .cindex "local part" "ACL checking"
31064 .cindex "&ACL;" "testing a local part"
31065 .vindex "&$local_part_data$&"
31066 This condition is relevant only after a RCPT command. It checks that the local
31067 part of the recipient address is in the list. If percent-hack processing is
31068 enabled, it is done before this test. If the check succeeds with a lookup, the
31069 result of the lookup is placed in &$local_part_data$&, which remains set until
31070 the next &%local_parts%& test.
31071
31072 .vitem &*malware&~=&~*&<&'option'&>
31073 .cindex "&%malware%& ACL condition"
31074 .cindex "&ACL;" "virus scanning"
31075 .cindex "&ACL;" "scanning for viruses"
31076 This condition is available only when Exim is compiled with the
31077 content-scanning extension
31078 and only after a DATA command.
31079 It causes the incoming message to be scanned for
31080 viruses. For details, see chapter &<<CHAPexiscan>>&.
31081
31082 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31083 .cindex "&%mime_regex%& ACL condition"
31084 .cindex "&ACL;" "testing by regex matching"
31085 This condition is available only when Exim is compiled with the
31086 content-scanning extension, and it is allowed only in the ACL defined by
31087 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
31088 with any of the regular expressions. For details, see chapter
31089 &<<CHAPexiscan>>&.
31090
31091 .vitem &*ratelimit&~=&~*&<&'parameters'&>
31092 .cindex "rate limiting"
31093 This condition can be used to limit the rate at which a user or host submits
31094 messages. Details are given in section &<<SECTratelimiting>>&.
31095
31096 .vitem &*recipients&~=&~*&<&'address&~list'&>
31097 .cindex "&%recipients%& ACL condition"
31098 .cindex "recipient" "ACL checking"
31099 .cindex "&ACL;" "testing a recipient"
31100 This condition is relevant only after a RCPT command. It checks the entire
31101 recipient address against a list of recipients.
31102
31103 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31104 .cindex "&%regex%& ACL condition"
31105 .cindex "&ACL;" "testing by regex matching"
31106 This condition is available only when Exim is compiled with the
31107 content-scanning extension, and is available only in the DATA, MIME, and
31108 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
31109 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
31110
31111 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
31112 .cindex "&%sender_domains%& ACL condition"
31113 .cindex "sender" "ACL checking"
31114 .cindex "&ACL;" "testing a sender domain"
31115 .vindex "&$domain$&"
31116 .vindex "&$sender_address_domain$&"
31117 This condition tests the domain of the sender of the message against the given
31118 domain list. &*Note*&: The domain of the sender address is in
31119 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
31120 of this condition. This is an exception to the general rule for testing domain
31121 lists. It is done this way so that, if this condition is used in an ACL for a
31122 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
31123 influence the sender checking.
31124
31125 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31126 relaying, because sender addresses are easily, and commonly, forged.
31127
31128 .vitem &*senders&~=&~*&<&'address&~list'&>
31129 .cindex "&%senders%& ACL condition"
31130 .cindex "sender" "ACL checking"
31131 .cindex "&ACL;" "testing a sender"
31132 This condition tests the sender of the message against the given list. To test
31133 for a bounce message, which has an empty sender, set
31134 .code
31135 senders = :
31136 .endd
31137 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31138 relaying, because sender addresses are easily, and commonly, forged.
31139
31140 .vitem &*spam&~=&~*&<&'username'&>
31141 .cindex "&%spam%& ACL condition"
31142 .cindex "&ACL;" "scanning for spam"
31143 This condition is available only when Exim is compiled with the
31144 content-scanning extension. It causes the incoming message to be scanned by
31145 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
31146
31147 .vitem &*verify&~=&~certificate*&
31148 .cindex "&%verify%& ACL condition"
31149 .cindex "TLS" "client certificate verification"
31150 .cindex "certificate" "verification of client"
31151 .cindex "&ACL;" "certificate verification"
31152 .cindex "&ACL;" "testing a TLS certificate"
31153 This condition is true in an SMTP session if the session is encrypted, and a
31154 certificate was received from the client, and the certificate was verified. The
31155 server requests a certificate only if the client matches &%tls_verify_hosts%&
31156 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
31157
31158 .vitem &*verify&~=&~csa*&
31159 .cindex "CSA verification"
31160 This condition checks whether the sending host (the client) is authorized to
31161 send email. Details of how this works are given in section
31162 &<<SECTverifyCSA>>&.
31163
31164 .vitem &*verify&~=&~header_names_ascii*&
31165 .cindex "&%verify%& ACL condition"
31166 .cindex "&ACL;" "verifying header names only ASCII"
31167 .cindex "header lines" "verifying header names only ASCII"
31168 .cindex "verifying" "header names only ASCII"
31169 This condition is relevant only in an ACL that is run after a message has been
31170 received, that is, in an ACL specified by &%acl_smtp_data%& or
31171 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
31172 there are no non-ASCII characters, also excluding control characters.  The
31173 allowable characters are decimal ASCII values 33 through 126.
31174
31175 Exim itself will handle headers with non-ASCII characters, but it can cause
31176 problems for downstream applications, so this option will allow their
31177 detection and rejection in the DATA ACL's.
31178
31179 .vitem &*verify&~=&~header_sender/*&<&'options'&>
31180 .cindex "&%verify%& ACL condition"
31181 .cindex "&ACL;" "verifying sender in the header"
31182 .cindex "header lines" "verifying the sender in"
31183 .cindex "sender" "verifying in header"
31184 .cindex "verifying" "sender in header"
31185 This condition is relevant only in an ACL that is run after a message has been
31186 received, that is, in an ACL specified by &%acl_smtp_data%& or
31187 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
31188 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
31189 is loosely thought of as a &"sender"& address (hence the name of the test).
31190 However, an address that appears in one of these headers need not be an address
31191 that accepts bounce messages; only sender addresses in envelopes are required
31192 to accept bounces. Therefore, if you use the callout option on this check, you
31193 might want to arrange for a non-empty address in the MAIL command.
31194
31195 Details of address verification and the options are given later, starting at
31196 section &<<SECTaddressverification>>& (callouts are described in section
31197 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
31198 condition to restrict it to bounce messages only:
31199 .code
31200 deny    senders = :
31201         message = A valid sender header is required for bounces
31202        !verify  = header_sender
31203 .endd
31204
31205 .vitem &*verify&~=&~header_syntax*&
31206 .cindex "&%verify%& ACL condition"
31207 .cindex "&ACL;" "verifying header syntax"
31208 .cindex "header lines" "verifying syntax"
31209 .cindex "verifying" "header syntax"
31210 This condition is relevant only in an ACL that is run after a message has been
31211 received, that is, in an ACL specified by &%acl_smtp_data%& or
31212 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
31213 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
31214 and &'Bcc:'&), returning true if there are no problems.
31215 Unqualified addresses (local parts without domains) are
31216 permitted only in locally generated messages and from hosts that match
31217 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
31218 appropriate.
31219
31220 Note that this condition is a syntax check only. However, a common spamming
31221 ploy used to be to send syntactically invalid headers such as
31222 .code
31223 To: @
31224 .endd
31225 and this condition can be used to reject such messages, though they are not as
31226 common as they used to be.
31227
31228 .vitem &*verify&~=&~helo*&
31229 .cindex "&%verify%& ACL condition"
31230 .cindex "&ACL;" "verifying HELO/EHLO"
31231 .cindex "HELO" "verifying"
31232 .cindex "EHLO" "verifying"
31233 .cindex "verifying" "EHLO"
31234 .cindex "verifying" "HELO"
31235 This condition is true if a HELO or EHLO command has been received from the
31236 client host, and its contents have been verified. If there has been no previous
31237 attempt to verify the HELO/EHLO contents, it is carried out when this
31238 condition is encountered. See the description of the &%helo_verify_hosts%& and
31239 &%helo_try_verify_hosts%& options for details of how to request verification
31240 independently of this condition, and for detail of the verification.
31241
31242 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
31243 option), this condition is always true.
31244
31245
31246 .vitem &*verify&~=&~not_blind/*&<&'options'&>
31247 .cindex "verifying" "not blind"
31248 .cindex "bcc recipients, verifying none"
31249 This condition checks that there are no blind (bcc) recipients in the message.
31250 Every envelope recipient must appear either in a &'To:'& header line or in a
31251 &'Cc:'& header line for this condition to be true. Local parts are checked
31252 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
31253 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
31254 used only in a DATA or non-SMTP ACL.
31255
31256 There is one possible option, &`case_insensitive`&.  If this is present then
31257 local parts are checked case-insensitively.
31258
31259 There are, of course, many legitimate messages that make use of blind (bcc)
31260 recipients. This check should not be used on its own for blocking messages.
31261
31262
31263 .vitem &*verify&~=&~recipient/*&<&'options'&>
31264 .cindex "&%verify%& ACL condition"
31265 .cindex "&ACL;" "verifying recipient"
31266 .cindex "recipient" "verifying"
31267 .cindex "verifying" "recipient"
31268 .vindex "&$address_data$&"
31269 This condition is relevant only after a RCPT command. It verifies the current
31270 recipient. Details of address verification are given later, starting at section
31271 &<<SECTaddressverification>>&. After a recipient has been verified, the value
31272 of &$address_data$& is the last value that was set while routing the address.
31273 This applies even if the verification fails. When an address that is being
31274 verified is redirected to a single address, verification continues with the new
31275 address, and in that case, the subsequent value of &$address_data$& is the
31276 value for the child address.
31277
31278 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
31279 .cindex "&%verify%& ACL condition"
31280 .cindex "&ACL;" "verifying host reverse lookup"
31281 .cindex "host" "verifying reverse lookup"
31282 This condition ensures that a verified host name has been looked up from the IP
31283 address of the client host. (This may have happened already if the host name
31284 was needed for checking a host list, or if the host matched &%host_lookup%&.)
31285 Verification ensures that the host name obtained from a reverse DNS lookup, or
31286 one of its aliases, does, when it is itself looked up in the DNS, yield the
31287 original IP address.
31288
31289 There is one possible option, &`defer_ok`&.  If this is present and a
31290 DNS operation returns a temporary error, the verify condition succeeds.
31291
31292 If this condition is used for a locally generated message (that is, when there
31293 is no client host involved), it always succeeds.
31294
31295 .vitem &*verify&~=&~sender/*&<&'options'&>
31296 .cindex "&%verify%& ACL condition"
31297 .cindex "&ACL;" "verifying sender"
31298 .cindex "sender" "verifying"
31299 .cindex "verifying" "sender"
31300 This condition is relevant only after a MAIL or RCPT command, or after a
31301 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
31302 the message's sender is empty (that is, this is a bounce message), the
31303 condition is true. Otherwise, the sender address is verified.
31304
31305 .vindex "&$address_data$&"
31306 .vindex "&$sender_address_data$&"
31307 If there is data in the &$address_data$& variable at the end of routing, its
31308 value is placed in &$sender_address_data$& at the end of verification. This
31309 value can be used in subsequent conditions and modifiers in the same ACL
31310 statement. It does not persist after the end of the current statement. If you
31311 want to preserve the value for longer, you can save it in an ACL variable.
31312
31313 Details of verification are given later, starting at section
31314 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
31315 to avoid doing it more than once per message.
31316
31317 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
31318 .cindex "&%verify%& ACL condition"
31319 This is a variation of the previous option, in which a modified address is
31320 verified as a sender.
31321
31322 Note that '/' is legal in local-parts; if the address may have such
31323 (eg. is generated from the received message)
31324 they must be protected from the options parsing by doubling:
31325 .code
31326 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
31327 .endd
31328 .endlist
31329
31330
31331
31332 .section "Using DNS lists" "SECTmorednslists"
31333 .cindex "DNS list" "in ACL"
31334 .cindex "black list (DNS)"
31335 .cindex "&ACL;" "testing a DNS list"
31336 In its simplest form, the &%dnslists%& condition tests whether the calling host
31337 is on at least one of a number of DNS lists by looking up the inverted IP
31338 address in one or more DNS domains. (Note that DNS list domains are not mail
31339 domains, so the &`+`& syntax for named lists doesn't work - it is used for
31340 special options instead.) For example, if the calling host's IP
31341 address is 192.168.62.43, and the ACL statement is
31342 .code
31343 deny dnslists = blackholes.mail-abuse.org : \
31344                 dialups.mail-abuse.org
31345 .endd
31346 the following records are looked up:
31347 .code
31348 43.62.168.192.blackholes.mail-abuse.org
31349 43.62.168.192.dialups.mail-abuse.org
31350 .endd
31351 As soon as Exim finds an existing DNS record, processing of the list stops.
31352 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
31353 to test that a host is on more than one list (an &"and"& conjunction), you can
31354 use two separate conditions:
31355 .code
31356 deny dnslists = blackholes.mail-abuse.org
31357      dnslists = dialups.mail-abuse.org
31358 .endd
31359 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
31360 behaves as if the host does not match the list item, that is, as if the DNS
31361 record does not exist. If there are further items in the DNS list, they are
31362 processed.
31363
31364 This is usually the required action when &%dnslists%& is used with &%deny%&
31365 (which is the most common usage), because it prevents a DNS failure from
31366 blocking mail. However, you can change this behaviour by putting one of the
31367 following special items in the list:
31368 .display
31369 &`+include_unknown `&   behave as if the item is on the list
31370 &`+exclude_unknown `&   behave as if the item is not on the list (default)
31371 &`+defer_unknown   `&   give a temporary error
31372 .endd
31373 .cindex "&`+include_unknown`&"
31374 .cindex "&`+exclude_unknown`&"
31375 .cindex "&`+defer_unknown`&"
31376 Each of these applies to any subsequent items on the list. For example:
31377 .code
31378 deny dnslists = +defer_unknown : foo.bar.example
31379 .endd
31380 Testing the list of domains stops as soon as a match is found. If you want to
31381 warn for one list and block for another, you can use two different statements:
31382 .code
31383 deny  dnslists = blackholes.mail-abuse.org
31384 warn  message  = X-Warn: sending host is on dialups list
31385       dnslists = dialups.mail-abuse.org
31386 .endd
31387 .cindex caching "of dns lookup"
31388 .cindex DNS TTL
31389 DNS list lookups are cached by Exim for the duration of the SMTP session
31390 (but limited by the DNS return TTL value),
31391 so a lookup based on the IP address is done at most once for any incoming
31392 connection (assuming long-enough TTL).
31393 Exim does not share information between multiple incoming
31394 connections (but your local name server cache should be active).
31395
31396 There are a number of DNS lists to choose from, some commercial, some free,
31397 or free for small deployments.  An overview can be found at
31398 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
31399
31400
31401
31402 .section "Specifying the IP address for a DNS list lookup" "SECID201"
31403 .cindex "DNS list" "keyed by explicit IP address"
31404 By default, the IP address that is used in a DNS list lookup is the IP address
31405 of the calling host. However, you can specify another IP address by listing it
31406 after the domain name, introduced by a slash. For example:
31407 .code
31408 deny dnslists = black.list.tld/192.168.1.2
31409 .endd
31410 This feature is not very helpful with explicit IP addresses; it is intended for
31411 use with IP addresses that are looked up, for example, the IP addresses of the
31412 MX hosts or nameservers of an email sender address. For an example, see section
31413 &<<SECTmulkeyfor>>& below.
31414
31415
31416
31417
31418 .section "DNS lists keyed on domain names" "SECID202"
31419 .cindex "DNS list" "keyed by domain name"
31420 There are some lists that are keyed on domain names rather than inverted IP
31421 addresses (see, e.g., the &'domain based zones'& link at
31422 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
31423 with these lists. You can change the name that is looked up in a DNS list by
31424 listing it after the domain name, introduced by a slash. For example,
31425 .code
31426 deny  message  = Sender's domain is listed at $dnslist_domain
31427       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
31428 .endd
31429 This particular example is useful only in ACLs that are obeyed after the
31430 RCPT or DATA commands, when a sender address is available. If (for
31431 example) the message's sender is &'user@tld.example'& the name that is looked
31432 up by this example is
31433 .code
31434 tld.example.dsn.rfc-ignorant.org
31435 .endd
31436 A single &%dnslists%& condition can contain entries for both names and IP
31437 addresses. For example:
31438 .code
31439 deny dnslists = sbl.spamhaus.org : \
31440                 dsn.rfc-ignorant.org/$sender_address_domain
31441 .endd
31442 The first item checks the sending host's IP address; the second checks a domain
31443 name. The whole condition is true if either of the DNS lookups succeeds.
31444
31445
31446
31447
31448 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
31449 .cindex "DNS list" "multiple keys for"
31450 The syntax described above for looking up explicitly-defined values (either
31451 names or IP addresses) in a DNS blacklist is a simplification. After the domain
31452 name for the DNS list, what follows the slash can in fact be a list of items.
31453 As with all lists in Exim, the default separator is a colon. However, because
31454 this is a sublist within the list of DNS blacklist domains, it is necessary
31455 either to double the separators like this:
31456 .code
31457 dnslists = black.list.tld/name.1::name.2
31458 .endd
31459 or to change the separator character, like this:
31460 .code
31461 dnslists = black.list.tld/<;name.1;name.2
31462 .endd
31463 If an item in the list is an IP address, it is inverted before the DNS
31464 blacklist domain is appended. If it is not an IP address, no inversion
31465 occurs. Consider this condition:
31466 .code
31467 dnslists = black.list.tld/<;192.168.1.2;a.domain
31468 .endd
31469 The DNS lookups that occur are:
31470 .code
31471 2.1.168.192.black.list.tld
31472 a.domain.black.list.tld
31473 .endd
31474 Once a DNS record has been found (that matches a specific IP return
31475 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
31476 are done. If there is a temporary DNS error, the rest of the sublist of domains
31477 or IP addresses is tried. A temporary error for the whole dnslists item occurs
31478 only if no other DNS lookup in this sublist succeeds. In other words, a
31479 successful lookup for any of the items in the sublist overrides a temporary
31480 error for a previous item.
31481
31482 The ability to supply a list of items after the slash is in some sense just a
31483 syntactic convenience. These two examples have the same effect:
31484 .code
31485 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
31486 dnslists = black.list.tld/a.domain::b.domain
31487 .endd
31488 However, when the data for the list is obtained from a lookup, the second form
31489 is usually much more convenient. Consider this example:
31490 .code
31491 deny message  = The mail servers for the domain \
31492                 $sender_address_domain \
31493                 are listed at $dnslist_domain ($dnslist_value); \
31494                 see $dnslist_text.
31495      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
31496                                    ${lookup dnsdb {>|mxh=\
31497                                    $sender_address_domain} }} }
31498 .endd
31499 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
31500 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
31501 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
31502 of expanding the condition might be something like this:
31503 .code
31504 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
31505 .endd
31506 Thus, this example checks whether or not the IP addresses of the sender
31507 domain's mail servers are on the Spamhaus black list.
31508
31509 The key that was used for a successful DNS list lookup is put into the variable
31510 &$dnslist_matched$& (see section &<<SECID204>>&).
31511
31512
31513
31514
31515 .section "Data returned by DNS lists" "SECID203"
31516 .cindex "DNS list" "data returned from"
31517 DNS lists are constructed using address records in the DNS. The original RBL
31518 just used the address 127.0.0.1 on the right hand side of each record, but the
31519 RBL+ list and some other lists use a number of values with different meanings.
31520 The values used on the RBL+ list are:
31521 .display
31522 127.1.0.1  RBL
31523 127.1.0.2  DUL
31524 127.1.0.3  DUL and RBL
31525 127.1.0.4  RSS
31526 127.1.0.5  RSS and RBL
31527 127.1.0.6  RSS and DUL
31528 127.1.0.7  RSS and DUL and RBL
31529 .endd
31530 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
31531 different values. Some DNS lists may return more than one address record;
31532 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
31533
31534
31535 .section "Variables set from DNS lists" "SECID204"
31536 .cindex "expansion" "variables, set from DNS list"
31537 .cindex "DNS list" "variables set from"
31538 .vindex "&$dnslist_domain$&"
31539 .vindex "&$dnslist_matched$&"
31540 .vindex "&$dnslist_text$&"
31541 .vindex "&$dnslist_value$&"
31542 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
31543 the name of the overall domain that matched (for example,
31544 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
31545 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
31546 the DNS record. When the key is an IP address, it is not reversed in
31547 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
31548 cases, for example:
31549 .code
31550 deny dnslists = spamhaus.example
31551 .endd
31552 the key is also available in another variable (in this case,
31553 &$sender_host_address$&). In more complicated cases, however, this is not true.
31554 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
31555 might generate a dnslists lookup like this:
31556 .code
31557 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
31558 .endd
31559 If this condition succeeds, the value in &$dnslist_matched$& might be
31560 &`192.168.6.7`& (for example).
31561
31562 If more than one address record is returned by the DNS lookup, all the IP
31563 addresses are included in &$dnslist_value$&, separated by commas and spaces.
31564 The variable &$dnslist_text$& contains the contents of any associated TXT
31565 record. For lists such as RBL+ the TXT record for a merged entry is often not
31566 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
31567 information.
31568
31569 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
31570 &-- although these appear before the condition in the ACL, they are not
31571 expanded until after it has failed. For example:
31572 .code
31573 deny    hosts = !+local_networks
31574         message = $sender_host_address is listed \
31575                   at $dnslist_domain
31576         dnslists = rbl-plus.mail-abuse.example
31577 .endd
31578
31579
31580
31581 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
31582 .cindex "DNS list" "matching specific returned data"
31583 You can add an equals sign and an IP address after a &%dnslists%& domain name
31584 in order to restrict its action to DNS records with a matching right hand side.
31585 For example,
31586 .code
31587 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
31588 .endd
31589 rejects only those hosts that yield 127.0.0.2. Without this additional data,
31590 any address record is considered to be a match. For the moment, we assume
31591 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
31592 describes how multiple records are handled.
31593
31594 More than one IP address may be given for checking, using a comma as a
31595 separator. These are alternatives &-- if any one of them matches, the
31596 &%dnslists%& condition is true. For example:
31597 .code
31598 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31599 .endd
31600 If you want to specify a constraining address list and also specify names or IP
31601 addresses to be looked up, the constraining address list must be specified
31602 first. For example:
31603 .code
31604 deny dnslists = dsn.rfc-ignorant.org\
31605                 =127.0.0.2/$sender_address_domain
31606 .endd
31607
31608 If the character &`&&`& is used instead of &`=`&, the comparison for each
31609 listed IP address is done by a bitwise &"and"& instead of by an equality test.
31610 In other words, the listed addresses are used as bit masks. The comparison is
31611 true if all the bits in the mask are present in the address that is being
31612 tested. For example:
31613 .code
31614 dnslists = a.b.c&0.0.0.3
31615 .endd
31616 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
31617 want to test whether one bit or another bit is present (as opposed to both
31618 being present), you must use multiple values. For example:
31619 .code
31620 dnslists = a.b.c&0.0.0.1,0.0.0.2
31621 .endd
31622 matches if the final component of the address is an odd number or two times
31623 an odd number.
31624
31625
31626
31627 .section "Negated DNS matching conditions" "SECID205"
31628 You can supply a negative list of IP addresses as part of a &%dnslists%&
31629 condition. Whereas
31630 .code
31631 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31632 .endd
31633 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31634 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
31635 .code
31636 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
31637 .endd
31638 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31639 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
31640 words, the result of the test is inverted if an exclamation mark appears before
31641 the &`=`& (or the &`&&`&) sign.
31642
31643 &*Note*&: This kind of negation is not the same as negation in a domain,
31644 host, or address list (which is why the syntax is different).
31645
31646 If you are using just one list, the negation syntax does not gain you much. The
31647 previous example is precisely equivalent to
31648 .code
31649 deny  dnslists = a.b.c
31650      !dnslists = a.b.c=127.0.0.2,127.0.0.3
31651 .endd
31652 However, if you are using multiple lists, the negation syntax is clearer.
31653 Consider this example:
31654 .code
31655 deny  dnslists = sbl.spamhaus.org : \
31656                  list.dsbl.org : \
31657                  dnsbl.njabl.org!=127.0.0.3 : \
31658                  relays.ordb.org
31659 .endd
31660 Using only positive lists, this would have to be:
31661 .code
31662 deny  dnslists = sbl.spamhaus.org : \
31663                  list.dsbl.org
31664 deny  dnslists = dnsbl.njabl.org
31665      !dnslists = dnsbl.njabl.org=127.0.0.3
31666 deny  dnslists = relays.ordb.org
31667 .endd
31668 which is less clear, and harder to maintain.
31669
31670
31671
31672
31673 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
31674 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
31675 thereby providing more than one IP address. When an item in a &%dnslists%& list
31676 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
31677 the match to specific results from the DNS lookup, there are two ways in which
31678 the checking can be handled. For example, consider the condition:
31679 .code
31680 dnslists = a.b.c=127.0.0.1
31681 .endd
31682 What happens if the DNS lookup for the incoming IP address yields both
31683 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
31684 condition true because at least one given value was found, or is it false
31685 because at least one of the found values was not listed? And how does this
31686 affect negated conditions? Both possibilities are provided for with the help of
31687 additional separators &`==`& and &`=&&`&.
31688
31689 .ilist
31690 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
31691 IP addresses matches one of the listed addresses. For the example above, the
31692 condition is true because 127.0.0.1 matches.
31693 .next
31694 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
31695 looked up IP addresses matches one of the listed addresses. If the condition is
31696 changed to:
31697 .code
31698 dnslists = a.b.c==127.0.0.1
31699 .endd
31700 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31701 false because 127.0.0.2 is not listed. You would need to have:
31702 .code
31703 dnslists = a.b.c==127.0.0.1,127.0.0.2
31704 .endd
31705 for the condition to be true.
31706 .endlist
31707
31708 When &`!`& is used to negate IP address matching, it inverts the result, giving
31709 the precise opposite of the behaviour above. Thus:
31710 .ilist
31711 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
31712 addresses matches one of the listed addresses. Consider:
31713 .code
31714 dnslists = a.b.c!&0.0.0.1
31715 .endd
31716 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31717 false because 127.0.0.1 matches.
31718 .next
31719 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
31720 looked up IP address that does not match. Consider:
31721 .code
31722 dnslists = a.b.c!=&0.0.0.1
31723 .endd
31724 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31725 true, because 127.0.0.2 does not match. You would need to have:
31726 .code
31727 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
31728 .endd
31729 for the condition to be false.
31730 .endlist
31731 When the DNS lookup yields only a single IP address, there is no difference
31732 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
31733
31734
31735
31736
31737 .section "Detailed information from merged DNS lists" "SECTmordetinf"
31738 .cindex "DNS list" "information from merged"
31739 When the facility for restricting the matching IP values in a DNS list is used,
31740 the text from the TXT record that is set in &$dnslist_text$& may not reflect
31741 the true reason for rejection. This happens when lists are merged and the IP
31742 address in the A record is used to distinguish them; unfortunately there is
31743 only one TXT record. One way round this is not to use merged lists, but that
31744 can be inefficient because it requires multiple DNS lookups where one would do
31745 in the vast majority of cases when the host of interest is not on any of the
31746 lists.
31747
31748 A less inefficient way of solving this problem is available. If
31749 two domain names, comma-separated, are given, the second is used first to
31750 do an initial check, making use of any IP value restrictions that are set.
31751 If there is a match, the first domain is used, without any IP value
31752 restrictions, to get the TXT record. As a byproduct of this, there is also
31753 a check that the IP being tested is indeed on the first list. The first
31754 domain is the one that is put in &$dnslist_domain$&. For example:
31755 .code
31756 deny message  = \
31757          rejected because $sender_host_address is blacklisted \
31758          at $dnslist_domain\n$dnslist_text
31759        dnslists = \
31760          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
31761          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31762 .endd
31763 For the first blacklist item, this starts by doing a lookup in
31764 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
31765 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
31766 value, and as long as something is found, it looks for the corresponding TXT
31767 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
31768 The second blacklist item is processed similarly.
31769
31770 If you are interested in more than one merged list, the same list must be
31771 given several times, but because the results of the DNS lookups are cached,
31772 the DNS calls themselves are not repeated. For example:
31773 .code
31774 deny dnslists = \
31775          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
31776          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
31777          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
31778          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31779 .endd
31780 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
31781 values matches (or if no record is found), this is the only lookup that is
31782 done. Only if there is a match is one of the more specific lists consulted.
31783
31784
31785
31786 .section "DNS lists and IPv6" "SECTmorednslistslast"
31787 .cindex "IPv6" "DNS black lists"
31788 .cindex "DNS list" "IPv6 usage"
31789 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
31790 nibble by nibble. For example, if the calling host's IP address is
31791 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
31792 .code
31793 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
31794   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
31795 .endd
31796 (split over two lines here to fit on the page). Unfortunately, some of the DNS
31797 lists contain wildcard records, intended for IPv4, that interact badly with
31798 IPv6. For example, the DNS entry
31799 .code
31800 *.3.some.list.example.    A    127.0.0.1
31801 .endd
31802 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
31803 Unfortunately, it also matches the entire 3::/4 IPv6 network.
31804
31805 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
31806 &%condition%& condition, as in this example:
31807 .code
31808 deny   condition = ${if isip4{$sender_host_address}}
31809        dnslists  = some.list.example
31810 .endd
31811
31812 If an explicit key is being used for a DNS lookup and it may be an IPv6
31813 address you should specify alternate list separators for both the outer
31814 (DNS list name) list and inner (lookup keys) list:
31815 .code
31816        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
31817 .endd
31818
31819 .section "Rate limiting incoming messages" "SECTratelimiting"
31820 .cindex "rate limiting" "client sending"
31821 .cindex "limiting client sending rates"
31822 .oindex "&%smtp_ratelimit_*%&"
31823 The &%ratelimit%& ACL condition can be used to measure and control the rate at
31824 which clients can send email. This is more powerful than the
31825 &%smtp_ratelimit_*%& options, because those options control the rate of
31826 commands in a single SMTP session only, whereas the &%ratelimit%& condition
31827 works across all connections (concurrent and sequential) from the same client
31828 host. The syntax of the &%ratelimit%& condition is:
31829 .display
31830 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
31831 .endd
31832 If the average client sending rate is less than &'m'& messages per time
31833 period &'p'& then the condition is false; otherwise it is true.
31834
31835 As a side-effect, the &%ratelimit%& condition sets the expansion variable
31836 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
31837 configured value of &'m'&, and &$sender_rate_period$& to the configured value
31838 of &'p'&.
31839
31840 The parameter &'p'& is the smoothing time constant, in the form of an Exim
31841 time interval, for example, &`8h`& for eight hours. A larger time constant
31842 means that it takes Exim longer to forget a client's past behaviour. The
31843 parameter &'m'& is the maximum number of messages that a client is permitted to
31844 send in each time interval. It also specifies the number of messages permitted
31845 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
31846 constant, you can allow a client to send more messages in a burst without
31847 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
31848 both small, messages must be sent at an even rate.
31849
31850 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
31851 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
31852 when deploying the &%ratelimit%& ACL condition. The script prints usage
31853 instructions when it is run with no arguments.
31854
31855 The key is used to look up the data for calculating the client's average
31856 sending rate. This data is stored in Exim's spool directory, alongside the
31857 retry and other hints databases. The default key is &$sender_host_address$&,
31858 which means Exim computes the sending rate of each client host IP address.
31859 By changing the key you can change how Exim identifies clients for the purpose
31860 of ratelimiting. For example, to limit the sending rate of each authenticated
31861 user, independent of the computer they are sending from, set the key to
31862 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
31863 example, &$authenticated_id$& is only meaningful if the client has
31864 authenticated (which you can check with the &%authenticated%& ACL condition).
31865
31866 The lookup key does not have to identify clients: If you want to limit the
31867 rate at which a recipient receives messages, you can use the key
31868 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
31869 ACL.
31870
31871 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
31872 specifies what Exim measures the rate of, for example, messages or recipients
31873 or bytes. You can adjust the measurement using the &%unique=%& and/or
31874 &%count=%& options. You can also control when Exim updates the recorded rate
31875 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
31876 separated by a slash, like the other parameters. They may appear in any order.
31877
31878 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
31879 any options that alter the meaning of the stored data. The limit &'m'& is not
31880 stored, so you can alter the configured maximum rate and Exim will still
31881 remember clients' past behaviour. If you change the &%per_*%& mode or add or
31882 remove the &%unique=%& option, the lookup key changes so Exim will forget past
31883 behaviour. The lookup key is not affected by changes to the update mode and
31884 the &%count=%& option.
31885
31886
31887 .section "Ratelimit options for what is being measured" "ratoptmea"
31888 .cindex "rate limiting" "per_* options"
31889 The &%per_conn%& option limits the client's connection rate. It is not
31890 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
31891 &%acl_not_smtp_start%& ACLs.
31892
31893 The &%per_mail%& option limits the client's rate of sending messages. This is
31894 the default if none of the &%per_*%& options is specified. It can be used in
31895 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
31896 &%acl_smtp_data%&, or &%acl_not_smtp%&.
31897
31898 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
31899 the same ACLs as the &%per_mail%& option, though it is best to use this option
31900 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
31901 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
31902 in its MAIL command, which may be inaccurate or completely missing. You can
31903 follow the limit &'m'& in the configuration with K, M, or G to specify limits
31904 in kilobytes, megabytes, or gigabytes, respectively.
31905
31906 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
31907 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31908 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
31909 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
31910 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
31911 in either case the rate limiting engine will see a message with many
31912 recipients as a large high-speed burst.
31913
31914 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
31915 number of different recipients that the client has sent messages to in the
31916 last time period. That is, if the client repeatedly sends messages to the same
31917 recipient, its measured rate is not increased. This option can only be used in
31918 &%acl_smtp_rcpt%&.
31919
31920 The &%per_cmd%& option causes Exim to recompute the rate every time the
31921 condition is processed. This can be used to limit the rate of any SMTP
31922 command. If it is used in multiple ACLs it can limit the aggregate rate of
31923 multiple different commands.
31924
31925 The &%count=%& option can be used to alter how much Exim adds to the client's
31926 measured rate. For example, the &%per_byte%& option is equivalent to
31927 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
31928 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
31929 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
31930
31931 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
31932
31933
31934 .section "Ratelimit update modes" "ratoptupd"
31935 .cindex "rate limiting" "reading data without updating"
31936 You can specify one of three options with the &%ratelimit%& condition to
31937 control when its database is updated. This section describes the &%readonly%&
31938 mode, and the next section describes the &%strict%& and &%leaky%& modes.
31939
31940 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
31941 previously-computed rate to check against the limit.
31942
31943 For example, you can test the client's sending rate and deny it access (when
31944 it is too fast) in the connect ACL. If the client passes this check then it
31945 can go on to send a message, in which case its recorded rate will be updated
31946 in the MAIL ACL. Subsequent connections from the same client will check this
31947 new rate.
31948 .code
31949 acl_check_connect:
31950  deny ratelimit = 100 / 5m / readonly
31951     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
31952                   (max $sender_rate_limit)
31953 # ...
31954 acl_check_mail:
31955  warn ratelimit = 100 / 5m / strict
31956     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
31957                   (max $sender_rate_limit)
31958 .endd
31959
31960 If Exim encounters multiple &%ratelimit%& conditions with the same key when
31961 processing a message then it may increase the client's measured rate more than
31962 it should. For example, this will happen if you check the &%per_rcpt%& option
31963 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
31964 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
31965 multiple update problems by using the &%readonly%& option on later ratelimit
31966 checks.
31967
31968 The &%per_*%& options described above do not make sense in some ACLs. If you
31969 use a &%per_*%& option in an ACL where it is not normally permitted then the
31970 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
31971 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
31972 next section) so you must specify the &%readonly%& option explicitly.
31973
31974
31975 .section "Ratelimit options for handling fast clients" "ratoptfast"
31976 .cindex "rate limiting" "strict and leaky modes"
31977 If a client's average rate is greater than the maximum, the rate limiting
31978 engine can react in two possible ways, depending on the presence of the
31979 &%strict%& or &%leaky%& update modes. This is independent of the other
31980 counter-measures (such as rejecting the message) that may be specified by the
31981 rest of the ACL.
31982
31983 The &%leaky%& (default) option means that the client's recorded rate is not
31984 updated if it is above the limit. The effect of this is that Exim measures the
31985 client's average rate of successfully sent email,
31986 up to the given limit.
31987 This is appropriate if the countermeasure when the condition is true
31988 consists of refusing the message, and
31989 is generally the better choice if you have clients that retry automatically.
31990 If the action when true is anything more complex then this option is
31991 likely not what is wanted.
31992
31993 The &%strict%& option means that the client's recorded rate is always
31994 updated. The effect of this is that Exim measures the client's average rate
31995 of attempts to send email, which can be much higher than the maximum it is
31996 actually allowed. If the client is over the limit it may be subjected to
31997 counter-measures by the ACL. It must slow down and allow sufficient time to
31998 pass that its computed rate falls below the maximum before it can send email
31999 again. The time (the number of smoothing periods) it must wait and not
32000 attempt to send mail can be calculated with this formula:
32001 .code
32002         ln(peakrate/maxrate)
32003 .endd
32004
32005
32006 .section "Limiting the rate of different events" "ratoptuniq"
32007 .cindex "rate limiting" "counting unique events"
32008 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
32009 rate of different events. For example, the &%per_addr%& option uses this
32010 mechanism to count the number of different recipients that the client has
32011 sent messages to in the last time period; it is equivalent to
32012 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
32013 measure the rate that a client uses different sender addresses with the
32014 options &`per_mail/unique=$sender_address`&.
32015
32016 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
32017 has seen for that key. The whole set is thrown away when it is older than the
32018 rate smoothing period &'p'&, so each different event is counted at most once
32019 per period. In the &%leaky%& update mode, an event that causes the client to
32020 go over the limit is not added to the set, in the same way that the client's
32021 recorded rate is not updated in the same situation.
32022
32023 When you combine the &%unique=%& and &%readonly%& options, the specific
32024 &%unique=%& value is ignored, and Exim just retrieves the client's stored
32025 rate.
32026
32027 The &%unique=%& mechanism needs more space in the ratelimit database than the
32028 other &%ratelimit%& options in order to store the event set. The number of
32029 unique values is potentially as large as the rate limit, so the extra space
32030 required increases with larger limits.
32031
32032 The uniqueification is not perfect: there is a small probability that Exim
32033 will think a new event has happened before. If the sender's rate is less than
32034 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
32035 the measured rate can go above the limit, in which case Exim may under-count
32036 events by a significant margin. Fortunately, if the rate is high enough (2.7
32037 times the limit) that the false positive rate goes above 9%, then Exim will
32038 throw away the over-full event set before the measured rate falls below the
32039 limit. Therefore the only harm should be that exceptionally high sending rates
32040 are logged incorrectly; any countermeasures you configure will be as effective
32041 as intended.
32042
32043
32044 .section "Using rate limiting" "useratlim"
32045 Exim's other ACL facilities are used to define what counter-measures are taken
32046 when the rate limit is exceeded. This might be anything from logging a warning
32047 (for example, while measuring existing sending rates in order to define
32048 policy), through time delays to slow down fast senders, up to rejecting the
32049 message. For example:
32050 .code
32051 # Log all senders' rates
32052 warn ratelimit = 0 / 1h / strict
32053      log_message = Sender rate $sender_rate / $sender_rate_period
32054
32055 # Slow down fast senders; note the need to truncate $sender_rate
32056 # at the decimal point.
32057 warn ratelimit = 100 / 1h / per_rcpt / strict
32058      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
32059                    $sender_rate_limit }s
32060
32061 # Keep authenticated users under control
32062 deny authenticated = *
32063      ratelimit = 100 / 1d / strict / $authenticated_id
32064
32065 # System-wide rate limit
32066 defer message = Sorry, too busy. Try again later.
32067      ratelimit = 10 / 1s / $primary_hostname
32068
32069 # Restrict incoming rate from each host, with a default
32070 # set using a macro and special cases looked up in a table.
32071 defer message = Sender rate exceeds $sender_rate_limit \
32072                messages per $sender_rate_period
32073      ratelimit = ${lookup {$sender_host_address} \
32074                    cdb {DB/ratelimits.cdb} \
32075                    {$value} {RATELIMIT} }
32076 .endd
32077 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
32078 especially with the &%per_rcpt%& option, you may suffer from a performance
32079 bottleneck caused by locking on the ratelimit hints database. Apart from
32080 making your ACLs less complicated, you can reduce the problem by using a
32081 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
32082 this means that Exim will lose its hints data after a reboot (including retry
32083 hints, the callout cache, and ratelimit data).
32084
32085
32086
32087 .section "Address verification" "SECTaddressverification"
32088 .cindex "verifying address" "options for"
32089 .cindex "policy control" "address verification"
32090 Several of the &%verify%& conditions described in section
32091 &<<SECTaclconditions>>& cause addresses to be verified. Section
32092 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
32093 The verification conditions can be followed by options that modify the
32094 verification process. The options are separated from the keyword and from each
32095 other by slashes, and some of them contain parameters. For example:
32096 .code
32097 verify = sender/callout
32098 verify = recipient/defer_ok/callout=10s,defer_ok
32099 .endd
32100 The first stage of address verification, which always happens, is to run the
32101 address through the routers, in &"verify mode"&. Routers can detect the
32102 difference between verification and routing for delivery, and their actions can
32103 be varied by a number of generic options such as &%verify%& and &%verify_only%&
32104 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
32105 The available options are as follows:
32106
32107 .ilist
32108 If the &%callout%& option is specified, successful routing to one or more
32109 remote hosts is followed by a &"callout"& to those hosts as an additional
32110 check. Callouts and their sub-options are discussed in the next section.
32111 .next
32112 If there is a defer error while doing verification routing, the ACL
32113 normally returns &"defer"&. However, if you include &%defer_ok%& in the
32114 options, the condition is forced to be true instead. Note that this is a main
32115 verification option as well as a suboption for callouts.
32116 .next
32117 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
32118 discusses the reporting of sender address verification failures.
32119 .next
32120 The &%success_on_redirect%& option causes verification always to succeed
32121 immediately after a successful redirection. By default, if a redirection
32122 generates just one address, that address is also verified. See further
32123 discussion in section &<<SECTredirwhilveri>>&.
32124 .endlist
32125
32126 .cindex "verifying address" "differentiating failures"
32127 .vindex "&$recipient_verify_failure$&"
32128 .vindex "&$sender_verify_failure$&"
32129 .vindex "&$acl_verify_message$&"
32130 After an address verification failure, &$acl_verify_message$& contains the
32131 error message that is associated with the failure. It can be preserved by
32132 coding like this:
32133 .code
32134 warn  !verify = sender
32135        set acl_m0 = $acl_verify_message
32136 .endd
32137 If you are writing your own custom rejection message or log message when
32138 denying access, you can use this variable to include information about the
32139 verification failure.
32140
32141 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
32142 appropriate) contains one of the following words:
32143
32144 .ilist
32145 &%qualify%&: The address was unqualified (no domain), and the message
32146 was neither local nor came from an exempted host.
32147 .next
32148 &%route%&: Routing failed.
32149 .next
32150 &%mail%&: Routing succeeded, and a callout was attempted; rejection
32151 occurred at or before the MAIL command (that is, on initial
32152 connection, HELO, or MAIL).
32153 .next
32154 &%recipient%&: The RCPT command in a callout was rejected.
32155 .next
32156 &%postmaster%&: The postmaster check in a callout was rejected.
32157 .endlist
32158
32159 The main use of these variables is expected to be to distinguish between
32160 rejections of MAIL and rejections of RCPT in callouts.
32161
32162 The above variables may also be set after a &*successful*&
32163 address verification to:
32164
32165 .ilist
32166 &%random%&: A random local-part callout succeeded
32167 .endlist
32168
32169
32170
32171
32172 .section "Callout verification" "SECTcallver"
32173 .cindex "verifying address" "by callout"
32174 .cindex "callout" "verification"
32175 .cindex "SMTP" "callout verification"
32176 For non-local addresses, routing verifies the domain, but is unable to do any
32177 checking of the local part. There are situations where some means of verifying
32178 the local part is desirable. One way this can be done is to make an SMTP
32179 &'callback'& to a delivery host for the sender address or a &'callforward'& to
32180 a subsequent host for a recipient address, to see if the host accepts the
32181 address. We use the term &'callout'& to cover both cases. Note that for a
32182 sender address, the callback is not to the client host that is trying to
32183 deliver the message, but to one of the hosts that accepts incoming mail for the
32184 sender's domain.
32185
32186 Exim does not do callouts by default. If you want them to happen, you must
32187 request them by setting appropriate options on the &%verify%& condition, as
32188 described below. This facility should be used with care, because it can add a
32189 lot of resource usage to the cost of verifying an address. However, Exim does
32190 cache the results of callouts, which helps to reduce the cost. Details of
32191 caching are in section &<<SECTcallvercache>>&.
32192
32193 Recipient callouts are usually used only between hosts that are controlled by
32194 the same administration. For example, a corporate gateway host could use
32195 callouts to check for valid recipients on an internal mailserver. A successful
32196 callout does not guarantee that a real delivery to the address would succeed;
32197 on the other hand, a failing callout does guarantee that a delivery would fail.
32198
32199 If the &%callout%& option is present on a condition that verifies an address, a
32200 second stage of verification occurs if the address is successfully routed to
32201 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
32202 &(manualroute)& router, where the router specifies the hosts. However, if a
32203 router that does not set up hosts routes to an &(smtp)& transport with a
32204 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
32205 &%hosts_override%& set, its hosts are always used, whether or not the router
32206 supplies a host list.
32207 Callouts are only supported on &(smtp)& transports.
32208
32209 The port that is used is taken from the transport, if it is specified and is a
32210 remote transport. (For routers that do verification only, no transport need be
32211 specified.) Otherwise, the default SMTP port is used. If a remote transport
32212 specifies an outgoing interface, this is used; otherwise the interface is not
32213 specified. Likewise, the text that is used for the HELO command is taken from
32214 the transport's &%helo_data%& option; if there is no transport, the value of
32215 &$smtp_active_hostname$& is used.
32216
32217 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
32218 test whether a bounce message could be delivered to the sender address. The
32219 following SMTP commands are sent:
32220 .display
32221 &`HELO `&<&'local host name'&>
32222 &`MAIL FROM:<>`&
32223 &`RCPT TO:`&<&'the address to be tested'&>
32224 &`QUIT`&
32225 .endd
32226 LHLO is used instead of HELO if the transport's &%protocol%& option is
32227 set to &"lmtp"&.
32228
32229 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
32230 settings.
32231
32232 A recipient callout check is similar. By default, it also uses an empty address
32233 for the sender. This default is chosen because most hosts do not make use of
32234 the sender address when verifying a recipient. Using the same address means
32235 that a single cache entry can be used for each recipient. Some sites, however,
32236 do make use of the sender address when verifying. These are catered for by the
32237 &%use_sender%& and &%use_postmaster%& options, described in the next section.
32238
32239 If the response to the RCPT command is a 2&'xx'& code, the verification
32240 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
32241 Exim tries the next host, if any. If there is a problem with all the remote
32242 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
32243 &%callout%& option is given, in which case the condition is forced to succeed.
32244
32245 .cindex "SMTP" "output flushing, disabling for callout"
32246 A callout may take a little time. For this reason, Exim normally flushes SMTP
32247 output before performing a callout in an ACL, to avoid unexpected timeouts in
32248 clients when the SMTP PIPELINING extension is in use. The flushing can be
32249 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
32250
32251
32252
32253
32254 .section "Additional parameters for callouts" "CALLaddparcall"
32255 .cindex "callout" "additional parameters for"
32256 The &%callout%& option can be followed by an equals sign and a number of
32257 optional parameters, separated by commas. For example:
32258 .code
32259 verify = recipient/callout=10s,defer_ok
32260 .endd
32261 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
32262 separate verify options, is retained for backwards compatibility, but is now
32263 deprecated. The additional parameters for &%callout%& are as follows:
32264
32265
32266 .vlist
32267 .vitem <&'a&~time&~interval'&>
32268 .cindex "callout" "timeout, specifying"
32269 This specifies the timeout that applies for the callout attempt to each host.
32270 For example:
32271 .code
32272 verify = sender/callout=5s
32273 .endd
32274 The default is 30 seconds. The timeout is used for each response from the
32275 remote host. It is also used for the initial connection, unless overridden by
32276 the &%connect%& parameter.
32277
32278
32279 .vitem &*connect&~=&~*&<&'time&~interval'&>
32280 .cindex "callout" "connection timeout, specifying"
32281 This parameter makes it possible to set a different (usually smaller) timeout
32282 for making the SMTP connection. For example:
32283 .code
32284 verify = sender/callout=5s,connect=1s
32285 .endd
32286 If not specified, this timeout defaults to the general timeout value.
32287
32288 .vitem &*defer_ok*&
32289 .cindex "callout" "defer, action on"
32290 When this parameter is present, failure to contact any host, or any other kind
32291 of temporary error, is treated as success by the ACL. However, the cache is not
32292 updated in this circumstance.
32293
32294 .vitem &*fullpostmaster*&
32295 .cindex "callout" "full postmaster check"
32296 This operates like the &%postmaster%& option (see below), but if the check for
32297 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
32298 accordance with the specification in RFC 2821. The RFC states that the
32299 unqualified address &'postmaster'& should be accepted.
32300
32301
32302 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
32303 .cindex "callout" "sender when verifying header"
32304 When verifying addresses in header lines using the &%header_sender%&
32305 verification option, Exim behaves by default as if the addresses are envelope
32306 sender addresses from a message. Callout verification therefore tests to see
32307 whether a bounce message could be delivered, by using an empty address in the
32308 MAIL command. However, it is arguable that these addresses might never be used
32309 as envelope senders, and could therefore justifiably reject bounce messages
32310 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
32311 address to use in the MAIL command. For example:
32312 .code
32313 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
32314 .endd
32315 This parameter is available only for the &%header_sender%& verification option.
32316
32317
32318 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
32319 .cindex "callout" "overall timeout, specifying"
32320 This parameter sets an overall timeout for performing a callout verification.
32321 For example:
32322 .code
32323 verify = sender/callout=5s,maxwait=30s
32324 .endd
32325 This timeout defaults to four times the callout timeout for individual SMTP
32326 commands. The overall timeout applies when there is more than one host that can
32327 be tried. The timeout is checked before trying the next host. This prevents
32328 very long delays if there are a large number of hosts and all are timing out
32329 (for example, when network connections are timing out).
32330
32331
32332 .vitem &*no_cache*&
32333 .cindex "callout" "cache, suppressing"
32334 .cindex "caching callout, suppressing"
32335 When this parameter is given, the callout cache is neither read nor updated.
32336
32337 .vitem &*postmaster*&
32338 .cindex "callout" "postmaster; checking"
32339 When this parameter is set, a successful callout check is followed by a similar
32340 check for the local part &'postmaster'& at the same domain. If this address is
32341 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
32342 the postmaster check is recorded in a cache record; if it is a failure, this is
32343 used to fail subsequent callouts for the domain without a connection being
32344 made, until the cache record expires.
32345
32346 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
32347 The postmaster check uses an empty sender in the MAIL command by default.
32348 You can use this parameter to do a postmaster check using a different address.
32349 For example:
32350 .code
32351 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
32352 .endd
32353 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
32354 one overrides. The &%postmaster%& parameter is equivalent to this example:
32355 .code
32356 require  verify = sender/callout=postmaster_mailfrom=
32357 .endd
32358 &*Warning*&: The caching arrangements for postmaster checking do not take
32359 account of the sender address. It is assumed that either the empty address or
32360 a fixed non-empty address will be used. All that Exim remembers is that the
32361 postmaster check for the domain succeeded or failed.
32362
32363
32364 .vitem &*random*&
32365 .cindex "callout" "&""random""& check"
32366 When this parameter is set, before doing the normal callout check, Exim does a
32367 check for a &"random"& local part at the same domain. The local part is not
32368 really random &-- it is defined by the expansion of the option
32369 &%callout_random_local_part%&, which defaults to
32370 .code
32371 $primary_hostname-$tod_epoch-testing
32372 .endd
32373 The idea here is to try to determine whether the remote host accepts all local
32374 parts without checking. If it does, there is no point in doing callouts for
32375 specific local parts. If the &"random"& check succeeds, the result is saved in
32376 a cache record, and used to force the current and subsequent callout checks to
32377 succeed without a connection being made, until the cache record expires.
32378
32379 .vitem &*use_postmaster*&
32380 .cindex "callout" "sender for recipient check"
32381 This parameter applies to recipient callouts only. For example:
32382 .code
32383 deny  !verify = recipient/callout=use_postmaster
32384 .endd
32385 .vindex "&$qualify_domain$&"
32386 It causes a non-empty postmaster address to be used in the MAIL command when
32387 performing the callout for the recipient, and also for a &"random"& check if
32388 that is configured. The local part of the address is &`postmaster`& and the
32389 domain is the contents of &$qualify_domain$&.
32390
32391 .vitem &*use_sender*&
32392 This option applies to recipient callouts only. For example:
32393 .code
32394 require  verify = recipient/callout=use_sender
32395 .endd
32396 It causes the message's actual sender address to be used in the MAIL
32397 command when performing the callout, instead of an empty address. There is no
32398 need to use this option unless you know that the called hosts make use of the
32399 sender when checking recipients. If used indiscriminately, it reduces the
32400 usefulness of callout caching.
32401
32402 .vitem &*hold*&
32403 This option applies to recipient callouts only. For example:
32404 .code
32405 require  verify = recipient/callout=use_sender,hold
32406 .endd
32407 It causes the connection to be held open and used for any further recipients
32408 and for eventual delivery (should that be done quickly).
32409 Doing this saves on TCP and SMTP startup costs, and TLS costs also
32410 when that is used for the connections.
32411 The advantage is only gained if there are no callout cache hits
32412 (which could be enforced by the no_cache option),
32413 if the use_sender option is used,
32414 if neither the random nor the use_postmaster option is used,
32415 and if no other callouts intervene.
32416 .endlist
32417
32418 If you use any of the parameters that set a non-empty sender for the MAIL
32419 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
32420 &%use_sender%&), you should think about possible loops. Recipient checking is
32421 usually done between two hosts that are under the same management, and the host
32422 that receives the callouts is not normally configured to do callouts itself.
32423 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
32424 these circumstances.
32425
32426 However, if you use a non-empty sender address for a callout to an arbitrary
32427 host, there is the likelihood that the remote host will itself initiate a
32428 callout check back to your host. As it is checking what appears to be a message
32429 sender, it is likely to use an empty address in MAIL, thus avoiding a
32430 callout loop. However, to be on the safe side it would be best to set up your
32431 own ACLs so that they do not do sender verification checks when the recipient
32432 is the address you use for header sender or postmaster callout checking.
32433
32434 Another issue to think about when using non-empty senders for callouts is
32435 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
32436 by the sender/recipient combination; thus, for any given recipient, many more
32437 actual callouts are performed than when an empty sender or postmaster is used.
32438
32439
32440
32441
32442 .section "Callout caching" "SECTcallvercache"
32443 .cindex "hints database" "callout cache"
32444 .cindex "callout" "cache, description of"
32445 .cindex "caching" "callout"
32446 Exim caches the results of callouts in order to reduce the amount of resources
32447 used, unless you specify the &%no_cache%& parameter with the &%callout%&
32448 option. A hints database called &"callout"& is used for the cache. Two
32449 different record types are used: one records the result of a callout check for
32450 a specific address, and the other records information that applies to the
32451 entire domain (for example, that it accepts the local part &'postmaster'&).
32452
32453 When an original callout fails, a detailed SMTP error message is given about
32454 the failure. However, for subsequent failures use the cache data, this message
32455 is not available.
32456
32457 The expiry times for negative and positive address cache records are
32458 independent, and can be set by the global options &%callout_negative_expire%&
32459 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
32460
32461 If a host gives a negative response to an SMTP connection, or rejects any
32462 commands up to and including
32463 .code
32464 MAIL FROM:<>
32465 .endd
32466 (but not including the MAIL command with a non-empty address),
32467 any callout attempt is bound to fail. Exim remembers such failures in a
32468 domain cache record, which it uses to fail callouts for the domain without
32469 making new connections, until the domain record times out. There are two
32470 separate expiry times for domain cache records:
32471 &%callout_domain_negative_expire%& (default 3h) and
32472 &%callout_domain_positive_expire%& (default 7d).
32473
32474 Domain records expire when the negative expiry time is reached if callouts
32475 cannot be made for the domain, or if the postmaster check failed.
32476 Otherwise, they expire when the positive expiry time is reached. This
32477 ensures that, for example, a host that stops accepting &"random"& local parts
32478 will eventually be noticed.
32479
32480 The callout caching mechanism is based on the domain of the address that is
32481 being tested. If the domain routes to several hosts, it is assumed that their
32482 behaviour will be the same.
32483
32484
32485
32486 .section "Sender address verification reporting" "SECTsenaddver"
32487 .cindex "verifying" "suppressing error details"
32488 See section &<<SECTaddressverification>>& for a general discussion of
32489 verification. When sender verification fails in an ACL, the details of the
32490 failure are given as additional output lines before the 550 response to the
32491 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
32492 you might see:
32493 .code
32494 MAIL FROM:<xyz@abc.example>
32495 250 OK
32496 RCPT TO:<pqr@def.example>
32497 550-Verification failed for <xyz@abc.example>
32498 550-Called:   192.168.34.43
32499 550-Sent:     RCPT TO:<xyz@abc.example>
32500 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
32501 550 Sender verification failed
32502 .endd
32503 If more than one RCPT command fails in the same way, the details are given
32504 only for the first of them. However, some administrators do not want to send
32505 out this much information. You can suppress the details by adding
32506 &`/no_details`& to the ACL statement that requests sender verification. For
32507 example:
32508 .code
32509 verify = sender/no_details
32510 .endd
32511
32512 .section "Redirection while verifying" "SECTredirwhilveri"
32513 .cindex "verifying" "redirection while"
32514 .cindex "address redirection" "while verifying"
32515 A dilemma arises when a local address is redirected by aliasing or forwarding
32516 during verification: should the generated addresses themselves be verified,
32517 or should the successful expansion of the original address be enough to verify
32518 it? By default, Exim takes the following pragmatic approach:
32519
32520 .ilist
32521 When an incoming address is redirected to just one child address, verification
32522 continues with the child address, and if that fails to verify, the original
32523 verification also fails.
32524 .next
32525 When an incoming address is redirected to more than one child address,
32526 verification does not continue. A success result is returned.
32527 .endlist
32528
32529 This seems the most reasonable behaviour for the common use of aliasing as a
32530 way of redirecting different local parts to the same mailbox. It means, for
32531 example, that a pair of alias entries of the form
32532 .code
32533 A.Wol:   aw123
32534 aw123:   :fail: Gone away, no forwarding address
32535 .endd
32536 work as expected, with both local parts causing verification failure. When a
32537 redirection generates more than one address, the behaviour is more like a
32538 mailing list, where the existence of the alias itself is sufficient for
32539 verification to succeed.
32540
32541 It is possible, however, to change the default behaviour so that all successful
32542 redirections count as successful verifications, however many new addresses are
32543 generated. This is specified by the &%success_on_redirect%& verification
32544 option. For example:
32545 .code
32546 require verify = recipient/success_on_redirect/callout=10s
32547 .endd
32548 In this example, verification succeeds if a router generates a new address, and
32549 the callout does not occur, because no address was routed to a remote host.
32550
32551 When verification is being tested via the &%-bv%& option, the treatment of
32552 redirections is as just described, unless the &%-v%& or any debugging option is
32553 also specified. In that case, full verification is done for every generated
32554 address and a report is output for each of them.
32555
32556
32557
32558 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
32559 .cindex "CSA" "verifying"
32560 Client SMTP Authorization is a system that allows a site to advertise
32561 which machines are and are not permitted to send email. This is done by placing
32562 special SRV records in the DNS; these are looked up using the client's HELO
32563 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
32564 Authorization checks in Exim are performed by the ACL condition:
32565 .code
32566 verify = csa
32567 .endd
32568 This fails if the client is not authorized. If there is a DNS problem, or if no
32569 valid CSA SRV record is found, or if the client is authorized, the condition
32570 succeeds. These three cases can be distinguished using the expansion variable
32571 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
32572 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
32573 be likely to cause problems for legitimate email.
32574
32575 The error messages produced by the CSA code include slightly more
32576 detail. If &$csa_status$& is &"defer"&, this may be because of problems
32577 looking up the CSA SRV record, or problems looking up the CSA target
32578 address record. There are four reasons for &$csa_status$& being &"fail"&:
32579
32580 .ilist
32581 The client's host name is explicitly not authorized.
32582 .next
32583 The client's IP address does not match any of the CSA target IP addresses.
32584 .next
32585 The client's host name is authorized but it has no valid target IP addresses
32586 (for example, the target's addresses are IPv6 and the client is using IPv4).
32587 .next
32588 The client's host name has no CSA SRV record but a parent domain has asserted
32589 that all subdomains must be explicitly authorized.
32590 .endlist
32591
32592 The &%csa%& verification condition can take an argument which is the domain to
32593 use for the DNS query. The default is:
32594 .code
32595 verify = csa/$sender_helo_name
32596 .endd
32597 This implementation includes an extension to CSA. If the query domain
32598 is an address literal such as [192.0.2.95], or if it is a bare IP
32599 address, Exim searches for CSA SRV records in the reverse DNS as if
32600 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
32601 meaningful to say:
32602 .code
32603 verify = csa/$sender_host_address
32604 .endd
32605 In fact, this is the check that Exim performs if the client does not say HELO.
32606 This extension can be turned off by setting the main configuration option
32607 &%dns_csa_use_reverse%& to be false.
32608
32609 If a CSA SRV record is not found for the domain itself, a search
32610 is performed through its parent domains for a record which might be
32611 making assertions about subdomains. The maximum depth of this search is limited
32612 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
32613 default. Exim does not look for CSA SRV records in a top level domain, so the
32614 default settings handle HELO domains as long as seven
32615 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
32616 of legitimate HELO domains.
32617
32618 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
32619 direct SRV lookups, this is not sufficient because of the extra parent domain
32620 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
32621 addresses into lookups in the reverse DNS space. The result of a successful
32622 lookup such as:
32623 .code
32624 ${lookup dnsdb {csa=$sender_helo_name}}
32625 .endd
32626 has two space-separated fields: an authorization code and a target host name.
32627 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
32628 authorization required but absent, or &"?"& for unknown.
32629
32630
32631
32632
32633 .section "Bounce address tag validation" "SECTverifyPRVS"
32634 .cindex "BATV, verifying"
32635 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
32636 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
32637 Genuine incoming bounce messages should therefore always be addressed to
32638 recipients that have a valid tag. This scheme is a way of detecting unwanted
32639 bounce messages caused by sender address forgeries (often called &"collateral
32640 spam"&), because the recipients of such messages do not include valid tags.
32641
32642 There are two expansion items to help with the implementation of the BATV
32643 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
32644 the original envelope sender address by using a simple key to add a hash of the
32645 address and some time-based randomizing information. The &%prvs%& expansion
32646 item creates a signed address, and the &%prvscheck%& expansion item checks one.
32647 The syntax of these expansion items is described in section
32648 &<<SECTexpansionitems>>&.
32649 The validity period on signed addresses is seven days.
32650
32651 As an example, suppose the secret per-address keys are stored in an MySQL
32652 database. A query to look up the key for an address could be defined as a macro
32653 like this:
32654 .code
32655 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
32656                 WHERE sender='${quote_mysql:$prvscheck_address}'\
32657                 }{$value}}
32658 .endd
32659 Suppose also that the senders who make use of BATV are defined by an address
32660 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
32661 use this:
32662 .code
32663 # Bounces: drop unsigned addresses for BATV senders
32664 deny message = This address does not send an unsigned reverse path
32665      senders = :
32666      recipients = +batv_senders
32667
32668 # Bounces: In case of prvs-signed address, check signature.
32669 deny message = Invalid reverse path signature.
32670      senders = :
32671      condition  = ${prvscheck {$local_part@$domain}\
32672                   {PRVSCHECK_SQL}{1}}
32673      !condition = $prvscheck_result
32674 .endd
32675 The first statement rejects recipients for bounce messages that are addressed
32676 to plain BATV sender addresses, because it is known that BATV senders do not
32677 send out messages with plain sender addresses. The second statement rejects
32678 recipients that are prvs-signed, but with invalid signatures (either because
32679 the key is wrong, or the signature has timed out).
32680
32681 A non-prvs-signed address is not rejected by the second statement, because the
32682 &%prvscheck%& expansion yields an empty string if its first argument is not a
32683 prvs-signed address, thus causing the &%condition%& condition to be false. If
32684 the first argument is a syntactically valid prvs-signed address, the yield is
32685 the third string (in this case &"1"&), whether or not the cryptographic and
32686 timeout checks succeed. The &$prvscheck_result$& variable contains the result
32687 of the checks (empty for failure, &"1"& for success).
32688
32689 There is one more issue you must consider when implementing prvs-signing:
32690 you have to ensure that the routers accept prvs-signed addresses and
32691 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
32692 router to remove the signature with a configuration along these lines:
32693 .code
32694 batv_redirect:
32695   driver = redirect
32696   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
32697 .endd
32698 This works because, if the third argument of &%prvscheck%& is empty, the result
32699 of the expansion of a prvs-signed address is the decoded value of the original
32700 address. This router should probably be the first of your routers that handles
32701 local addresses.
32702
32703 To create BATV-signed addresses in the first place, a transport of this form
32704 can be used:
32705 .code
32706 external_smtp_batv:
32707   driver = smtp
32708   return_path = ${prvs {$return_path} \
32709                        {${lookup mysql{SELECT \
32710                        secret FROM batv_prvs WHERE \
32711                        sender='${quote_mysql:$sender_address}'} \
32712                        {$value}fail}}}
32713 .endd
32714 If no key can be found for the existing return path, no signing takes place.
32715
32716
32717
32718 .section "Using an ACL to control relaying" "SECTrelaycontrol"
32719 .cindex "&ACL;" "relay control"
32720 .cindex "relaying" "control by ACL"
32721 .cindex "policy control" "relay control"
32722 An MTA is said to &'relay'& a message if it receives it from some host and
32723 delivers it directly to another host as a result of a remote address contained
32724 within it. Redirecting a local address via an alias or forward file and then
32725 passing the message on to another host is not relaying,
32726 .cindex "&""percent hack""&"
32727 but a redirection as a result of the &"percent hack"& is.
32728
32729 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
32730 A host which is acting as a gateway or an MX backup is concerned with incoming
32731 relaying from arbitrary hosts to a specific set of domains. On the other hand,
32732 a host which is acting as a smart host for a number of clients is concerned
32733 with outgoing relaying from those clients to the Internet at large. Often the
32734 same host is fulfilling both functions,
32735 . ///
32736 . as illustrated in the diagram below,
32737 . ///
32738 but in principle these two kinds of relaying are entirely independent. What is
32739 not wanted is the transmission of mail from arbitrary remote hosts through your
32740 system to arbitrary domains.
32741
32742
32743 You can implement relay control by means of suitable statements in the ACL that
32744 runs for each RCPT command. For convenience, it is often easiest to use
32745 Exim's named list facility to define the domains and hosts involved. For
32746 example, suppose you want to do the following:
32747
32748 .ilist
32749 Deliver a number of domains to mailboxes on the local host (or process them
32750 locally in some other way). Let's say these are &'my.dom1.example'& and
32751 &'my.dom2.example'&.
32752 .next
32753 Relay mail for a number of other domains for which you are the secondary MX.
32754 These might be &'friend1.example'& and &'friend2.example'&.
32755 .next
32756 Relay mail from the hosts on your local LAN, to whatever domains are involved.
32757 Suppose your LAN is 192.168.45.0/24.
32758 .endlist
32759
32760
32761 In the main part of the configuration, you put the following definitions:
32762 .code
32763 domainlist local_domains    = my.dom1.example : my.dom2.example
32764 domainlist relay_to_domains = friend1.example : friend2.example
32765 hostlist   relay_from_hosts = 192.168.45.0/24
32766 .endd
32767 Now you can use these definitions in the ACL that is run for every RCPT
32768 command:
32769 .code
32770 acl_check_rcpt:
32771   accept domains = +local_domains : +relay_to_domains
32772   accept hosts   = +relay_from_hosts
32773 .endd
32774 The first statement accepts any RCPT command that contains an address in
32775 the local or relay domains. For any other domain, control passes to the second
32776 statement, which accepts the command only if it comes from one of the relay
32777 hosts. In practice, you will probably want to make your ACL more sophisticated
32778 than this, for example, by including sender and recipient verification. The
32779 default configuration includes a more comprehensive example, which is described
32780 in chapter &<<CHAPdefconfil>>&.
32781
32782
32783
32784 .section "Checking a relay configuration" "SECTcheralcon"
32785 .cindex "relaying" "checking control of"
32786 You can check the relay characteristics of your configuration in the same way
32787 that you can test any ACL behaviour for an incoming SMTP connection, by using
32788 the &%-bh%& option to run a fake SMTP session with which you interact.
32789 .ecindex IIDacl
32790
32791
32792
32793 . ////////////////////////////////////////////////////////////////////////////
32794 . ////////////////////////////////////////////////////////////////////////////
32795
32796 .chapter "Content scanning at ACL time" "CHAPexiscan"
32797 .scindex IIDcosca "content scanning" "at ACL time"
32798 The extension of Exim to include content scanning at ACL time, formerly known
32799 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
32800 was integrated into the main source for Exim release 4.50, and Tom continues to
32801 maintain it. Most of the wording of this chapter is taken from Tom's
32802 specification.
32803
32804 It is also possible to scan the content of messages at other times. The
32805 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
32806 scanning after all the ACLs have run. A transport filter can be used to scan
32807 messages at delivery time (see the &%transport_filter%& option, described in
32808 chapter &<<CHAPtransportgeneric>>&).
32809
32810 If you want to include the ACL-time content-scanning features when you compile
32811 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
32812 &_Local/Makefile_&. When you do that, the Exim binary is built with:
32813
32814 .ilist
32815 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
32816 for all MIME parts for SMTP and non-SMTP messages, respectively.
32817 .next
32818 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
32819 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
32820 run at the end of message reception (the &%acl_smtp_data%& ACL).
32821 .next
32822 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
32823 of messages, or parts of messages, for debugging purposes.
32824 .next
32825 Additional expansion variables that are set in the new ACL and by the new
32826 conditions.
32827 .next
32828 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
32829 .endlist
32830
32831 Content-scanning is continually evolving, and new features are still being
32832 added. While such features are still unstable and liable to incompatible
32833 changes, they are made available in Exim by setting options whose names begin
32834 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
32835 this manual. You can find out about them by reading the file called
32836 &_doc/experimental.txt_&.
32837
32838 All the content-scanning facilities work on a MBOX copy of the message that is
32839 temporarily created in a file called:
32840 .display
32841 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
32842 .endd
32843 The &_.eml_& extension is a friendly hint to virus scanners that they can
32844 expect an MBOX-like structure inside that file. The file is created when the
32845 first content scanning facility is called. Subsequent calls to content
32846 scanning conditions open the same file again. The directory is recursively
32847 removed when the &%acl_smtp_data%& ACL has finished running, unless
32848 .code
32849 control = no_mbox_unspool
32850 .endd
32851 has been encountered. When the MIME ACL decodes files, they are put into the
32852 same directory by default.
32853
32854
32855
32856 .section "Scanning for viruses" "SECTscanvirus"
32857 .cindex "virus scanning"
32858 .cindex "content scanning" "for viruses"
32859 .cindex "content scanning" "the &%malware%& condition"
32860 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
32861 It supports a &"generic"& interface to scanners called via the shell, and
32862 specialized interfaces for &"daemon"& type virus scanners, which are resident
32863 in memory and thus are much faster.
32864
32865 Since message data needs to have arrived,
32866 the condition may be only called in ACL defined by
32867 &%acl_smtp_data%&,
32868 &%acl_smtp_data_prdr%&,
32869 &%acl_smtp_mime%& or
32870 &%acl_smtp_dkim%&
32871
32872 A timeout of 2 minutes is applied to a scanner call (by default);
32873 if it expires then a defer action is taken.
32874
32875 .oindex "&%av_scanner%&"
32876 You can set the &%av_scanner%& option in the main part of the configuration
32877 to specify which scanner to use, together with any additional options that
32878 are needed. The basic syntax is as follows:
32879 .display
32880 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
32881 .endd
32882 If you do not set &%av_scanner%&, it defaults to
32883 .code
32884 av_scanner = sophie:/var/run/sophie
32885 .endd
32886 If the value of &%av_scanner%& starts with a dollar character, it is expanded
32887 before use.
32888 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
32889 The following scanner types are supported in this release,
32890 though individual ones can be included or not at build time:
32891
32892 .vlist
32893 .vitem &%avast%&
32894 .cindex "virus scanners" "avast"
32895 This is the scanner daemon of Avast. It has been tested with Avast Core
32896 Security (currently at version 2.2.0).
32897 You can get a trial version at &url(https://www.avast.com) or for Linux
32898 at &url(https://www.avast.com/linux-server-antivirus).
32899 This scanner type takes one option,
32900 which can be either a full path to a UNIX socket,
32901 or host and port specifiers separated by white space.
32902 The host may be a name or an IP address; the port is either a
32903 single number or a pair of numbers with a dash between.
32904 A list of options may follow. These options are interpreted on the
32905 Exim's side of the malware scanner, or are given on separate lines to
32906 the daemon as options before the main scan command.
32907
32908 .cindex &`pass_unscanned`& "avast"
32909 If &`pass_unscanned`&
32910 is set, any files the Avast scanner can't scan (e.g.
32911 decompression bombs, or invalid archives) are considered clean. Use with
32912 care.
32913
32914 For example:
32915 .code
32916 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
32917 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
32918 av_scanner = avast:192.168.2.22 5036
32919 .endd
32920 If you omit the argument, the default path
32921 &_/var/run/avast/scan.sock_&
32922 is used.
32923 If you use a remote host,
32924 you need to make Exim's spool directory available to it,
32925 as the scanner is passed a file path, not file contents.
32926 For information about available commands and their options you may use
32927 .code
32928 $ socat UNIX:/var/run/avast/scan.sock STDIO:
32929     FLAGS
32930     SENSITIVITY
32931     PACK
32932 .endd
32933
32934 If the scanner returns a temporary failure (e.g. license issues, or
32935 permission problems), the message is deferred and a paniclog entry is
32936 written.  The usual &`defer_ok`& option is available.
32937
32938 .vitem &%aveserver%&
32939 .cindex "virus scanners" "Kaspersky"
32940 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
32941 at &url(https://www.kaspersky.com/). This scanner type takes one option,
32942 which is the path to the daemon's UNIX socket. The default is shown in this
32943 example:
32944 .code
32945 av_scanner = aveserver:/var/run/aveserver
32946 .endd
32947
32948
32949 .vitem &%clamd%&
32950 .cindex "virus scanners" "clamd"
32951 This daemon-type scanner is GPL and free. You can get it at
32952 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
32953 unpack MIME containers, so it used to be recommended to unpack MIME attachments
32954 in the MIME ACL. This is no longer believed to be necessary.
32955
32956 The options are a list of server specifiers, which may be
32957 a UNIX socket specification,
32958 a TCP socket specification,
32959 or a (global) option.
32960
32961 A socket specification consists of a space-separated list.
32962 For a Unix socket the first element is a full path for the socket,
32963 for a TCP socket the first element is the IP address
32964 and the second a port number,
32965 Any further elements are per-server (non-global) options.
32966 These per-server options are supported:
32967 .code
32968 retry=<timespec>        Retry on connect fail
32969 .endd
32970
32971 The &`retry`& option specifies a time after which a single retry for
32972 a failed connect is made.  The default is to not retry.
32973
32974 If a Unix socket file is specified, only one server is supported.
32975
32976 Examples:
32977 .code
32978 av_scanner = clamd:/opt/clamd/socket
32979 av_scanner = clamd:192.0.2.3 1234
32980 av_scanner = clamd:192.0.2.3 1234:local
32981 av_scanner = clamd:192.0.2.3 1234 retry=10s
32982 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
32983 .endd
32984 If the value of av_scanner points to a UNIX socket file or contains the
32985 &`local`&
32986 option, then the ClamAV interface will pass a filename containing the data
32987 to be scanned, which should normally result in less I/O happening and be
32988 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
32989 Exim does not assume that there is a common filesystem with the remote host.
32990
32991 The final example shows that multiple TCP targets can be specified.  Exim will
32992 randomly use one for each incoming email (i.e. it load balances them).  Note
32993 that only TCP targets may be used if specifying a list of scanners; a UNIX
32994 socket cannot be mixed in with TCP targets.  If one of the servers becomes
32995 unavailable, Exim will try the remaining one(s) until it finds one that works.
32996 When a clamd server becomes unreachable, Exim will log a message.  Exim does
32997 not keep track of scanner state between multiple messages, and the scanner
32998 selection is random, so the message will get logged in the mainlog for each
32999 email that the down scanner gets chosen first (message wrapped to be readable):
33000 .code
33001 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
33002    clamd: connection to localhost, port 3310 failed
33003    (Connection refused)
33004 .endd
33005
33006 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
33007 contributing the code for this scanner.
33008
33009 .vitem &%cmdline%&
33010 .cindex "virus scanners" "command line interface"
33011 This is the keyword for the generic command line scanner interface. It can be
33012 used to attach virus scanners that are invoked from the shell. This scanner
33013 type takes 3 mandatory options:
33014
33015 .olist
33016 The full path and name of the scanner binary, with all command line options,
33017 and a placeholder (&`%s`&) for the directory to scan.
33018
33019 .next
33020 A regular expression to match against the STDOUT and STDERR output of the
33021 virus scanner. If the expression matches, a virus was found. You must make
33022 absolutely sure that this expression matches on &"virus found"&. This is called
33023 the &"trigger"& expression.
33024
33025 .next
33026 Another regular expression, containing exactly one pair of parentheses, to
33027 match the name of the virus found in the scanners output. This is called the
33028 &"name"& expression.
33029 .endlist olist
33030
33031 For example, Sophos Sweep reports a virus on a line like this:
33032 .code
33033 Virus 'W32/Magistr-B' found in file ./those.bat
33034 .endd
33035 For the trigger expression, we can match the phrase &"found in file"&. For the
33036 name expression, we want to extract the W32/Magistr-B string, so we can match
33037 for the single quotes left and right of it. Altogether, this makes the
33038 configuration setting:
33039 .code
33040 av_scanner = cmdline:\
33041              /path/to/sweep -ss -all -rec -archive %s:\
33042              found in file:'(.+)'
33043 .endd
33044 .vitem &%drweb%&
33045 .cindex "virus scanners" "DrWeb"
33046 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
33047 takes one option,
33048 either a full path to a UNIX socket,
33049 or host and port specifiers separated by white space.
33050 The host may be a name or an IP address; the port is either a
33051 single number or a pair of numbers with a dash between.
33052 For example:
33053 .code
33054 av_scanner = drweb:/var/run/drwebd.sock
33055 av_scanner = drweb:192.168.2.20 31337
33056 .endd
33057 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
33058 is used. Thanks to Alex Miller for contributing the code for this scanner.
33059
33060 .vitem &%f-protd%&
33061 .cindex "virus scanners" "f-protd"
33062 The f-protd scanner is accessed via HTTP over TCP.
33063 One argument is taken, being a space-separated hostname and port number
33064 (or port-range).
33065 For example:
33066 .code
33067 av_scanner = f-protd:localhost 10200-10204
33068 .endd
33069 If you omit the argument, the default values shown above are used.
33070
33071 .vitem &%f-prot6d%&
33072 .cindex "virus scanners" "f-prot6d"
33073 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
33074 One argument is taken, being a space-separated hostname and port number.
33075 For example:
33076 .code
33077 av_scanner = f-prot6d:localhost 10200
33078 .endd
33079 If you omit the argument, the default values show above are used.
33080
33081 .vitem &%fsecure%&
33082 .cindex "virus scanners" "F-Secure"
33083 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
33084 argument which is the path to a UNIX socket. For example:
33085 .code
33086 av_scanner = fsecure:/path/to/.fsav
33087 .endd
33088 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
33089 Thelmen for contributing the code for this scanner.
33090
33091 .vitem &%kavdaemon%&
33092 .cindex "virus scanners" "Kaspersky"
33093 This is the scanner daemon of Kaspersky Version 4. This version of the
33094 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
33095 scanner type takes one option, which is the path to the daemon's UNIX socket.
33096 For example:
33097 .code
33098 av_scanner = kavdaemon:/opt/AVP/AvpCtl
33099 .endd
33100 The default path is &_/var/run/AvpCtl_&.
33101
33102 .vitem &%mksd%&
33103 .cindex "virus scanners" "mksd"
33104 This was a daemon type scanner that is aimed mainly at Polish users,
33105 though some documentation was available in English.
33106 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
33107 and this appears to be a candidate for removal from Exim, unless
33108 we are informed of other virus scanners which use the same protocol
33109 to integrate.
33110 The only option for this scanner type is
33111 the maximum number of processes used simultaneously to scan the attachments,
33112 provided that mksd has
33113 been run with at least the same number of child processes. For example:
33114 .code
33115 av_scanner = mksd:2
33116 .endd
33117 You can safely omit this option (the default value is 1).
33118
33119 .vitem &%sock%&
33120 .cindex "virus scanners" "simple socket-connected"
33121 This is a general-purpose way of talking to simple scanner daemons
33122 running on the local machine.
33123 There are four options:
33124 an address (which may be an IP address and port, or the path of a Unix socket),
33125 a commandline to send (may include a single %s which will be replaced with
33126 the path to the mail file to be scanned),
33127 an RE to trigger on from the returned data,
33128 and an RE to extract malware_name from the returned data.
33129 For example:
33130 .code
33131 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
33132 .endd
33133 Note that surrounding whitespace is stripped from each option, meaning
33134 there is no way to specify a trailing newline.
33135 The socket specifier and both regular-expressions are required.
33136 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
33137 specify an empty element to get this.
33138
33139 .vitem &%sophie%&
33140 .cindex "virus scanners" "Sophos and Sophie"
33141 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
33142 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
33143 for this scanner type is the path to the UNIX socket that Sophie uses for
33144 client communication. For example:
33145 .code
33146 av_scanner = sophie:/tmp/sophie
33147 .endd
33148 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
33149 the option.
33150 .endlist
33151
33152 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
33153 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
33154 ACL.
33155
33156 The &%av_scanner%& option is expanded each time &%malware%& is called. This
33157 makes it possible to use different scanners. See further below for an example.
33158 The &%malware%& condition caches its results, so when you use it multiple times
33159 for the same message, the actual scanning process is only carried out once.
33160 However, using expandable items in &%av_scanner%& disables this caching, in
33161 which case each use of the &%malware%& condition causes a new scan of the
33162 message.
33163
33164 The &%malware%& condition takes a right-hand argument that is expanded before
33165 use and taken as a list, slash-separated by default.
33166 The first element can then be one of
33167
33168 .ilist
33169 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
33170 The condition succeeds if a virus was found, and fail otherwise. This is the
33171 recommended usage.
33172 .next
33173 &"false"& or &"0"& or an empty string, in which case no scanning is done and
33174 the condition fails immediately.
33175 .next
33176 A regular expression, in which case the message is scanned for viruses. The
33177 condition succeeds if a virus is found and its name matches the regular
33178 expression. This allows you to take special actions on certain types of virus.
33179 Note that &"/"& characters in the RE must be doubled due to the list-processing,
33180 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
33181 .endlist
33182
33183 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
33184 messages even if there is a problem with the virus scanner.
33185 Otherwise, such a problem causes the ACL to defer.
33186
33187 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
33188 specify a non-default timeout.  The default is two minutes.
33189 For example:
33190 .code
33191 malware = * / defer_ok / tmo=10s
33192 .endd
33193 A timeout causes the ACL to defer.
33194
33195 .vindex "&$callout_address$&"
33196 When a connection is made to the scanner the expansion variable &$callout_address$&
33197 is set to record the actual address used.
33198
33199 .vindex "&$malware_name$&"
33200 When a virus is found, the condition sets up an expansion variable called
33201 &$malware_name$& that contains the name of the virus. You can use it in a
33202 &%message%& modifier that specifies the error returned to the sender, and/or in
33203 logging data.
33204
33205 Beware the interaction of Exim's &%message_size_limit%& with any size limits
33206 imposed by your anti-virus scanner.
33207
33208 Here is a very simple scanning example:
33209 .code
33210 deny message = This message contains malware ($malware_name)
33211      malware = *
33212 .endd
33213 The next example accepts messages when there is a problem with the scanner:
33214 .code
33215 deny message = This message contains malware ($malware_name)
33216      malware = */defer_ok
33217 .endd
33218 The next example shows how to use an ACL variable to scan with both sophie and
33219 aveserver. It assumes you have set:
33220 .code
33221 av_scanner = $acl_m0
33222 .endd
33223 in the main Exim configuration.
33224 .code
33225 deny message = This message contains malware ($malware_name)
33226      set acl_m0 = sophie
33227      malware = *
33228
33229 deny message = This message contains malware ($malware_name)
33230      set acl_m0 = aveserver
33231      malware = *
33232 .endd
33233
33234
33235 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
33236 .cindex "content scanning" "for spam"
33237 .cindex "spam scanning"
33238 .cindex "SpamAssassin"
33239 .cindex "Rspamd"
33240 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
33241 score and a report for the message.
33242 Support is also provided for Rspamd.
33243
33244 For more information about installation and configuration of SpamAssassin or
33245 Rspamd refer to their respective websites at
33246 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
33247
33248 SpamAssassin can be installed with CPAN by running:
33249 .code
33250 perl -MCPAN -e 'install Mail::SpamAssassin'
33251 .endd
33252 SpamAssassin has its own set of configuration files. Please review its
33253 documentation to see how you can tweak it. The default installation should work
33254 nicely, however.
33255
33256 .oindex "&%spamd_address%&"
33257 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
33258 intend to use an instance running on the local host you do not need to set
33259 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
33260 you must set the &%spamd_address%& option in the global part of the Exim
33261 configuration as follows (example):
33262 .code
33263 spamd_address = 192.168.99.45 783
33264 .endd
33265 The SpamAssassin protocol relies on a TCP half-close from the client.
33266 If your SpamAssassin client side is running a Linux system with an
33267 iptables firewall, consider setting
33268 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
33269 timeout, Exim uses when waiting for a response from the SpamAssassin
33270 server (currently defaulting to 120s).  With a lower value the Linux
33271 connection tracking may consider your half-closed connection as dead too
33272 soon.
33273
33274
33275 To use Rspamd (which by default listens on all local addresses
33276 on TCP port 11333)
33277 you should add &%variant=rspamd%& after the address/port pair, for example:
33278 .code
33279 spamd_address = 127.0.0.1 11333 variant=rspamd
33280 .endd
33281
33282 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
33283 sockets. If you want to us these, supply &%spamd_address%& with an absolute
33284 filename instead of an address/port pair:
33285 .code
33286 spamd_address = /var/run/spamd_socket
33287 .endd
33288 You can have multiple &%spamd%& servers to improve scalability. These can
33289 reside on other hardware reachable over the network. To specify multiple
33290 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
33291 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
33292 .code
33293 spamd_address = 192.168.2.10 783 : \
33294                 192.168.2.11 783 : \
33295                 192.168.2.12 783
33296 .endd
33297 Up to 32 &%spamd%& servers are supported.
33298 When a server fails to respond to the connection attempt, all other
33299 servers are tried until one succeeds. If no server responds, the &%spam%&
33300 condition defers.
33301
33302 Unix and TCP socket specifications may be mixed in any order.
33303 Each element of the list is a list itself, space-separated by default
33304 and changeable in the usual way (&<<SECTlistsepchange>>&);
33305 take care to not double the separator.
33306
33307 For TCP socket specifications a host name or IP (v4 or v6, but
33308 subject to list-separator quoting rules) address can be used,
33309 and the port can be one or a dash-separated pair.
33310 In the latter case, the range is tried in strict order.
33311
33312 Elements after the first for Unix sockets, or second for TCP socket,
33313 are options.
33314 The supported options are:
33315 .code
33316 pri=<priority>      Selection priority
33317 weight=<value>      Selection bias
33318 time=<start>-<end>  Use only between these times of day
33319 retry=<timespec>    Retry on connect fail
33320 tmo=<timespec>      Connection time limit
33321 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
33322 .endd
33323
33324 The &`pri`& option specifies a priority for the server within the list,
33325 higher values being tried first.
33326 The default priority is 1.
33327
33328 The &`weight`& option specifies a selection bias.
33329 Within a priority set
33330 servers are queried in a random fashion, weighted by this value.
33331 The default value for selection bias is 1.
33332
33333 Time specifications for the &`time`& option are <hour>.<minute>.<second>
33334 in the local time zone; each element being one or more digits.
33335 Either the seconds or both minutes and seconds, plus the leading &`.`&
33336 characters, may be omitted and will be taken as zero.
33337
33338 Timeout specifications for the &`retry`& and &`tmo`& options
33339 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
33340
33341 The &`tmo`& option specifies an overall timeout for communication.
33342 The default value is two minutes.
33343
33344 The &`retry`& option specifies a time after which a single retry for
33345 a failed connect is made.
33346 The default is to not retry.
33347
33348 The &%spamd_address%& variable is expanded before use if it starts with
33349 a dollar sign. In this case, the expansion may return a string that is
33350 used as the list so that multiple spamd servers can be the result of an
33351 expansion.
33352
33353 .vindex "&$callout_address$&"
33354 When a connection is made to the server the expansion variable &$callout_address$&
33355 is set to record the actual address used.
33356
33357 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
33358 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
33359 .code
33360 deny message = This message was classified as SPAM
33361      spam = joe
33362 .endd
33363 The right-hand side of the &%spam%& condition specifies a name. This is
33364 relevant if you have set up multiple SpamAssassin profiles. If you do not want
33365 to scan using a specific profile, but rather use the SpamAssassin system-wide
33366 default profile, you can scan for an unknown name, or simply use &"nobody"&.
33367 Rspamd does not use this setting. However, you must put something on the
33368 right-hand side.
33369
33370 The name allows you to use per-domain or per-user antispam profiles in
33371 principle, but this is not straightforward in practice, because a message may
33372 have multiple recipients, not necessarily all in the same domain. Because the
33373 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
33374 read the contents of the message, the variables &$local_part$& and &$domain$&
33375 are not set.
33376 Careful enforcement of single-recipient messages
33377 (e.g. by responding with defer in the recipient ACL for all recipients
33378 after the first),
33379 or the use of PRDR,
33380 .cindex "PRDR" "use for per-user SpamAssassin profiles"
33381 are needed to use this feature.
33382
33383 The right-hand side of the &%spam%& condition is expanded before being used, so
33384 you can put lookups or conditions there. When the right-hand side evaluates to
33385 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
33386
33387
33388 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
33389 large ones may cause significant performance degradation. As most spam messages
33390 are quite small, it is recommended that you do not scan the big ones. For
33391 example:
33392 .code
33393 deny message = This message was classified as SPAM
33394      condition = ${if < {$message_size}{10K}}
33395      spam = nobody
33396 .endd
33397
33398 The &%spam%& condition returns true if the threshold specified in the user's
33399 SpamAssassin profile has been matched or exceeded. If you want to use the
33400 &%spam%& condition for its side effects (see the variables below), you can make
33401 it always return &"true"& by appending &`:true`& to the username.
33402
33403 .cindex "spam scanning" "returned variables"
33404 When the &%spam%& condition is run, it sets up a number of expansion
33405 variables.
33406 Except for &$spam_report$&,
33407 these variables are saved with the received message so are
33408 available for use at delivery time.
33409
33410 .vlist
33411 .vitem &$spam_score$&
33412 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
33413 for inclusion in log or reject messages.
33414
33415 .vitem &$spam_score_int$&
33416 The spam score of the message, multiplied by ten, as an integer value. For
33417 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
33418 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
33419 The integer value is useful for numeric comparisons in conditions.
33420
33421 .vitem &$spam_bar$&
33422 A string consisting of a number of &"+"& or &"-"& characters, representing the
33423 integer part of the spam score value. A spam score of 4.4 would have a
33424 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
33425 headers, since MUAs can match on such strings. The maximum length of the
33426 spam bar is 50 characters.
33427
33428 .vitem &$spam_report$&
33429 A multiline text table, containing the full SpamAssassin report for the
33430 message. Useful for inclusion in headers or reject messages.
33431 This variable is only usable in a DATA-time ACL.
33432 Beware that SpamAssassin may return non-ASCII characters, especially
33433 when running in country-specific locales, which are not legal
33434 unencoded in headers.
33435
33436 .vitem &$spam_action$&
33437 For SpamAssassin either 'reject' or 'no action' depending on the
33438 spam score versus threshold.
33439 For Rspamd, the recommended action.
33440
33441 .endlist
33442
33443 The &%spam%& condition caches its results unless expansion in
33444 spamd_address was used. If you call it again with the same user name, it
33445 does not scan again, but rather returns the same values as before.
33446
33447 The &%spam%& condition returns DEFER if there is any error while running
33448 the message through SpamAssassin or if the expansion of spamd_address
33449 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
33450 statement block), append &`/defer_ok`& to the right-hand side of the
33451 spam condition, like this:
33452 .code
33453 deny message = This message was classified as SPAM
33454      spam    = joe/defer_ok
33455 .endd
33456 This causes messages to be accepted even if there is a problem with &%spamd%&.
33457
33458 Here is a longer, commented example of the use of the &%spam%&
33459 condition:
33460 .code
33461 # put headers in all messages (no matter if spam or not)
33462 warn  spam = nobody:true
33463       add_header = X-Spam-Score: $spam_score ($spam_bar)
33464       add_header = X-Spam-Report: $spam_report
33465
33466 # add second subject line with *SPAM* marker when message
33467 # is over threshold
33468 warn  spam = nobody
33469       add_header = Subject: *SPAM* $h_Subject:
33470
33471 # reject spam at high scores (> 12)
33472 deny  message = This message scored $spam_score spam points.
33473       spam = nobody:true
33474       condition = ${if >{$spam_score_int}{120}{1}{0}}
33475 .endd
33476
33477
33478
33479 .section "Scanning MIME parts" "SECTscanmimepart"
33480 .cindex "content scanning" "MIME parts"
33481 .cindex "MIME content scanning"
33482 .oindex "&%acl_smtp_mime%&"
33483 .oindex "&%acl_not_smtp_mime%&"
33484 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
33485 each MIME part of an SMTP message, including multipart types, in the sequence
33486 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
33487 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
33488 options may both refer to the same ACL if you want the same processing in both
33489 cases.
33490
33491 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
33492 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
33493 the case of a non-SMTP message. However, a MIME ACL is called only if the
33494 message contains a &'Content-Type:'& header line. When a call to a MIME
33495 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
33496 result code is sent to the client. In the case of an SMTP message, the
33497 &%acl_smtp_data%& ACL is not called when this happens.
33498
33499 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
33500 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
33501 condition to match against the raw MIME part. You can also use the
33502 &%mime_regex%& condition to match against the decoded MIME part (see section
33503 &<<SECTscanregex>>&).
33504
33505 At the start of a MIME ACL, a number of variables are set from the header
33506 information for the relevant MIME part. These are described below. The contents
33507 of the MIME part are not by default decoded into a disk file except for MIME
33508 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
33509 part into a disk file, you can use the &%decode%& condition. The general
33510 syntax is:
33511 .display
33512 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
33513 .endd
33514 The right hand side is expanded before use. After expansion,
33515 the value can be:
33516
33517 .olist
33518 &"0"& or &"false"&, in which case no decoding is done.
33519 .next
33520 The string &"default"&. In that case, the file is put in the temporary
33521 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
33522 a sequential filename consisting of the message id and a sequence number. The
33523 full path and name is available in &$mime_decoded_filename$& after decoding.
33524 .next
33525 A full path name starting with a slash. If the full name is an existing
33526 directory, it is used as a replacement for the default directory. The filename
33527 is then sequentially assigned. If the path does not exist, it is used as
33528 the full path and filename.
33529 .next
33530 If the string does not start with a slash, it is used as the
33531 filename, and the default path is then used.
33532 .endlist
33533 The &%decode%& condition normally succeeds. It is only false for syntax
33534 errors or unusual circumstances such as memory shortages. You can easily decode
33535 a file with its original, proposed filename using
33536 .code
33537 decode = $mime_filename
33538 .endd
33539 However, you should keep in mind that &$mime_filename$& might contain
33540 anything. If you place files outside of the default path, they are not
33541 automatically unlinked.
33542
33543 For RFC822 attachments (these are messages attached to messages, with a
33544 content-type of &"message/rfc822"&), the ACL is called again in the same manner
33545 as for the primary message, only that the &$mime_is_rfc822$& expansion
33546 variable is set (see below). Attached messages are always decoded to disk
33547 before being checked, and the files are unlinked once the check is done.
33548
33549 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
33550 used to match regular expressions against raw and decoded MIME parts,
33551 respectively. They are described in section &<<SECTscanregex>>&.
33552
33553 .cindex "MIME content scanning" "returned variables"
33554 The following list describes all expansion variables that are
33555 available in the MIME ACL:
33556
33557 .vlist
33558 .vitem &$mime_boundary$&
33559 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
33560 have a boundary string, which is stored in this variable. If the current part
33561 has no boundary parameter in the &'Content-Type:'& header, this variable
33562 contains the empty string.
33563
33564 .vitem &$mime_charset$&
33565 This variable contains the character set identifier, if one was found in the
33566 &'Content-Type:'& header. Examples for charset identifiers are:
33567 .code
33568 us-ascii
33569 gb2312 (Chinese)
33570 iso-8859-1
33571 .endd
33572 Please note that this value is not normalized, so you should do matches
33573 case-insensitively.
33574
33575 .vitem &$mime_content_description$&
33576 This variable contains the normalized content of the &'Content-Description:'&
33577 header. It can contain a human-readable description of the parts content. Some
33578 implementations repeat the filename for attachments here, but they are usually
33579 only used for display purposes.
33580
33581 .vitem &$mime_content_disposition$&
33582 This variable contains the normalized content of the &'Content-Disposition:'&
33583 header. You can expect strings like &"attachment"& or &"inline"& here.
33584
33585 .vitem &$mime_content_id$&
33586 This variable contains the normalized content of the &'Content-ID:'& header.
33587 This is a unique ID that can be used to reference a part from another part.
33588
33589 .vitem &$mime_content_size$&
33590 This variable is set only after the &%decode%& modifier (see above) has been
33591 successfully run. It contains the size of the decoded part in kilobytes. The
33592 size is always rounded up to full kilobytes, so only a completely empty part
33593 has a &$mime_content_size$& of zero.
33594
33595 .vitem &$mime_content_transfer_encoding$&
33596 This variable contains the normalized content of the
33597 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
33598 type. Typical values are &"base64"& and &"quoted-printable"&.
33599
33600 .vitem &$mime_content_type$&
33601 If the MIME part has a &'Content-Type:'& header, this variable contains its
33602 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
33603 are some examples of popular MIME types, as they may appear in this variable:
33604 .code
33605 text/plain
33606 text/html
33607 application/octet-stream
33608 image/jpeg
33609 audio/midi
33610 .endd
33611 If the MIME part has no &'Content-Type:'& header, this variable contains the
33612 empty string.
33613
33614 .vitem &$mime_decoded_filename$&
33615 This variable is set only after the &%decode%& modifier (see above) has been
33616 successfully run. It contains the full path and filename of the file
33617 containing the decoded data.
33618 .endlist
33619
33620 .cindex "RFC 2047"
33621 .vlist
33622 .vitem &$mime_filename$&
33623 This is perhaps the most important of the MIME variables. It contains a
33624 proposed filename for an attachment, if one was found in either the
33625 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
33626 RFC2047
33627 or RFC2231
33628 decoded, but no additional sanity checks are done.
33629  If no filename was
33630 found, this variable contains the empty string.
33631
33632 .vitem &$mime_is_coverletter$&
33633 This variable attempts to differentiate the &"cover letter"& of an e-mail from
33634 attached data. It can be used to clamp down on flashy or unnecessarily encoded
33635 content in the cover letter, while not restricting attachments at all.
33636
33637 The variable contains 1 (true) for a MIME part believed to be part of the
33638 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
33639 follows:
33640
33641 .olist
33642 The outermost MIME part of a message is always a cover letter.
33643
33644 .next
33645 If a multipart/alternative or multipart/related MIME part is a cover letter,
33646 so are all MIME subparts within that multipart.
33647
33648 .next
33649 If any other multipart is a cover letter, the first subpart is a cover letter,
33650 and the rest are attachments.
33651
33652 .next
33653 All parts contained within an attachment multipart are attachments.
33654 .endlist olist
33655
33656 As an example, the following will ban &"HTML mail"& (including that sent with
33657 alternative plain text), while allowing HTML files to be attached. HTML
33658 coverletter mail attached to non-HTML coverletter mail will also be allowed:
33659 .code
33660 deny message = HTML mail is not accepted here
33661 !condition = $mime_is_rfc822
33662 condition = $mime_is_coverletter
33663 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
33664 .endd
33665 .vitem &$mime_is_multipart$&
33666 This variable has the value 1 (true) when the current part has the main type
33667 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
33668 Since multipart entities only serve as containers for other parts, you may not
33669 want to carry out specific actions on them.
33670
33671 .vitem &$mime_is_rfc822$&
33672 This variable has the value 1 (true) if the current part is not a part of the
33673 checked message itself, but part of an attached message. Attached message
33674 decoding is fully recursive.
33675
33676 .vitem &$mime_part_count$&
33677 This variable is a counter that is raised for each processed MIME part. It
33678 starts at zero for the very first part (which is usually a multipart). The
33679 counter is per-message, so it is reset when processing RFC822 attachments (see
33680 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
33681 complete, so you can use it in the DATA ACL to determine the number of MIME
33682 parts of a message. For non-MIME messages, this variable contains the value -1.
33683 .endlist
33684
33685
33686
33687 .section "Scanning with regular expressions" "SECTscanregex"
33688 .cindex "content scanning" "with regular expressions"
33689 .cindex "regular expressions" "content scanning with"
33690 You can specify your own custom regular expression matches on the full body of
33691 the message, or on individual MIME parts.
33692
33693 The &%regex%& condition takes one or more regular expressions as arguments and
33694 matches them against the full message (when called in the DATA ACL) or a raw
33695 MIME part (when called in the MIME ACL). The &%regex%& condition matches
33696 linewise, with a maximum line length of 32K characters. That means you cannot
33697 have multiline matches with the &%regex%& condition.
33698
33699 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
33700 to 32K of decoded content (the whole content at once, not linewise). If the
33701 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
33702 is decoded automatically when &%mime_regex%& is executed (using default path
33703 and filename values). If the decoded data is larger than  32K, only the first
33704 32K characters are checked.
33705
33706 The regular expressions are passed as a colon-separated list. To include a
33707 literal colon, you must double it. Since the whole right-hand side string is
33708 expanded before being used, you must also escape dollar signs and backslashes
33709 with more backslashes, or use the &`\N`& facility to disable expansion.
33710 Here is a simple example that contains two regular expressions:
33711 .code
33712 deny message = contains blacklisted regex ($regex_match_string)
33713      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
33714 .endd
33715 The conditions returns true if any one of the regular expressions matches. The
33716 &$regex_match_string$& expansion variable is then set up and contains the
33717 matching regular expression.
33718 The expansion variables &$regex1$& &$regex2$& etc
33719 are set to any substrings captured by the regular expression.
33720
33721 &*Warning*&: With large messages, these conditions can be fairly
33722 CPU-intensive.
33723
33724 .ecindex IIDcosca
33725
33726
33727
33728
33729 . ////////////////////////////////////////////////////////////////////////////
33730 . ////////////////////////////////////////////////////////////////////////////
33731
33732 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
33733          "Local scan function"
33734 .scindex IIDlosca "&[local_scan()]& function" "description of"
33735 .cindex "customizing" "input scan using C function"
33736 .cindex "policy control" "by local scan function"
33737 In these days of email worms, viruses, and ever-increasing spam, some sites
33738 want to apply a lot of checking to messages before accepting them.
33739
33740 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
33741 passing messages to external virus and spam scanning software. You can also do
33742 a certain amount in Exim itself through string expansions and the &%condition%&
33743 condition in the ACL that runs after the SMTP DATA command or the ACL for
33744 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
33745
33746 To allow for further customization to a site's own requirements, there is the
33747 possibility of linking Exim with a private message scanning function, written
33748 in C. If you want to run code that is written in something other than C, you
33749 can of course use a little C stub to call it.
33750
33751 The local scan function is run once for every incoming message, at the point
33752 when Exim is just about to accept the message.
33753 It can therefore be used to control non-SMTP messages from local processes as
33754 well as messages arriving via SMTP.
33755
33756 Exim applies a timeout to calls of the local scan function, and there is an
33757 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
33758 Zero means &"no timeout"&.
33759 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
33760 before calling the local scan function, so that the most common types of crash
33761 are caught. If the timeout is exceeded or one of those signals is caught, the
33762 incoming message is rejected with a temporary error if it is an SMTP message.
33763 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
33764 code. The incident is logged on the main and reject logs.
33765
33766
33767
33768 .section "Building Exim to use a local scan function" "SECID207"
33769 .cindex "&[local_scan()]& function" "building Exim to use"
33770 To make use of the local scan function feature, you must tell Exim where your
33771 function is before building Exim, by setting
33772 both HAVE_LOCAL_SCAN and
33773 LOCAL_SCAN_SOURCE in your
33774 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
33775 directory, so you might set
33776 .code
33777 HAVE_LOCAL_SCAN=yes
33778 LOCAL_SCAN_SOURCE=Local/local_scan.c
33779 .endd
33780 for example. The function must be called &[local_scan()]&;
33781 .new
33782 the source file(s) for it should first #define LOCAL_SCAN
33783 and then #include "local_scan.h".
33784 .wen
33785 It is called by
33786 Exim after it has received a message, when the success return code is about to
33787 be sent. This is after all the ACLs have been run. The return code from your
33788 function controls whether the message is actually accepted or not. There is a
33789 commented template function (that just accepts the message) in the file
33790 _src/local_scan.c_.
33791
33792 If you want to make use of Exim's runtime configuration file to set options
33793 for your &[local_scan()]& function, you must also set
33794 .code
33795 LOCAL_SCAN_HAS_OPTIONS=yes
33796 .endd
33797 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
33798
33799
33800
33801
33802 .section "API for local_scan()" "SECTapiforloc"
33803 .cindex "&[local_scan()]& function" "API description"
33804 .cindex &%dlfunc%& "API description"
33805 You must include this line near the start of your code:
33806 .code
33807 #include "local_scan.h"
33808 .endd
33809 This header file defines a number of variables and other values, and the
33810 prototype for the function itself. Exim is coded to use unsigned char values
33811 almost exclusively, and one of the things this header defines is a shorthand
33812 for &`unsigned char`& called &`uschar`&.
33813 It also contains the following macro definitions, to simplify casting character
33814 strings and pointers to character strings:
33815 .code
33816 #define CS   (char *)
33817 #define CCS  (const char *)
33818 #define CSS  (char **)
33819 #define US   (unsigned char *)
33820 #define CUS  (const unsigned char *)
33821 #define USS  (unsigned char **)
33822 .endd
33823 The function prototype for &[local_scan()]& is:
33824 .code
33825 extern int local_scan(int fd, uschar **return_text);
33826 .endd
33827 The arguments are as follows:
33828
33829 .ilist
33830 &%fd%& is a file descriptor for the file that contains the body of the message
33831 (the -D file). The file is open for reading and writing, but updating it is not
33832 recommended. &*Warning*&: You must &'not'& close this file descriptor.
33833
33834 The descriptor is positioned at character 19 of the file, which is the first
33835 character of the body itself, because the first 19 characters are the message
33836 id followed by &`-D`& and a newline. If you rewind the file, you should use the
33837 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
33838 case this changes in some future version.
33839 .next
33840 &%return_text%& is an address which you can use to return a pointer to a text
33841 string at the end of the function. The value it points to on entry is NULL.
33842 .endlist
33843
33844 The function must return an &%int%& value which is one of the following macros:
33845
33846 .vlist
33847 .vitem &`LOCAL_SCAN_ACCEPT`&
33848 .vindex "&$local_scan_data$&"
33849 The message is accepted. If you pass back a string of text, it is saved with
33850 the message, and made available in the variable &$local_scan_data$&. No
33851 newlines are permitted (if there are any, they are turned into spaces) and the
33852 maximum length of text is 1000 characters.
33853
33854 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
33855 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33856 queued without immediate delivery, and is frozen.
33857
33858 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
33859 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33860 queued without immediate delivery.
33861
33862 .vitem &`LOCAL_SCAN_REJECT`&
33863 The message is rejected; the returned text is used as an error message which is
33864 passed back to the sender and which is also logged. Newlines are permitted &--
33865 they cause a multiline response for SMTP rejections, but are converted to
33866 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
33867 used.
33868
33869 .vitem &`LOCAL_SCAN_TEMPREJECT`&
33870 The message is temporarily rejected; the returned text is used as an error
33871 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
33872 problem"& is used.
33873
33874 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
33875 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
33876 message is not written to the reject log. It has the effect of unsetting the
33877 &%rejected_header%& log selector for just this rejection. If
33878 &%rejected_header%& is already unset (see the discussion of the
33879 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
33880 same as LOCAL_SCAN_REJECT.
33881
33882 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
33883 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
33884 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
33885 .endlist
33886
33887 If the message is not being received by interactive SMTP, rejections are
33888 reported by writing to &%stderr%& or by sending an email, as configured by the
33889 &%-oe%& command line options.
33890
33891
33892
33893 .section "Configuration options for local_scan()" "SECTconoptloc"
33894 .cindex "&[local_scan()]& function" "configuration options"
33895 It is possible to have option settings in the main configuration file
33896 that set values in static variables in the &[local_scan()]& module. If you
33897 want to do this, you must have the line
33898 .code
33899 LOCAL_SCAN_HAS_OPTIONS=yes
33900 .endd
33901 in your &_Local/Makefile_& when you build Exim. (This line is in
33902 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
33903 file, you must define static variables to hold the option values, and a table
33904 to define them.
33905
33906 The table must be a vector called &%local_scan_options%&, of type
33907 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
33908 and a pointer to the variable that holds the value. The entries must appear in
33909 alphabetical order. Following &%local_scan_options%& you must also define a
33910 variable called &%local_scan_options_count%& that contains the number of
33911 entries in the table. Here is a short example, showing two kinds of option:
33912 .code
33913 static int my_integer_option = 42;
33914 static uschar *my_string_option = US"a default string";
33915
33916 optionlist local_scan_options[] = {
33917   { "my_integer", opt_int,       &my_integer_option },
33918   { "my_string",  opt_stringptr, &my_string_option }
33919 };
33920
33921 int local_scan_options_count =
33922   sizeof(local_scan_options)/sizeof(optionlist);
33923 .endd
33924 The values of the variables can now be changed from Exim's runtime
33925 configuration file by including a local scan section as in this example:
33926 .code
33927 begin local_scan
33928 my_integer = 99
33929 my_string = some string of text...
33930 .endd
33931 The available types of option data are as follows:
33932
33933 .vlist
33934 .vitem &*opt_bool*&
33935 This specifies a boolean (true/false) option. The address should point to a
33936 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
33937 that are defined as &"1"& and &"0"&, respectively. If you want to detect
33938 whether such a variable has been set at all, you can initialize it to
33939 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
33940 values.)
33941
33942 .vitem &*opt_fixed*&
33943 This specifies a fixed point number, such as is used for load averages.
33944 The address should point to a variable of type &`int`&. The value is stored
33945 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
33946
33947 .vitem &*opt_int*&
33948 This specifies an integer; the address should point to a variable of type
33949 &`int`&. The value may be specified in any of the integer formats accepted by
33950 Exim.
33951
33952 .vitem &*opt_mkint*&
33953 This is the same as &%opt_int%&, except that when such a value is output in a
33954 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
33955 printed with the suffix K or M.
33956
33957 .vitem &*opt_octint*&
33958 This also specifies an integer, but the value is always interpreted as an
33959 octal integer, whether or not it starts with the digit zero, and it is
33960 always output in octal.
33961
33962 .vitem &*opt_stringptr*&
33963 This specifies a string value; the address must be a pointer to a
33964 variable that points to a string (for example, of type &`uschar *`&).
33965
33966 .vitem &*opt_time*&
33967 This specifies a time interval value. The address must point to a variable of
33968 type &`int`&. The value that is placed there is a number of seconds.
33969 .endlist
33970
33971 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
33972 out the values of all the &[local_scan()]& options.
33973
33974
33975
33976 .section "Available Exim variables" "SECID208"
33977 .cindex "&[local_scan()]& function" "available Exim variables"
33978 The header &_local_scan.h_& gives you access to a number of C variables. These
33979 are the only ones that are guaranteed to be maintained from release to release.
33980 Note, however, that you can obtain the value of any Exim expansion variable,
33981 including &$recipients$&, by calling &'expand_string()'&. The exported
33982 C variables are as follows:
33983
33984 .vlist
33985 .vitem &*int&~body_linecount*&
33986 This variable contains the number of lines in the message's body.
33987 It is not valid if the &%spool_files_wireformat%& option is used.
33988
33989 .vitem &*int&~body_zerocount*&
33990 This variable contains the number of binary zero bytes in the message's body.
33991 It is not valid if the &%spool_files_wireformat%& option is used.
33992
33993 .vitem &*unsigned&~int&~debug_selector*&
33994 This variable is set to zero when no debugging is taking place. Otherwise, it
33995 is a bitmap of debugging selectors. Two bits are identified for use in
33996 &[local_scan()]&; they are defined as macros:
33997
33998 .ilist
33999 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
34000 testing option that is not privileged &-- any caller may set it. All the
34001 other selector bits can be set only by admin users.
34002
34003 .next
34004 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
34005 by the &`+local_scan`& debug selector. It is not included in the default set
34006 of debugging bits.
34007 .endlist ilist
34008
34009 Thus, to write to the debugging output only when &`+local_scan`& has been
34010 selected, you should use code like this:
34011 .code
34012 if ((debug_selector & D_local_scan) != 0)
34013   debug_printf("xxx", ...);
34014 .endd
34015 .vitem &*uschar&~*expand_string_message*&
34016 After a failing call to &'expand_string()'& (returned value NULL), the
34017 variable &%expand_string_message%& contains the error message, zero-terminated.
34018
34019 .vitem &*header_line&~*header_list*&
34020 A pointer to a chain of header lines. The &%header_line%& structure is
34021 discussed below.
34022
34023 .vitem &*header_line&~*header_last*&
34024 A pointer to the last of the header lines.
34025
34026 .vitem &*uschar&~*headers_charset*&
34027 The value of the &%headers_charset%& configuration option.
34028
34029 .vitem &*BOOL&~host_checking*&
34030 This variable is TRUE during a host checking session that is initiated by the
34031 &%-bh%& command line option.
34032
34033 .vitem &*uschar&~*interface_address*&
34034 The IP address of the interface that received the message, as a string. This
34035 is NULL for locally submitted messages.
34036
34037 .vitem &*int&~interface_port*&
34038 The port on which this message was received. When testing with the &%-bh%&
34039 command line option, the value of this variable is -1 unless a port has been
34040 specified via the &%-oMi%& option.
34041
34042 .vitem &*uschar&~*message_id*&
34043 This variable contains Exim's message id for the incoming message (the value of
34044 &$message_exim_id$&) as a zero-terminated string.
34045
34046 .vitem &*uschar&~*received_protocol*&
34047 The name of the protocol by which the message was received.
34048
34049 .vitem &*int&~recipients_count*&
34050 The number of accepted recipients.
34051
34052 .vitem &*recipient_item&~*recipients_list*&
34053 .cindex "recipient" "adding in local scan"
34054 .cindex "recipient" "removing in local scan"
34055 The list of accepted recipients, held in a vector of length
34056 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
34057 can add additional recipients by calling &'receive_add_recipient()'& (see
34058 below). You can delete recipients by removing them from the vector and
34059 adjusting the value in &%recipients_count%&. In particular, by setting
34060 &%recipients_count%& to zero you remove all recipients. If you then return the
34061 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
34062 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
34063 and then call &'receive_add_recipient()'& as often as needed.
34064
34065 .vitem &*uschar&~*sender_address*&
34066 The envelope sender address. For bounce messages this is the empty string.
34067
34068 .vitem &*uschar&~*sender_host_address*&
34069 The IP address of the sending host, as a string. This is NULL for
34070 locally-submitted messages.
34071
34072 .vitem &*uschar&~*sender_host_authenticated*&
34073 The name of the authentication mechanism that was used, or NULL if the message
34074 was not received over an authenticated SMTP connection.
34075
34076 .vitem &*uschar&~*sender_host_name*&
34077 The name of the sending host, if known.
34078
34079 .vitem &*int&~sender_host_port*&
34080 The port on the sending host.
34081
34082 .vitem &*BOOL&~smtp_input*&
34083 This variable is TRUE for all SMTP input, including BSMTP.
34084
34085 .vitem &*BOOL&~smtp_batched_input*&
34086 This variable is TRUE for BSMTP input.
34087
34088 .vitem &*int&~store_pool*&
34089 The contents of this variable control which pool of memory is used for new
34090 requests. See section &<<SECTmemhanloc>>& for details.
34091 .endlist
34092
34093
34094 .section "Structure of header lines" "SECID209"
34095 The &%header_line%& structure contains the members listed below.
34096 You can add additional header lines by calling the &'header_add()'& function
34097 (see below). You can cause header lines to be ignored (deleted) by setting
34098 their type to *.
34099
34100
34101 .vlist
34102 .vitem &*struct&~header_line&~*next*&
34103 A pointer to the next header line, or NULL for the last line.
34104
34105 .vitem &*int&~type*&
34106 A code identifying certain headers that Exim recognizes. The codes are printing
34107 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
34108 Notice in particular that any header line whose type is * is not transmitted
34109 with the message. This flagging is used for header lines that have been
34110 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
34111 lines.) Effectively, * means &"deleted"&.
34112
34113 .vitem &*int&~slen*&
34114 The number of characters in the header line, including the terminating and any
34115 internal newlines.
34116
34117 .vitem &*uschar&~*text*&
34118 A pointer to the text of the header. It always ends with a newline, followed by
34119 a zero byte. Internal newlines are preserved.
34120 .endlist
34121
34122
34123
34124 .section "Structure of recipient items" "SECID210"
34125 The &%recipient_item%& structure contains these members:
34126
34127 .vlist
34128 .vitem &*uschar&~*address*&
34129 This is a pointer to the recipient address as it was received.
34130
34131 .vitem &*int&~pno*&
34132 This is used in later Exim processing when top level addresses are created by
34133 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
34134 and must always contain -1 at this stage.
34135
34136 .vitem &*uschar&~*errors_to*&
34137 If this value is not NULL, bounce messages caused by failing to deliver to the
34138 recipient are sent to the address it contains. In other words, it overrides the
34139 envelope sender for this one recipient. (Compare the &%errors_to%& generic
34140 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
34141 an unqualified address, Exim qualifies it using the domain from
34142 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
34143 is NULL for all recipients.
34144 .endlist
34145
34146
34147
34148 .section "Available Exim functions" "SECID211"
34149 .cindex "&[local_scan()]& function" "available Exim functions"
34150 The header &_local_scan.h_& gives you access to a number of Exim functions.
34151 These are the only ones that are guaranteed to be maintained from release to
34152 release:
34153
34154 .vlist
34155 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
34156        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
34157
34158 This function creates a child process that runs the command specified by
34159 &%argv%&. The environment for the process is specified by &%envp%&, which can
34160 be NULL if no environment variables are to be passed. A new umask is supplied
34161 for the process in &%newumask%&.
34162
34163 Pipes to the standard input and output of the new process are set up
34164 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
34165 standard error is cloned to the standard output. If there are any file
34166 descriptors &"in the way"& in the new process, they are closed. If the final
34167 argument is TRUE, the new process is made into a process group leader.
34168
34169 The function returns the pid of the new process, or -1 if things go wrong.
34170
34171 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
34172 This function waits for a child process to terminate, or for a timeout (in
34173 seconds) to expire. A timeout value of zero means wait as long as it takes. The
34174 return value is as follows:
34175
34176 .ilist
34177 >= 0
34178
34179 The process terminated by a normal exit and the value is the process
34180 ending status.
34181
34182 .next
34183 < 0 and > &--256
34184
34185 The process was terminated by a signal and the value is the negation of the
34186 signal number.
34187
34188 .next
34189 &--256
34190
34191 The process timed out.
34192 .next
34193 &--257
34194
34195 The was some other error in wait(); &%errno%& is still set.
34196 .endlist
34197
34198 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
34199 This function provide you with a means of submitting a new message to
34200 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
34201 want, but this packages it all up for you.) The function creates a pipe,
34202 forks a subprocess that is running
34203 .code
34204 exim -t -oem -oi -f <>
34205 .endd
34206 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
34207 that is connected to the standard input. The yield of the function is the PID
34208 of the subprocess. You can then write a message to the file descriptor, with
34209 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
34210
34211 When you have finished, call &'child_close()'& to wait for the process to
34212 finish and to collect its ending status. A timeout value of zero is usually
34213 fine in this circumstance. Unless you have made a mistake with the recipient
34214 addresses, you should get a return code of zero.
34215
34216
34217 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
34218        *sender_authentication)*&
34219 This function is a more sophisticated version of &'child_open()'&. The command
34220 that it runs is:
34221 .display
34222 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
34223 .endd
34224 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
34225
34226
34227 .vitem &*void&~debug_printf(char&~*,&~...)*&
34228 This is Exim's debugging function, with arguments as for &'(printf()'&. The
34229 output is written to the standard error stream. If no debugging is selected,
34230 calls to &'debug_printf()'& have no effect. Normally, you should make calls
34231 conditional on the &`local_scan`& debug selector by coding like this:
34232 .code
34233 if ((debug_selector & D_local_scan) != 0)
34234   debug_printf("xxx", ...);
34235 .endd
34236
34237 .vitem &*uschar&~*expand_string(uschar&~*string)*&
34238 This is an interface to Exim's string expansion code. The return value is the
34239 expanded string, or NULL if there was an expansion failure.
34240 The C variable &%expand_string_message%& contains an error message after an
34241 expansion failure. If expansion does not change the string, the return value is
34242 the pointer to the input string. Otherwise, the return value points to a new
34243 block of memory that was obtained by a call to &'store_get()'&. See section
34244 &<<SECTmemhanloc>>& below for a discussion of memory handling.
34245
34246 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
34247 This function allows you to an add additional header line at the end of the
34248 existing ones. The first argument is the type, and should normally be a space
34249 character. The second argument is a format string and any number of
34250 substitution arguments as for &[sprintf()]&. You may include internal newlines
34251 if you want, and you must ensure that the string ends with a newline.
34252
34253 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
34254         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
34255 This function adds a new header line at a specified point in the header
34256 chain. The header itself is specified as for &'header_add()'&.
34257
34258 If &%name%& is NULL, the new header is added at the end of the chain if
34259 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
34260 NULL, the header lines are searched for the first non-deleted header that
34261 matches the name. If one is found, the new header is added before it if
34262 &%after%& is false. If &%after%& is true, the new header is added after the
34263 found header and any adjacent subsequent ones with the same name (even if
34264 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
34265 option controls where the header is added. If it is true, addition is at the
34266 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
34267 headers, or at the top if there are no &'Received:'& headers, you could use
34268 .code
34269 header_add_at_position(TRUE, US"Received", TRUE,
34270   ' ', "X-xxx: ...");
34271 .endd
34272 Normally, there is always at least one non-deleted &'Received:'& header, but
34273 there may not be if &%received_header_text%& expands to an empty string.
34274
34275
34276 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
34277 This function removes header lines. If &%occurrence%& is zero or negative, all
34278 occurrences of the header are removed. If occurrence is greater than zero, that
34279 particular instance of the header is removed. If no header(s) can be found that
34280 match the specification, the function does nothing.
34281
34282
34283 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
34284         int&~length,&~BOOL&~notdel)*&"
34285 This function tests whether the given header has the given name. It is not just
34286 a string comparison, because white space is permitted between the name and the
34287 colon. If the &%notdel%& argument is true, a false return is forced for all
34288 &"deleted"& headers; otherwise they are not treated specially. For example:
34289 .code
34290 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
34291 .endd
34292 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
34293 .cindex "base64 encoding" "functions for &[local_scan()]& use"
34294 This function base64-encodes a string, which is passed by address and length.
34295 The text may contain bytes of any value, including zero. The result is passed
34296 back in dynamic memory that is obtained by calling &'store_get()'&. It is
34297 zero-terminated.
34298
34299 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
34300 This function decodes a base64-encoded string. Its arguments are a
34301 zero-terminated base64-encoded string and the address of a variable that is set
34302 to point to the result, which is in dynamic memory. The length of the decoded
34303 string is the yield of the function. If the input is invalid base64 data, the
34304 yield is -1. A zero byte is added to the end of the output string to make it
34305 easy to interpret as a C string (assuming it contains no zeros of its own). The
34306 added zero byte is not included in the returned count.
34307
34308 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
34309 This function checks for a match in a domain list. Domains are always
34310 matched caselessly. The return value is one of the following:
34311 .display
34312 &`OK     `& match succeeded
34313 &`FAIL   `& match failed
34314 &`DEFER  `& match deferred
34315 .endd
34316 DEFER is usually caused by some kind of lookup defer, such as the
34317 inability to contact a database.
34318
34319 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
34320         BOOL&~caseless)*&"
34321 This function checks for a match in a local part list. The third argument
34322 controls case-sensitivity. The return values are as for
34323 &'lss_match_domain()'&.
34324
34325 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
34326         BOOL&~caseless)*&"
34327 This function checks for a match in an address list. The third argument
34328 controls the case-sensitivity of the local part match. The domain is always
34329 matched caselessly. The return values are as for &'lss_match_domain()'&.
34330
34331 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
34332         uschar&~*list)*&"
34333 This function checks for a match in a host list. The most common usage is
34334 expected to be
34335 .code
34336 lss_match_host(sender_host_name, sender_host_address, ...)
34337 .endd
34338 .vindex "&$sender_host_address$&"
34339 An empty address field matches an empty item in the host list. If the host name
34340 is NULL, the name corresponding to &$sender_host_address$& is automatically
34341 looked up if a host name is required to match an item in the list. The return
34342 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
34343 returns ERROR in the case when it had to look up a host name, but the lookup
34344 failed.
34345
34346 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
34347         *format,&~...)*&"
34348 This function writes to Exim's log files. The first argument should be zero (it
34349 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
34350 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
34351 them. It specifies to which log or logs the message is written. The remaining
34352 arguments are a format and relevant insertion arguments. The string should not
34353 contain any newlines, not even at the end.
34354
34355
34356 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
34357 This function adds an additional recipient to the message. The first argument
34358 is the recipient address. If it is unqualified (has no domain), it is qualified
34359 with the &%qualify_recipient%& domain. The second argument must always be -1.
34360
34361 This function does not allow you to specify a private &%errors_to%& address (as
34362 described with the structure of &%recipient_item%& above), because it pre-dates
34363 the addition of that field to the structure. However, it is easy to add such a
34364 value afterwards. For example:
34365 .code
34366  receive_add_recipient(US"monitor@mydom.example", -1);
34367  recipients_list[recipients_count-1].errors_to =
34368    US"postmaster@mydom.example";
34369 .endd
34370
34371 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
34372 This is a convenience function to remove a named recipient from the list of
34373 recipients. It returns true if a recipient was removed, and false if no
34374 matching recipient could be found. The argument must be a complete email
34375 address.
34376 .endlist
34377
34378
34379 .cindex "RFC 2047"
34380 .vlist
34381 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
34382   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
34383 This function decodes strings that are encoded according to RFC 2047. Typically
34384 these are the contents of header lines. First, each &"encoded word"& is decoded
34385 from the Q or B encoding into a byte-string. Then, if provided with the name of
34386 a charset encoding, and if the &[iconv()]& function is available, an attempt is
34387 made  to translate the result to the named character set. If this fails, the
34388 binary string is returned with an error message.
34389
34390 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
34391 maximum MIME word length is enforced. The third argument is the target
34392 encoding, or NULL if no translation is wanted.
34393
34394 .cindex "binary zero" "in RFC 2047 decoding"
34395 .cindex "RFC 2047" "binary zero in"
34396 If a binary zero is encountered in the decoded string, it is replaced by the
34397 contents of the &%zeroval%& argument. For use with Exim headers, the value must
34398 not be 0 because header lines are handled as zero-terminated strings.
34399
34400 The function returns the result of processing the string, zero-terminated; if
34401 &%lenptr%& is not NULL, the length of the result is set in the variable to
34402 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
34403
34404 If an error is encountered, the function returns NULL and uses the &%error%&
34405 argument to return an error message. The variable pointed to by &%error%& is
34406 set to NULL if there is no error; it may be set non-NULL even when the function
34407 returns a non-NULL value if decoding was successful, but there was a problem
34408 with translation.
34409
34410
34411 .vitem &*int&~smtp_fflush(void)*&
34412 This function is used in conjunction with &'smtp_printf()'&, as described
34413 below.
34414
34415 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
34416 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
34417 output stream. You should use this function only when there is an SMTP output
34418 stream, that is, when the incoming message is being received via interactive
34419 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
34420 is FALSE. If you want to test for an incoming message from another host (as
34421 opposed to a local process that used the &%-bs%& command line option), you can
34422 test the value of &%sender_host_address%&, which is non-NULL when a remote host
34423 is involved.
34424
34425 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
34426 output function, so it can be used for all forms of SMTP connection.
34427
34428 The second argument is used to request that the data be buffered
34429 (when TRUE) or flushed (along with any previously buffered, when FALSE).
34430 This is advisory only, but likely to save on system-calls and packets
34431 sent when a sequence of calls to the function are made.
34432
34433 The argument was added in Exim version 4.90 - changing the API/ABI.
34434 Nobody noticed until 4.93 was imminent, at which point the
34435 ABI version number was incremented.
34436
34437 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
34438 must start with an appropriate response code: 550 if you are going to return
34439 LOCAL_SCAN_REJECT, 451 if you are going to return
34440 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
34441 initial lines of a multi-line response, the code must be followed by a hyphen
34442 to indicate that the line is not the final response line. You must also ensure
34443 that the lines you write terminate with CRLF. For example:
34444 .code
34445 smtp_printf("550-this is some extra info\r\n");
34446 return LOCAL_SCAN_REJECT;
34447 .endd
34448 Note that you can also create multi-line responses by including newlines in
34449 the data returned via the &%return_text%& argument. The added value of using
34450 &'smtp_printf()'& is that, for instance, you could introduce delays between
34451 multiple output lines.
34452
34453 The &'smtp_printf()'& function does not return any error indication, because it
34454 does not
34455 guarantee a flush of
34456 pending output, and therefore does not test
34457 the state of the stream. (In the main code of Exim, flushing and error
34458 detection is done when Exim is ready for the next SMTP input command.) If
34459 you want to flush the output and check for an error (for example, the
34460 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
34461 arguments. It flushes the output stream, and returns a non-zero value if there
34462 is an error.
34463
34464 .new
34465 .vitem &*void&~*store_get(int,BOOL)*&
34466 This function accesses Exim's internal store (memory) manager. It gets a new
34467 chunk of memory whose size is given by the first argument.
34468 The second argument should be given as TRUE if the memory will be used for
34469 data possibly coming from an attacker (eg. the message content),
34470 FALSE if it is locally-sourced.
34471 Exim bombs out if it ever
34472 runs out of memory. See the next section for a discussion of memory handling.
34473 .wen
34474
34475 .vitem &*void&~*store_get_perm(int,BOOL)*&
34476 This function is like &'store_get()'&, but it always gets memory from the
34477 permanent pool. See the next section for a discussion of memory handling.
34478
34479 .vitem &*uschar&~*string_copy(uschar&~*string)*&
34480 See below.
34481
34482 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
34483 See below.
34484
34485 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
34486 These three functions create strings using Exim's dynamic memory facilities.
34487 The first makes a copy of an entire string. The second copies up to a maximum
34488 number of characters, indicated by the second argument. The third uses a format
34489 and insertion arguments to create a new string. In each case, the result is a
34490 pointer to a new string in the current memory pool. See the next section for
34491 more discussion.
34492 .endlist
34493
34494
34495
34496 .section "More about Exim's memory handling" "SECTmemhanloc"
34497 .cindex "&[local_scan()]& function" "memory handling"
34498 No function is provided for freeing memory, because that is never needed.
34499 The dynamic memory that Exim uses when receiving a message is automatically
34500 recycled if another message is received by the same process (this applies only
34501 to incoming SMTP connections &-- other input methods can supply only one
34502 message at a time). After receiving the last message, a reception process
34503 terminates.
34504
34505 Because it is recycled, the normal dynamic memory cannot be used for holding
34506 data that must be preserved over a number of incoming messages on the same SMTP
34507 connection. However, Exim in fact uses two pools of dynamic memory; the second
34508 one is not recycled, and can be used for this purpose.
34509
34510 If you want to allocate memory that remains available for subsequent messages
34511 in the same SMTP connection, you should set
34512 .code
34513 store_pool = POOL_PERM
34514 .endd
34515 before calling the function that does the allocation. There is no need to
34516 restore the value if you do not need to; however, if you do want to revert to
34517 the normal pool, you can either restore the previous value of &%store_pool%& or
34518 set it explicitly to POOL_MAIN.
34519
34520 The pool setting applies to all functions that get dynamic memory, including
34521 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
34522 There is also a convenience function called &'store_get_perm()'& that gets a
34523 block of memory from the permanent pool while preserving the value of
34524 &%store_pool%&.
34525 .ecindex IIDlosca
34526
34527
34528
34529
34530 . ////////////////////////////////////////////////////////////////////////////
34531 . ////////////////////////////////////////////////////////////////////////////
34532
34533 .chapter "System-wide message filtering" "CHAPsystemfilter"
34534 .scindex IIDsysfil1 "filter" "system filter"
34535 .scindex IIDsysfil2 "filtering all mail"
34536 .scindex IIDsysfil3 "system filter"
34537 The previous chapters (on ACLs and the local scan function) describe checks
34538 that can be applied to messages before they are accepted by a host. There is
34539 also a mechanism for checking messages once they have been received, but before
34540 they are delivered. This is called the &'system filter'&.
34541
34542 The system filter operates in a similar manner to users' filter files, but it
34543 is run just once per message (however many recipients the message has).
34544 It should not normally be used as a substitute for routing, because &%deliver%&
34545 commands in a system router provide new envelope recipient addresses.
34546 The system filter must be an Exim filter. It cannot be a Sieve filter.
34547
34548 The system filter is run at the start of a delivery attempt, before any routing
34549 is done. If a message fails to be completely delivered at the first attempt,
34550 the system filter is run again at the start of every retry.
34551 If you want your filter to do something only once per message, you can make use
34552 of the &%first_delivery%& condition in an &%if%& command in the filter to
34553 prevent it happening on retries.
34554
34555 .vindex "&$domain$&"
34556 .vindex "&$local_part$&"
34557 &*Warning*&: Because the system filter runs just once, variables that are
34558 specific to individual recipient addresses, such as &$local_part$& and
34559 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
34560 you want to run a centrally-specified filter for each recipient address
34561 independently, you can do so by setting up a suitable &(redirect)& router, as
34562 described in section &<<SECTperaddfil>>& below.
34563
34564
34565 .section "Specifying a system filter" "SECID212"
34566 .cindex "uid (user id)" "system filter"
34567 .cindex "gid (group id)" "system filter"
34568 The name of the file that contains the system filter must be specified by
34569 setting &%system_filter%&. If you want the filter to run under a uid and gid
34570 other than root, you must also set &%system_filter_user%& and
34571 &%system_filter_group%& as appropriate. For example:
34572 .code
34573 system_filter = /etc/mail/exim.filter
34574 system_filter_user = exim
34575 .endd
34576 If a system filter generates any deliveries directly to files or pipes (via the
34577 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
34578 specified by setting &%system_filter_file_transport%& and
34579 &%system_filter_pipe_transport%&, respectively. Similarly,
34580 &%system_filter_reply_transport%& must be set to handle any messages generated
34581 by the &%reply%& command.
34582
34583
34584 .section "Testing a system filter" "SECID213"
34585 You can run simple tests of a system filter in the same way as for a user
34586 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
34587 are permitted only in system filters are recognized.
34588
34589 If you want to test the combined effect of a system filter and a user filter,
34590 you can use both &%-bF%& and &%-bf%& on the same command line.
34591
34592
34593
34594 .section "Contents of a system filter" "SECID214"
34595 The language used to specify system filters is the same as for users' filter
34596 files. It is described in the separate end-user document &'Exim's interface to
34597 mail filtering'&. However, there are some additional features that are
34598 available only in system filters; these are described in subsequent sections.
34599 If they are encountered in a user's filter file or when testing with &%-bf%&,
34600 they cause errors.
34601
34602 .cindex "frozen messages" "manual thaw; testing in filter"
34603 There are two special conditions which, though available in users' filter
34604 files, are designed for use in system filters. The condition &%first_delivery%&
34605 is true only for the first attempt at delivering a message, and
34606 &%manually_thawed%& is true only if the message has been frozen, and
34607 subsequently thawed by an admin user. An explicit forced delivery counts as a
34608 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
34609
34610 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
34611 specify an &"unseen"& (non-significant) delivery, and that delivery does not
34612 succeed, it will not be tried again.
34613 If you want Exim to retry an unseen delivery until it succeeds, you should
34614 arrange to set it up every time the filter runs.
34615
34616 When a system filter finishes running, the values of the variables &$n0$& &--
34617 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
34618 users' filter files. Thus a system filter can, for example, set up &"scores"&
34619 to which users' filter files can refer.
34620
34621
34622
34623 .section "Additional variable for system filters" "SECID215"
34624 .vindex "&$recipients$&"
34625 The expansion variable &$recipients$&, containing a list of all the recipients
34626 of the message (separated by commas and white space), is available in system
34627 filters. It is not available in users' filters for privacy reasons.
34628
34629
34630
34631 .section "Defer, freeze, and fail commands for system filters" "SECID216"
34632 .cindex "freezing messages"
34633 .cindex "message" "freezing"
34634 .cindex "message" "forced failure"
34635 .cindex "&%fail%&" "in system filter"
34636 .cindex "&%freeze%& in system filter"
34637 .cindex "&%defer%& in system filter"
34638 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
34639 always available in system filters, but are not normally enabled in users'
34640 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
34641 for the &(redirect)& router.) These commands can optionally be followed by the
34642 word &%text%& and a string containing an error message, for example:
34643 .code
34644 fail text "this message looks like spam to me"
34645 .endd
34646 The keyword &%text%& is optional if the next character is a double quote.
34647
34648 The &%defer%& command defers delivery of the original recipients of the
34649 message. The &%fail%& command causes all the original recipients to be failed,
34650 and a bounce message to be created. The &%freeze%& command suspends all
34651 delivery attempts for the original recipients. In all cases, any new deliveries
34652 that are specified by the filter are attempted as normal after the filter has
34653 run.
34654
34655 The &%freeze%& command is ignored if the message has been manually unfrozen and
34656 not manually frozen since. This means that automatic freezing by a system
34657 filter can be used as a way of checking out suspicious messages. If a message
34658 is found to be all right, manually unfreezing it allows it to be delivered.
34659
34660 .cindex "log" "&%fail%& command log line"
34661 .cindex "&%fail%&" "log line; reducing"
34662 The text given with a fail command is used as part of the bounce message as
34663 well as being written to the log. If the message is quite long, this can fill
34664 up a lot of log space when such failures are common. To reduce the size of the
34665 log message, Exim interprets the text in a special way if it starts with the
34666 two characters &`<<`& and contains &`>>`& later. The text between these two
34667 strings is written to the log, and the rest of the text is used in the bounce
34668 message. For example:
34669 .code
34670 fail "<<filter test 1>>Your message is rejected \
34671      because it contains attachments that we are \
34672      not prepared to receive."
34673 .endd
34674
34675 .cindex "loop" "caused by &%fail%&"
34676 Take great care with the &%fail%& command when basing the decision to fail on
34677 the contents of the message, because the bounce message will of course include
34678 the contents of the original message and will therefore trigger the &%fail%&
34679 command again (causing a mail loop) unless steps are taken to prevent this.
34680 Testing the &%error_message%& condition is one way to prevent this. You could
34681 use, for example
34682 .code
34683 if $message_body contains "this is spam" and not error_message
34684 then fail text "spam is not wanted here" endif
34685 .endd
34686 though of course that might let through unwanted bounce messages. The
34687 alternative is clever checking of the body and/or headers to detect bounces
34688 generated by the filter.
34689
34690 The interpretation of a system filter file ceases after a
34691 &%defer%&,
34692 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
34693 set up earlier in the filter file are honoured, so you can use a sequence such
34694 as
34695 .code
34696 mail ...
34697 freeze
34698 .endd
34699 to send a specified message when the system filter is freezing (or deferring or
34700 failing) a message. The normal deliveries for the message do not, of course,
34701 take place.
34702
34703
34704
34705 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
34706 .cindex "header lines" "adding; in system filter"
34707 .cindex "header lines" "removing; in system filter"
34708 .cindex "filter" "header lines; adding/removing"
34709 Two filter commands that are available only in system filters are:
34710 .code
34711 headers add <string>
34712 headers remove <string>
34713 .endd
34714 The argument for the &%headers add%& is a string that is expanded and then
34715 added to the end of the message's headers. It is the responsibility of the
34716 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
34717 space is ignored, and if the string is otherwise empty, or if the expansion is
34718 forced to fail, the command has no effect.
34719
34720 You can use &"\n"& within the string, followed by white space, to specify
34721 continued header lines. More than one header may be added in one command by
34722 including &"\n"& within the string without any following white space. For
34723 example:
34724 .code
34725 headers add "X-header-1: ....\n  \
34726              continuation of X-header-1 ...\n\
34727              X-header-2: ...."
34728 .endd
34729 Note that the header line continuation white space after the first newline must
34730 be placed before the backslash that continues the input string, because white
34731 space after input continuations is ignored.
34732
34733 The argument for &%headers remove%& is a colon-separated list of header names.
34734 This command applies only to those headers that are stored with the message;
34735 those that are added at delivery time (such as &'Envelope-To:'& and
34736 &'Return-Path:'&) cannot be removed by this means. If there is more than one
34737 header with the same name, they are all removed.
34738
34739 The &%headers%& command in a system filter makes an immediate change to the set
34740 of header lines that was received with the message (with possible additions
34741 from ACL processing). Subsequent commands in the system filter operate on the
34742 modified set, which also forms the basis for subsequent message delivery.
34743 Unless further modified during routing or transporting, this set of headers is
34744 used for all recipients of the message.
34745
34746 During routing and transporting, the variables that refer to the contents of
34747 header lines refer only to those lines that are in this set. Thus, header lines
34748 that are added by a system filter are visible to users' filter files and to all
34749 routers and transports. This contrasts with the manipulation of header lines by
34750 routers and transports, which is not immediate, but which instead is saved up
34751 until the message is actually being written (see section
34752 &<<SECTheadersaddrem>>&).
34753
34754 If the message is not delivered at the first attempt, header lines that were
34755 added by the system filter are stored with the message, and so are still
34756 present at the next delivery attempt. Header lines that were removed are still
34757 present, but marked &"deleted"& so that they are not transported with the
34758 message. For this reason, it is usual to make the &%headers%& command
34759 conditional on &%first_delivery%& so that the set of header lines is not
34760 modified more than once.
34761
34762 Because header modification in a system filter acts immediately, you have to
34763 use an indirect approach if you want to modify the contents of a header line.
34764 For example:
34765 .code
34766 headers add "Old-Subject: $h_subject:"
34767 headers remove "Subject"
34768 headers add "Subject: new subject (was: $h_old-subject:)"
34769 headers remove "Old-Subject"
34770 .endd
34771
34772
34773
34774 .section "Setting an errors address in a system filter" "SECID217"
34775 .cindex "envelope from"
34776 .cindex "envelope sender"
34777 In a system filter, if a &%deliver%& command is followed by
34778 .code
34779 errors_to <some address>
34780 .endd
34781 in order to change the envelope sender (and hence the error reporting) for that
34782 delivery, any address may be specified. (In a user filter, only the current
34783 user's address can be set.) For example, if some mail is being monitored, you
34784 might use
34785 .code
34786 unseen deliver monitor@spying.example errors_to root@local.example
34787 .endd
34788 to take a copy which would not be sent back to the normal error reporting
34789 address if its delivery failed.
34790
34791
34792
34793 .section "Per-address filtering" "SECTperaddfil"
34794 .vindex "&$domain$&"
34795 .vindex "&$local_part$&"
34796 In contrast to the system filter, which is run just once per message for each
34797 delivery attempt, it is also possible to set up a system-wide filtering
34798 operation that runs once for each recipient address. In this case, variables
34799 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
34800 filter file could be made dependent on them. This is an example of a router
34801 which implements such a filter:
34802 .code
34803 central_filter:
34804   check_local_user
34805   driver = redirect
34806   domains = +local_domains
34807   file = /central/filters/$local_part
34808   no_verify
34809   allow_filter
34810   allow_freeze
34811 .endd
34812 The filter is run in a separate process under its own uid. Therefore, either
34813 &%check_local_user%& must be set (as above), in which case the filter is run as
34814 the local user, or the &%user%& option must be used to specify which user to
34815 use. If both are set, &%user%& overrides.
34816
34817 Care should be taken to ensure that none of the commands in the filter file
34818 specify a significant delivery if the message is to go on to be delivered to
34819 its intended recipient. The router will not then claim to have dealt with the
34820 address, so it will be passed on to subsequent routers to be delivered in the
34821 normal way.
34822 .ecindex IIDsysfil1
34823 .ecindex IIDsysfil2
34824 .ecindex IIDsysfil3
34825
34826
34827
34828
34829
34830
34831 . ////////////////////////////////////////////////////////////////////////////
34832 . ////////////////////////////////////////////////////////////////////////////
34833
34834 .chapter "Message processing" "CHAPmsgproc"
34835 .scindex IIDmesproc "message" "general processing"
34836 Exim performs various transformations on the sender and recipient addresses of
34837 all messages that it handles, and also on the messages' header lines. Some of
34838 these are optional and configurable, while others always take place. All of
34839 this processing, except rewriting as a result of routing, and the addition or
34840 removal of header lines while delivering, happens when a message is received,
34841 before it is placed on Exim's queue.
34842
34843 Some of the automatic processing takes place by default only for
34844 &"locally-originated"& messages. This adjective is used to describe messages
34845 that are not received over TCP/IP, but instead are passed to an Exim process on
34846 its standard input. This includes the interactive &"local SMTP"& case that is
34847 set up by the &%-bs%& command line option.
34848
34849 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
34850 or ::1) are not considered to be locally-originated. Exim does not treat the
34851 loopback interface specially in any way.
34852
34853 If you want the loopback interface to be treated specially, you must ensure
34854 that there are appropriate entries in your ACLs.
34855
34856
34857
34858
34859 .section "Submission mode for non-local messages" "SECTsubmodnon"
34860 .cindex "message" "submission"
34861 .cindex "submission mode"
34862 Processing that happens automatically for locally-originated messages (unless
34863 &%suppress_local_fixups%& is set) can also be requested for messages that are
34864 received over TCP/IP. The term &"submission mode"& is used to describe this
34865 state. Submission mode is set by the modifier
34866 .code
34867 control = submission
34868 .endd
34869 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
34870 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
34871 a local submission, and is normally used when the source of the message is
34872 known to be an MUA running on a client host (as opposed to an MTA). For
34873 example, to set submission mode for messages originating on the IPv4 loopback
34874 interface, you could include the following in the MAIL ACL:
34875 .code
34876 warn  hosts = 127.0.0.1
34877       control = submission
34878 .endd
34879 .cindex "&%sender_retain%& submission option"
34880 There are some options that can be used when setting submission mode. A slash
34881 is used to separate options. For example:
34882 .code
34883 control = submission/sender_retain
34884 .endd
34885 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
34886 true and &%local_from_check%& false for the current incoming message. The first
34887 of these allows an existing &'Sender:'& header in the message to remain, and
34888 the second suppresses the check to ensure that &'From:'& matches the
34889 authenticated sender. With this setting, Exim still fixes up messages by adding
34890 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
34891 attempt to check sender authenticity in header lines.
34892
34893 When &%sender_retain%& is not set, a submission mode setting may specify a
34894 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
34895 example:
34896 .code
34897 control = submission/domain=some.domain
34898 .endd
34899 The domain may be empty. How this value is used is described in sections
34900 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
34901 that allows you to specify the user's full name for inclusion in a created
34902 &'Sender:'& or &'From:'& header line. For example:
34903 .code
34904 accept authenticated = *
34905        control = submission/domain=wonderland.example/\
34906                             name=${lookup {$authenticated_id} \
34907                                    lsearch {/etc/exim/namelist}}
34908 .endd
34909 Because the name may contain any characters, including slashes, the &%name%&
34910 option must be given last. The remainder of the string is used as the name. For
34911 the example above, if &_/etc/exim/namelist_& contains:
34912 .code
34913 bigegg:  Humpty Dumpty
34914 .endd
34915 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
34916 line would be:
34917 .code
34918 Sender: Humpty Dumpty <bigegg@wonderland.example>
34919 .endd
34920 .cindex "return path" "in submission mode"
34921 By default, submission mode forces the return path to the same address as is
34922 used to create the &'Sender:'& header. However, if &%sender_retain%& is
34923 specified, the return path is also left unchanged.
34924
34925 &*Note*&: The changes caused by submission mode take effect after the predata
34926 ACL. This means that any sender checks performed before the fix-ups use the
34927 untrusted sender address specified by the user, not the trusted sender address
34928 specified by submission mode. Although this might be slightly unexpected, it
34929 does mean that you can configure ACL checks to spot that a user is trying to
34930 spoof another's address.
34931
34932 .section "Line endings" "SECTlineendings"
34933 .cindex "line endings"
34934 .cindex "carriage return"
34935 .cindex "linefeed"
34936 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
34937 linefeed) is the line ending for messages transmitted over the Internet using
34938 SMTP over TCP/IP. However, within individual operating systems, different
34939 conventions are used. For example, Unix-like systems use just LF, but others
34940 use CRLF or just CR.
34941
34942 Exim was designed for Unix-like systems, and internally, it stores messages
34943 using the system's convention of a single LF as a line terminator. When
34944 receiving a message, all line endings are translated to this standard format.
34945 Originally, it was thought that programs that passed messages directly to an
34946 MTA within an operating system would use that system's convention. Experience
34947 has shown that this is not the case; for example, there are Unix applications
34948 that use CRLF in this circumstance. For this reason, and for compatibility with
34949 other MTAs, the way Exim handles line endings for all messages is now as
34950 follows:
34951
34952 .ilist
34953 LF not preceded by CR is treated as a line ending.
34954 .next
34955 CR is treated as a line ending; if it is immediately followed by LF, the LF
34956 is ignored.
34957 .next
34958 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
34959 nor a local message in the state where a line containing only a dot is a
34960 terminator.
34961 .next
34962 If a bare CR is encountered within a header line, an extra space is added after
34963 the line terminator so as not to end the header line. The reasoning behind this
34964 is that bare CRs in header lines are most likely either to be mistakes, or
34965 people trying to play silly games.
34966 .next
34967 If the first header line received in a message ends with CRLF, a subsequent
34968 bare LF in a header line is treated in the same way as a bare CR in a header
34969 line.
34970 .endlist
34971
34972
34973
34974
34975
34976 .section "Unqualified addresses" "SECID218"
34977 .cindex "unqualified addresses"
34978 .cindex "address" "qualification"
34979 By default, Exim expects every envelope address it receives from an external
34980 host to be fully qualified. Unqualified addresses cause negative responses to
34981 SMTP commands. However, because SMTP is used as a means of transporting
34982 messages from MUAs running on personal workstations, there is sometimes a
34983 requirement to accept unqualified addresses from specific hosts or IP networks.
34984
34985 Exim has two options that separately control which hosts may send unqualified
34986 sender or recipient addresses in SMTP commands, namely
34987 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
34988 cases, if an unqualified address is accepted, it is qualified by adding the
34989 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
34990
34991 .oindex "&%qualify_domain%&"
34992 .oindex "&%qualify_recipient%&"
34993 Unqualified addresses in header lines are automatically qualified for messages
34994 that are locally originated, unless the &%-bnq%& option is given on the command
34995 line. For messages received over SMTP, unqualified addresses in header lines
34996 are qualified only if unqualified addresses are permitted in SMTP commands. In
34997 other words, such qualification is also controlled by
34998 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
34999
35000
35001
35002
35003 .section "The UUCP From line" "SECID219"
35004 .cindex "&""From""& line"
35005 .cindex "UUCP" "&""From""& line"
35006 .cindex "sender" "address"
35007 .oindex "&%uucp_from_pattern%&"
35008 .oindex "&%uucp_from_sender%&"
35009 .cindex "envelope from"
35010 .cindex "envelope sender"
35011 .cindex "Sendmail compatibility" "&""From""& line"
35012 Messages that have come from UUCP (and some other applications) often begin
35013 with a line containing the envelope sender and a timestamp, following the word
35014 &"From"&. Examples of two common formats are:
35015 .code
35016 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
35017 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
35018 .endd
35019 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
35020 Exim recognizes such lines at the start of messages that are submitted to it
35021 via the command line (that is, on the standard input). It does not recognize
35022 such lines in incoming SMTP messages, unless the sending host matches
35023 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
35024 and &%ignore_fromline_local%& is set. The recognition is controlled by a
35025 regular expression that is defined by the &%uucp_from_pattern%& option, whose
35026 default value matches the two common cases shown above and puts the address
35027 that follows &"From"& into &$1$&.
35028
35029 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
35030 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
35031 a trusted user, the message's sender address is constructed by expanding the
35032 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
35033 then parsed as an RFC 2822 address. If there is no domain, the local part is
35034 qualified with &%qualify_domain%& unless it is the empty string. However, if
35035 the command line &%-f%& option is used, it overrides the &"From"& line.
35036
35037 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
35038 sender address is not changed. This is also the case for incoming SMTP messages
35039 that are permitted to contain &"From"& lines.
35040
35041 Only one &"From"& line is recognized. If there is more than one, the second is
35042 treated as a data line that starts the body of the message, as it is not valid
35043 as a header line. This also happens if a &"From"& line is present in an
35044 incoming SMTP message from a source that is not permitted to send them.
35045
35046
35047
35048 .section "Resent- header lines" "SECID220"
35049 .cindex "&%Resent-%& header lines"
35050 .cindex "header lines" "Resent-"
35051 RFC 2822 makes provision for sets of header lines starting with the string
35052 &`Resent-`& to be added to a message when it is resent by the original
35053 recipient to somebody else. These headers are &'Resent-Date:'&,
35054 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
35055 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
35056
35057 .blockquote
35058 &'Resent fields are strictly informational. They MUST NOT be used in the normal
35059 processing of replies or other such automatic actions on messages.'&
35060 .endblockquote
35061
35062 This leaves things a bit vague as far as other processing actions such as
35063 address rewriting are concerned. Exim treats &%Resent-%& header lines as
35064 follows:
35065
35066 .ilist
35067 A &'Resent-From:'& line that just contains the login id of the submitting user
35068 is automatically rewritten in the same way as &'From:'& (see below).
35069 .next
35070 If there's a rewriting rule for a particular header line, it is also applied to
35071 &%Resent-%& header lines of the same type. For example, a rule that rewrites
35072 &'From:'& also rewrites &'Resent-From:'&.
35073 .next
35074 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
35075 also removed.
35076 .next
35077 For a locally-submitted message,
35078 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
35079 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
35080 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
35081 included in log lines in this case.
35082 .next
35083 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
35084 &%Resent-%& header lines are present.
35085 .endlist
35086
35087
35088
35089
35090 .section "The Auto-Submitted: header line" "SECID221"
35091 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
35092 includes the header line:
35093 .code
35094 Auto-Submitted: auto-replied
35095 .endd
35096
35097 .section "The Bcc: header line" "SECID222"
35098 .cindex "&'Bcc:'& header line"
35099 If Exim is called with the &%-t%& option, to take recipient addresses from a
35100 message's header, it removes any &'Bcc:'& header line that may exist (after
35101 extracting its addresses). If &%-t%& is not present on the command line, any
35102 existing &'Bcc:'& is not removed.
35103
35104
35105 .section "The Date: header line" "SECID223"
35106 .cindex "&'Date:'& header line"
35107 .cindex "header lines" "Date:"
35108 If a locally-generated or submission-mode message has no &'Date:'& header line,
35109 Exim adds one, using the current date and time, unless the
35110 &%suppress_local_fixups%& control has been specified.
35111
35112 .section "The Delivery-date: header line" "SECID224"
35113 .cindex "&'Delivery-date:'& header line"
35114 .oindex "&%delivery_date_remove%&"
35115 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
35116 set. Exim can be configured to add them to the final delivery of messages. (See
35117 the generic &%delivery_date_add%& transport option.) They should not be present
35118 in messages in transit. If the &%delivery_date_remove%& configuration option is
35119 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
35120 messages.
35121
35122
35123 .section "The Envelope-to: header line" "SECID225"
35124 .cindex "&'Envelope-to:'& header line"
35125 .cindex "header lines" "Envelope-to:"
35126 .oindex "&%envelope_to_remove%&"
35127 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
35128 Exim can be configured to add them to the final delivery of messages. (See the
35129 generic &%envelope_to_add%& transport option.) They should not be present in
35130 messages in transit. If the &%envelope_to_remove%& configuration option is set
35131 (the default), Exim removes &'Envelope-to:'& header lines from incoming
35132 messages.
35133
35134
35135 .section "The From: header line" "SECTthefrohea"
35136 .cindex "&'From:'& header line"
35137 .cindex "header lines" "From:"
35138 .cindex "Sendmail compatibility" "&""From""& line"
35139 .cindex "message" "submission"
35140 .cindex "submission mode"
35141 If a submission-mode message does not contain a &'From:'& header line, Exim
35142 adds one if either of the following conditions is true:
35143
35144 .ilist
35145 The envelope sender address is not empty (that is, this is not a bounce
35146 message). The added header line copies the envelope sender address.
35147 .next
35148 .vindex "&$authenticated_id$&"
35149 The SMTP session is authenticated and &$authenticated_id$& is not empty.
35150 .olist
35151 .vindex "&$qualify_domain$&"
35152 If no domain is specified by the submission control, the local part is
35153 &$authenticated_id$& and the domain is &$qualify_domain$&.
35154 .next
35155 If a non-empty domain is specified by the submission control, the local
35156 part is &$authenticated_id$&, and the domain is the specified domain.
35157 .next
35158 If an empty domain is specified by the submission control,
35159 &$authenticated_id$& is assumed to be the complete address.
35160 .endlist
35161 .endlist
35162
35163 A non-empty envelope sender takes precedence.
35164
35165 If a locally-generated incoming message does not contain a &'From:'& header
35166 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
35167 containing the sender's address. The calling user's login name and full name
35168 are used to construct the address, as described in section &<<SECTconstr>>&.
35169 They are obtained from the password data by calling &[getpwuid()]& (but see the
35170 &%unknown_login%& configuration option). The address is qualified with
35171 &%qualify_domain%&.
35172
35173 For compatibility with Sendmail, if an incoming, non-SMTP message has a
35174 &'From:'& header line containing just the unqualified login name of the calling
35175 user, this is replaced by an address containing the user's login name and full
35176 name as described in section &<<SECTconstr>>&.
35177
35178
35179 .section "The Message-ID: header line" "SECID226"
35180 .cindex "&'Message-ID:'& header line"
35181 .cindex "header lines" "Message-ID:"
35182 .cindex "message" "submission"
35183 .oindex "&%message_id_header_text%&"
35184 If a locally-generated or submission-mode incoming message does not contain a
35185 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
35186 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
35187 to the message. If there are any &'Resent-:'& headers in the message, it
35188 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
35189 message id, preceded by the letter E to ensure it starts with a letter, and
35190 followed by @ and the primary host name. Additional information can be included
35191 in this header line by setting the &%message_id_header_text%& and/or
35192 &%message_id_header_domain%& options.
35193
35194
35195 .section "The Received: header line" "SECID227"
35196 .cindex "&'Received:'& header line"
35197 .cindex "header lines" "Received:"
35198 A &'Received:'& header line is added at the start of every message. The
35199 contents are defined by the &%received_header_text%& configuration option, and
35200 Exim automatically adds a semicolon and a timestamp to the configured string.
35201
35202 The &'Received:'& header is generated as soon as the message's header lines
35203 have been received. At this stage, the timestamp in the &'Received:'& header
35204 line is the time that the message started to be received. This is the value
35205 that is seen by the DATA ACL and by the &[local_scan()]& function.
35206
35207 Once a message is accepted, the timestamp in the &'Received:'& header line is
35208 changed to the time of acceptance, which is (apart from a small delay while the
35209 -H spool file is written) the earliest time at which delivery could start.
35210
35211
35212 .section "The References: header line" "SECID228"
35213 .cindex "&'References:'& header line"
35214 .cindex "header lines" "References:"
35215 Messages created by the &(autoreply)& transport include a &'References:'&
35216 header line. This is constructed according to the rules that are described in
35217 section 3.64 of RFC 2822 (which states that replies should contain such a
35218 header line), and section 3.14 of RFC 3834 (which states that automatic
35219 responses are not different in this respect). However, because some mail
35220 processing software does not cope well with very long header lines, no more
35221 than 12 message IDs are copied from the &'References:'& header line in the
35222 incoming message. If there are more than 12, the first one and then the final
35223 11 are copied, before adding the message ID of the incoming message.
35224
35225
35226
35227 .section "The Return-path: header line" "SECID229"
35228 .cindex "&'Return-path:'& header line"
35229 .cindex "header lines" "Return-path:"
35230 .oindex "&%return_path_remove%&"
35231 &'Return-path:'& header lines are defined as something an MTA may insert when
35232 it does the final delivery of messages. (See the generic &%return_path_add%&
35233 transport option.) Therefore, they should not be present in messages in
35234 transit. If the &%return_path_remove%& configuration option is set (the
35235 default), Exim removes &'Return-path:'& header lines from incoming messages.
35236
35237
35238
35239 .section "The Sender: header line" "SECTthesenhea"
35240 .cindex "&'Sender:'& header line"
35241 .cindex "message" "submission"
35242 .cindex "header lines" "Sender:"
35243 For a locally-originated message from an untrusted user, Exim may remove an
35244 existing &'Sender:'& header line, and it may add a new one. You can modify
35245 these actions by setting the &%local_sender_retain%& option true, the
35246 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
35247 control setting.
35248
35249 When a local message is received from an untrusted user and
35250 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
35251 control has not been set, a check is made to see if the address given in the
35252 &'From:'& header line is the correct (local) sender of the message. The address
35253 that is expected has the login name as the local part and the value of
35254 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
35255 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
35256 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
35257 line is added to the message.
35258
35259 If you set &%local_from_check%& false, this checking does not occur. However,
35260 the removal of an existing &'Sender:'& line still happens, unless you also set
35261 &%local_sender_retain%& to be true. It is not possible to set both of these
35262 options true at the same time.
35263
35264 .cindex "submission mode"
35265 By default, no processing of &'Sender:'& header lines is done for messages
35266 received over TCP/IP or for messages submitted by trusted users. However, when
35267 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
35268 not specified on the submission control, the following processing takes place:
35269
35270 .vindex "&$authenticated_id$&"
35271 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
35272 authenticated, and &$authenticated_id$& is not empty, a sender address is
35273 created as follows:
35274
35275 .ilist
35276 .vindex "&$qualify_domain$&"
35277 If no domain is specified by the submission control, the local part is
35278 &$authenticated_id$& and the domain is &$qualify_domain$&.
35279 .next
35280 If a non-empty domain is specified by the submission control, the local part
35281 is &$authenticated_id$&, and the domain is the specified domain.
35282 .next
35283 If an empty domain is specified by the submission control,
35284 &$authenticated_id$& is assumed to be the complete address.
35285 .endlist
35286
35287 This address is compared with the address in the &'From:'& header line. If they
35288 are different, a &'Sender:'& header line containing the created address is
35289 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
35290 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
35291
35292 .cindex "return path" "created from &'Sender:'&"
35293 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
35294 the message (the envelope sender address) is changed to be the same address,
35295 except in the case of submission mode when &%sender_retain%& is specified.
35296
35297
35298
35299 .section "Adding and removing header lines in routers and transports" &&&
35300          "SECTheadersaddrem"
35301 .cindex "header lines" "adding; in router or transport"
35302 .cindex "header lines" "removing; in router or transport"
35303 When a message is delivered, the addition and removal of header lines can be
35304 specified in a system filter, or on any of the routers and transports that
35305 process the message. Section &<<SECTaddremheasys>>& contains details about
35306 modifying headers in a system filter. Header lines can also be added in an ACL
35307 as a message is received (see section &<<SECTaddheadacl>>&).
35308
35309 In contrast to what happens in a system filter, header modifications that are
35310 specified on routers and transports apply only to the particular recipient
35311 addresses that are being processed by those routers and transports. These
35312 changes do not actually take place until a copy of the message is being
35313 transported. Therefore, they do not affect the basic set of header lines, and
35314 they do not affect the values of the variables that refer to header lines.
35315
35316 &*Note*&: In particular, this means that any expansions in the configuration of
35317 the transport cannot refer to the modified header lines, because such
35318 expansions all occur before the message is actually transported.
35319
35320 For both routers and transports, the argument of a &%headers_add%&
35321 option must be in the form of one or more RFC 2822 header lines, separated by
35322 newlines (coded as &"\n"&). For example:
35323 .code
35324 headers_add = X-added-header: added by $primary_hostname\n\
35325               X-added-second: another added header line
35326 .endd
35327 Exim does not check the syntax of these added header lines.
35328
35329 Multiple &%headers_add%& options for a single router or transport can be
35330 specified; the values will append to a single list of header lines.
35331 Each header-line is separately expanded.
35332
35333 The argument of a &%headers_remove%& option must consist of a colon-separated
35334 list of header names. This is confusing, because header names themselves are
35335 often terminated by colons. In this case, the colons are the list separators,
35336 not part of the names. For example:
35337 .code
35338 headers_remove = return-receipt-to:acknowledge-to
35339 .endd
35340
35341 Multiple &%headers_remove%& options for a single router or transport can be
35342 specified; the arguments will append to a single header-names list.
35343 Each item is separately expanded.
35344 Note that colons in complex expansions which are used to
35345 form all or part of a &%headers_remove%& list
35346 will act as list separators.
35347
35348 When &%headers_add%& or &%headers_remove%& is specified on a router,
35349 items are expanded at routing time,
35350 and then associated with all addresses that are
35351 accepted by that router, and also with any new addresses that it generates. If
35352 an address passes through several routers as a result of aliasing or
35353 forwarding, the changes are cumulative.
35354
35355 .oindex "&%unseen%&"
35356 However, this does not apply to multiple routers that result from the use of
35357 the &%unseen%& option. Any header modifications that were specified by the
35358 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
35359
35360 Addresses that end up with different &%headers_add%& or &%headers_remove%&
35361 settings cannot be delivered together in a batch, so a transport is always
35362 dealing with a set of addresses that have the same header-processing
35363 requirements.
35364
35365 The transport starts by writing the original set of header lines that arrived
35366 with the message, possibly modified by the system filter. As it writes out
35367 these lines, it consults the list of header names that were attached to the
35368 recipient address(es) by &%headers_remove%& options in routers, and it also
35369 consults the transport's own &%headers_remove%& option. Header lines whose
35370 names are on either of these lists are not written out. If there are multiple
35371 instances of any listed header, they are all skipped.
35372
35373 After the remaining original header lines have been written, new header
35374 lines that were specified by routers' &%headers_add%& options are written, in
35375 the order in which they were attached to the address. These are followed by any
35376 header lines specified by the transport's &%headers_add%& option.
35377
35378 This way of handling header line modifications in routers and transports has
35379 the following consequences:
35380
35381 .ilist
35382 The original set of header lines, possibly modified by the system filter,
35383 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
35384 to it, at all times.
35385 .next
35386 Header lines that are added by a router's
35387 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
35388 expansion syntax in subsequent routers or the transport.
35389 .next
35390 Conversely, header lines that are specified for removal by &%headers_remove%&
35391 in a router remain visible to subsequent routers and the transport.
35392 .next
35393 Headers added to an address by &%headers_add%& in a router cannot be removed by
35394 a later router or by a transport.
35395 .next
35396 An added header can refer to the contents of an original header that is to be
35397 removed, even it has the same name as the added header. For example:
35398 .code
35399 headers_remove = subject
35400 headers_add = Subject: new subject (was: $h_subject:)
35401 .endd
35402 .endlist
35403
35404 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
35405 for a &(redirect)& router that has the &%one_time%& option set.
35406
35407
35408
35409
35410
35411 .section "Constructed addresses" "SECTconstr"
35412 .cindex "address" "constructed"
35413 .cindex "constructed address"
35414 When Exim constructs a sender address for a locally-generated message, it uses
35415 the form
35416 .display
35417 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
35418 .endd
35419 For example:
35420 .code
35421 Zaphod Beeblebrox <zaphod@end.univ.example>
35422 .endd
35423 The user name is obtained from the &%-F%& command line option if set, or
35424 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
35425 &"gecos"& field from the password entry. If the &"gecos"& field contains an
35426 ampersand character, this is replaced by the login name with the first letter
35427 upper cased, as is conventional in a number of operating systems. See the
35428 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
35429 The &%unknown_username%& option can be used to specify user names in cases when
35430 there is no password file entry.
35431
35432 .cindex "RFC 2047"
35433 In all cases, the user name is made to conform to RFC 2822 by quoting all or
35434 parts of it if necessary. In addition, if it contains any non-printing
35435 characters, it is encoded as described in RFC 2047, which defines a way of
35436 including non-ASCII characters in header lines. The value of the
35437 &%headers_charset%& option specifies the name of the encoding that is used (the
35438 characters are assumed to be in this encoding). The setting of
35439 &%print_topbitchars%& controls whether characters with the top bit set (that
35440 is, with codes greater than 127) count as printing characters or not.
35441
35442
35443
35444 .section "Case of local parts" "SECID230"
35445 .cindex "case of local parts"
35446 .cindex "local part" "case of"
35447 RFC 2822 states that the case of letters in the local parts of addresses cannot
35448 be assumed to be non-significant. Exim preserves the case of local parts of
35449 addresses, but by default it uses a lower-cased form when it is routing,
35450 because on most Unix systems, usernames are in lower case and case-insensitive
35451 routing is required. However, any particular router can be made to use the
35452 original case for local parts by setting the &%caseful_local_part%& generic
35453 router option.
35454
35455 .cindex "mixed-case login names"
35456 If you must have mixed-case user names on your system, the best way to proceed,
35457 assuming you want case-independent handling of incoming email, is to set up
35458 your first router to convert incoming local parts in your domains to the
35459 correct case by means of a file lookup. For example:
35460 .code
35461 correct_case:
35462   driver = redirect
35463   domains = +local_domains
35464   data = ${lookup{$local_part}cdb\
35465               {/etc/usercased.cdb}{$value}fail}\
35466               @$domain
35467 .endd
35468 For this router, the local part is forced to lower case by the default action
35469 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
35470 up a new local part in the correct case. If you then set &%caseful_local_part%&
35471 on any subsequent routers which process your domains, they will operate on
35472 local parts with the correct case in a case-sensitive manner.
35473
35474
35475
35476 .section "Dots in local parts" "SECID231"
35477 .cindex "dot" "in local part"
35478 .cindex "local part" "dots in"
35479 RFC 2822 forbids empty components in local parts. That is, an unquoted local
35480 part may not begin or end with a dot, nor have two consecutive dots in the
35481 middle. However, it seems that many MTAs do not enforce this, so Exim permits
35482 empty components for compatibility.
35483
35484
35485
35486 .section "Rewriting addresses" "SECID232"
35487 .cindex "rewriting" "addresses"
35488 Rewriting of sender and recipient addresses, and addresses in headers, can
35489 happen automatically, or as the result of configuration options, as described
35490 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
35491 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
35492
35493 Automatic rewriting includes qualification, as mentioned above. The other case
35494 in which it can happen is when an incomplete non-local domain is given. The
35495 routing process may cause this to be expanded into the full domain name. For
35496 example, a header such as
35497 .code
35498 To: hare@teaparty
35499 .endd
35500 might get rewritten as
35501 .code
35502 To: hare@teaparty.wonderland.fict.example
35503 .endd
35504 Rewriting as a result of routing is the one kind of message processing that
35505 does not happen at input time, as it cannot be done until the address has
35506 been routed.
35507
35508 Strictly, one should not do &'any'& deliveries of a message until all its
35509 addresses have been routed, in case any of the headers get changed as a
35510 result of routing. However, doing this in practice would hold up many
35511 deliveries for unreasonable amounts of time, just because one address could not
35512 immediately be routed. Exim therefore does not delay other deliveries when
35513 routing of one or more addresses is deferred.
35514 .ecindex IIDmesproc
35515
35516
35517
35518 . ////////////////////////////////////////////////////////////////////////////
35519 . ////////////////////////////////////////////////////////////////////////////
35520
35521 .chapter "SMTP processing" "CHAPSMTP"
35522 .scindex IIDsmtpproc1 "SMTP" "processing details"
35523 .scindex IIDsmtpproc2 "LMTP" "processing details"
35524 Exim supports a number of different ways of using the SMTP protocol, and its
35525 LMTP variant, which is an interactive protocol for transferring messages into a
35526 closed mail store application. This chapter contains details of how SMTP is
35527 processed. For incoming mail, the following are available:
35528
35529 .ilist
35530 SMTP over TCP/IP (Exim daemon or &'inetd'&);
35531 .next
35532 SMTP over the standard input and output (the &%-bs%& option);
35533 .next
35534 Batched SMTP on the standard input (the &%-bS%& option).
35535 .endlist
35536
35537 For mail delivery, the following are available:
35538
35539 .ilist
35540 SMTP over TCP/IP (the &(smtp)& transport);
35541 .next
35542 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
35543 &"lmtp"&);
35544 .next
35545 LMTP over a pipe to a process running in the local host (the &(lmtp)&
35546 transport);
35547 .next
35548 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
35549 the &%use_bsmtp%& option set).
35550 .endlist
35551
35552 &'Batched SMTP'& is the name for a process in which batches of messages are
35553 stored in or read from files (or pipes), in a format in which SMTP commands are
35554 used to contain the envelope information.
35555
35556
35557
35558 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
35559 .cindex "SMTP" "outgoing over TCP/IP"
35560 .cindex "outgoing SMTP over TCP/IP"
35561 .cindex "LMTP" "over TCP/IP"
35562 .cindex "outgoing LMTP over TCP/IP"
35563 .cindex "EHLO"
35564 .cindex "HELO"
35565 .cindex "SIZE option on MAIL command"
35566 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
35567 The &%protocol%& option selects which protocol is to be used, but the actual
35568 processing is the same in both cases.
35569
35570 If, in response to its EHLO command, Exim is told that the SIZE
35571 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
35572 command. The value of <&'n'&> is the message size plus the value of the
35573 &%size_addition%& option (default 1024) to allow for additions to the message
35574 such as per-transport header lines, or changes made in a
35575 .cindex "transport" "filter"
35576 .cindex "filter" "transport filter"
35577 transport filter. If &%size_addition%& is set negative, the use of SIZE is
35578 suppressed.
35579
35580 If the remote server advertises support for PIPELINING, Exim uses the
35581 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
35582 required for the transaction.
35583
35584 If the remote server advertises support for the STARTTLS command, and Exim
35585 was built to support TLS encryption, it tries to start a TLS session unless the
35586 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
35587 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
35588 is called for verification.
35589
35590 If the remote server advertises support for the AUTH command, Exim scans
35591 the authenticators configuration for any suitable client settings, as described
35592 in chapter &<<CHAPSMTPAUTH>>&.
35593
35594 .cindex "carriage return"
35595 .cindex "linefeed"
35596 Responses from the remote host are supposed to be terminated by CR followed by
35597 LF. However, there are known to be hosts that do not send CR characters, so in
35598 order to be able to interwork with such hosts, Exim treats LF on its own as a
35599 line terminator.
35600
35601 If a message contains a number of different addresses, all those with the same
35602 characteristics (for example, the same envelope sender) that resolve to the
35603 same set of hosts, in the same order, are sent in a single SMTP transaction,
35604 even if they are for different domains, unless there are more than the setting
35605 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
35606 they are split into groups containing no more than &%max_rcpt%&s addresses
35607 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
35608 in parallel sessions. The order of hosts with identical MX values is not
35609 significant when checking whether addresses can be batched in this way.
35610
35611 When the &(smtp)& transport suffers a temporary failure that is not
35612 message-related, Exim updates its transport-specific database, which contains
35613 records indexed by host name that remember which messages are waiting for each
35614 particular host. It also updates the retry database with new retry times.
35615
35616 .cindex "hints database" "retry keys"
35617 Exim's retry hints are based on host name plus IP address, so if one address of
35618 a multi-homed host is broken, it will soon be skipped most of the time.
35619 See the next section for more detail about error handling.
35620
35621 .cindex "SMTP" "passed connection"
35622 .cindex "SMTP" "batching over TCP/IP"
35623 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
35624 looks in the hints database for the transport to see if there are any queued
35625 messages waiting for the host to which it is connected. If it finds one, it
35626 creates a new Exim process using the &%-MC%& option (which can only be used by
35627 a process running as root or the Exim user) and passes the TCP/IP socket to it
35628 so that it can deliver another message using the same socket. The new process
35629 does only those deliveries that are routed to the connected host, and may in
35630 turn pass the socket on to a third process, and so on.
35631
35632 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
35633 limit the number of messages sent down a single TCP/IP connection.
35634
35635 .cindex "asterisk" "after IP address"
35636 The second and subsequent messages delivered down an existing connection are
35637 identified in the main log by the addition of an asterisk after the closing
35638 square bracket of the IP address.
35639
35640
35641
35642
35643 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
35644 .cindex "error" "in outgoing SMTP"
35645 .cindex "SMTP" "errors in outgoing"
35646 .cindex "host" "error"
35647 Three different kinds of error are recognized for outgoing SMTP: host errors,
35648 message errors, and recipient errors.
35649
35650 .vlist
35651 .vitem "&*Host errors*&"
35652 A host error is not associated with a particular message or with a
35653 particular recipient of a message. The host errors are:
35654
35655 .ilist
35656 Connection refused or timed out,
35657 .next
35658 Any error response code on connection,
35659 .next
35660 Any error response code to EHLO or HELO,
35661 .next
35662 Loss of connection at any time, except after &"."&,
35663 .next
35664 I/O errors at any time,
35665 .next
35666 Timeouts during the session, other than in response to MAIL, RCPT or
35667 the &"."& at the end of the data.
35668 .endlist ilist
35669
35670 For a host error, a permanent error response on connection, or in response to
35671 EHLO, causes all addresses routed to the host to be failed. Any other host
35672 error causes all addresses to be deferred, and retry data to be created for the
35673 host. It is not tried again, for any message, until its retry time arrives. If
35674 the current set of addresses are not all delivered in this run (to some
35675 alternative host), the message is added to the list of those waiting for this
35676 host, so if it is still undelivered when a subsequent successful delivery is
35677 made to the host, it will be sent down the same SMTP connection.
35678
35679 .vitem "&*Message errors*&"
35680 .cindex "message" "error"
35681 A message error is associated with a particular message when sent to a
35682 particular host, but not with a particular recipient of the message. The
35683 message errors are:
35684
35685 .ilist
35686 Any error response code to MAIL, DATA, or the &"."& that terminates
35687 the data,
35688 .next
35689 Timeout after MAIL,
35690 .next
35691 Timeout or loss of connection after the &"."& that terminates the data. A
35692 timeout after the DATA command itself is treated as a host error, as is loss of
35693 connection at any other time.
35694 .endlist ilist
35695
35696 For a message error, a permanent error response (5&'xx'&) causes all addresses
35697 to be failed, and a delivery error report to be returned to the sender. A
35698 temporary error response (4&'xx'&), or one of the timeouts, causes all
35699 addresses to be deferred. Retry data is not created for the host, but instead,
35700 a retry record for the combination of host plus message id is created. The
35701 message is not added to the list of those waiting for this host. This ensures
35702 that the failing message will not be sent to this host again until the retry
35703 time arrives. However, other messages that are routed to the host are not
35704 affected, so if it is some property of the message that is causing the error,
35705 it will not stop the delivery of other mail.
35706
35707 If the remote host specified support for the SIZE parameter in its response
35708 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
35709 over-large message will cause a message error because the error arrives as a
35710 response to MAIL.
35711
35712 .vitem "&*Recipient errors*&"
35713 .cindex "recipient" "error"
35714 A recipient error is associated with a particular recipient of a message. The
35715 recipient errors are:
35716
35717 .ilist
35718 Any error response to RCPT,
35719 .next
35720 Timeout after RCPT.
35721 .endlist
35722
35723 For a recipient error, a permanent error response (5&'xx'&) causes the
35724 recipient address to be failed, and a bounce message to be returned to the
35725 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
35726 address to be deferred, and routing retry data to be created for it. This is
35727 used to delay processing of the address in subsequent queue runs, until its
35728 routing retry time arrives. This applies to all messages, but because it
35729 operates only in queue runs, one attempt will be made to deliver a new message
35730 to the failing address before the delay starts to operate. This ensures that,
35731 if the failure is really related to the message rather than the recipient
35732 (&"message too big for this recipient"& is a possible example), other messages
35733 have a chance of getting delivered. If a delivery to the address does succeed,
35734 the retry information gets cleared, so all stuck messages get tried again, and
35735 the retry clock is reset.
35736
35737 The message is not added to the list of those waiting for this host. Use of the
35738 host for other messages is unaffected, and except in the case of a timeout,
35739 other recipients are processed independently, and may be successfully delivered
35740 in the current SMTP session. After a timeout it is of course impossible to
35741 proceed with the session, so all addresses get deferred. However, those other
35742 than the one that failed do not suffer any subsequent retry delays. Therefore,
35743 if one recipient is causing trouble, the others have a chance of getting
35744 through when a subsequent delivery attempt occurs before the failing
35745 recipient's retry time.
35746 .endlist
35747
35748 In all cases, if there are other hosts (or IP addresses) available for the
35749 current set of addresses (for example, from multiple MX records), they are
35750 tried in this run for any undelivered addresses, subject of course to their
35751 own retry data. In other words, recipient error retry data does not take effect
35752 until the next delivery attempt.
35753
35754 Some hosts have been observed to give temporary error responses to every
35755 MAIL command at certain times (&"insufficient space"& has been seen). It
35756 would be nice if such circumstances could be recognized, and defer data for the
35757 host itself created, but this is not possible within the current Exim design.
35758 What actually happens is that retry data for every (host, message) combination
35759 is created.
35760
35761 The reason that timeouts after MAIL and RCPT are treated specially is that
35762 these can sometimes arise as a result of the remote host's verification
35763 procedures. Exim makes this assumption, and treats them as if a temporary error
35764 response had been received. A timeout after &"."& is treated specially because
35765 it is known that some broken implementations fail to recognize the end of the
35766 message if the last character of the last line is a binary zero. Thus, it is
35767 helpful to treat this case as a message error.
35768
35769 Timeouts at other times are treated as host errors, assuming a problem with the
35770 host, or the connection to it. If a timeout after MAIL, RCPT,
35771 or &"."& is really a connection problem, the assumption is that at the next try
35772 the timeout is likely to occur at some other point in the dialogue, causing it
35773 then to be treated as a host error.
35774
35775 There is experimental evidence that some MTAs drop the connection after the
35776 terminating &"."& if they do not like the contents of the message for some
35777 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
35778 should be given. That is why Exim treats this case as a message rather than a
35779 host error, in order not to delay other messages to the same host.
35780
35781
35782
35783
35784 .section "Incoming SMTP messages over TCP/IP" "SECID233"
35785 .cindex "SMTP" "incoming over TCP/IP"
35786 .cindex "incoming SMTP over TCP/IP"
35787 .cindex "inetd"
35788 .cindex "daemon"
35789 Incoming SMTP messages can be accepted in one of two ways: by running a
35790 listening daemon, or by using &'inetd'&. In the latter case, the entry in
35791 &_/etc/inetd.conf_& should be like this:
35792 .code
35793 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
35794 .endd
35795 Exim distinguishes between this case and the case of a locally running user
35796 agent using the &%-bs%& option by checking whether or not the standard input is
35797 a socket. When it is, either the port must be privileged (less than 1024), or
35798 the caller must be root or the Exim user. If any other user passes a socket
35799 with an unprivileged port number, Exim prints a message on the standard error
35800 stream and exits with an error code.
35801
35802 By default, Exim does not make a log entry when a remote host connects or
35803 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
35804 unexpected. It can be made to write such log entries by setting the
35805 &%smtp_connection%& log selector.
35806
35807 .cindex "carriage return"
35808 .cindex "linefeed"
35809 Commands from the remote host are supposed to be terminated by CR followed by
35810 LF. However, there are known to be hosts that do not send CR characters. In
35811 order to be able to interwork with such hosts, Exim treats LF on its own as a
35812 line terminator.
35813 Furthermore, because common code is used for receiving messages from all
35814 sources, a CR on its own is also interpreted as a line terminator. However, the
35815 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
35816
35817 .cindex "EHLO" "invalid data"
35818 .cindex "HELO" "invalid data"
35819 One area that sometimes gives rise to problems concerns the EHLO or
35820 HELO commands. Some clients send syntactically invalid versions of these
35821 commands, which Exim rejects by default. (This is nothing to do with verifying
35822 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
35823 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
35824 match the broken hosts that send invalid commands.
35825
35826 .cindex "SIZE option on MAIL command"
35827 .cindex "MAIL" "SIZE option"
35828 The amount of disk space available is checked whenever SIZE is received on
35829 a MAIL command, independently of whether &%message_size_limit%& or
35830 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
35831 false. A temporary error is given if there is not enough space. If
35832 &%check_spool_space%& is set, the check is for that amount of space plus the
35833 value given with SIZE, that is, it checks that the addition of the incoming
35834 message will not reduce the space below the threshold.
35835
35836 When a message is successfully received, Exim includes the local message id in
35837 its response to the final &"."& that terminates the data. If the remote host
35838 logs this text it can help with tracing what has happened to a message.
35839
35840 The Exim daemon can limit the number of simultaneous incoming connections it is
35841 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
35842 number of simultaneous incoming connections from a single remote host (see the
35843 &%smtp_accept_max_per_host%& option). Additional connection attempts are
35844 rejected using the SMTP temporary error code 421.
35845
35846 The Exim daemon does not rely on the SIGCHLD signal to detect when a
35847 subprocess has finished, as this can get lost at busy times. Instead, it looks
35848 for completed subprocesses every time it wakes up. Provided there are other
35849 things happening (new incoming calls, starts of queue runs), completed
35850 processes will be noticed and tidied away. On very quiet systems you may
35851 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
35852 it will be noticed when the daemon next wakes up.
35853
35854 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
35855 and can also be set up to reject SMTP calls from non-reserved hosts at times of
35856 high system load &-- for details see the &%smtp_accept_reserve%&,
35857 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
35858 applies in both the daemon and &'inetd'& cases.
35859
35860 Exim normally starts a delivery process for each message received, though this
35861 can be varied by means of the &%-odq%& command line option and the
35862 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
35863 number of simultaneously running delivery processes started in this way from
35864 SMTP input can be limited by the &%smtp_accept_queue%& and
35865 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
35866 subsequently received messages are just put on the input queue without starting
35867 a delivery process.
35868
35869 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
35870 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
35871 started up from the &'inetd'& daemon, because in that case each connection is
35872 handled by an entirely independent Exim process. Control by load average is,
35873 however, available with &'inetd'&.
35874
35875 Exim can be configured to verify addresses in incoming SMTP commands as they
35876 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
35877 to rewrite addresses at this time &-- before any syntax checking is done. See
35878 section &<<SECTrewriteS>>&.
35879
35880 Exim can also be configured to limit the rate at which a client host submits
35881 MAIL and RCPT commands in a single SMTP session. See the
35882 &%smtp_ratelimit_hosts%& option.
35883
35884
35885
35886 .section "Unrecognized SMTP commands" "SECID234"
35887 .cindex "SMTP" "unrecognized commands"
35888 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
35889 commands during a single SMTP connection, it drops the connection after sending
35890 the error response to the last command. The default value for
35891 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
35892 abuse that subvert web servers into making connections to SMTP ports; in these
35893 circumstances, a number of non-SMTP lines are sent first.
35894
35895
35896 .section "Syntax and protocol errors in SMTP commands" "SECID235"
35897 .cindex "SMTP" "syntax errors"
35898 .cindex "SMTP" "protocol errors"
35899 A syntax error is detected if an SMTP command is recognized, but there is
35900 something syntactically wrong with its data, for example, a malformed email
35901 address in a RCPT command. Protocol errors include invalid command
35902 sequencing such as RCPT before MAIL. If Exim receives more than
35903 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
35904 drops the connection after sending the error response to the last command. The
35905 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
35906 broken clients that loop sending bad commands (yes, it has been seen).
35907
35908
35909
35910 .section "Use of non-mail SMTP commands" "SECID236"
35911 .cindex "SMTP" "non-mail commands"
35912 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
35913 DATA. Exim counts such commands, and drops the connection if there are too
35914 many of them in a single SMTP session. This action catches some
35915 denial-of-service attempts and things like repeated failing AUTHs, or a mad
35916 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
35917 defines what &"too many"& means. Its default value is 10.
35918
35919 When a new message is expected, one occurrence of RSET is not counted. This
35920 allows a client to send one RSET between messages (this is not necessary,
35921 but some clients do it). Exim also allows one uncounted occurrence of HELO
35922 or EHLO, and one occurrence of STARTTLS between messages. After
35923 starting up a TLS session, another EHLO is expected, and so it too is not
35924 counted.
35925
35926 The first occurrence of AUTH in a connection, or immediately following
35927 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
35928 RCPT, DATA, and QUIT are counted.
35929
35930 You can control which hosts are subject to the limit set by
35931 &%smtp_accept_max_nonmail%& by setting
35932 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
35933 the limit apply to all hosts. This option means that you can exclude any
35934 specific badly-behaved hosts that you have to live with.
35935
35936
35937
35938
35939 .section "The VRFY and EXPN commands" "SECID237"
35940 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
35941 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
35942 appropriate) in order to decide whether the command should be accepted or not.
35943
35944 .cindex "VRFY" "processing"
35945 When no ACL is defined for VRFY, or if it rejects without
35946 setting an explicit response code, the command is accepted
35947 (with a 252 SMTP response code)
35948 in order to support awkward clients that do a VRFY before every RCPT.
35949 When VRFY is accepted, it runs exactly the same code as when Exim is
35950 called with the &%-bv%& option, and returns 250/451/550
35951 SMTP response codes.
35952
35953 .cindex "EXPN" "processing"
35954 If no ACL for EXPN is defined, the command is rejected.
35955 When EXPN is accepted, a single-level expansion of the address is done.
35956 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
35957 than a verification (the &%-bv%& option). If an unqualified local part is given
35958 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
35959 of VRFY and EXPN commands are logged on the main and reject logs, and
35960 VRFY verification failures are logged on the main log for consistency with
35961 RCPT failures.
35962
35963
35964
35965 .section "The ETRN command" "SECTETRN"
35966 .cindex "ETRN" "processing"
35967 RFC 1985 describes an SMTP command called ETRN that is designed to
35968 overcome the security problems of the TURN command (which has fallen into
35969 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
35970 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
35971 should be accepted or not. If no ACL is defined, the command is rejected.
35972
35973 The ETRN command is concerned with &"releasing"& messages that are awaiting
35974 delivery to certain hosts. As Exim does not organize its message queue by host,
35975 the only form of ETRN that is supported by default is the one where the
35976 text starts with the &"#"& prefix, in which case the remainder of the text is
35977 specific to the SMTP server. A valid ETRN command causes a run of Exim with
35978 the &%-R%& option to happen, with the remainder of the ETRN text as its
35979 argument. For example,
35980 .code
35981 ETRN #brigadoon
35982 .endd
35983 runs the command
35984 .code
35985 exim -R brigadoon
35986 .endd
35987 which causes a delivery attempt on all messages with undelivered addresses
35988 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
35989 default), Exim prevents the simultaneous execution of more than one queue run
35990 for the same argument string as a result of an ETRN command. This stops
35991 a misbehaving client from starting more than one queue runner at once.
35992
35993 .cindex "hints database" "ETRN serialization"
35994 Exim implements the serialization by means of a hints database in which a
35995 record is written whenever a process is started by ETRN, and deleted when
35996 the process completes. However, Exim does not keep the SMTP session waiting for
35997 the ETRN process to complete. Once ETRN is accepted, the client is sent
35998 a &"success"& return code. Obviously there is scope for hints records to get
35999 left lying around if there is a system or program crash. To guard against this,
36000 Exim ignores any records that are more than six hours old.
36001
36002 .oindex "&%smtp_etrn_command%&"
36003 For more control over what ETRN does, the &%smtp_etrn_command%& option can
36004 used. This specifies a command that is run whenever ETRN is received,
36005 whatever the form of its argument. For
36006 example:
36007 .code
36008 smtp_etrn_command = /etc/etrn_command $domain \
36009                     $sender_host_address
36010 .endd
36011 .vindex "&$domain$&"
36012 The string is split up into arguments which are independently expanded. The
36013 expansion variable &$domain$& is set to the argument of the ETRN command,
36014 and no syntax checking is done on the contents of this argument. Exim does not
36015 wait for the command to complete, so its status code is not checked. Exim runs
36016 under its own uid and gid when receiving incoming SMTP, so it is not possible
36017 for it to change them before running the command.
36018
36019
36020
36021 .section "Incoming local SMTP" "SECID238"
36022 .cindex "SMTP" "local incoming"
36023 Some user agents use SMTP to pass messages to their local MTA using the
36024 standard input and output, as opposed to passing the envelope on the command
36025 line and writing the message to the standard input. This is supported by the
36026 &%-bs%& option. This form of SMTP is handled in the same way as incoming
36027 messages over TCP/IP (including the use of ACLs), except that the envelope
36028 sender given in a MAIL command is ignored unless the caller is trusted. In
36029 an ACL you can detect this form of SMTP input by testing for an empty host
36030 identification. It is common to have this as the first line in the ACL that
36031 runs for RCPT commands:
36032 .code
36033 accept hosts = :
36034 .endd
36035 This accepts SMTP messages from local processes without doing any other tests.
36036
36037
36038
36039 .section "Outgoing batched SMTP" "SECTbatchSMTP"
36040 .cindex "SMTP" "batched outgoing"
36041 .cindex "batched SMTP output"
36042 Both the &(appendfile)& and &(pipe)& transports can be used for handling
36043 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
36044 be output in BSMTP format. No SMTP responses are possible for this form of
36045 delivery. All it is doing is using SMTP commands as a way of transmitting the
36046 envelope along with the message.
36047
36048 The message is written to the file or pipe preceded by the SMTP commands
36049 MAIL and RCPT, and followed by a line containing a single dot. Lines in
36050 the message that start with a dot have an extra dot added. The SMTP command
36051 HELO is not normally used. If it is required, the &%message_prefix%& option
36052 can be used to specify it.
36053
36054 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
36055 one recipient address at a time by default. However, you can arrange for them
36056 to handle several addresses at once by setting the &%batch_max%& option. When
36057 this is done for BSMTP, messages may contain multiple RCPT commands. See
36058 chapter &<<CHAPbatching>>& for more details.
36059
36060 .vindex "&$host$&"
36061 When one or more addresses are routed to a BSMTP transport by a router that
36062 sets up a host list, the name of the first host on the list is available to the
36063 transport in the variable &$host$&. Here is an example of such a transport and
36064 router:
36065 .code
36066 begin routers
36067 route_append:
36068   driver = manualroute
36069   transport = smtp_appendfile
36070   route_list = domain.example  batch.host.example
36071
36072 begin transports
36073 smtp_appendfile:
36074   driver = appendfile
36075   directory = /var/bsmtp/$host
36076   batch_max = 1000
36077   use_bsmtp
36078   user = exim
36079 .endd
36080 This causes messages addressed to &'domain.example'& to be written in BSMTP
36081 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
36082 message (unless there are more than 1000 recipients).
36083
36084
36085
36086 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
36087 .cindex "SMTP" "batched incoming"
36088 .cindex "batched SMTP input"
36089 The &%-bS%& command line option causes Exim to accept one or more messages by
36090 reading SMTP on the standard input, but to generate no responses. If the caller
36091 is trusted, the senders in the MAIL commands are believed; otherwise the
36092 sender is always the caller of Exim. Unqualified senders and receivers are not
36093 rejected (there seems little point) but instead just get qualified. HELO
36094 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
36095 as NOOP; QUIT quits.
36096
36097 Minimal policy checking is done for BSMTP input. Only the non-SMTP
36098 ACL is run in the same way as for non-SMTP local input.
36099
36100 If an error is detected while reading a message, including a missing &"."& at
36101 the end, Exim gives up immediately. It writes details of the error to the
36102 standard output in a stylized way that the calling program should be able to
36103 make some use of automatically, for example:
36104 .code
36105 554 Unexpected end of file
36106 Transaction started in line 10
36107 Error detected in line 14
36108 .endd
36109 It writes a more verbose version, for human consumption, to the standard error
36110 file, for example:
36111 .code
36112 An error was detected while processing a file of BSMTP input.
36113 The error message was:
36114
36115 501 '>' missing at end of address
36116
36117 The SMTP transaction started in line 10.
36118 The error was detected in line 12.
36119 The SMTP command at fault was:
36120
36121 rcpt to:<malformed@in.com.plete
36122
36123 1 previous message was successfully processed.
36124 The rest of the batch was abandoned.
36125 .endd
36126 The return code from Exim is zero only if there were no errors. It is 1 if some
36127 messages were accepted before an error was detected, and 2 if no messages were
36128 accepted.
36129 .ecindex IIDsmtpproc1
36130 .ecindex IIDsmtpproc2
36131
36132
36133
36134 . ////////////////////////////////////////////////////////////////////////////
36135 . ////////////////////////////////////////////////////////////////////////////
36136
36137 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
36138          "Customizing messages"
36139 When a message fails to be delivered, or remains in the queue for more than a
36140 configured amount of time, Exim sends a message to the original sender, or
36141 to an alternative configured address. The text of these messages is built into
36142 the code of Exim, but it is possible to change it, either by adding a single
36143 string, or by replacing each of the paragraphs by text supplied in a file.
36144
36145 The &'From:'& and &'To:'& header lines are automatically generated; you can
36146 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
36147 option. Exim also adds the line
36148 .code
36149 Auto-Submitted: auto-generated
36150 .endd
36151 to all warning and bounce messages,
36152
36153
36154 .section "Customizing bounce messages" "SECID239"
36155 .cindex "customizing" "bounce message"
36156 .cindex "bounce message" "customizing"
36157 If &%bounce_message_text%& is set, its contents are included in the default
36158 message immediately after &"This message was created automatically by mail
36159 delivery software."& The string is not expanded. It is not used if
36160 &%bounce_message_file%& is set.
36161
36162 When &%bounce_message_file%& is set, it must point to a template file for
36163 constructing error messages. The file consists of a series of text items,
36164 separated by lines consisting of exactly four asterisks. If the file cannot be
36165 opened, default text is used and a message is written to the main and panic
36166 logs. If any text item in the file is empty, default text is used for that
36167 item.
36168
36169 .vindex "&$bounce_recipient$&"
36170 .vindex "&$bounce_return_size_limit$&"
36171 Each item of text that is read from the file is expanded, and there are two
36172 expansion variables which can be of use here: &$bounce_recipient$& is set to
36173 the recipient of an error message while it is being created, and
36174 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
36175 option, rounded to a whole number.
36176
36177 The items must appear in the file in the following order:
36178
36179 .ilist
36180 The first item is included in the headers, and should include at least a
36181 &'Subject:'& header. Exim does not check the syntax of these headers.
36182 .next
36183 The second item forms the start of the error message. After it, Exim lists the
36184 failing addresses with their error messages.
36185 .next
36186 The third item is used to introduce any text from pipe transports that is to be
36187 returned to the sender. It is omitted if there is no such text.
36188 .next
36189 The fourth, fifth and sixth items will be ignored and may be empty.
36190 The fields exist for back-compatibility
36191 .endlist
36192
36193 The default state (&%bounce_message_file%& unset) is equivalent to the
36194 following file, in which the sixth item is empty. The &'Subject:'& and some
36195 other lines have been split in order to fit them on the page:
36196 .code
36197 Subject: Mail delivery failed
36198   ${if eq{$sender_address}{$bounce_recipient}
36199   {: returning message to sender}}
36200 ****
36201 This message was created automatically by mail delivery software.
36202
36203 A message ${if eq{$sender_address}{$bounce_recipient}
36204   {that you sent }{sent by
36205
36206 <$sender_address>
36207
36208 }}could not be delivered to all of its recipients.
36209 This is a permanent error. The following address(es) failed:
36210 ****
36211 The following text was generated during the delivery attempt(s):
36212 ****
36213 ------ This is a copy of the message, including all the headers.
36214   ------
36215 ****
36216 ------ The body of the message is $message_size characters long;
36217   only the first
36218 ------ $bounce_return_size_limit or so are included here.
36219 ****
36220 .endd
36221 .section "Customizing warning messages" "SECTcustwarn"
36222 .cindex "customizing" "warning message"
36223 .cindex "warning of delay" "customizing the message"
36224 The option &%warn_message_file%& can be pointed at a template file for use when
36225 warnings about message delays are created. In this case there are only three
36226 text sections:
36227
36228 .ilist
36229 The first item is included in the headers, and should include at least a
36230 &'Subject:'& header. Exim does not check the syntax of these headers.
36231 .next
36232 The second item forms the start of the warning message. After it, Exim lists
36233 the delayed addresses.
36234 .next
36235 The third item then ends the message.
36236 .endlist
36237
36238 The default state is equivalent to the following file, except that some lines
36239 have been split here, in order to fit them on the page:
36240 .code
36241 Subject: Warning: message $message_exim_id delayed
36242   $warn_message_delay
36243 ****
36244 This message was created automatically by mail delivery software.
36245
36246 A message ${if eq{$sender_address}{$warn_message_recipients}
36247 {that you sent }{sent by
36248
36249 <$sender_address>
36250
36251 }}has not been delivered to all of its recipients after
36252 more than $warn_message_delay in the queue on $primary_hostname.
36253
36254 The message identifier is:     $message_exim_id
36255 The subject of the message is: $h_subject
36256 The date of the message is:    $h_date
36257
36258 The following address(es) have not yet been delivered:
36259 ****
36260 No action is required on your part. Delivery attempts will
36261 continue for some time, and this warning may be repeated at
36262 intervals if the message remains undelivered. Eventually the
36263 mail delivery software will give up, and when that happens,
36264 the message will be returned to you.
36265 .endd
36266 .vindex "&$warn_message_delay$&"
36267 .vindex "&$warn_message_recipients$&"
36268 However, in the default state the subject and date lines are omitted if no
36269 appropriate headers exist. During the expansion of this file,
36270 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
36271 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
36272 of recipients for the warning message. There may be more than one if there are
36273 multiple addresses with different &%errors_to%& settings on the routers that
36274 handled them.
36275
36276
36277
36278
36279 . ////////////////////////////////////////////////////////////////////////////
36280 . ////////////////////////////////////////////////////////////////////////////
36281
36282 .chapter "Some common configuration settings" "CHAPcomconreq"
36283 This chapter discusses some configuration settings that seem to be fairly
36284 common. More examples and discussion can be found in the Exim book.
36285
36286
36287
36288 .section "Sending mail to a smart host" "SECID240"
36289 .cindex "smart host" "example router"
36290 If you want to send all mail for non-local domains to a &"smart host"&, you
36291 should replace the default &(dnslookup)& router with a router which does the
36292 routing explicitly:
36293 .code
36294 send_to_smart_host:
36295   driver = manualroute
36296   route_list = !+local_domains smart.host.name
36297   transport = remote_smtp
36298 .endd
36299 You can use the smart host's IP address instead of the name if you wish.
36300 If you are using Exim only to submit messages to a smart host, and not for
36301 receiving incoming messages, you can arrange for it to do the submission
36302 synchronously by setting the &%mua_wrapper%& option (see chapter
36303 &<<CHAPnonqueueing>>&).
36304
36305
36306
36307
36308 .section "Using Exim to handle mailing lists" "SECTmailinglists"
36309 .cindex "mailing lists"
36310 Exim can be used to run simple mailing lists, but for large and/or complicated
36311 requirements, the use of additional specialized mailing list software such as
36312 Majordomo or Mailman is recommended.
36313
36314 The &(redirect)& router can be used to handle mailing lists where each list
36315 is maintained in a separate file, which can therefore be managed by an
36316 independent manager. The &%domains%& router option can be used to run these
36317 lists in a separate domain from normal mail. For example:
36318 .code
36319 lists:
36320   driver = redirect
36321   domains = lists.example
36322   file = /usr/lists/$local_part
36323   forbid_pipe
36324   forbid_file
36325   errors_to = $local_part-request@lists.example
36326   no_more
36327 .endd
36328 This router is skipped for domains other than &'lists.example'&. For addresses
36329 in that domain, it looks for a file that matches the local part. If there is no
36330 such file, the router declines, but because &%no_more%& is set, no subsequent
36331 routers are tried, and so the whole delivery fails.
36332
36333 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
36334 expanded into a filename or a pipe delivery, which is usually inappropriate in
36335 a mailing list.
36336
36337 .oindex "&%errors_to%&"
36338 The &%errors_to%& option specifies that any delivery errors caused by addresses
36339 taken from a mailing list are to be sent to the given address rather than the
36340 original sender of the message. However, before acting on this, Exim verifies
36341 the error address, and ignores it if verification fails.
36342
36343 For example, using the configuration above, mail sent to
36344 &'dicts@lists.example'& is passed on to those addresses contained in
36345 &_/usr/lists/dicts_&, with error reports directed to
36346 &'dicts-request@lists.example'&, provided that this address can be verified.
36347 There could be a file called &_/usr/lists/dicts-request_& containing
36348 the address(es) of this particular list's manager(s), but other approaches,
36349 such as setting up an earlier router (possibly using the &%local_part_prefix%&
36350 or &%local_part_suffix%& options) to handle addresses of the form
36351 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
36352
36353
36354
36355 .section "Syntax errors in mailing lists" "SECID241"
36356 .cindex "mailing lists" "syntax errors in"
36357 If an entry in redirection data contains a syntax error, Exim normally defers
36358 delivery of the original address. That means that a syntax error in a mailing
36359 list holds up all deliveries to the list. This may not be appropriate when a
36360 list is being maintained automatically from data supplied by users, and the
36361 addresses are not rigorously checked.
36362
36363 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
36364 entries that fail to parse, noting the incident in the log. If in addition
36365 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
36366 whenever a broken address is skipped. It is usually appropriate to set
36367 &%syntax_errors_to%& to the same address as &%errors_to%&.
36368
36369
36370
36371 .section "Re-expansion of mailing lists" "SECID242"
36372 .cindex "mailing lists" "re-expansion of"
36373 Exim remembers every individual address to which a message has been delivered,
36374 in order to avoid duplication, but it normally stores only the original
36375 recipient addresses with a message. If all the deliveries to a mailing list
36376 cannot be done at the first attempt, the mailing list is re-expanded when the
36377 delivery is next tried. This means that alterations to the list are taken into
36378 account at each delivery attempt, so addresses that have been added to
36379 the list since the message arrived will therefore receive a copy of the
36380 message, even though it pre-dates their subscription.
36381
36382 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
36383 on the &(redirect)& router. If this is done, any addresses generated by the
36384 router that fail to deliver at the first attempt are added to the message as
36385 &"top level"& addresses, and the parent address that generated them is marked
36386 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
36387 subsequent delivery attempts. The disadvantage of this is that if any of the
36388 failing addresses are incorrect, correcting them in the file has no effect on
36389 pre-existing messages.
36390
36391 The original top-level address is remembered with each of the generated
36392 addresses, and is output in any log messages. However, any intermediate parent
36393 addresses are not recorded. This makes a difference to the log only if the
36394 &%all_parents%& selector is set, but for mailing lists there is normally only
36395 one level of expansion anyway.
36396
36397
36398
36399 .section "Closed mailing lists" "SECID243"
36400 .cindex "mailing lists" "closed"
36401 The examples so far have assumed open mailing lists, to which anybody may
36402 send mail. It is also possible to set up closed lists, where mail is accepted
36403 from specified senders only. This is done by making use of the generic
36404 &%senders%& option to restrict the router that handles the list.
36405
36406 The following example uses the same file as a list of recipients and as a list
36407 of permitted senders. It requires three routers:
36408 .code
36409 lists_request:
36410   driver = redirect
36411   domains = lists.example
36412   local_part_suffix = -request
36413   file = /usr/lists/$local_part$local_part_suffix
36414   no_more
36415
36416 lists_post:
36417   driver = redirect
36418   domains = lists.example
36419   senders = ${if exists {/usr/lists/$local_part}\
36420              {lsearch;/usr/lists/$local_part}{*}}
36421   file = /usr/lists/$local_part
36422   forbid_pipe
36423   forbid_file
36424   errors_to = $local_part-request@lists.example
36425   no_more
36426
36427 lists_closed:
36428   driver = redirect
36429   domains = lists.example
36430   allow_fail
36431   data = :fail: $local_part@lists.example is a closed mailing list
36432 .endd
36433 All three routers have the same &%domains%& setting, so for any other domains,
36434 they are all skipped. The first router runs only if the local part ends in
36435 &%-request%&. It handles messages to the list manager(s) by means of an open
36436 mailing list.
36437
36438 The second router runs only if the &%senders%& precondition is satisfied. It
36439 checks for the existence of a list that corresponds to the local part, and then
36440 checks that the sender is on the list by means of a linear search. It is
36441 necessary to check for the existence of the file before trying to search it,
36442 because otherwise Exim thinks there is a configuration error. If the file does
36443 not exist, the expansion of &%senders%& is *, which matches all senders. This
36444 means that the router runs, but because there is no list, declines, and
36445 &%no_more%& ensures that no further routers are run. The address fails with an
36446 &"unrouteable address"& error.
36447
36448 The third router runs only if the second router is skipped, which happens when
36449 a mailing list exists, but the sender is not on it. This router forcibly fails
36450 the address, giving a suitable error message.
36451
36452
36453
36454
36455 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
36456 .cindex "VERP"
36457 .cindex "Variable Envelope Return Paths"
36458 .cindex "envelope from"
36459 .cindex "envelope sender"
36460 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
36461 are a way of helping mailing list administrators discover which subscription
36462 address is the cause of a particular delivery failure. The idea is to encode
36463 the original recipient address in the outgoing envelope sender address, so that
36464 if the message is forwarded by another host and then subsequently bounces, the
36465 original recipient can be extracted from the recipient address of the bounce.
36466
36467 .oindex &%errors_to%&
36468 .oindex &%return_path%&
36469 Envelope sender addresses can be modified by Exim using two different
36470 facilities: the &%errors_to%& option on a router (as shown in previous mailing
36471 list examples), or the &%return_path%& option on a transport. The second of
36472 these is effective only if the message is successfully delivered to another
36473 host; it is not used for errors detected on the local host (see the description
36474 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
36475 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
36476 .code
36477 verp_smtp:
36478   driver = smtp
36479   max_rcpt = 1
36480   return_path = \
36481     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36482       {$1-request+$local_part=$domain@your.dom.example}fail}
36483 .endd
36484 This has the effect of rewriting the return path (envelope sender) on outgoing
36485 SMTP messages, if the local part of the original return path ends in
36486 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
36487 local part and domain of the recipient into the return path. Suppose, for
36488 example, that a message whose return path has been set to
36489 &'somelist-request@your.dom.example'& is sent to
36490 &'subscriber@other.dom.example'&. In the transport, the return path is
36491 rewritten as
36492 .code
36493 somelist-request+subscriber=other.dom.example@your.dom.example
36494 .endd
36495 .vindex "&$local_part$&"
36496 For this to work, you must tell Exim to send multiple copies of messages that
36497 have more than one recipient, so that each copy has just one recipient. This is
36498 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
36499 might be sent to several different recipients in the same domain, in which case
36500 &$local_part$& is not available in the transport, because it is not unique.
36501
36502 Unless your host is doing nothing but mailing list deliveries, you should
36503 probably use a separate transport for the VERP deliveries, so as not to use
36504 extra resources in making one-per-recipient copies for other deliveries. This
36505 can easily be done by expanding the &%transport%& option in the router:
36506 .code
36507 dnslookup:
36508   driver = dnslookup
36509   domains = ! +local_domains
36510   transport = \
36511     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36512       {verp_smtp}{remote_smtp}}
36513   no_more
36514 .endd
36515 If you want to change the return path using &%errors_to%& in a router instead
36516 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
36517 routers that handle mailing list addresses. This will ensure that all delivery
36518 errors, including those detected on the local host, are sent to the VERP
36519 address.
36520
36521 On a host that does no local deliveries and has no manual routing, only the
36522 &(dnslookup)& router needs to be changed. A special transport is not needed for
36523 SMTP deliveries. Every mailing list recipient has its own return path value,
36524 and so Exim must hand them to the transport one at a time. Here is an example
36525 of a &(dnslookup)& router that implements VERP:
36526 .code
36527 verp_dnslookup:
36528   driver = dnslookup
36529   domains = ! +local_domains
36530   transport = remote_smtp
36531   errors_to = \
36532     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
36533      {$1-request+$local_part=$domain@your.dom.example}fail}
36534   no_more
36535 .endd
36536 Before you start sending out messages with VERPed return paths, you must also
36537 configure Exim to accept the bounce messages that come back to those paths.
36538 Typically this is done by setting a &%local_part_suffix%& option for a
36539 router, and using this to route the messages to wherever you want to handle
36540 them.
36541
36542 The overhead incurred in using VERP depends very much on the size of the
36543 message, the number of recipient addresses that resolve to the same remote
36544 host, and the speed of the connection over which the message is being sent. If
36545 a lot of addresses resolve to the same host and the connection is slow, sending
36546 a separate copy of the message for each address may take substantially longer
36547 than sending a single copy with many recipients (for which VERP cannot be
36548 used).
36549
36550
36551
36552
36553
36554
36555 .section "Virtual domains" "SECTvirtualdomains"
36556 .cindex "virtual domains"
36557 .cindex "domain" "virtual"
36558 The phrase &'virtual domain'& is unfortunately used with two rather different
36559 meanings:
36560
36561 .ilist
36562 A domain for which there are no real mailboxes; all valid local parts are
36563 aliases for other email addresses. Common examples are organizational
36564 top-level domains and &"vanity"& domains.
36565 .next
36566 One of a number of independent domains that are all handled by the same host,
36567 with mailboxes on that host, but where the mailbox owners do not necessarily
36568 have login accounts on that host.
36569 .endlist
36570
36571 The first usage is probably more common, and does seem more &"virtual"& than
36572 the second. This kind of domain can be handled in Exim with a straightforward
36573 aliasing router. One approach is to create a separate alias file for each
36574 virtual domain. Exim can test for the existence of the alias file to determine
36575 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
36576 to a router of this form:
36577 .code
36578 virtual:
36579   driver = redirect
36580   domains = dsearch;/etc/mail/virtual
36581   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
36582   no_more
36583 .endd
36584 The &%domains%& option specifies that the router is to be skipped, unless there
36585 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
36586 domain that is being processed. When the router runs, it looks up the local
36587 part in the file to find a new address (or list of addresses). The &%no_more%&
36588 setting ensures that if the lookup fails (leading to &%data%& being an empty
36589 string), Exim gives up on the address without trying any subsequent routers.
36590
36591 This one router can handle all the virtual domains because the alias filenames
36592 follow a fixed pattern. Permissions can be arranged so that appropriate people
36593 can edit the different alias files. A successful aliasing operation results in
36594 a new envelope recipient address, which is then routed from scratch.
36595
36596 The other kind of &"virtual"& domain can also be handled in a straightforward
36597 way. One approach is to create a file for each domain containing a list of
36598 valid local parts, and use it in a router like this:
36599 .code
36600 my_domains:
36601   driver = accept
36602   domains = dsearch;/etc/mail/domains
36603   local_parts = lsearch;/etc/mail/domains/$domain
36604   transport = my_mailboxes
36605 .endd
36606 The address is accepted if there is a file for the domain, and the local part
36607 can be found in the file. The &%domains%& option is used to check for the
36608 file's existence because &%domains%& is tested before the &%local_parts%&
36609 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
36610 because that option is tested after &%local_parts%&. The transport is as
36611 follows:
36612 .code
36613 my_mailboxes:
36614   driver = appendfile
36615   file = /var/mail/$domain/$local_part
36616   user = mail
36617 .endd
36618 This uses a directory of mailboxes for each domain. The &%user%& setting is
36619 required, to specify which uid is to be used for writing to the mailboxes.
36620
36621 The configuration shown here is just one example of how you might support this
36622 requirement. There are many other ways this kind of configuration can be set
36623 up, for example, by using a database instead of separate files to hold all the
36624 information about the domains.
36625
36626
36627
36628 .section "Multiple user mailboxes" "SECTmulbox"
36629 .cindex "multiple mailboxes"
36630 .cindex "mailbox" "multiple"
36631 .cindex "local part" "prefix"
36632 .cindex "local part" "suffix"
36633 Heavy email users often want to operate with multiple mailboxes, into which
36634 incoming mail is automatically sorted. A popular way of handling this is to
36635 allow users to use multiple sender addresses, so that replies can easily be
36636 identified. Users are permitted to add prefixes or suffixes to their local
36637 parts for this purpose. The wildcard facility of the generic router options
36638 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
36639 example, consider this router:
36640 .code
36641 userforward:
36642   driver = redirect
36643   check_local_user
36644   file = $home/.forward
36645   local_part_suffix = -*
36646   local_part_suffix_optional
36647   allow_filter
36648 .endd
36649 .vindex "&$local_part_suffix$&"
36650 It runs a user's &_.forward_& file for all local parts of the form
36651 &'username-*'&. Within the filter file the user can distinguish different
36652 cases by testing the variable &$local_part_suffix$&. For example:
36653 .code
36654 if $local_part_suffix contains -special then
36655 save /home/$local_part/Mail/special
36656 endif
36657 .endd
36658 If the filter file does not exist, or does not deal with such addresses, they
36659 fall through to subsequent routers, and, assuming no subsequent use of the
36660 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
36661 control over which suffixes are valid.
36662
36663 Alternatively, a suffix can be used to trigger the use of a different
36664 &_.forward_& file &-- which is the way a similar facility is implemented in
36665 another MTA:
36666 .code
36667 userforward:
36668   driver = redirect
36669   check_local_user
36670   file = $home/.forward$local_part_suffix
36671   local_part_suffix = -*
36672   local_part_suffix_optional
36673   allow_filter
36674 .endd
36675 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
36676 example, &_.forward-special_& is used. Once again, if the appropriate file
36677 does not exist, or does not deal with the address, it is passed on to
36678 subsequent routers, which could, if required, look for an unqualified
36679 &_.forward_& file to use as a default.
36680
36681
36682
36683 .section "Simplified vacation processing" "SECID244"
36684 .cindex "vacation processing"
36685 The traditional way of running the &'vacation'& program is for a user to set up
36686 a pipe command in a &_.forward_& file
36687 (see section &<<SECTspecitredli>>& for syntax details).
36688 This is prone to error by inexperienced users. There are two features of Exim
36689 that can be used to make this process simpler for users:
36690
36691 .ilist
36692 A local part prefix such as &"vacation-"& can be specified on a router which
36693 can cause the message to be delivered directly to the &'vacation'& program, or
36694 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
36695 &_.forward_& file are then much simpler. For example:
36696 .code
36697 spqr, vacation-spqr
36698 .endd
36699 .next
36700 The &%require_files%& generic router option can be used to trigger a
36701 vacation delivery by checking for the existence of a certain file in the
36702 user's home directory. The &%unseen%& generic option should also be used, to
36703 ensure that the original delivery also proceeds. In this case, all the user has
36704 to do is to create a file called, say, &_.vacation_&, containing a vacation
36705 message.
36706 .endlist
36707
36708 Another advantage of both these methods is that they both work even when the
36709 use of arbitrary pipes by users is locked out.
36710
36711
36712
36713 .section "Taking copies of mail" "SECID245"
36714 .cindex "message" "copying every"
36715 Some installations have policies that require archive copies of all messages to
36716 be made. A single copy of each message can easily be taken by an appropriate
36717 command in a system filter, which could, for example, use a different file for
36718 each day's messages.
36719
36720 There is also a shadow transport mechanism that can be used to take copies of
36721 messages that are successfully delivered by local transports, one copy per
36722 delivery. This could be used, &'inter alia'&, to implement automatic
36723 notification of delivery by sites that insist on doing such things.
36724
36725
36726
36727 .section "Intermittently connected hosts" "SECID246"
36728 .cindex "intermittently connected hosts"
36729 It has become quite common (because it is cheaper) for hosts to connect to the
36730 Internet periodically rather than remain connected all the time. The normal
36731 arrangement is that mail for such hosts accumulates on a system that is
36732 permanently connected.
36733
36734 Exim was designed for use on permanently connected hosts, and so it is not
36735 particularly well-suited to use in an intermittently connected environment.
36736 Nevertheless there are some features that can be used.
36737
36738
36739 .section "Exim on the upstream server host" "SECID247"
36740 It is tempting to arrange for incoming mail for the intermittently connected
36741 host to remain in Exim's queue until the client connects. However, this
36742 approach does not scale very well. Two different kinds of waiting message are
36743 being mixed up in the same queue &-- those that cannot be delivered because of
36744 some temporary problem, and those that are waiting for their destination host
36745 to connect. This makes it hard to manage the queue, as well as wasting
36746 resources, because each queue runner scans the entire queue.
36747
36748 A better approach is to separate off those messages that are waiting for an
36749 intermittently connected host. This can be done by delivering these messages
36750 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
36751 format, from where they are transmitted by other software when their
36752 destination connects. This makes it easy to collect all the mail for one host
36753 in a single directory, and to apply local timeout rules on a per-message basis
36754 if required.
36755
36756 On a very small scale, leaving the mail on Exim's queue can be made to work. If
36757 you are doing this, you should configure Exim with a long retry period for the
36758 intermittent host. For example:
36759 .code
36760 cheshire.wonderland.fict.example    *   F,5d,24h
36761 .endd
36762 This stops a lot of failed delivery attempts from occurring, but Exim remembers
36763 which messages it has queued up for that host. Once the intermittent host comes
36764 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
36765 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
36766 causes all the queued up messages to be delivered, often down a single SMTP
36767 connection. While the host remains connected, any new messages get delivered
36768 immediately.
36769
36770 If the connecting hosts do not have fixed IP addresses, that is, if a host is
36771 issued with a different IP address each time it connects, Exim's retry
36772 mechanisms on the holding host get confused, because the IP address is normally
36773 used as part of the key string for holding retry information. This can be
36774 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
36775 Since this has disadvantages for permanently connected hosts, it is best to
36776 arrange a separate transport for the intermittently connected ones.
36777
36778
36779
36780 .section "Exim on the intermittently connected client host" "SECID248"
36781 The value of &%smtp_accept_queue_per_connection%& should probably be
36782 increased, or even set to zero (that is, disabled) on the intermittently
36783 connected host, so that all incoming messages down a single connection get
36784 delivered immediately.
36785
36786 .cindex "SMTP" "passed connection"
36787 .cindex "SMTP" "multiple deliveries"
36788 .cindex "multiple SMTP deliveries"
36789 Mail waiting to be sent from an intermittently connected host will probably
36790 not have been routed, because without a connection DNS lookups are not
36791 possible. This means that if a normal queue run is done at connection time,
36792 each message is likely to be sent in a separate SMTP session. This can be
36793 avoided by starting the queue run with a command line option beginning with
36794 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
36795 first pass, routing is done but no deliveries take place. The second pass is a
36796 normal queue run; since all the messages have been previously routed, those
36797 destined for the same host are likely to get sent as multiple deliveries in a
36798 single SMTP connection.
36799
36800
36801
36802 . ////////////////////////////////////////////////////////////////////////////
36803 . ////////////////////////////////////////////////////////////////////////////
36804
36805 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
36806          "Exim as a non-queueing client"
36807 .cindex "client, non-queueing"
36808 .cindex "smart host" "suppressing queueing"
36809 On a personal computer, it is a common requirement for all
36810 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
36811 configured to operate that way, for all the popular operating systems.
36812 However, there are some MUAs for Unix-like systems that cannot be so
36813 configured: they submit messages using the command line interface of
36814 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
36815 messages this way.
36816
36817 If the personal computer runs continuously, there is no problem, because it can
36818 run a conventional MTA that handles delivery to the smart host, and deal with
36819 any delays via its queueing mechanism. However, if the computer does not run
36820 continuously or runs different operating systems at different times, queueing
36821 email is not desirable.
36822
36823 There is therefore a requirement for something that can provide the
36824 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
36825 any queueing or retrying facilities. Furthermore, the delivery to the smart
36826 host should be synchronous, so that if it fails, the sending MUA is immediately
36827 informed. In other words, we want something that extends an MUA that submits
36828 to a local MTA via the command line so that it behaves like one that submits
36829 to a remote smart host using TCP/SMTP.
36830
36831 There are a number of applications (for example, there is one called &'ssmtp'&)
36832 that do this job. However, people have found them to be lacking in various
36833 ways. For instance, you might want to allow aliasing and forwarding to be done
36834 before sending a message to the smart host.
36835
36836 Exim already had the necessary infrastructure for doing this job. Just a few
36837 tweaks were needed to make it behave as required, though it is somewhat of an
36838 overkill to use a fully-featured MTA for this purpose.
36839
36840 .oindex "&%mua_wrapper%&"
36841 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
36842 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
36843 assumes that it is being used to &"wrap"& a command-line MUA in the manner
36844 just described. As well as setting &%mua_wrapper%&, you also need to provide a
36845 compatible router and transport configuration. Typically there will be just one
36846 router and one transport, sending everything to a smart host.
36847
36848 When run in MUA wrapping mode, the behaviour of Exim changes in the
36849 following ways:
36850
36851 .ilist
36852 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
36853 In other words, the only way to submit messages is via the command line.
36854 .next
36855 Each message is synchronously delivered as soon as it is received (&%-odi%& is
36856 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
36857 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
36858 does not finish until the delivery attempt is complete. If the delivery is
36859 successful, a zero return code is given.
36860 .next
36861 Address redirection is permitted, but the final routing for all addresses must
36862 be to the same remote transport, and to the same list of hosts. Furthermore,
36863 the return address (envelope sender) must be the same for all recipients, as
36864 must any added or deleted header lines. In other words, it must be possible to
36865 deliver the message in a single SMTP transaction, however many recipients there
36866 are.
36867 .next
36868 If these conditions are not met, or if routing any address results in a
36869 failure or defer status, or if Exim is unable to deliver all the recipients
36870 successfully to one of the smart hosts, delivery of the entire message fails.
36871 .next
36872 Because no queueing is allowed, all failures are treated as permanent; there
36873 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
36874 smart host. Furthermore, because only a single yes/no response can be given to
36875 the caller, it is not possible to deliver to some recipients and not others. If
36876 there is an error (temporary or permanent) for any recipient, all are failed.
36877 .next
36878 If more than one smart host is listed, Exim will try another host after a
36879 connection failure or a timeout, in the normal way. However, if this kind of
36880 failure happens for all the hosts, the delivery fails.
36881 .next
36882 When delivery fails, an error message is written to the standard error stream
36883 (as well as to Exim's log), and Exim exits to the caller with a return code
36884 value 1. The message is expunged from Exim's spool files. No bounce messages
36885 are ever generated.
36886 .next
36887 No retry data is maintained, and any retry rules are ignored.
36888 .next
36889 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
36890 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
36891 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
36892 .endlist
36893
36894 The overall effect is that Exim makes a single synchronous attempt to deliver
36895 the message, failing if there is any kind of problem. Because no local
36896 deliveries are done and no daemon can be run, Exim does not need root
36897 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
36898 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
36899 the advantages and disadvantages of running without root privilege.
36900
36901
36902
36903
36904 . ////////////////////////////////////////////////////////////////////////////
36905 . ////////////////////////////////////////////////////////////////////////////
36906
36907 .chapter "Log files" "CHAPlog"
36908 .scindex IIDloggen "log" "general description"
36909 .cindex "log" "types of"
36910 Exim writes three different logs, referred to as the main log, the reject log,
36911 and the panic log:
36912
36913 .ilist
36914 .cindex "main log"
36915 The main log records the arrival of each message and each delivery in a single
36916 line in each case. The format is as compact as possible, in an attempt to keep
36917 down the size of log files. Two-character flag sequences make it easy to pick
36918 out these lines. A number of other events are recorded in the main log. Some of
36919 them are optional, in which case the &%log_selector%& option controls whether
36920 they are included or not. A Perl script called &'eximstats'&, which does simple
36921 analysis of main log files, is provided in the Exim distribution (see section
36922 &<<SECTmailstat>>&).
36923 .next
36924 .cindex "reject log"
36925 The reject log records information from messages that are rejected as a result
36926 of a configuration option (that is, for policy reasons).
36927 The first line of each rejection is a copy of the line that is also written to
36928 the main log. Then, if the message's header has been read at the time the log
36929 is written, its contents are written to this log. Only the original header
36930 lines are available; header lines added by ACLs are not logged. You can use the
36931 reject log to check that your policy controls are working correctly; on a busy
36932 host this may be easier than scanning the main log for rejection messages. You
36933 can suppress the writing of the reject log by setting &%write_rejectlog%&
36934 false.
36935 .next
36936 .cindex "panic log"
36937 .cindex "system log"
36938 When certain serious errors occur, Exim writes entries to its panic log. If the
36939 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
36940 are usually written to the main log as well, but can get lost amid the mass of
36941 other entries. The panic log should be empty under normal circumstances. It is
36942 therefore a good idea to check it (or to have a &'cron'& script check it)
36943 regularly, in order to become aware of any problems. When Exim cannot open its
36944 panic log, it tries as a last resort to write to the system log (syslog). This
36945 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
36946 message itself is written at priority LOG_CRIT.
36947 .endlist
36948
36949 Every log line starts with a timestamp, in the format shown in the following
36950 example. Note that many of the examples shown in this chapter are line-wrapped.
36951 In the log file, this would be all on one line:
36952 .code
36953 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
36954   by QUIT
36955 .endd
36956 By default, the timestamps are in the local timezone. There are two
36957 ways of changing this:
36958
36959 .ilist
36960 You can set the &%timezone%& option to a different time zone; in particular, if
36961 you set
36962 .code
36963 timezone = UTC
36964 .endd
36965 the timestamps will be in UTC (aka GMT).
36966 .next
36967 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
36968 example:
36969 .code
36970 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
36971 .endd
36972 .endlist
36973
36974 .cindex "log" "process ids in"
36975 .cindex "pid (process id)" "in log lines"
36976 Exim does not include its process id in log lines by default, but you can
36977 request that it does so by specifying the &`pid`& log selector (see section
36978 &<<SECTlogselector>>&). When this is set, the process id is output, in square
36979 brackets, immediately after the time and date.
36980
36981
36982
36983
36984 .section "Where the logs are written" "SECTwhelogwri"
36985 .cindex "log" "destination"
36986 .cindex "log" "to file"
36987 .cindex "log" "to syslog"
36988 .cindex "syslog"
36989 The logs may be written to local files, or to syslog, or both. However, it
36990 should be noted that many syslog implementations use UDP as a transport, and
36991 are therefore unreliable in the sense that messages are not guaranteed to
36992 arrive at the loghost, nor is the ordering of messages necessarily maintained.
36993 It has also been reported that on large log files (tens of megabytes) you may
36994 need to tweak syslog to prevent it syncing the file with each write &-- on
36995 Linux this has been seen to make syslog take 90% plus of CPU time.
36996
36997 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
36998 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
36999 configuration. This latter string is expanded, so it can contain, for example,
37000 references to the host name:
37001 .code
37002 log_file_path = /var/log/$primary_hostname/exim_%slog
37003 .endd
37004 It is generally advisable, however, to set the string in &_Local/Makefile_&
37005 rather than at runtime, because then the setting is available right from the
37006 start of Exim's execution. Otherwise, if there's something it wants to log
37007 before it has read the configuration file (for example, an error in the
37008 configuration file) it will not use the path you want, and may not be able to
37009 log at all.
37010
37011 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
37012 list, currently limited to at most two items. This is one option where the
37013 facility for changing a list separator may not be used. The list must always be
37014 colon-separated. If an item in the list is &"syslog"& then syslog is used;
37015 otherwise the item must either be an absolute path, containing &`%s`& at the
37016 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
37017 implying the use of a default path.
37018
37019 When Exim encounters an empty item in the list, it searches the list defined by
37020 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
37021 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
37022 mean &"use the path specified at build time"&. It no such item exists, log
37023 files are written in the &_log_& subdirectory of the spool directory. This is
37024 equivalent to the setting:
37025 .code
37026 log_file_path = $spool_directory/log/%slog
37027 .endd
37028 If you do not specify anything at build time or runtime,
37029 or if you unset the option at runtime (i.e. &`log_file_path = `&),
37030 that is where the logs are written.
37031
37032 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
37033 are in use &-- see section &<<SECTdatlogfil>>& below.
37034
37035 Here are some examples of possible settings:
37036 .display
37037 &`LOG_FILE_PATH=syslog                    `& syslog only
37038 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
37039 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
37040 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
37041 .endd
37042 If there are more than two paths in the list, the first is used and a panic
37043 error is logged.
37044
37045
37046
37047 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
37048 .cindex "log" "cycling local files"
37049 .cindex "cycling logs"
37050 .cindex "&'exicyclog'&"
37051 .cindex "log" "local files; writing to"
37052 Some operating systems provide centralized and standardized methods for cycling
37053 log files. For those that do not, a utility script called &'exicyclog'& is
37054 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
37055 main and reject logs each time it is called. The maximum number of old logs to
37056 keep can be set. It is suggested this script is run as a daily &'cron'& job.
37057
37058 An Exim delivery process opens the main log when it first needs to write to it,
37059 and it keeps the file open in case subsequent entries are required &-- for
37060 example, if a number of different deliveries are being done for the same
37061 message. However, remote SMTP deliveries can take a long time, and this means
37062 that the file may be kept open long after it is renamed if &'exicyclog'& or
37063 something similar is being used to rename log files on a regular basis. To
37064 ensure that a switch of log files is noticed as soon as possible, Exim calls
37065 &[stat()]& on the main log's name before reusing an open file, and if the file
37066 does not exist, or its inode has changed, the old file is closed and Exim
37067 tries to open the main log from scratch. Thus, an old log file may remain open
37068 for quite some time, but no Exim processes should write to it once it has been
37069 renamed.
37070
37071
37072
37073 .section "Datestamped log files" "SECTdatlogfil"
37074 .cindex "log" "datestamped files"
37075 Instead of cycling the main and reject log files by renaming them
37076 periodically, some sites like to use files whose names contain a datestamp,
37077 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
37078 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
37079 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
37080 point where the datestamp is required. For example:
37081 .code
37082 log_file_path = /var/spool/exim/log/%slog-%D
37083 log_file_path = /var/log/exim-%s-%D.log
37084 log_file_path = /var/spool/exim/log/%D-%slog
37085 log_file_path = /var/log/exim/%s.%M
37086 .endd
37087 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
37088 examples of names generated by the above examples:
37089 .code
37090 /var/spool/exim/log/mainlog-20021225
37091 /var/log/exim-reject-20021225.log
37092 /var/spool/exim/log/20021225-mainlog
37093 /var/log/exim/main.200212
37094 .endd
37095 When this form of log file is specified, Exim automatically switches to new
37096 files at midnight. It does not make any attempt to compress old logs; you
37097 will need to write your own script if you require this. You should not
37098 run &'exicyclog'& with this form of logging.
37099
37100 The location of the panic log is also determined by &%log_file_path%&, but it
37101 is not datestamped, because rotation of the panic log does not make sense.
37102 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
37103 the string. In addition, if it immediately follows a slash, a following
37104 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
37105 character is removed. Thus, the four examples above would give these panic
37106 log names:
37107 .code
37108 /var/spool/exim/log/paniclog
37109 /var/log/exim-panic.log
37110 /var/spool/exim/log/paniclog
37111 /var/log/exim/panic
37112 .endd
37113
37114
37115 .section "Logging to syslog" "SECID249"
37116 .cindex "log" "syslog; writing to"
37117 The use of syslog does not change what Exim logs or the format of its messages,
37118 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
37119 Exim's log lines are omitted when these lines are sent to syslog. Apart from
37120 that, the same strings are written to syslog as to log files. The syslog
37121 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
37122 by default, but you can change these by setting the &%syslog_facility%& and
37123 &%syslog_processname%& options, respectively. If Exim was compiled with
37124 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
37125 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
37126 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
37127 the time and host name to each line.
37128 The three log streams are mapped onto syslog priorities as follows:
37129
37130 .ilist
37131 &'mainlog'& is mapped to LOG_INFO
37132 .next
37133 &'rejectlog'& is mapped to LOG_NOTICE
37134 .next
37135 &'paniclog'& is mapped to LOG_ALERT
37136 .endlist
37137
37138 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
37139 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
37140 these are routed by syslog to the same place. You can suppress this duplication
37141 by setting &%syslog_duplication%& false.
37142
37143 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
37144 entries contain multiple lines when headers are included. To cope with both
37145 these cases, entries written to syslog are split into separate &[syslog()]&
37146 calls at each internal newline, and also after a maximum of
37147 870 data characters. (This allows for a total syslog line length of 1024, when
37148 additions such as timestamps are added.) If you are running a syslog
37149 replacement that can handle lines longer than the 1024 characters allowed by
37150 RFC 3164, you should set
37151 .code
37152 SYSLOG_LONG_LINES=yes
37153 .endd
37154 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
37155 lines, but it still splits at internal newlines in &'reject'& log entries.
37156
37157 To make it easy to re-assemble split lines later, each component of a split
37158 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
37159 where <&'n'&> is the component number and <&'m'&> is the total number of
37160 components in the entry. The / delimiter is used when the line was split
37161 because it was too long; if it was split because of an internal newline, the \
37162 delimiter is used. For example, supposing the length limit to be 50 instead of
37163 870, the following would be the result of a typical rejection message to
37164 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
37165 name, and pid as added by syslog:
37166 .code
37167 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
37168 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
37169 [3/5]  when scanning for sender: missing or malformed lo
37170 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
37171 [5/5] mple>)
37172 .endd
37173 The same error might cause the following lines to be written to &"rejectlog"&
37174 (LOG_NOTICE):
37175 .code
37176 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
37177 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
37178 [3/18] er when scanning for sender: missing or malformed
37179 [4/18]  local part in "<>" (envelope sender is <ph10@cam
37180 [5\18] .example>)
37181 [6\18] Recipients: ph10@some.domain.cam.example
37182 [7\18] P Received: from [127.0.0.1] (ident=ph10)
37183 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
37184 [9\18]        id 16RdAL-0006pc-00
37185 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
37186 [11\18] 09:43 +0100
37187 [12\18] F From: <>
37188 [13\18]   Subject: this is a test header
37189 [18\18]   X-something: this is another header
37190 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
37191 [16\18] le>
37192 [17\18] B Bcc:
37193 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
37194 .endd
37195 Log lines that are neither too long nor contain newlines are written to syslog
37196 without modification.
37197
37198 If only syslog is being used, the Exim monitor is unable to provide a log tail
37199 display, unless syslog is routing &'mainlog'& to a file on the local host and
37200 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
37201 where it is.
37202
37203
37204
37205 .section "Log line flags" "SECID250"
37206 One line is written to the main log for each message received, and for each
37207 successful, unsuccessful, and delayed delivery. These lines can readily be
37208 picked out by the distinctive two-character flags that immediately follow the
37209 timestamp. The flags are:
37210 .display
37211 &`<=`&     message arrival
37212 &`(=`&     message fakereject
37213 &`=>`&     normal message delivery
37214 &`->`&     additional address in same delivery
37215 &`>>`&     cutthrough message delivery
37216 &`*>`&     delivery suppressed by &%-N%&
37217 &`**`&     delivery failed; address bounced
37218 &`==`&     delivery deferred; temporary problem
37219 .endd
37220
37221
37222 .section "Logging message reception" "SECID251"
37223 .cindex "log" "reception line"
37224 The format of the single-line entry in the main log that is written for every
37225 message received is shown in the basic example below, which is split over
37226 several lines in order to fit it on the page:
37227 .code
37228 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
37229   H=mailer.fict.example [192.168.123.123] U=exim
37230   P=smtp S=5678 id=<incoming message id>
37231 .endd
37232 The address immediately following &"<="& is the envelope sender address. A
37233 bounce message is shown with the sender address &"<>"&, and if it is locally
37234 generated, this is followed by an item of the form
37235 .code
37236 R=<message id>
37237 .endd
37238 which is a reference to the message that caused the bounce to be sent.
37239
37240 .cindex "HELO"
37241 .cindex "EHLO"
37242 For messages from other hosts, the H and U fields identify the remote host and
37243 record the RFC 1413 identity of the user that sent the message, if one was
37244 received. The number given in square brackets is the IP address of the sending
37245 host. If there is a single, unparenthesized  host name in the H field, as
37246 above, it has been verified to correspond to the IP address (see the
37247 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
37248 by the remote host in the SMTP HELO or EHLO command, and has not been
37249 verified. If verification yields a different name to that given for HELO or
37250 EHLO, the verified name appears first, followed by the HELO or EHLO
37251 name in parentheses.
37252
37253 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
37254 without brackets, in the HELO or EHLO command, leading to entries in
37255 the log containing text like these examples:
37256 .code
37257 H=(10.21.32.43) [192.168.8.34]
37258 H=([10.21.32.43]) [192.168.8.34]
37259 .endd
37260 This can be confusing. Only the final address in square brackets can be relied
37261 on.
37262
37263 For locally generated messages (that is, messages not received over TCP/IP),
37264 the H field is omitted, and the U field contains the login name of the caller
37265 of Exim.
37266
37267 .cindex "authentication" "logging"
37268 .cindex "AUTH" "logging"
37269 For all messages, the P field specifies the protocol used to receive the
37270 message. This is the value that is stored in &$received_protocol$&. In the case
37271 of incoming SMTP messages, the value indicates whether or not any SMTP
37272 extensions (ESMTP), encryption, or authentication were used. If the SMTP
37273 session was encrypted, there is an additional X field that records the cipher
37274 suite that was used.
37275
37276 .cindex log protocol
37277 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
37278 hosts that have authenticated themselves using the SMTP AUTH command. The first
37279 value is used when the SMTP connection was encrypted (&"secure"&). In this case
37280 there is an additional item A= followed by the name of the authenticator that
37281 was used. If an authenticated identification was set up by the authenticator's
37282 &%server_set_id%& option, this is logged too, separated by a colon from the
37283 authenticator name.
37284
37285 .cindex "size" "of message"
37286 The id field records the existing message id, if present. The size of the
37287 received message is given by the S field. When the message is delivered,
37288 headers may be removed or added, so that the size of delivered copies of the
37289 message may not correspond with this value (and indeed may be different to each
37290 other).
37291
37292 The &%log_selector%& option can be used to request the logging of additional
37293 data when a message is received. See section &<<SECTlogselector>>& below.
37294
37295
37296
37297 .section "Logging deliveries" "SECID252"
37298 .cindex "log" "delivery line"
37299 The format of the single-line entry in the main log that is written for every
37300 delivery is shown in one of the examples below, for local and remote
37301 deliveries, respectively. Each example has been split into multiple lines in order
37302 to fit it on the page:
37303 .code
37304 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
37305   <marv@hitch.fict.example> R=localuser T=local_delivery
37306 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
37307   monk@holistic.fict.example R=dnslookup T=remote_smtp
37308   H=holistic.fict.example [192.168.234.234]
37309 .endd
37310 For ordinary local deliveries, the original address is given in angle brackets
37311 after the final delivery address, which might be a pipe or a file. If
37312 intermediate address(es) exist between the original and the final address, the
37313 last of these is given in parentheses after the final address. The R and T
37314 fields record the router and transport that were used to process the address.
37315
37316 If SMTP AUTH was used for the delivery there is an additional item A=
37317 followed by the name of the authenticator that was used.
37318 If an authenticated identification was set up by the authenticator's &%client_set_id%&
37319 option, this is logged too, separated by a colon from the authenticator name.
37320
37321 If a shadow transport was run after a successful local delivery, the log line
37322 for the successful delivery has an item added on the end, of the form
37323 .display
37324 &`ST=<`&&'shadow transport name'&&`>`&
37325 .endd
37326 If the shadow transport did not succeed, the error message is put in
37327 parentheses afterwards.
37328
37329 .cindex "asterisk" "after IP address"
37330 When more than one address is included in a single delivery (for example, two
37331 SMTP RCPT commands in one transaction) the second and subsequent addresses are
37332 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
37333 down a single SMTP connection, an asterisk follows the IP address in the log
37334 lines for the second and subsequent messages.
37335 When two or more messages are delivered down a single TLS connection, the
37336 DNS and some TLS-related information logged for the first message delivered
37337 will not be present in the log lines for the second and subsequent messages.
37338 TLS cipher information is still available.
37339
37340 .cindex "delivery" "cutthrough; logging"
37341 .cindex "cutthrough" "logging"
37342 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
37343 line precedes the reception line, since cutthrough waits for a possible
37344 rejection from the destination in case it can reject the sourced item.
37345
37346 The generation of a reply message by a filter file gets logged as a
37347 &"delivery"& to the addressee, preceded by &">"&.
37348
37349 The &%log_selector%& option can be used to request the logging of additional
37350 data when a message is delivered. See section &<<SECTlogselector>>& below.
37351
37352
37353 .section "Discarded deliveries" "SECID253"
37354 .cindex "discarded messages"
37355 .cindex "message" "discarded"
37356 .cindex "delivery" "discarded; logging"
37357 When a message is discarded as a result of the command &"seen finish"& being
37358 obeyed in a filter file which generates no deliveries, a log entry of the form
37359 .code
37360 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
37361   <low.club@bridge.example> R=userforward
37362 .endd
37363 is written, to record why no deliveries are logged. When a message is discarded
37364 because it is aliased to &":blackhole:"& the log line is like this:
37365 .code
37366 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
37367   <hole@nowhere.example> R=blackhole_router
37368 .endd
37369
37370
37371 .section "Deferred deliveries" "SECID254"
37372 When a delivery is deferred, a line of the following form is logged:
37373 .code
37374 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
37375   R=dnslookup T=smtp defer (146): Connection refused
37376 .endd
37377 In the case of remote deliveries, the error is the one that was given for the
37378 last IP address that was tried. Details of individual SMTP failures are also
37379 written to the log, so the above line would be preceded by something like
37380 .code
37381 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
37382   mail1.endrest.example [192.168.239.239]: Connection refused
37383 .endd
37384 When a deferred address is skipped because its retry time has not been reached,
37385 a message is written to the log, but this can be suppressed by setting an
37386 appropriate value in &%log_selector%&.
37387
37388
37389
37390 .section "Delivery failures" "SECID255"
37391 .cindex "delivery" "failure; logging"
37392 If a delivery fails because an address cannot be routed, a line of the
37393 following form is logged:
37394 .code
37395 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
37396   <jim@trek99.example>: unknown mail domain
37397 .endd
37398 If a delivery fails at transport time, the router and transport are shown, and
37399 the response from the remote host is included, as in this example:
37400 .code
37401 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
37402   R=dnslookup T=remote_smtp: SMTP error from remote mailer
37403   after pipelined RCPT TO:<ace400@pb.example>: host
37404   pbmail3.py.example [192.168.63.111]: 553 5.3.0
37405   <ace400@pb.example>...Addressee unknown
37406 .endd
37407 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
37408 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
37409 disabling PIPELINING. The log lines for all forms of delivery failure are
37410 flagged with &`**`&.
37411
37412
37413
37414 .section "Fake deliveries" "SECID256"
37415 .cindex "delivery" "fake; logging"
37416 If a delivery does not actually take place because the &%-N%& option has been
37417 used to suppress it, a normal delivery line is written to the log, except that
37418 &"=>"& is replaced by &"*>"&.
37419
37420
37421
37422 .section "Completion" "SECID257"
37423 A line of the form
37424 .code
37425 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
37426 .endd
37427 is written to the main log when a message is about to be removed from the spool
37428 at the end of its processing.
37429
37430
37431
37432
37433 .section "Summary of Fields in Log Lines" "SECID258"
37434 .cindex "log" "summary of fields"
37435 A summary of the field identifiers that are used in log lines is shown in
37436 the following table:
37437 .display
37438 &`A   `&        authenticator name (and optional id and sender)
37439 &`C   `&        SMTP confirmation on delivery
37440 &`    `&        command list for &"no mail in SMTP session"&
37441 &`CV  `&        certificate verification status
37442 &`D   `&        duration of &"no mail in SMTP session"&
37443 &`DKIM`&        domain verified in incoming message
37444 &`DN  `&        distinguished name from peer certificate
37445 &`DS  `&        DNSSEC secured lookups
37446 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
37447 &`F   `&        sender address (on delivery lines)
37448 &`H   `&        host name and IP address
37449 &`I   `&        local interface used
37450 &`id  `&        message id (from header) for incoming message
37451 &`K   `&        CHUNKING extension used
37452 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
37453 &`M8S `&        8BITMIME status for incoming message
37454 &`P   `&        on &`<=`& lines: protocol used
37455 &`    `&        on &`=>`& and &`**`& lines: return path
37456 &`PRDR`&        PRDR extension used
37457 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
37458 &`Q   `&        alternate queue name
37459 &`QT  `&        on &`=>`& lines: time spent on queue so far
37460 &`    `&        on &"Completed"& lines: time spent on queue
37461 &`R   `&        on &`<=`& lines: reference for local bounce
37462 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
37463 &`RT  `&        on &`<=`& lines: time taken for reception
37464 &`S   `&        size of message in bytes
37465 &`SNI `&        server name indication from TLS client hello
37466 &`ST  `&        shadow transport name
37467 &`T   `&        on &`<=`& lines: message subject (topic)
37468 &`TFO `&        connection took advantage of TCP Fast Open
37469 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
37470 &`U   `&        local user or RFC 1413 identity
37471 &`X   `&        TLS cipher suite
37472 .endd
37473
37474
37475 .section "Other log entries" "SECID259"
37476 Various other types of log entry are written from time to time. Most should be
37477 self-explanatory. Among the more common are:
37478
37479 .ilist
37480 .cindex "retry" "time not reached"
37481 &'retry time not reached'&&~&~An address previously suffered a temporary error
37482 during routing or local delivery, and the time to retry has not yet arrived.
37483 This message is not written to an individual message log file unless it happens
37484 during the first delivery attempt.
37485 .next
37486 &'retry time not reached for any host'&&~&~An address previously suffered
37487 temporary errors during remote delivery, and the retry time has not yet arrived
37488 for any of the hosts to which it is routed.
37489 .next
37490 .cindex "spool directory" "file locked"
37491 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
37492 some other Exim process is already working on the message. This can be quite
37493 common if queue running processes are started at frequent intervals. The
37494 &'exiwhat'& utility script can be used to find out what Exim processes are
37495 doing.
37496 .next
37497 .cindex "error" "ignored"
37498 &'error ignored'&&~&~There are several circumstances that give rise to this
37499 message:
37500 .olist
37501 Exim failed to deliver a bounce message whose age was greater than
37502 &%ignore_bounce_errors_after%&. The bounce was discarded.
37503 .next
37504 A filter file set up a delivery using the &"noerror"& option, and the delivery
37505 failed. The delivery was discarded.
37506 .next
37507 A delivery set up by a router configured with
37508 . ==== As this is a nested list, any displays it contains must be indented
37509 . ==== as otherwise they are too far to the left.
37510 .code
37511     errors_to = <>
37512 .endd
37513 failed. The delivery was discarded.
37514 .endlist olist
37515 .next
37516 .cindex DKIM "log line"
37517 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
37518 logging and the message has a DKIM signature header.
37519 .endlist ilist
37520
37521
37522
37523
37524
37525 .section "Reducing or increasing what is logged" "SECTlogselector"
37526 .cindex "log" "selectors"
37527 By setting the &%log_selector%& global option, you can disable some of Exim's
37528 default logging, or you can request additional logging. The value of
37529 &%log_selector%& is made up of names preceded by plus or minus characters. For
37530 example:
37531 .code
37532 log_selector = +arguments -retry_defer
37533 .endd
37534 The list of optional log items is in the following table, with the default
37535 selection marked by asterisks:
37536 .display
37537 &` 8bitmime                   `&  received 8BITMIME status
37538 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
37539 &` address_rewrite            `&  address rewriting
37540 &` all_parents                `&  all parents in => lines
37541 &` arguments                  `&  command line arguments
37542 &`*connection_reject          `&  connection rejections
37543 &`*delay_delivery             `&  immediate delivery delayed
37544 &` deliver_time               `&  time taken to attempt delivery
37545 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
37546 &`*dkim                       `&  DKIM verified domain on <= lines
37547 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
37548 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
37549 &` dnssec                     `&  DNSSEC secured lookups
37550 &`*etrn                       `&  ETRN commands
37551 &`*host_lookup_failed         `&  as it says
37552 &` ident_timeout              `&  timeout for ident connection
37553 &` incoming_interface         `&  local interface on <= and => lines
37554 &` incoming_port              `&  remote port on <= lines
37555 &`*lost_incoming_connection   `&  as it says (includes timeouts)
37556 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
37557 &`*msg_id                     `&  on <= lines, Message-ID: header value
37558 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
37559 &` outgoing_interface         `&  local interface on => lines
37560 &` outgoing_port              `&  add remote port to => lines
37561 &`*queue_run                  `&  start and end queue runs
37562 &` queue_time                 `&  time on queue for one recipient
37563 &` queue_time_overall         `&  time on queue for whole message
37564 &` pid                        `&  Exim process id
37565 &` pipelining                 `&  PIPELINING use, on <= and => lines
37566 &` proxy                      `&  proxy address on <= and => lines
37567 &` receive_time               `&  time taken to receive message
37568 &` received_recipients        `&  recipients on <= lines
37569 &` received_sender            `&  sender on <= lines
37570 &`*rejected_header            `&  header contents on reject log
37571 &`*retry_defer                `&  &"retry time not reached"&
37572 &` return_path_on_delivery    `&  put return path on => and ** lines
37573 &` sender_on_delivery         `&  add sender to => lines
37574 &`*sender_verify_fail         `&  sender verification failures
37575 &`*size_reject                `&  rejection because too big
37576 &`*skip_delivery              `&  delivery skipped in a queue run
37577 &`*smtp_confirmation          `&  SMTP confirmation on => lines
37578 &` smtp_connection            `&  incoming SMTP connections
37579 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
37580 &` smtp_mailauth              `&  AUTH argument to MAIL commands
37581 &` smtp_no_mail               `&  session with no MAIL commands
37582 &` smtp_protocol_error        `&  SMTP protocol errors
37583 &` smtp_syntax_error          `&  SMTP syntax errors
37584 &` subject                    `&  contents of &'Subject:'& on <= lines
37585 &`*tls_certificate_verified   `&  certificate verification status
37586 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
37587 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
37588 &` tls_sni                    `&  TLS SNI on <= lines
37589 &` unknown_in_list            `&  DNS lookup failed in list match
37590
37591 &` all                        `&  all of the above
37592 .endd
37593 See also the &%slow_lookup_log%& main configuration option,
37594 section &<<SECID99>>&
37595
37596 More details on each of these items follows:
37597
37598 .ilist
37599 .cindex "8BITMIME"
37600 .cindex "log" "8BITMIME"
37601 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
37602 which may help in tracking down interoperability issues with ancient MTAs
37603 that are not 8bit clean.  This is added to the &"<="& line, tagged with
37604 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
37605 &`7BIT`& and &`8BITMIME`& respectively.
37606 .next
37607 .cindex "&%warn%& ACL verb" "log when skipping"
37608 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
37609 its conditions cannot be evaluated, a log line to this effect is written if
37610 this log selector is set.
37611 .next
37612 .cindex "log" "rewriting"
37613 .cindex "rewriting" "logging"
37614 &%address_rewrite%&: This applies both to global rewrites and per-transport
37615 rewrites, but not to rewrites in filters run as an unprivileged user (because
37616 such users cannot access the log).
37617 .next
37618 .cindex "log" "full parentage"
37619 &%all_parents%&: Normally only the original and final addresses are logged on
37620 delivery lines; with this selector, intermediate parents are given in
37621 parentheses between them.
37622 .next
37623 .cindex "log" "Exim arguments"
37624 .cindex "Exim arguments, logging"
37625 &%arguments%&: This causes Exim to write the arguments with which it was called
37626 to the main log, preceded by the current working directory. This is a debugging
37627 feature, added to make it easier to find out how certain MUAs call
37628 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
37629 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
37630 that are empty or that contain white space are quoted. Non-printing characters
37631 are shown as escape sequences. This facility cannot log unrecognized arguments,
37632 because the arguments are checked before the configuration file is read. The
37633 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
37634 between the caller and Exim.
37635 .next
37636 .cindex "log" "connection rejections"
37637 &%connection_reject%&: A log entry is written whenever an incoming SMTP
37638 connection is rejected, for whatever reason.
37639 .next
37640 .cindex "log" "delayed delivery"
37641 .cindex "delayed delivery, logging"
37642 &%delay_delivery%&: A log entry is written whenever a delivery process is not
37643 started for an incoming message because the load is too high or too many
37644 messages were received on one connection. Logging does not occur if no delivery
37645 process is started because &%queue_only%& is set or &%-odq%& was used.
37646 .next
37647 .cindex "log" "delivery duration"
37648 &%deliver_time%&: For each delivery, the amount of real time it has taken to
37649 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
37650 If millisecond logging is enabled, short times will be shown with greater
37651 precision, eg. &`DT=0.304s`&.
37652 .next
37653 .cindex "log" "message size on delivery"
37654 .cindex "size" "of message"
37655 &%delivery_size%&: For each delivery, the size of message delivered is added to
37656 the &"=>"& line, tagged with S=.
37657 .next
37658 .cindex log "DKIM verification"
37659 .cindex DKIM "verification logging"
37660 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
37661 verifies successfully a tag of DKIM is added, with one of the verified domains.
37662 .next
37663 .cindex log "DKIM verification"
37664 .cindex DKIM "verification logging"
37665 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
37666 .next
37667 .cindex "log" "dnslist defer"
37668 .cindex "DNS list" "logging defer"
37669 .cindex "black list (DNS)"
37670 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
37671 DNS black list suffers a temporary error.
37672 .next
37673 .cindex log dnssec
37674 .cindex dnssec logging
37675 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
37676 dns lookups gave secure results a tag of DS is added.
37677 For acceptance this covers the reverse and forward lookups for host name verification.
37678 It does not cover helo-name verification.
37679 For delivery this covers the SRV, MX, A and/or AAAA lookups.
37680 .next
37681 .cindex "log" "ETRN commands"
37682 .cindex "ETRN" "logging"
37683 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
37684 is run to determine whether or not it is actually accepted. An invalid ETRN
37685 command, or one received within a message transaction is not logged by this
37686 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
37687 .next
37688 .cindex "log" "host lookup failure"
37689 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
37690 any addresses, or when a lookup of an IP address fails to find a host name, a
37691 log line is written. This logging does not apply to direct DNS lookups when
37692 routing email addresses, but it does apply to &"byname"& lookups.
37693 .next
37694 .cindex "log" "ident timeout"
37695 .cindex "RFC 1413" "logging timeout"
37696 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
37697 client's ident port times out.
37698 .next
37699 .cindex "log" "incoming interface"
37700 .cindex "log" "local interface"
37701 .cindex "log" "local address and port"
37702 .cindex "TCP/IP" "logging local address and port"
37703 .cindex "interface" "logging"
37704 &%incoming_interface%&: The interface on which a message was received is added
37705 to the &"<="& line as an IP address in square brackets, tagged by I= and
37706 followed by a colon and the port number. The local interface and port are also
37707 added to other SMTP log lines, for example, &"SMTP connection from"&, to
37708 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
37709 The latter can be disabled by turning off the &%outgoing_interface%& option.
37710 .next
37711 .cindex log "incoming proxy address"
37712 .cindex proxy "logging proxy address"
37713 .cindex "TCP/IP" "logging proxy address"
37714 &%proxy%&: The internal (closest to the system running Exim) IP address
37715 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
37716 on a proxied connection
37717 or the &"=>"& line for a message delivered on a proxied connection.
37718 See &<<SECTproxyInbound>>& for more information.
37719 .next
37720 .cindex "log" "incoming remote port"
37721 .cindex "port" "logging remote"
37722 .cindex "TCP/IP" "logging incoming remote port"
37723 .vindex "&$sender_fullhost$&"
37724 .vindex "&$sender_rcvhost$&"
37725 &%incoming_port%&: The remote port number from which a message was received is
37726 added to log entries and &'Received:'& header lines, following the IP address
37727 in square brackets, and separated from it by a colon. This is implemented by
37728 changing the value that is put in the &$sender_fullhost$& and
37729 &$sender_rcvhost$& variables. Recording the remote port number has become more
37730 important with the widening use of NAT (see RFC 2505).
37731 .next
37732 .cindex "log" "dropped connection"
37733 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
37734 connection is unexpectedly dropped.
37735 .next
37736 .cindex "log" "millisecond timestamps"
37737 .cindex millisecond logging
37738 .cindex timestamps "millisecond, in logs"
37739 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
37740 appended to the seconds value.
37741 .next
37742 .cindex "log" "message id"
37743 &%msg_id%&: The value of the Message-ID: header.
37744 .next
37745 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
37746 This will be either because the message is a bounce, or was submitted locally
37747 (submission mode) without one.
37748 The field identifier will have an asterix appended: &"id*="&.
37749 .next
37750 .cindex "log" "outgoing interface"
37751 .cindex "log" "local interface"
37752 .cindex "log" "local address and port"
37753 .cindex "TCP/IP" "logging local address and port"
37754 .cindex "interface" "logging"
37755 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
37756 interface on which a message was sent is added to delivery lines as an I= tag
37757 followed by IP address in square brackets. You can disable this by turning
37758 off the &%outgoing_interface%& option.
37759 .next
37760 .cindex "log" "outgoing remote port"
37761 .cindex "port" "logging outgoing remote"
37762 .cindex "TCP/IP" "logging outgoing remote port"
37763 &%outgoing_port%&: The remote port number is added to delivery log lines (those
37764 containing => tags) following the IP address.
37765 The local port is also added if &%incoming_interface%& and
37766 &%outgoing_interface%& are both enabled.
37767 This option is not included in the default setting, because for most ordinary
37768 configurations, the remote port number is always 25 (the SMTP port), and the
37769 local port is a random ephemeral port.
37770 .next
37771 .cindex "log" "process ids in"
37772 .cindex "pid (process id)" "in log lines"
37773 &%pid%&: The current process id is added to every log line, in square brackets,
37774 immediately after the time and date.
37775 .next
37776 .cindex log pipelining
37777 .cindex pipelining "logging outgoing"
37778 &%pipelining%&: A field is added to delivery and accept
37779 log lines when the ESMTP PIPELINING extension was used.
37780 The field is a single "L".
37781
37782 On accept lines, where PIPELINING was offered but not used by the client,
37783 the field has a minus appended.
37784
37785 .cindex "pipelining" "early connection"
37786 If Exim is built with the SUPPORT_PIPE_CONNECT build option
37787 accept "L" fields have a period appended if the feature was
37788 offered but not used, or an asterisk appended if used.
37789 Delivery "L" fields have an asterisk appended if used.
37790
37791 .next
37792 .cindex "log" "queue run"
37793 .cindex "queue runner" "logging"
37794 &%queue_run%&: The start and end of every queue run are logged.
37795 .next
37796 .cindex "log" "queue time"
37797 &%queue_time%&: The amount of time the message has been in the queue on the
37798 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
37799 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
37800 includes reception time as well as the delivery time for the current address.
37801 This means that it may be longer than the difference between the arrival and
37802 delivery log line times, because the arrival log line is not written until the
37803 message has been successfully received.
37804 If millisecond logging is enabled, short times will be shown with greater
37805 precision, eg. &`QT=1.578s`&.
37806 .next
37807 &%queue_time_overall%&: The amount of time the message has been in the queue on
37808 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
37809 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
37810 message, so it includes reception time as well as the total delivery time.
37811 .next
37812 .cindex "log" "receive duration"
37813 &%receive_time%&: For each message, the amount of real time it has taken to
37814 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
37815 If millisecond logging is enabled, short times will be shown with greater
37816 precision, eg. &`RT=0.204s`&.
37817 .next
37818 .cindex "log" "recipients"
37819 &%received_recipients%&: The recipients of a message are listed in the main log
37820 as soon as the message is received. The list appears at the end of the log line
37821 that is written when a message is received, preceded by the word &"for"&. The
37822 addresses are listed after they have been qualified, but before any rewriting
37823 has taken place.
37824 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
37825 in the list.
37826 .next
37827 .cindex "log" "sender reception"
37828 &%received_sender%&: The unrewritten original sender of a message is added to
37829 the end of the log line that records the message's arrival, after the word
37830 &"from"& (before the recipients if &%received_recipients%& is also set).
37831 .next
37832 .cindex "log" "header lines for rejection"
37833 &%rejected_header%&: If a message's header has been received at the time a
37834 rejection is written to the reject log, the complete header is added to the
37835 log. Header logging can be turned off individually for messages that are
37836 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
37837 .next
37838 .cindex "log" "retry defer"
37839 &%retry_defer%&: A log line is written if a delivery is deferred because a
37840 retry time has not yet been reached. However, this &"retry time not reached"&
37841 message is always omitted from individual message logs after the first delivery
37842 attempt.
37843 .next
37844 .cindex "log" "return path"
37845 &%return_path_on_delivery%&: The return path that is being transmitted with
37846 the message is included in delivery and bounce lines, using the tag P=.
37847 This is omitted if no delivery actually happens, for example, if routing fails,
37848 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
37849 .next
37850 .cindex "log" "sender on delivery"
37851 &%sender_on_delivery%&: The message's sender address is added to every delivery
37852 and bounce line, tagged by F= (for &"from"&).
37853 This is the original sender that was received with the message; it is not
37854 necessarily the same as the outgoing return path.
37855 .next
37856 .cindex "log" "sender verify failure"
37857 &%sender_verify_fail%&: If this selector is unset, the separate log line that
37858 gives details of a sender verification failure is not written. Log lines for
37859 the rejection of SMTP commands contain just &"sender verify failed"&, so some
37860 detail is lost.
37861 .next
37862 .cindex "log" "size rejection"
37863 &%size_reject%&: A log line is written whenever a message is rejected because
37864 it is too big.
37865 .next
37866 .cindex "log" "frozen messages; skipped"
37867 .cindex "frozen messages" "logging skipping"
37868 &%skip_delivery%&: A log line is written whenever a message is skipped during a
37869 queue run because it is frozen or because another process is already delivering
37870 it.
37871 .cindex "&""spool file is locked""&"
37872 The message that is written is &"spool file is locked"&.
37873 .next
37874 .cindex "log" "smtp confirmation"
37875 .cindex "SMTP" "logging confirmation"
37876 .cindex "LMTP" "logging confirmation"
37877 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
37878 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
37879 A number of MTAs (including Exim) return an identifying string in this
37880 response.
37881 .next
37882 .cindex "log" "SMTP connections"
37883 .cindex "SMTP" "logging connections"
37884 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
37885 established or closed, unless the connection is from a host that matches
37886 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
37887 only when the closure is unexpected.) This applies to connections from local
37888 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
37889 dropped in the middle of a message, a log line is always written, whether or
37890 not this selector is set, but otherwise nothing is written at the start and end
37891 of connections unless this selector is enabled.
37892
37893 For TCP/IP connections to an Exim daemon, the current number of connections is
37894 included in the log message for each new connection, but note that the count is
37895 reset if the daemon is restarted.
37896 Also, because connections are closed (and the closure is logged) in
37897 subprocesses, the count may not include connections that have been closed but
37898 whose termination the daemon has not yet noticed. Thus, while it is possible to
37899 match up the opening and closing of connections in the log, the value of the
37900 logged counts may not be entirely accurate.
37901 .next
37902 .cindex "log" "SMTP transaction; incomplete"
37903 .cindex "SMTP" "logging incomplete transactions"
37904 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
37905 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
37906 and the message sender plus any accepted recipients are included in the log
37907 line. This can provide evidence of dictionary attacks.
37908 .next
37909 .cindex "log" "non-MAIL SMTP sessions"
37910 .cindex "MAIL" "logging session without"
37911 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
37912 connection terminates without having issued a MAIL command. This includes both
37913 the case when the connection is dropped, and the case when QUIT is used. It
37914 does not include cases where the connection is rejected right at the start (by
37915 an ACL, or because there are too many connections, or whatever). These cases
37916 already have their own log lines.
37917
37918 The log line that is written contains the identity of the client in the usual
37919 way, followed by D= and a time, which records the duration of the connection.
37920 If the connection was authenticated, this fact is logged exactly as it is for
37921 an incoming message, with an A= item. If the connection was encrypted, CV=,
37922 DN=, and X= items may appear as they do for an incoming message, controlled by
37923 the same logging options.
37924
37925 Finally, if any SMTP commands were issued during the connection, a C= item
37926 is added to the line, listing the commands that were used. For example,
37927 .code
37928 C=EHLO,QUIT
37929 .endd
37930 shows that the client issued QUIT straight after EHLO. If there were fewer
37931 than 20 commands, they are all listed. If there were more than 20 commands,
37932 the last 20 are listed, preceded by &"..."&. However, with the default
37933 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
37934 have been aborted before 20 non-mail commands are processed.
37935 .next
37936 &%smtp_mailauth%&: A third subfield with the authenticated sender,
37937 colon-separated, is appended to the A= item for a message arrival or delivery
37938 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
37939 was accepted or used.
37940 .next
37941 .cindex "log" "SMTP protocol error"
37942 .cindex "SMTP" "logging protocol error"
37943 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
37944 encountered. Exim does not have perfect detection of all protocol errors
37945 because of transmission delays and the use of pipelining. If PIPELINING has
37946 been advertised to a client, an Exim server assumes that the client will use
37947 it, and therefore it does not count &"expected"& errors (for example, RCPT
37948 received after rejecting MAIL) as protocol errors.
37949 .next
37950 .cindex "SMTP" "logging syntax errors"
37951 .cindex "SMTP" "syntax errors; logging"
37952 .cindex "SMTP" "unknown command; logging"
37953 .cindex "log" "unknown SMTP command"
37954 .cindex "log" "SMTP syntax error"
37955 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
37956 encountered. An unrecognized command is treated as a syntax error. For an
37957 external connection, the host identity is given; for an internal connection
37958 using &%-bs%& the sender identification (normally the calling user) is given.
37959 .next
37960 .cindex "log" "subject"
37961 .cindex "subject, logging"
37962 &%subject%&: The subject of the message is added to the arrival log line,
37963 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
37964 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
37965 specifies whether characters with values greater than 127 should be logged
37966 unchanged, or whether they should be rendered as escape sequences.
37967 .next
37968 .cindex "log" "certificate verification"
37969 .cindex log DANE
37970 .cindex DANE logging
37971 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
37972 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
37973 verified
37974 using a CA trust anchor,
37975 &`CA=dane`& if using a DNS trust anchor,
37976 and &`CV=no`& if not.
37977 .next
37978 .cindex "log" "TLS cipher"
37979 .cindex "TLS" "logging cipher"
37980 &%tls_cipher%&: When a message is sent or received over an encrypted
37981 connection, the cipher suite used is added to the log line, preceded by X=.
37982 .next
37983 .cindex "log" "TLS peer DN"
37984 .cindex "TLS" "logging peer DN"
37985 &%tls_peerdn%&: When a message is sent or received over an encrypted
37986 connection, and a certificate is supplied by the remote host, the peer DN is
37987 added to the log line, preceded by DN=.
37988 .next
37989 .cindex "log" "TLS SNI"
37990 .cindex "TLS" "logging SNI"
37991 &%tls_sni%&: When a message is received over an encrypted connection, and
37992 the remote host provided the Server Name Indication extension, the SNI is
37993 added to the log line, preceded by SNI=.
37994 .next
37995 .cindex "log" "DNS failure in list"
37996 &%unknown_in_list%&: This setting causes a log entry to be written when the
37997 result of a list match is failure because a DNS lookup failed.
37998 .endlist
37999
38000
38001 .section "Message log" "SECID260"
38002 .cindex "message" "log file for"
38003 .cindex "log" "message log; description of"
38004 .cindex "&_msglog_& directory"
38005 .oindex "&%preserve_message_logs%&"
38006 In addition to the general log files, Exim writes a log file for each message
38007 that it handles. The names of these per-message logs are the message ids, and
38008 they are kept in the &_msglog_& sub-directory of the spool directory. Each
38009 message log contains copies of the log lines that apply to the message. This
38010 makes it easier to inspect the status of an individual message without having
38011 to search the main log. A message log is deleted when processing of the message
38012 is complete, unless &%preserve_message_logs%& is set, but this should be used
38013 only with great care because they can fill up your disk very quickly.
38014
38015 On a heavily loaded system, it may be desirable to disable the use of
38016 per-message logs, in order to reduce disk I/O. This can be done by setting the
38017 &%message_logs%& option false.
38018 .ecindex IIDloggen
38019
38020
38021
38022
38023 . ////////////////////////////////////////////////////////////////////////////
38024 . ////////////////////////////////////////////////////////////////////////////
38025
38026 .chapter "Exim utilities" "CHAPutils"
38027 .scindex IIDutils "utilities"
38028 A number of utility scripts and programs are supplied with Exim and are
38029 described in this chapter. There is also the Exim Monitor, which is covered in
38030 the next chapter. The utilities described here are:
38031
38032 .itable none 0 0 3  7* left  15* left  40* left
38033 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
38034   "list what Exim processes are doing"
38035 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
38036 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
38037 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
38038 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
38039                                                 various criteria"
38040 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
38041 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
38042   "extract statistics from the log"
38043 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
38044   "check address acceptance from given IP"
38045 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
38046 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
38047 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
38048 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
38049 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
38050 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
38051 .endtable
38052
38053 Another utility that might be of use to sites with many MTAs is Tom Kistner's
38054 &'exilog'&. It provides log visualizations across multiple Exim servers. See
38055 &url(https://duncanthrax.net/exilog/) for details.
38056
38057
38058
38059
38060 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
38061 .cindex "&'exiwhat'&"
38062 .cindex "process, querying"
38063 .cindex "SIGUSR1"
38064 On operating systems that can restart a system call after receiving a signal
38065 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
38066 a line describing what it is doing to the file &_exim-process.info_& in the
38067 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
38068 processes it can find, having first emptied the file. It then waits for one
38069 second to allow the Exim processes to react before displaying the results. In
38070 order to run &'exiwhat'& successfully you have to have sufficient privilege to
38071 send the signal to the Exim processes, so it is normally run as root.
38072
38073 &*Warning*&: This is not an efficient process. It is intended for occasional
38074 use by system administrators. It is not sensible, for example, to set up a
38075 script that sends SIGUSR1 signals to Exim processes at short intervals.
38076
38077
38078 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
38079 varies in different operating systems. Not only are different options used,
38080 but the format of the output is different. For this reason, there are some
38081 system configuration options that configure exactly how &'exiwhat'& works. If
38082 it doesn't seem to be working for you, check the following compile-time
38083 options:
38084 .display
38085 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
38086 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
38087 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
38088 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
38089 .endd
38090 An example of typical output from &'exiwhat'& is
38091 .code
38092 164 daemon: -q1h, listening on port 25
38093 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
38094 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
38095   [10.19.42.42] (editor@ref.example)
38096 10592 handling incoming call from [192.168.243.242]
38097 10628 accepting a local non-SMTP message
38098 .endd
38099 The first number in the output line is the process number. The third line has
38100 been split here, in order to fit it on the page.
38101
38102
38103
38104 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
38105 .cindex "&'exiqgrep'&"
38106 .cindex "queue" "grepping"
38107 This utility is a Perl script contributed by Matt Hubbard. It runs
38108 .code
38109 exim -bpu
38110 .endd
38111 or (in case &*-a*& switch is specified)
38112 .code
38113 exim -bp
38114 .endd
38115 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
38116 contain alternate exim configuration the queue management might be using.
38117
38118 to obtain a queue listing, and then greps the output to select messages
38119 that match given criteria. The following selection options are available:
38120
38121 .vlist
38122 .vitem &*-f*&&~<&'regex'&>
38123 Match the sender address using a case-insensitive search. The field that is
38124 tested is enclosed in angle brackets, so you can test for bounce messages with
38125 .code
38126 exiqgrep -f '^<>$'
38127 .endd
38128 .vitem &*-r*&&~<&'regex'&>
38129 Match a recipient address using a case-insensitive search. The field that is
38130 tested is not enclosed in angle brackets.
38131
38132 .vitem &*-s*&&~<&'regex'&>
38133 Match against the size field.
38134
38135 .vitem &*-y*&&~<&'seconds'&>
38136 Match messages that are younger than the given time.
38137
38138 .vitem &*-o*&&~<&'seconds'&>
38139 Match messages that are older than the given time.
38140
38141 .vitem &*-z*&
38142 Match only frozen messages.
38143
38144 .vitem &*-x*&
38145 Match only non-frozen messages.
38146
38147 .vitem &*-G*&&~<&'queuename'&>
38148 Match only messages in the given queue.  Without this, the default queue is searched.
38149 .endlist
38150
38151 The following options control the format of the output:
38152
38153 .vlist
38154 .vitem &*-c*&
38155 Display only the count of matching messages.
38156
38157 .vitem &*-l*&
38158 Long format &-- display the full message information as output by Exim. This is
38159 the default.
38160
38161 .vitem &*-i*&
38162 Display message ids only.
38163
38164 .vitem &*-b*&
38165 Brief format &-- one line per message.
38166
38167 .vitem &*-R*&
38168 Display messages in reverse order.
38169
38170 .vitem &*-a*&
38171 Include delivered recipients in queue listing.
38172 .endlist
38173
38174 There is one more option, &%-h%&, which outputs a list of options.
38175
38176
38177
38178 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
38179 .cindex "&'exiqsumm'&"
38180 .cindex "queue" "summary"
38181 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
38182 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
38183 running a command such as
38184 .code
38185 exim -bp | exiqsumm
38186 .endd
38187 The output consists of one line for each domain that has messages waiting for
38188 it, as in the following example:
38189 .code
38190 3   2322   74m   66m  msn.com.example
38191 .endd
38192 Each line lists the number of pending deliveries for a domain, their total
38193 volume, and the length of time that the oldest and the newest messages have
38194 been waiting. Note that the number of pending deliveries is greater than the
38195 number of messages when messages have more than one recipient.
38196
38197 A summary line is output at the end. By default the output is sorted on the
38198 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
38199 the output to be sorted by oldest message and by count of messages,
38200 respectively. There are also three options that split the messages for each
38201 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
38202 separates frozen messages, and &%-s%& separates messages according to their
38203 sender.
38204
38205 The output of &'exim -bp'& contains the original addresses in the message, so
38206 this also applies to the output from &'exiqsumm'&. No domains from addresses
38207 generated by aliasing or forwarding are included (unless the &%one_time%&
38208 option of the &(redirect)& router has been used to convert them into &"top
38209 level"& addresses).
38210
38211
38212
38213
38214 .section "Extracting specific information from the log (exigrep)" &&&
38215          "SECTextspeinf"
38216 .cindex "&'exigrep'&"
38217 .cindex "log" "extracts; grepping for"
38218 The &'exigrep'& utility is a Perl script that searches one or more main log
38219 files for entries that match a given pattern. When it finds a match, it
38220 extracts all the log entries for the relevant message, not just those that
38221 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
38222 given message, or all mail for a given user, or for a given host, for example.
38223 The input files can be in Exim log format or syslog format.
38224 If a matching log line is not associated with a specific message, it is
38225 included in &'exigrep'&'s output without any additional lines. The usage is:
38226 .display
38227 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
38228 .endd
38229 If no log filenames are given on the command line, the standard input is read.
38230
38231 The &%-t%& argument specifies a number of seconds. It adds an additional
38232 condition for message selection. Messages that are complete are shown only if
38233 they spent more than <&'n'&> seconds in the queue.
38234
38235 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
38236 makes it case-sensitive. This may give a performance improvement when searching
38237 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
38238 option; with &%-I%& they do not. In both cases it is possible to change the
38239 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
38240
38241 The &%-l%& option means &"literal"&, that is, treat all characters in the
38242 pattern as standing for themselves. Otherwise the pattern must be a Perl
38243 regular expression.
38244
38245 The &%-v%& option inverts the matching condition. That is, a line is selected
38246 if it does &'not'& match the pattern.
38247
38248 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
38249 that are generated as a result/response to a message that &'exigrep'& matched
38250 normally.
38251
38252 Example of &%-M%&:
38253 user_a sends a message to user_b, which generates a bounce back to user_b. If
38254 &'exigrep'& is used to search for &"user_a"&, only the first message will be
38255 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
38256 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
38257 when searching for &"user_a"& will show both messages since the bounce is
38258 &"related"& to or a &"result"& of the first message that was found by the
38259 search term.
38260
38261 If the location of a &'zcat'& command is known from the definition of
38262 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
38263 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
38264 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
38265 autodetection of some well known compression extensions.
38266
38267
38268 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
38269 .cindex "&'exipick'&"
38270 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
38271 lists messages from the queue according to a variety of criteria. For details
38272 of &'exipick'&'s facilities, run &'exipick'& with
38273 the &%--help%& option.
38274
38275
38276 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
38277 .cindex "log" "cycling local files"
38278 .cindex "cycling logs"
38279 .cindex "&'exicyclog'&"
38280 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
38281 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
38282 you are using log files with datestamps in their names (see section
38283 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
38284 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
38285 There are two command line options for &'exicyclog'&:
38286 .ilist
38287 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
38288 default that is set when Exim is built. The default default is 10.
38289 .next
38290 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
38291 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
38292 overriding the script's default, which is to find the setting from Exim's
38293 configuration.
38294 .endlist
38295
38296 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
38297 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
38298 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
38299 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
38300 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
38301 logs are handled similarly.
38302
38303 If the limit is greater than 99, the script uses 3-digit numbers such as
38304 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
38305 to one that is greater, or &'vice versa'&, you will have to fix the names of
38306 any existing log files.
38307
38308 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
38309 the end are deleted. All files with numbers greater than 01 are compressed,
38310 using a compression command which is configured by the COMPRESS_COMMAND
38311 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
38312 root &%crontab%& entry of the form
38313 .code
38314 1 0 * * * su exim -c /usr/exim/bin/exicyclog
38315 .endd
38316 assuming you have used the name &"exim"& for the Exim user. You can run
38317 &'exicyclog'& as root if you wish, but there is no need.
38318
38319
38320
38321 .section "Mail statistics (eximstats)" "SECTmailstat"
38322 .cindex "statistics"
38323 .cindex "&'eximstats'&"
38324 A Perl script called &'eximstats'& is provided for extracting statistical
38325 information from log files. The output is either plain text, or HTML.
38326 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
38327 . --- 404 error and everything else points to that.
38328
38329 The &'eximstats'& script has been hacked about quite a bit over time. The
38330 latest version is the result of some extensive revision by Steve Campbell. A
38331 lot of information is given by default, but there are options for suppressing
38332 various parts of it. Following any options, the arguments to the script are a
38333 list of files, which should be main log files. For example:
38334 .code
38335 eximstats -nr /var/spool/exim/log/mainlog.01
38336 .endd
38337 By default, &'eximstats'& extracts information about the number and volume of
38338 messages received from or delivered to various hosts. The information is sorted
38339 both by message count and by volume, and the top fifty hosts in each category
38340 are listed on the standard output. Similar information, based on email
38341 addresses or domains instead of hosts can be requested by means of various
38342 options. For messages delivered and received locally, similar statistics are
38343 also produced per user.
38344
38345 The output also includes total counts and statistics about delivery errors, and
38346 histograms showing the number of messages received and deliveries made in each
38347 hour of the day. A delivery with more than one address in its envelope (for
38348 example, an SMTP transaction with more than one RCPT command) is counted
38349 as a single delivery by &'eximstats'&.
38350
38351 Though normally more deliveries than receipts are reported (as messages may
38352 have multiple recipients), it is possible for &'eximstats'& to report more
38353 messages received than delivered, even though the queue is empty at the start
38354 and end of the period in question. If an incoming message contains no valid
38355 recipients, no deliveries are recorded for it. A bounce message is handled as
38356 an entirely separate message.
38357
38358 &'eximstats'& always outputs a grand total summary giving the volume and number
38359 of messages received and deliveries made, and the number of hosts involved in
38360 each case. It also outputs the number of messages that were delayed (that is,
38361 not completely delivered at the first attempt), and the number that had at
38362 least one address that failed.
38363
38364 The remainder of the output is in sections that can be independently disabled
38365 or modified by various options. It consists of a summary of deliveries by
38366 transport, histograms of messages received and delivered per time interval
38367 (default per hour), information about the time messages spent in the queue,
38368 a list of relayed messages, lists of the top fifty sending hosts, local
38369 senders, destination hosts, and destination local users by count and by volume,
38370 and a list of delivery errors that occurred.
38371
38372 The relay information lists messages that were actually relayed, that is, they
38373 came from a remote host and were directly delivered to some other remote host,
38374 without being processed (for example, for aliasing or forwarding) locally.
38375
38376 There are quite a few options for &'eximstats'& to control exactly what it
38377 outputs. These are documented in the Perl script itself, and can be extracted
38378 by running the command &(perldoc)& on the script. For example:
38379 .code
38380 perldoc /usr/exim/bin/eximstats
38381 .endd
38382
38383 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
38384 .cindex "&'exim_checkaccess'&"
38385 .cindex "policy control" "checking access"
38386 .cindex "checking access"
38387 The &%-bh%& command line argument allows you to run a fake SMTP session with
38388 debugging output, in order to check what Exim is doing when it is applying
38389 policy controls to incoming SMTP mail. However, not everybody is sufficiently
38390 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
38391 sometimes you just want to answer the question &"Does this address have
38392 access?"& without bothering with any further details.
38393
38394 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
38395 two arguments, an IP address and an email address:
38396 .code
38397 exim_checkaccess 10.9.8.7 A.User@a.domain.example
38398 .endd
38399 The utility runs a call to Exim with the &%-bh%& option, to test whether the
38400 given email address would be accepted in a RCPT command in a TCP/IP
38401 connection from the host with the given IP address. The output of the utility
38402 is either the word &"accepted"&, or the SMTP error response, for example:
38403 .code
38404 Rejected:
38405 550 Relay not permitted
38406 .endd
38407 When running this test, the utility uses &`<>`& as the envelope sender address
38408 for the MAIL command, but you can change this by providing additional
38409 options. These are passed directly to the Exim command. For example, to specify
38410 that the test is to be run with the sender address &'himself@there.example'&
38411 you can use:
38412 .code
38413 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
38414                  -f himself@there.example
38415 .endd
38416 Note that these additional Exim command line items must be given after the two
38417 mandatory arguments.
38418
38419 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
38420 while running its checks. You can run checks that include callouts by using
38421 &%-bhc%&, but this is not yet available in a &"packaged"& form.
38422
38423
38424
38425 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
38426 .cindex "DBM" "building dbm files"
38427 .cindex "building DBM files"
38428 .cindex "&'exim_dbmbuild'&"
38429 .cindex "lower casing"
38430 .cindex "binary zero" "in lookup key"
38431 The &'exim_dbmbuild'& program reads an input file containing keys and data in
38432 the format used by the &(lsearch)& lookup (see section
38433 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
38434 names as keys and the remainder of the information as data. The lower-casing
38435 can be prevented by calling the program with the &%-nolc%& option.
38436
38437 A terminating zero is included as part of the key string. This is expected by
38438 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
38439 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
38440 strings or the data strings. The &(dbmnz)& lookup type can be used with such
38441 files.
38442
38443 The program requires two arguments: the name of the input file (which can be a
38444 single hyphen to indicate the standard input), and the name of the output file.
38445 It creates the output under a temporary name, and then renames it if all went
38446 well.
38447
38448 .cindex "USE_DB"
38449 If the native DB interface is in use (USE_DB is set in a compile-time
38450 configuration file &-- this is common in free versions of Unix) the two
38451 filenames must be different, because in this mode the Berkeley DB functions
38452 create a single output file using exactly the name given. For example,
38453 .code
38454 exim_dbmbuild /etc/aliases /etc/aliases.db
38455 .endd
38456 reads the system alias file and creates a DBM version of it in
38457 &_/etc/aliases.db_&.
38458
38459 In systems that use the &'ndbm'& routines (mostly proprietary versions of
38460 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
38461 environment, the suffixes are added to the second argument of
38462 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
38463 when the Berkeley functions are used in compatibility mode (though this is not
38464 recommended), because in that case it adds a &_.db_& suffix to the filename.
38465
38466 If a duplicate key is encountered, the program outputs a warning, and when it
38467 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
38468 option is used. By default, only the first of a set of duplicates is used &--
38469 this makes it compatible with &(lsearch)& lookups. There is an option
38470 &%-lastdup%& which causes it to use the data for the last duplicate instead.
38471 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
38472 &%stderr%&. For other errors, where it doesn't actually make a new file, the
38473 return code is 2.
38474
38475
38476
38477
38478 .section "Finding individual retry times (exinext)" "SECTfinindret"
38479 .cindex "retry" "times"
38480 .cindex "&'exinext'&"
38481 A utility called &'exinext'& (mostly a Perl script) provides the ability to
38482 fish specific information out of the retry database. Given a mail domain (or a
38483 complete address), it looks up the hosts for that domain, and outputs any retry
38484 information for the hosts or for the domain. At present, the retry information
38485 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
38486 output. For example:
38487 .code
38488 $ exinext piglet@milne.fict.example
38489 kanga.milne.example:192.168.8.1 error 146: Connection refused
38490   first failed: 21-Feb-1996 14:57:34
38491   last tried:   21-Feb-1996 14:57:34
38492   next try at:  21-Feb-1996 15:02:34
38493 roo.milne.example:192.168.8.3 error 146: Connection refused
38494   first failed: 20-Jan-1996 13:12:08
38495   last tried:   21-Feb-1996 11:42:03
38496   next try at:  21-Feb-1996 19:42:03
38497   past final cutoff time
38498 .endd
38499 You can also give &'exinext'& a local part, without a domain, and it
38500 will give any retry information for that local part in your default domain.
38501 A message id can be used to obtain retry information pertaining to a specific
38502 message. This exists only when an attempt to deliver a message to a remote host
38503 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
38504 &'exinext'& is not particularly efficient, but then it is not expected to be
38505 run very often.
38506
38507 The &'exinext'& utility calls Exim to find out information such as the location
38508 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
38509 passed on to the &'exim'& commands. The first specifies an alternate Exim
38510 configuration file, and the second sets macros for use within the configuration
38511 file. These features are mainly to help in testing, but might also be useful in
38512 environments where more than one configuration file is in use.
38513
38514
38515
38516 .section "Hints database maintenance" "SECThindatmai"
38517 .cindex "hints database" "maintenance"
38518 .cindex "maintaining Exim's hints database"
38519 Three utility programs are provided for maintaining the DBM files that Exim
38520 uses to contain its delivery hint information. Each program requires two
38521 arguments. The first specifies the name of Exim's spool directory, and the
38522 second is the name of the database it is to operate on. These are as follows:
38523
38524 .ilist
38525 &'retry'&: the database of retry information
38526 .next
38527 &'wait-'&<&'transport name'&>: databases of information about messages waiting
38528 for remote hosts
38529 .next
38530 &'callout'&: the callout cache
38531 .next
38532 &'ratelimit'&: the data for implementing the ratelimit ACL condition
38533 .next
38534 &'misc'&: other hints data
38535 .endlist
38536
38537 The &'misc'& database is used for
38538
38539 .ilist
38540 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
38541 .next
38542 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
38543 &(smtp)& transport)
38544 .next
38545 Limiting the concurrency of specific transports (when &%max_parallel%& is set
38546 in a transport)
38547 .endlist
38548
38549
38550
38551 .section "exim_dumpdb" "SECID261"
38552 .cindex "&'exim_dumpdb'&"
38553 The entire contents of a database are written to the standard output by the
38554 &'exim_dumpdb'& program, which has no options or arguments other than the
38555 spool and database names. For example, to dump the retry database:
38556 .code
38557 exim_dumpdb /var/spool/exim retry
38558 .endd
38559 Two lines of output are produced for each entry:
38560 .code
38561 T:mail.ref.example:192.168.242.242 146 77 Connection refused
38562 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
38563 .endd
38564 The first item on the first line is the key of the record. It starts with one
38565 of the letters R, or T, depending on whether it refers to a routing or
38566 transport retry. For a local delivery, the next part is the local address; for
38567 a remote delivery it is the name of the remote host, followed by its failing IP
38568 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
38569 transport). If the remote port is not the standard one (port 25), it is added
38570 to the IP address. Then there follows an error code, an additional error code,
38571 and a textual description of the error.
38572
38573 The three times on the second line are the time of first failure, the time of
38574 the last delivery attempt, and the computed time for the next attempt. The line
38575 ends with an asterisk if the cutoff time for the last retry rule has been
38576 exceeded.
38577
38578 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
38579 consists of a host name followed by a list of ids for messages that are or were
38580 waiting to be delivered to that host. If there are a very large number for any
38581 one host, continuation records, with a sequence number added to the host name,
38582 may be seen. The data in these records is often out of date, because a message
38583 may be routed to several alternative hosts, and Exim makes no effort to keep
38584 cross-references.
38585
38586
38587
38588 .section "exim_tidydb" "SECID262"
38589 .cindex "&'exim_tidydb'&"
38590 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
38591 database. If run with no options, it removes all records that are more than 30
38592 days old. The age is calculated from the date and time that the record was last
38593 updated. Note that, in the case of the retry database, it is &'not'& the time
38594 since the first delivery failure. Information about a host that has been down
38595 for more than 30 days will remain in the database, provided that the record is
38596 updated sufficiently often.
38597
38598 The cutoff date can be altered by means of the &%-t%& option, which must be
38599 followed by a time. For example, to remove all records older than a week from
38600 the retry database:
38601 .code
38602 exim_tidydb -t 7d /var/spool/exim retry
38603 .endd
38604 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
38605 message ids. In the former these appear as data in records keyed by host &--
38606 they were messages that were waiting for that host &-- and in the latter they
38607 are the keys for retry information for messages that have suffered certain
38608 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
38609 message ids in database records are those of messages that are still on the
38610 queue. Message ids for messages that no longer exist are removed from
38611 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
38612 For the &'retry'& database, records whose keys are non-existent message ids are
38613 removed. The &'exim_tidydb'& utility outputs comments on the standard output
38614 whenever it removes information from the database.
38615
38616 Certain records are automatically removed by Exim when they are no longer
38617 needed, but others are not. For example, if all the MX hosts for a domain are
38618 down, a retry record is created for each one. If the primary MX host comes back
38619 first, its record is removed when Exim successfully delivers to it, but the
38620 records for the others remain because Exim has not tried to use those hosts.
38621
38622 It is important, therefore, to run &'exim_tidydb'& periodically on all the
38623 hints databases. You should do this at a quiet time of day, because it requires
38624 a database to be locked (and therefore inaccessible to Exim) while it does its
38625 work. Removing records from a DBM file does not normally make the file smaller,
38626 but all the common DBM libraries are able to re-use the space that is released.
38627 After an initial phase of increasing in size, the databases normally reach a
38628 point at which they no longer get any bigger, as long as they are regularly
38629 tidied.
38630
38631 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
38632 databases is likely to keep on increasing.
38633
38634
38635
38636
38637 .section "exim_fixdb" "SECID263"
38638 .cindex "&'exim_fixdb'&"
38639 The &'exim_fixdb'& program is a utility for interactively modifying databases.
38640 Its main use is for testing Exim, but it might also be occasionally useful for
38641 getting round problems in a live system. It has no options, and its interface
38642 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
38643 key of a database record can then be entered, and the data for that record is
38644 displayed.
38645
38646 If &"d"& is typed at the next prompt, the entire record is deleted. For all
38647 except the &'retry'& database, that is the only operation that can be carried
38648 out. For the &'retry'& database, each field is output preceded by a number, and
38649 data for individual fields can be changed by typing the field number followed
38650 by new data, for example:
38651 .code
38652 > 4 951102:1000
38653 .endd
38654 resets the time of the next delivery attempt. Time values are given as a
38655 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
38656 used as optional separators.
38657
38658
38659
38660
38661 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
38662 .cindex "mailbox" "maintenance"
38663 .cindex "&'exim_lock'&"
38664 .cindex "locking mailboxes"
38665 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
38666 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
38667 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
38668 a user agent while investigating a problem. The utility requires the name of
38669 the file as its first argument. If the locking is successful, the second
38670 argument is run as a command (using C's &[system()]& function); if there is no
38671 second argument, the value of the SHELL environment variable is used; if this
38672 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
38673 is unlocked and the utility ends. The following options are available:
38674
38675 .vlist
38676 .vitem &%-fcntl%&
38677 Use &[fcntl()]& locking on the open mailbox.
38678
38679 .vitem &%-flock%&
38680 Use &[flock()]& locking on the open mailbox, provided the operating system
38681 supports it.
38682
38683 .vitem &%-interval%&
38684 This must be followed by a number, which is a number of seconds; it sets the
38685 interval to sleep between retries (default 3).
38686
38687 .vitem &%-lockfile%&
38688 Create a lock file before opening the mailbox.
38689
38690 .vitem &%-mbx%&
38691 Lock the mailbox using MBX rules.
38692
38693 .vitem &%-q%&
38694 Suppress verification output.
38695
38696 .vitem &%-retries%&
38697 This must be followed by a number; it sets the number of times to try to get
38698 the lock (default 10).
38699
38700 .vitem &%-restore_time%&
38701 This option causes &%exim_lock%& to restore the modified and read times to the
38702 locked file before exiting. This allows you to access a locked mailbox (for
38703 example, to take a backup copy) without disturbing the times that the user
38704 subsequently sees.
38705
38706 .vitem &%-timeout%&
38707 This must be followed by a number, which is a number of seconds; it sets a
38708 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
38709 default), a non-blocking call is used.
38710
38711 .vitem &%-v%&
38712 Generate verbose output.
38713 .endlist
38714
38715 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
38716 default is to create a lock file and also to use &[fcntl()]& locking on the
38717 mailbox, which is the same as Exim's default. The use of &%-flock%& or
38718 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
38719 requires that the directory containing the file be writeable. Locking by lock
38720 file does not last forever; Exim assumes that a lock file is expired if it is
38721 more than 30 minutes old.
38722
38723 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
38724 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
38725 to be taken out on the open mailbox, and an exclusive lock on the file
38726 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
38727 number of the mailbox file. When the locking is released, if an exclusive lock
38728 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
38729
38730 The default output contains verification of the locking that takes place. The
38731 &%-v%& option causes some additional information to be given. The &%-q%& option
38732 suppresses all output except error messages.
38733
38734 A command such as
38735 .code
38736 exim_lock /var/spool/mail/spqr
38737 .endd
38738 runs an interactive shell while the file is locked, whereas
38739 .display
38740 &`exim_lock -q /var/spool/mail/spqr <<End`&
38741 <&'some commands'&>
38742 &`End`&
38743 .endd
38744 runs a specific non-interactive sequence of commands while the file is locked,
38745 suppressing all verification output. A single command can be run by a command
38746 such as
38747 .code
38748 exim_lock -q /var/spool/mail/spqr \
38749   "cp /var/spool/mail/spqr /some/where"
38750 .endd
38751 Note that if a command is supplied, it must be entirely contained within the
38752 second argument &-- hence the quotes.
38753 .ecindex IIDutils
38754
38755
38756 . ////////////////////////////////////////////////////////////////////////////
38757 . ////////////////////////////////////////////////////////////////////////////
38758
38759 .chapter "The Exim monitor" "CHAPeximon"
38760 .scindex IIDeximon "Exim monitor" "description"
38761 .cindex "X-windows"
38762 .cindex "&'eximon'&"
38763 .cindex "Local/eximon.conf"
38764 .cindex "&_exim_monitor/EDITME_&"
38765 The Exim monitor is an application which displays in an X window information
38766 about the state of Exim's queue and what Exim is doing. An admin user can
38767 perform certain operations on messages from this GUI interface; however all
38768 such facilities are also available from the command line, and indeed, the
38769 monitor itself makes use of the command line to perform any actions requested.
38770
38771
38772
38773 .section "Running the monitor" "SECID264"
38774 The monitor is started by running the script called &'eximon'&. This is a shell
38775 script that sets up a number of environment variables, and then runs the
38776 binary called &_eximon.bin_&. The default appearance of the monitor window can
38777 be changed by editing the &_Local/eximon.conf_& file created by editing
38778 &_exim_monitor/EDITME_&. Comments in that file describe what the various
38779 parameters are for.
38780
38781 The parameters that get built into the &'eximon'& script can be overridden for
38782 a particular invocation by setting up environment variables of the same names,
38783 preceded by &`EXIMON_`&. For example, a shell command such as
38784 .code
38785 EXIMON_LOG_DEPTH=400 eximon
38786 .endd
38787 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
38788 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
38789 overrides the Exim log file configuration. This makes it possible to have
38790 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
38791 syslog messages are routed to a file on the local host.
38792
38793 X resources can be used to change the appearance of the window in the normal
38794 way. For example, a resource setting of the form
38795 .code
38796 Eximon*background: gray94
38797 .endd
38798 changes the colour of the background to light grey rather than white. The
38799 stripcharts are drawn with both the data lines and the reference lines in
38800 black. This means that the reference lines are not visible when on top of the
38801 data. However, their colour can be changed by setting a resource called
38802 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
38803 For example, if your X server is running Unix, you could set up lighter
38804 reference lines in the stripcharts by obeying
38805 .code
38806 xrdb -merge <<End
38807 Eximon*highlight: gray
38808 End
38809 .endd
38810 .cindex "admin user"
38811 In order to see the contents of messages in the queue, and to operate on them,
38812 &'eximon'& must either be run as root or by an admin user.
38813
38814 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
38815 contain X11 resource parameters interpreted by the X11 library.  In addition,
38816 if the first parameter starts with the string "gdb" then it is removed and the
38817 binary is invoked under gdb (the parameter is used as the gdb command-name, so
38818 versioned variants of gdb can be invoked).
38819
38820 The monitor's window is divided into three parts. The first contains one or
38821 more stripcharts and two action buttons, the second contains a &"tail"& of the
38822 main log file, and the third is a display of the queue of messages awaiting
38823 delivery, with two more action buttons. The following sections describe these
38824 different parts of the display.
38825
38826
38827
38828
38829 .section "The stripcharts" "SECID265"
38830 .cindex "stripchart"
38831 The first stripchart is always a count of messages in the queue. Its name can
38832 be configured by setting QUEUE_STRIPCHART_NAME in the
38833 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
38834 configuration script by regular expression matches on log file entries, making
38835 it possible to display, for example, counts of messages delivered to certain
38836 hosts or using certain transports. The supplied defaults display counts of
38837 received and delivered messages, and of local and SMTP deliveries. The default
38838 period between stripchart updates is one minute; this can be adjusted by a
38839 parameter in the &_Local/eximon.conf_& file.
38840
38841 The stripchart displays rescale themselves automatically as the value they are
38842 displaying changes. There are always 10 horizontal lines in each chart; the
38843 title string indicates the value of each division when it is greater than one.
38844 For example, &"x2"& means that each division represents a value of 2.
38845
38846 It is also possible to have a stripchart which shows the percentage fullness of
38847 a particular disk partition, which is useful when local deliveries are confined
38848 to a single partition.
38849
38850 .cindex "&%statvfs%& function"
38851 This relies on the availability of the &[statvfs()]& function or equivalent in
38852 the operating system. Most, but not all versions of Unix that support Exim have
38853 this. For this particular stripchart, the top of the chart always represents
38854 100%, and the scale is given as &"x10%"&. This chart is configured by setting
38855 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
38856 &_Local/eximon.conf_& file.
38857
38858
38859
38860
38861 .section "Main action buttons" "SECID266"
38862 .cindex "size" "of monitor window"
38863 .cindex "Exim monitor" "window size"
38864 .cindex "window size"
38865 Below the stripcharts there is an action button for quitting the monitor. Next
38866 to this is another button marked &"Size"&. They are placed here so that
38867 shrinking the window to its default minimum size leaves just the queue count
38868 stripchart and these two buttons visible. Pressing the &"Size"& button causes
38869 the window to expand to its maximum size, unless it is already at the maximum,
38870 in which case it is reduced to its minimum.
38871
38872 When expanding to the maximum, if the window cannot be fully seen where it
38873 currently is, it is moved back to where it was the last time it was at full
38874 size. When it is expanding from its minimum size, the old position is
38875 remembered, and next time it is reduced to the minimum it is moved back there.
38876
38877 The idea is that you can keep a reduced window just showing one or two
38878 stripcharts at a convenient place on your screen, easily expand it to show
38879 the full window when required, and just as easily put it back to what it was.
38880 The idea is copied from what the &'twm'& window manager does for its
38881 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
38882 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
38883
38884 Normally, the monitor starts up with the window at its full size, but it can be
38885 built so that it starts up with the window at its smallest size, by setting
38886 START_SMALL=yes in &_Local/eximon.conf_&.
38887
38888
38889
38890 .section "The log display" "SECID267"
38891 .cindex "log" "tail of; in monitor"
38892 The second section of the window is an area in which a display of the tail of
38893 the main log is maintained.
38894 To save space on the screen, the timestamp on each log line is shortened by
38895 removing the date and, if &%log_timezone%& is set, the timezone.
38896 The log tail is not available when the only destination for logging data is
38897 syslog, unless the syslog lines are routed to a local file whose name is passed
38898 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
38899
38900 The log sub-window has a scroll bar at its lefthand side which can be used to
38901 move back to look at earlier text, and the up and down arrow keys also have a
38902 scrolling effect. The amount of log that is kept depends on the setting of
38903 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
38904 to use. When this is full, the earlier 50% of data is discarded &-- this is
38905 much more efficient than throwing it away line by line. The sub-window also has
38906 a horizontal scroll bar for accessing the ends of long log lines. This is the
38907 only means of horizontal scrolling; the right and left arrow keys are not
38908 available. Text can be cut from this part of the window using the mouse in the
38909 normal way. The size of this subwindow is controlled by parameters in the
38910 configuration file &_Local/eximon.conf_&.
38911
38912 Searches of the text in the log window can be carried out by means of the ^R
38913 and ^S keystrokes, which default to a reverse and a forward search,
38914 respectively. The search covers only the text that is displayed in the window.
38915 It cannot go further back up the log.
38916
38917 The point from which the search starts is indicated by a caret marker. This is
38918 normally at the end of the text in the window, but can be positioned explicitly
38919 by pointing and clicking with the left mouse button, and is moved automatically
38920 by a successful search. If new text arrives in the window when it is scrolled
38921 back, the caret remains where it is, but if the window is not scrolled back,
38922 the caret is moved to the end of the new text.
38923
38924 Pressing ^R or ^S pops up a window into which the search text can be typed.
38925 There are buttons for selecting forward or reverse searching, for carrying out
38926 the search, and for cancelling. If the &"Search"& button is pressed, the search
38927 happens and the window remains so that further searches can be done. If the
38928 &"Return"& key is pressed, a single search is done and the window is closed. If
38929 ^C is typed the search is cancelled.
38930
38931 The searching facility is implemented using the facilities of the Athena text
38932 widget. By default this pops up a window containing both &"search"& and
38933 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
38934 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
38935 However, the linkers in BSDI and HP-UX seem unable to handle an externally
38936 provided version of &%TextPop%& when the remaining parts of the text widget
38937 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
38938 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
38939 on these systems, at the expense of having unwanted items in the search popup
38940 window.
38941
38942
38943
38944 .section "The queue display" "SECID268"
38945 .cindex "queue" "display in monitor"
38946 The bottom section of the monitor window contains a list of all messages that
38947 are in the queue, which includes those currently being received or delivered,
38948 as well as those awaiting delivery. The size of this subwindow is controlled by
38949 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
38950 at which it is updated is controlled by another parameter in the same file &--
38951 the default is 5 minutes, since queue scans can be quite expensive. However,
38952 there is an &"Update"& action button just above the display which can be used
38953 to force an update of the queue display at any time.
38954
38955 When a host is down for some time, a lot of pending mail can build up for it,
38956 and this can make it hard to deal with other messages in the queue. To help
38957 with this situation there is a button next to &"Update"& called &"Hide"&. If
38958 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
38959 type anything in here and press &"Return"&, the text is added to a chain of
38960 such texts, and if every undelivered address in a message matches at least one
38961 of the texts, the message is not displayed.
38962
38963 If there is an address that does not match any of the texts, all the addresses
38964 are displayed as normal. The matching happens on the ends of addresses so, for
38965 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
38966 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
38967 has been set up, a button called &"Unhide"& is displayed. If pressed, it
38968 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
38969 a hide request is automatically cancelled after one hour.
38970
38971 While the dialogue box is displayed, you can't press any buttons or do anything
38972 else to the monitor window. For this reason, if you want to cut text from the
38973 queue display to use in the dialogue box, you have to do the cutting before
38974 pressing the &"Hide"& button.
38975
38976 The queue display contains, for each unhidden queued message, the length of
38977 time it has been in the queue, the size of the message, the message id, the
38978 message sender, and the first undelivered recipient, all on one line. If it is
38979 a bounce message, the sender is shown as &"<>"&. If there is more than one
38980 recipient to which the message has not yet been delivered, subsequent ones are
38981 listed on additional lines, up to a maximum configured number, following which
38982 an ellipsis is displayed. Recipients that have already received the message are
38983 not shown.
38984
38985 .cindex "frozen messages" "display"
38986 If a message is frozen, an asterisk is displayed at the left-hand side.
38987
38988 The queue display has a vertical scroll bar, and can also be scrolled by means
38989 of the arrow keys. Text can be cut from it using the mouse in the normal way.
38990 The text searching facilities, as described above for the log window, are also
38991 available, but the caret is always moved to the end of the text when the queue
38992 display is updated.
38993
38994
38995
38996 .section "The queue menu" "SECID269"
38997 .cindex "queue" "menu in monitor"
38998 If the &%shift%& key is held down and the left button is clicked when the mouse
38999 pointer is over the text for any message, an action menu pops up, and the first
39000 line of the queue display for the message is highlighted. This does not affect
39001 any selected text.
39002
39003 If you want to use some other event for popping up the menu, you can set the
39004 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
39005 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
39006 value set in this parameter is a standard X event description. For example, to
39007 run eximon using &%ctrl%& rather than &%shift%& you could use
39008 .code
39009 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
39010 .endd
39011 The title of the menu is the message id, and it contains entries which act as
39012 follows:
39013
39014 .ilist
39015 &'message log'&: The contents of the message log for the message are displayed
39016 in a new text window.
39017 .next
39018 &'headers'&: Information from the spool file that contains the envelope
39019 information and headers is displayed in a new text window. See chapter
39020 &<<CHAPspool>>& for a description of the format of spool files.
39021 .next
39022 &'body'&: The contents of the spool file containing the body of the message are
39023 displayed in a new text window. There is a default limit of 20,000 bytes to the
39024 amount of data displayed. This can be changed by setting the BODY_MAX
39025 option at compile time, or the EXIMON_BODY_MAX option at runtime.
39026 .next
39027 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
39028 delivery of the message. This causes an automatic thaw if the message is
39029 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
39030 a new text window. The delivery is run in a separate process, to avoid holding
39031 up the monitor while the delivery proceeds.
39032 .next
39033 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
39034 that the message be frozen.
39035 .next
39036 .cindex "thawing messages"
39037 .cindex "unfreezing messages"
39038 .cindex "frozen messages" "thawing"
39039 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
39040 that the message be thawed.
39041 .next
39042 .cindex "delivery" "forcing failure"
39043 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
39044 that Exim gives up trying to deliver the message. A bounce message is generated
39045 for any remaining undelivered addresses.
39046 .next
39047 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
39048 that the message be deleted from the system without generating a bounce
39049 message.
39050 .next
39051 &'add recipient'&: A dialog box is displayed into which a recipient address can
39052 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39053 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39054 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39055 causes a call to Exim to be made using the &%-Mar%& option to request that an
39056 additional recipient be added to the message, unless the entry box is empty, in
39057 which case no action is taken.
39058 .next
39059 &'mark delivered'&: A dialog box is displayed into which a recipient address
39060 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39061 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39062 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39063 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
39064 recipient address as already delivered, unless the entry box is empty, in which
39065 case no action is taken.
39066 .next
39067 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
39068 mark all recipient addresses as already delivered.
39069 .next
39070 &'edit sender'&: A dialog box is displayed initialized with the current
39071 sender's address. Pressing RETURN causes a call to Exim to be made using the
39072 &%-Mes%& option to replace the sender address, unless the entry box is empty,
39073 in which case no action is taken. If you want to set an empty sender (as in
39074 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
39075 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
39076 the address is qualified with that domain.
39077 .endlist
39078
39079 When a delivery is forced, a window showing the &%-v%& output is displayed. In
39080 other cases when a call to Exim is made, if there is any output from Exim (in
39081 particular, if the command fails) a window containing the command and the
39082 output is displayed. Otherwise, the results of the action are normally apparent
39083 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
39084 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
39085 if no output is generated.
39086
39087 The queue display is automatically updated for actions such as freezing and
39088 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
39089 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
39090 force an update of the display after one of these actions.
39091
39092 In any text window that is displayed as result of a menu action, the normal
39093 cut-and-paste facility is available, and searching can be carried out using ^R
39094 and ^S, as described above for the log tail window.
39095 .ecindex IIDeximon
39096
39097
39098
39099
39100
39101 . ////////////////////////////////////////////////////////////////////////////
39102 . ////////////////////////////////////////////////////////////////////////////
39103
39104 .chapter "Security considerations" "CHAPsecurity"
39105 .scindex IIDsecurcon "security" "discussion of"
39106 This chapter discusses a number of issues concerned with security, some of
39107 which are also covered in other parts of this manual.
39108
39109 For reasons that this author does not understand, some people have promoted
39110 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
39111 existence of this chapter in the documentation. However, the intent of the
39112 chapter is simply to describe the way Exim works in relation to certain
39113 security concerns, not to make any specific claims about the effectiveness of
39114 its security as compared with other MTAs.
39115
39116 What follows is a description of the way Exim is supposed to be. Best efforts
39117 have been made to try to ensure that the code agrees with the theory, but an
39118 absence of bugs can never be guaranteed. Any that are reported will get fixed
39119 as soon as possible.
39120
39121
39122 .section "Building a more &""hardened""& Exim" "SECID286"
39123 .cindex "security" "build-time features"
39124 There are a number of build-time options that can be set in &_Local/Makefile_&
39125 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
39126 Exim administrator who does not have the root password, or by someone who has
39127 penetrated the Exim (but not the root) account. These options are as follows:
39128
39129 .ilist
39130 ALT_CONFIG_PREFIX can be set to a string that is required to match the
39131 start of any filenames used with the &%-C%& option. When it is set, these
39132 filenames are also not allowed to contain the sequence &"/../"&. (However, if
39133 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
39134 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
39135 default setting for &%ALT_CONFIG_PREFIX%&.
39136
39137 If the permitted configuration files are confined to a directory to
39138 which only root has access, this guards against someone who has broken
39139 into the Exim account from running a privileged Exim with an arbitrary
39140 configuration file, and using it to break into other accounts.
39141 .next
39142
39143 If a non-trusted configuration file (i.e. not the default configuration file
39144 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
39145 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
39146 the next item), then root privilege is retained only if the caller of Exim is
39147 root. This locks out the possibility of testing a configuration using &%-C%&
39148 right through message reception and delivery, even if the caller is root. The
39149 reception works, but by that time, Exim is running as the Exim user, so when
39150 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
39151 privilege to be lost. However, root can test reception and delivery using two
39152 separate commands.
39153
39154 .next
39155 The WHITELIST_D_MACROS build option declares some macros to be safe to override
39156 with &%-D%& if the real uid is one of root, the Exim run-time user or the
39157 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
39158 requiring the run-time value supplied to &%-D%& to match a regex that errs on
39159 the restrictive side.  Requiring build-time selection of safe macros is onerous
39160 but this option is intended solely as a transition mechanism to permit
39161 previously-working configurations to continue to work after release 4.73.
39162 .next
39163 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
39164 is disabled.
39165 .next
39166 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
39167 never to be used for any deliveries. This is like the &%never_users%& runtime
39168 option, but it cannot be overridden; the runtime option adds additional users
39169 to the list. The default setting is &"root"&; this prevents a non-root user who
39170 is permitted to modify the runtime file from using Exim as a way to get root.
39171 .endlist
39172
39173
39174
39175 .section "Root privilege" "SECID270"
39176 .cindex "setuid"
39177 .cindex "root privilege"
39178 The Exim binary is normally setuid to root, which means that it gains root
39179 privilege (runs as root) when it starts execution. In some special cases (for
39180 example, when the daemon is not in use and there are no local deliveries), it
39181 may be possible to run Exim setuid to some user other than root. This is
39182 discussed in the next section. However, in most installations, root privilege
39183 is required for two things:
39184
39185 .ilist
39186 To set up a socket connected to the standard SMTP port (25) when initialising
39187 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
39188 not required.
39189 .next
39190 To be able to change uid and gid in order to read users' &_.forward_& files and
39191 perform local deliveries as the receiving user or as specified in the
39192 configuration.
39193 .endlist
39194
39195 It is not necessary to be root to do any of the other things Exim does, such as
39196 receiving messages and delivering them externally over SMTP, and it is
39197 obviously more secure if Exim does not run as root except when necessary.
39198 For this reason, a user and group for Exim to use must be defined in
39199 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
39200 group"&. Their values can be changed by the runtime configuration, though this
39201 is not recommended. Often a user called &'exim'& is used, but some sites use
39202 &'mail'& or another user name altogether.
39203
39204 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
39205 abdication; the process cannot regain root afterwards. Prior to release 4.00,
39206 &[seteuid()]& was used in some circumstances, but this is no longer the case.
39207
39208 After a new Exim process has interpreted its command line options, it changes
39209 uid and gid in the following cases:
39210
39211 .ilist
39212 .oindex "&%-C%&"
39213 .oindex "&%-D%&"
39214 If the &%-C%& option is used to specify an alternate configuration file, or if
39215 the &%-D%& option is used to define macro values for the configuration, and the
39216 calling process is not running as root, the uid and gid are changed to those of
39217 the calling process.
39218 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
39219 option may not be used at all.
39220 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
39221 can be supplied if the calling process is running as root, the Exim run-time
39222 user or CONFIGURE_OWNER, if defined.
39223 .next
39224 .oindex "&%-be%&"
39225 .oindex "&%-bf%&"
39226 .oindex "&%-bF%&"
39227 If the expansion test option (&%-be%&) or one of the filter testing options
39228 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
39229 calling process.
39230 .next
39231 If the process is not a daemon process or a queue runner process or a delivery
39232 process or a process for testing address routing (started with &%-bt%&), the
39233 uid and gid are changed to the Exim user and group. This means that Exim always
39234 runs under its own uid and gid when receiving messages. This also applies when
39235 testing address verification
39236 .oindex "&%-bv%&"
39237 .oindex "&%-bh%&"
39238 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
39239 option).
39240 .next
39241 For a daemon, queue runner, delivery, or address testing process, the uid
39242 remains as root at this stage, but the gid is changed to the Exim group.
39243 .endlist
39244
39245 The processes that initially retain root privilege behave as follows:
39246
39247 .ilist
39248 A daemon process changes the gid to the Exim group and the uid to the Exim
39249 user after setting up one or more listening sockets. The &[initgroups()]&
39250 function is called, so that if the Exim user is in any additional groups, they
39251 will be used during message reception.
39252 .next
39253 A queue runner process retains root privilege throughout its execution. Its
39254 job is to fork a controlled sequence of delivery processes.
39255 .next
39256 A delivery process retains root privilege throughout most of its execution,
39257 but any actual deliveries (that is, the transports themselves) are run in
39258 subprocesses which always change to a non-root uid and gid. For local
39259 deliveries this is typically the uid and gid of the owner of the mailbox; for
39260 remote deliveries, the Exim uid and gid are used. Once all the delivery
39261 subprocesses have been run, a delivery process changes to the Exim uid and gid
39262 while doing post-delivery tidying up such as updating the retry database and
39263 generating bounce and warning messages.
39264
39265 While the recipient addresses in a message are being routed, the delivery
39266 process runs as root. However, if a user's filter file has to be processed,
39267 this is done in a subprocess that runs under the individual user's uid and
39268 gid. A system filter is run as root unless &%system_filter_user%& is set.
39269 .next
39270 A process that is testing addresses (the &%-bt%& option) runs as root so that
39271 the routing is done in the same environment as a message delivery.
39272 .endlist
39273
39274
39275
39276
39277 .section "Running Exim without privilege" "SECTrunexiwitpri"
39278 .cindex "privilege, running without"
39279 .cindex "unprivileged running"
39280 .cindex "root privilege" "running without"
39281 Some installations like to run Exim in an unprivileged state for more of its
39282 operation, for added security. Support for this mode of operation is provided
39283 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
39284 gid are changed to the Exim user and group at the start of a delivery process
39285 (and also queue runner and address testing processes). This means that address
39286 routing is no longer run as root, and the deliveries themselves cannot change
39287 to any other uid.
39288
39289 .cindex SIGHUP
39290 .cindex "daemon" "restarting"
39291 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
39292 that the daemon can still be started in the usual way, and it can respond
39293 correctly to SIGHUP because the re-invocation regains root privilege.
39294
39295 An alternative approach is to make Exim setuid to the Exim user and also setgid
39296 to the Exim group. If you do this, the daemon must be started from a root
39297 process. (Calling Exim from a root process makes it behave in the way it does
39298 when it is setuid root.) However, the daemon cannot restart itself after a
39299 SIGHUP signal because it cannot regain privilege.
39300
39301 It is still useful to set &%deliver_drop_privilege%& in this case, because it
39302 stops Exim from trying to re-invoke itself to do a delivery after a message has
39303 been received. Such a re-invocation is a waste of resources because it has no
39304 effect.
39305
39306 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
39307 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
39308 to the Exim user seems a clean approach, but there is one complication:
39309
39310 In this style of operation, Exim is running with the real uid and gid set to
39311 those of the calling process, and the effective uid/gid set to Exim's values.
39312 Ideally, any association with the calling process' uid/gid should be dropped,
39313 that is, the real uid/gid should be reset to the effective values so as to
39314 discard any privileges that the caller may have. While some operating systems
39315 have a function that permits this action for a non-root effective uid, quite a
39316 number of them do not. Because of this lack of standardization, Exim does not
39317 address this problem at this time.
39318
39319 For this reason, the recommended approach for &"mostly unprivileged"& running
39320 is to keep the Exim binary setuid to root, and to set
39321 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
39322 be used in the most straightforward way.
39323
39324 If you configure Exim not to run delivery processes as root, there are a
39325 number of restrictions on what you can do:
39326
39327 .ilist
39328 You can deliver only as the Exim user/group. You should  explicitly use the
39329 &%user%& and &%group%& options to override routers or local transports that
39330 normally deliver as the recipient. This makes sure that configurations that
39331 work in this mode function the same way in normal mode. Any implicit or
39332 explicit specification of another user causes an error.
39333 .next
39334 Use of &_.forward_& files is severely restricted, such that it is usually
39335 not worthwhile to include them in the configuration.
39336 .next
39337 Users who wish to use &_.forward_& would have to make their home directory and
39338 the file itself accessible to the Exim user. Pipe and append-to-file entries,
39339 and their equivalents in Exim filters, cannot be used. While they could be
39340 enabled in the Exim user's name, that would be insecure and not very useful.
39341 .next
39342 Unless the local user mailboxes are all owned by the Exim user (possible in
39343 some POP3 or IMAP-only environments):
39344
39345 .olist
39346 They must be owned by the Exim group and be writeable by that group. This
39347 implies you must set &%mode%& in the appendfile configuration, as well as the
39348 mode of the mailbox files themselves.
39349 .next
39350 You must set &%no_check_owner%&, since most or all of the files will not be
39351 owned by the Exim user.
39352 .next
39353 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
39354 on a newly created mailbox when unprivileged. This also implies that new
39355 mailboxes need to be created manually.
39356 .endlist olist
39357 .endlist ilist
39358
39359
39360 These restrictions severely restrict what can be done in local deliveries.
39361 However, there are no restrictions on remote deliveries. If you are running a
39362 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
39363 gives more security at essentially no cost.
39364
39365 If you are using the &%mua_wrapper%& facility (see chapter
39366 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
39367
39368
39369
39370
39371 .section "Delivering to local files" "SECID271"
39372 Full details of the checks applied by &(appendfile)& before it writes to a file
39373 are given in chapter &<<CHAPappendfile>>&.
39374
39375
39376
39377 .section "Running local commands" "SECTsecconslocalcmds"
39378 .cindex "security" "local commands"
39379 .cindex "security" "command injection attacks"
39380 There are a number of ways in which an administrator can configure Exim to run
39381 commands based upon received, untrustworthy, data. Further, in some
39382 configurations a user who can control a &_.forward_& file can also arrange to
39383 run commands. Configuration to check includes, but is not limited to:
39384
39385 .ilist
39386 Use of &%use_shell%& in the pipe transport: various forms of shell command
39387 injection may be possible with this option present. It is dangerous and should
39388 be used only with considerable caution. Consider constraints which whitelist
39389 allowed characters in a variable which is to be used in a pipe transport that
39390 has &%use_shell%& enabled.
39391 .next
39392 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
39393 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
39394 &_.forward_& files in a redirect router. If Exim is running on a central mail
39395 hub to which ordinary users do not have shell access, but home directories are
39396 NFS mounted (for instance) then administrators should review the list of these
39397 forbid options available, and should bear in mind that the options that may
39398 need forbidding can change as new features are added between releases.
39399 .next
39400 The &%${run...}%& expansion item does not use a shell by default, but
39401 administrators can configure use of &_/bin/sh_& as part of the command.
39402 Such invocations should be viewed with prejudicial suspicion.
39403 .next
39404 Administrators who use embedded Perl are advised to explore how Perl's
39405 taint checking might apply to their usage.
39406 .next
39407 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
39408 administrators are well advised to view its use with suspicion, in case (for
39409 instance) it allows a local-part to contain embedded Exim directives.
39410 .next
39411 Use of &%${match_local_part...}%& and friends becomes more dangerous if
39412 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
39413 each can reference arbitrary lists and files, rather than just being a list
39414 of opaque strings.
39415 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
39416 real-world security vulnerabilities caused by its use with untrustworthy data
39417 injected in, for SQL injection attacks.
39418 Consider the use of the &%inlisti%& expansion condition instead.
39419 .endlist
39420
39421
39422
39423
39424 .section "Trust in configuration data" "SECTsecconfdata"
39425 .cindex "security" "data sources"
39426 .cindex "security" "regular expressions"
39427 .cindex "regular expressions" "security"
39428 .cindex "PCRE" "security"
39429 If configuration data for Exim can come from untrustworthy sources, there
39430 are some issues to be aware of:
39431
39432 .ilist
39433 Use of &%${expand...}%& may provide a path for shell injection attacks.
39434 .next
39435 Letting untrusted data provide a regular expression is unwise.
39436 .next
39437 Using &%${match...}%& to apply a fixed regular expression against untrusted
39438 data may result in pathological behaviour within PCRE.  Be aware of what
39439 "backtracking" means and consider options for being more strict with a regular
39440 expression. Avenues to explore include limiting what can match (avoiding &`.`&
39441 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
39442 possessive quantifiers or just not using regular expressions against untrusted
39443 data.
39444 .next
39445 It can be important to correctly use &%${quote:...}%&,
39446 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
39447 items to ensure that data is correctly constructed.
39448 .next
39449 Some lookups might return multiple results, even though normal usage is only
39450 expected to yield one result.
39451 .endlist
39452
39453
39454
39455
39456 .section "IPv4 source routing" "SECID272"
39457 .cindex "source routing" "in IP packets"
39458 .cindex "IP source routing"
39459 Many operating systems suppress IP source-routed packets in the kernel, but
39460 some cannot be made to do this, so Exim does its own check. It logs incoming
39461 IPv4 source-routed TCP calls, and then drops them. Things are all different in
39462 IPv6. No special checking is currently done.
39463
39464
39465
39466 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
39467 Support for these SMTP commands is disabled by default. If required, they can
39468 be enabled by defining suitable ACLs.
39469
39470
39471
39472
39473 .section "Privileged users" "SECID274"
39474 .cindex "trusted users"
39475 .cindex "admin user"
39476 .cindex "privileged user"
39477 .cindex "user" "trusted"
39478 .cindex "user" "admin"
39479 Exim recognizes two sets of users with special privileges. Trusted users are
39480 able to submit new messages to Exim locally, but supply their own sender
39481 addresses and information about a sending host. For other users submitting
39482 local messages, Exim sets up the sender address from the uid, and doesn't
39483 permit a remote host to be specified.
39484
39485 .oindex "&%-f%&"
39486 However, an untrusted user is permitted to use the &%-f%& command line option
39487 in the special form &%-f <>%& to indicate that a delivery failure for the
39488 message should not cause an error report. This affects the message's envelope,
39489 but it does not affect the &'Sender:'& header. Untrusted users may also be
39490 permitted to use specific forms of address with the &%-f%& option by setting
39491 the &%untrusted_set_sender%& option.
39492
39493 Trusted users are used to run processes that receive mail messages from some
39494 other mail domain and pass them on to Exim for delivery either locally, or over
39495 the Internet. Exim trusts a caller that is running as root, as the Exim user,
39496 as any user listed in the &%trusted_users%& configuration option, or under any
39497 group listed in the &%trusted_groups%& option.
39498
39499 Admin users are permitted to do things to the messages on Exim's queue. They
39500 can freeze or thaw messages, cause them to be returned to their senders, remove
39501 them entirely, or modify them in various ways. In addition, admin users can run
39502 the Exim monitor and see all the information it is capable of providing, which
39503 includes the contents of files on the spool.
39504
39505 .oindex "&%-M%&"
39506 .oindex "&%-q%&"
39507 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
39508 delivery of messages on its queue is restricted to admin users. This
39509 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
39510 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
39511 queue is also restricted to admin users. This restriction can be relaxed by
39512 setting &%no_queue_list_requires_admin%&.
39513
39514 Exim recognizes an admin user if the calling process is running as root or as
39515 the Exim user or if any of the groups associated with the calling process is
39516 the Exim group. It is not necessary actually to be running under the Exim
39517 group. However, if admin users who are not root or the Exim user are to access
39518 the contents of files on the spool via the Exim monitor (which runs
39519 unprivileged), Exim must be built to allow group read access to its spool
39520 files.
39521
39522 By default, regular users are trusted to perform basic testing and
39523 introspection commands, as themselves.  This setting can be tightened by
39524 setting the &%commandline_checks_require_admin%& option.
39525 This affects most of the checking options,
39526 such as &%-be%& and anything else &%-b*%&.
39527
39528
39529 .section "Spool files" "SECID275"
39530 .cindex "spool directory" "files"
39531 Exim's spool directory and everything it contains is owned by the Exim user and
39532 set to the Exim group. The mode for spool files is defined in the
39533 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
39534 any user who is a member of the Exim group can access these files.
39535
39536
39537
39538 .section "Use of argv[0]" "SECID276"
39539 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
39540 of specific strings, Exim assumes certain options. For example, calling Exim
39541 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
39542 to calling it with the option &%-bS%&. There are no security implications in
39543 this.
39544
39545
39546
39547 .section "Use of %f formatting" "SECID277"
39548 The only use made of &"%f"& by Exim is in formatting load average values. These
39549 are actually stored in integer variables as 1000 times the load average.
39550 Consequently, their range is limited and so therefore is the length of the
39551 converted output.
39552
39553
39554
39555 .section "Embedded Exim path" "SECID278"
39556 Exim uses its own path name, which is embedded in the code, only when it needs
39557 to re-exec in order to regain root privilege. Therefore, it is not root when it
39558 does so. If some bug allowed the path to get overwritten, it would lead to an
39559 arbitrary program's being run as exim, not as root.
39560
39561
39562
39563 .section "Dynamic module directory" "SECTdynmoddir"
39564 Any dynamically loadable modules must be installed into the directory
39565 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
39566 loading it.
39567
39568
39569 .section "Use of sprintf()" "SECID279"
39570 .cindex "&[sprintf()]&"
39571 A large number of occurrences of &"sprintf"& in the code are actually calls to
39572 &'string_sprintf()'&, a function that returns the result in malloc'd store.
39573 The intermediate formatting is done into a large fixed buffer by a function
39574 that runs through the format string itself, and checks the length of each
39575 conversion before performing it, thus preventing buffer overruns.
39576
39577 The remaining uses of &[sprintf()]& happen in controlled circumstances where
39578 the output buffer is known to be sufficiently long to contain the converted
39579 string.
39580
39581
39582
39583 .section "Use of debug_printf() and log_write()" "SECID280"
39584 Arbitrary strings are passed to both these functions, but they do their
39585 formatting by calling the function &'string_vformat()'&, which runs through
39586 the format string itself, and checks the length of each conversion.
39587
39588
39589
39590 .section "Use of strcat() and strcpy()" "SECID281"
39591 These are used only in cases where the output buffer is known to be large
39592 enough to hold the result.
39593 .ecindex IIDsecurcon
39594
39595
39596
39597
39598 . ////////////////////////////////////////////////////////////////////////////
39599 . ////////////////////////////////////////////////////////////////////////////
39600
39601 .chapter "Format of spool files" "CHAPspool"
39602 .scindex IIDforspo1 "format" "spool files"
39603 .scindex IIDforspo2 "spool directory" "format of files"
39604 .scindex IIDforspo3 "spool files" "format of"
39605 .cindex "spool files" "editing"
39606 A message on Exim's queue consists of two files, whose names are the message id
39607 followed by -D and -H, respectively. The data portion of the message is kept in
39608 the -D file on its own. The message's envelope, status, and headers are all
39609 kept in the -H file, whose format is described in this chapter. Each of these
39610 two files contains the final component of its own name as its first line. This
39611 is insurance against disk crashes where the directory is lost but the files
39612 themselves are recoverable.
39613
39614 The file formats may be changed, or new formats added, at any release.
39615 Spool files are not intended as an interface to other programs
39616 and should not be used as such.
39617
39618 Some people are tempted into editing -D files in order to modify messages. You
39619 need to be extremely careful if you do this; it is not recommended and you are
39620 on your own if you do it. Here are some of the pitfalls:
39621
39622 .ilist
39623 You must ensure that Exim does not try to deliver the message while you are
39624 fiddling with it. The safest way is to take out a write lock on the -D file,
39625 which is what Exim itself does, using &[fcntl()]&. If you update the file in
39626 place, the lock will be retained. If you write a new file and rename it, the
39627 lock will be lost at the instant of rename.
39628 .next
39629 .vindex "&$body_linecount$&"
39630 If you change the number of lines in the file, the value of
39631 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
39632 cause incomplete transmission of messages or undeliverable messages.
39633 .next
39634 If the message is in MIME format, you must take care not to break it.
39635 .next
39636 If the message is cryptographically signed, any change will invalidate the
39637 signature.
39638 .endlist
39639 All in all, modifying -D files is fraught with danger.
39640
39641 Files whose names end with -J may also be seen in the &_input_& directory (or
39642 its subdirectories when &%split_spool_directory%& is set). These are journal
39643 files, used to record addresses to which the message has been delivered during
39644 the course of a delivery attempt. If there are still undelivered recipients at
39645 the end, the -H file is updated, and the -J file is deleted. If, however, there
39646 is some kind of crash (for example, a power outage) before this happens, the -J
39647 file remains in existence. When Exim next processes the message, it notices the
39648 -J file and uses it to update the -H file before starting the next delivery
39649 attempt.
39650
39651 Files whose names end with -K or .eml may also be seen in the spool.
39652 These are temporaries used for DKIM or malware processing, when that is used.
39653 They should be tidied up by normal operations; any old ones are probably
39654 relics of crashes and can be removed.
39655
39656 .section "Format of the -H file" "SECID282"
39657 .cindex "uid (user id)" "in spool file"
39658 .cindex "gid (group id)" "in spool file"
39659 The second line of the -H file contains the login name for the uid of the
39660 process that called Exim to read the message, followed by the numerical uid and
39661 gid. For a locally generated message, this is normally the user who sent the
39662 message. For a message received over TCP/IP via the daemon, it is
39663 normally the Exim user.
39664
39665 The third line of the file contains the address of the message's sender as
39666 transmitted in the envelope, contained in angle brackets. The sender address is
39667 empty for bounce messages. For incoming SMTP mail, the sender address is given
39668 in the MAIL command. For locally generated mail, the sender address is
39669 created by Exim from the login name of the current user and the configured
39670 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
39671 leading &"From&~"& line if the caller is trusted, or if the supplied address is
39672 &"<>"& or an address that matches &%untrusted_set_senders%&.
39673
39674 The fourth line contains two numbers. The first is the time that the message
39675 was received, in the conventional Unix form &-- the number of seconds since the
39676 start of the epoch. The second number is a count of the number of messages
39677 warning of delayed delivery that have been sent to the sender.
39678
39679 There follow a number of lines starting with a hyphen. These can appear in any
39680 order, and are omitted when not relevant:
39681
39682 .vlist
39683 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
39684 This item is obsolete, and is not generated from Exim release 4.61 onwards;
39685 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
39686 recognized, to provide backward compatibility. In the old format, a line of
39687 this form is present for every ACL variable that is not empty. The number
39688 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
39689 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
39690 the data string for the variable. The string itself starts at the beginning of
39691 the next line, and is followed by a newline character. It may contain internal
39692 newlines.
39693
39694 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
39695 A line of this form is present for every ACL connection variable that is
39696 defined. Note that there is a space between &%-aclc%& and the rest of the name.
39697 The length is the length of the data string for the variable. The string itself
39698 starts at the beginning of the next line, and is followed by a newline
39699 character. It may contain internal newlines.
39700
39701 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
39702 A line of this form is present for every ACL message variable that is defined.
39703 Note that there is a space between &%-aclm%& and the rest of the name. The
39704 length is the length of the data string for the variable. The string itself
39705 starts at the beginning of the next line, and is followed by a newline
39706 character. It may contain internal newlines.
39707
39708 .vitem "&%-active_hostname%&&~<&'hostname'&>"
39709 This is present if, when the message was received over SMTP, the value of
39710 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
39711
39712 .vitem &%-allow_unqualified_recipient%&
39713 This is present if unqualified recipient addresses are permitted in header
39714 lines (to stop such addresses from being qualified if rewriting occurs at
39715 transport time). Local messages that were input using &%-bnq%& and remote
39716 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
39717
39718 .vitem &%-allow_unqualified_sender%&
39719 This is present if unqualified sender addresses are permitted in header lines
39720 (to stop such addresses from being qualified if rewriting occurs at transport
39721 time). Local messages that were input using &%-bnq%& and remote messages from
39722 hosts that match &%sender_unqualified_hosts%& set this flag.
39723
39724 .vitem "&%-auth_id%&&~<&'text'&>"
39725 The id information for a message received on an authenticated SMTP connection
39726 &-- the value of the &$authenticated_id$& variable.
39727
39728 .vitem "&%-auth_sender%&&~<&'address'&>"
39729 The address of an authenticated sender &-- the value of the
39730 &$authenticated_sender$& variable.
39731
39732 .vitem "&%-body_linecount%&&~<&'number'&>"
39733 This records the number of lines in the body of the message, and is
39734 present unless &%-spool_file_wireformat%& is.
39735
39736 .vitem "&%-body_zerocount%&&~<&'number'&>"
39737 This records the number of binary zero bytes in the body of the message, and is
39738 present if the number is greater than zero.
39739
39740 .vitem &%-deliver_firsttime%&
39741 This is written when a new message is first added to the spool. When the spool
39742 file is updated after a deferral, it is omitted.
39743
39744 .vitem "&%-frozen%&&~<&'time'&>"
39745 .cindex "frozen messages" "spool data"
39746 The message is frozen, and the freezing happened at <&'time'&>.
39747
39748 .vitem "&%-helo_name%&&~<&'text'&>"
39749 This records the host name as specified by a remote host in a HELO or EHLO
39750 command.
39751
39752 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
39753 This records the IP address of the host from which the message was received and
39754 the remote port number that was used. It is omitted for locally generated
39755 messages.
39756
39757 .vitem "&%-host_auth%&&~<&'text'&>"
39758 If the message was received on an authenticated SMTP connection, this records
39759 the name of the authenticator &-- the value of the
39760 &$sender_host_authenticated$& variable.
39761
39762 .vitem &%-host_lookup_failed%&
39763 This is present if an attempt to look up the sending host's name from its IP
39764 address failed. It corresponds to the &$host_lookup_failed$& variable.
39765
39766 .vitem "&%-host_name%&&~<&'text'&>"
39767 .cindex "reverse DNS lookup"
39768 .cindex "DNS" "reverse lookup"
39769 This records the name of the remote host from which the message was received,
39770 if the host name was looked up from the IP address when the message was being
39771 received. It is not present if no reverse lookup was done.
39772
39773 .vitem "&%-ident%&&~<&'text'&>"
39774 For locally submitted messages, this records the login of the originating user,
39775 unless it was a trusted user and the &%-oMt%& option was used to specify an
39776 ident value. For messages received over TCP/IP, this records the ident string
39777 supplied by the remote host, if any.
39778
39779 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
39780 This records the IP address of the local interface and the port number through
39781 which a message was received from a remote host. It is omitted for locally
39782 generated messages.
39783
39784 .vitem &%-local%&
39785 The message is from a local sender.
39786
39787 .vitem &%-localerror%&
39788 The message is a locally-generated bounce message.
39789
39790 .vitem "&%-local_scan%&&~<&'string'&>"
39791 This records the data string that was returned by the &[local_scan()]& function
39792 when the message was received &-- the value of the &$local_scan_data$&
39793 variable. It is omitted if no data was returned.
39794
39795 .vitem &%-manual_thaw%&
39796 The message was frozen but has been thawed manually, that is, by an explicit
39797 Exim command rather than via the auto-thaw process.
39798
39799 .vitem &%-N%&
39800 A testing delivery process was started using the &%-N%& option to suppress any
39801 actual deliveries, but delivery was deferred. At any further delivery attempts,
39802 &%-N%& is assumed.
39803
39804 .vitem &%-received_protocol%&
39805 This records the value of the &$received_protocol$& variable, which contains
39806 the name of the protocol by which the message was received.
39807
39808 .vitem &%-sender_set_untrusted%&
39809 The envelope sender of this message was set by an untrusted local caller (used
39810 to ensure that the caller is displayed in queue listings).
39811
39812 .vitem "&%-spam_score_int%&&~<&'number'&>"
39813 If a message was scanned by SpamAssassin, this is present. It records the value
39814 of &$spam_score_int$&.
39815
39816 .vitem &%-spool_file_wireformat%&
39817 The -D file for this message is in wire-format (for ESMTP CHUNKING)
39818 rather than Unix-format.
39819 The line-ending is CRLF rather than newline.
39820 There is still, however, no leading-dot-stuffing.
39821
39822 .vitem &%-tls_certificate_verified%&
39823 A TLS certificate was received from the client that sent this message, and the
39824 certificate was verified by the server.
39825
39826 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
39827 When the message was received over an encrypted connection, this records the
39828 name of the cipher suite that was used.
39829
39830 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
39831 When the message was received over an encrypted connection, and a certificate
39832 was received from the client, this records the Distinguished Name from that
39833 certificate.
39834 .endlist
39835
39836 Any of the above may have an extra hyphen prepended, to indicate the the
39837 corresponding data is untrusted.
39838
39839 Following the options there is a list of those addresses to which the message
39840 is not to be delivered. This set of addresses is initialized from the command
39841 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
39842 is set; otherwise it starts out empty. Whenever a successful delivery is made,
39843 the address is added to this set. The addresses are kept internally as a
39844 balanced binary tree, and it is a representation of that tree which is written
39845 to the spool file. If an address is expanded via an alias or forward file, the
39846 original address is added to the tree when deliveries to all its child
39847 addresses are complete.
39848
39849 If the tree is empty, there is a single line in the spool file containing just
39850 the text &"XX"&. Otherwise, each line consists of two letters, which are either
39851 Y or N, followed by an address. The address is the value for the node of the
39852 tree, and the letters indicate whether the node has a left branch and/or a
39853 right branch attached to it, respectively. If branches exist, they immediately
39854 follow. Here is an example of a three-node tree:
39855 .code
39856 YY darcy@austen.fict.example
39857 NN alice@wonderland.fict.example
39858 NN editor@thesaurus.ref.example
39859 .endd
39860 After the non-recipients tree, there is a list of the message's recipients.
39861 This is a simple list, preceded by a count. It includes all the original
39862 recipients of the message, including those to whom the message has already been
39863 delivered. In the simplest case, the list contains one address per line. For
39864 example:
39865 .code
39866 4
39867 editor@thesaurus.ref.example
39868 darcy@austen.fict.example
39869 rdo@foundation
39870 alice@wonderland.fict.example
39871 .endd
39872 However, when a child address has been added to the top-level addresses as a
39873 result of the use of the &%one_time%& option on a &(redirect)& router, each
39874 line is of the following form:
39875 .display
39876 <&'top-level address'&> <&'errors_to address'&> &&&
39877   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
39878 .endd
39879 The 01 flag bit indicates the presence of the three other fields that follow
39880 the top-level address. Other bits may be used in future to support additional
39881 fields. The <&'parent number'&> is the offset in the recipients list of the
39882 original parent of the &"one time"& address. The first two fields are the
39883 envelope sender that is associated with this address and its length. If the
39884 length is zero, there is no special envelope sender (there are then two space
39885 characters in the line). A non-empty field can arise from a &(redirect)& router
39886 that has an &%errors_to%& setting.
39887
39888
39889 A blank line separates the envelope and status information from the headers
39890 which follow. A header may occupy several lines of the file, and to save effort
39891 when reading it in, each header is preceded by a number and an identifying
39892 character. The number is the number of characters in the header, including any
39893 embedded newlines and the terminating newline. The character is one of the
39894 following:
39895
39896 .table2 50pt
39897 .row <&'blank'&>         "header in which Exim has no special interest"
39898 .row &`B`&               "&'Bcc:'& header"
39899 .row &`C`&               "&'Cc:'& header"
39900 .row &`F`&               "&'From:'& header"
39901 .row &`I`&               "&'Message-id:'& header"
39902 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
39903 .row &`R`&               "&'Reply-To:'& header"
39904 .row &`S`&               "&'Sender:'& header"
39905 .row &`T`&               "&'To:'& header"
39906 .row &`*`&               "replaced or deleted header"
39907 .endtable
39908
39909 Deleted or replaced (rewritten) headers remain in the spool file for debugging
39910 purposes. They are not transmitted when the message is delivered. Here is a
39911 typical set of headers:
39912 .code
39913 111P Received: by hobbit.fict.example with local (Exim 4.00)
39914 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
39915 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
39916 038* X-rewrote-sender: bb@hobbit.fict.example
39917 042* From: Bilbo Baggins <bb@hobbit.fict.example>
39918 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
39919 099* To: alice@wonderland.fict.example, rdo@foundation,
39920 darcy@austen.fict.example, editor@thesaurus.ref.example
39921 104T To: alice@wonderland.fict.example, rdo@foundation.example,
39922 darcy@austen.fict.example, editor@thesaurus.ref.example
39923 038  Date: Fri, 11 May 2001 10:28:59 +0100
39924 .endd
39925 The asterisked headers indicate that the envelope sender, &'From:'& header, and
39926 &'To:'& header have been rewritten, the last one because routing expanded the
39927 unqualified domain &'foundation'&.
39928 .ecindex IIDforspo1
39929 .ecindex IIDforspo2
39930 .ecindex IIDforspo3
39931
39932 .section "Format of the -D file" "SECID282a"
39933 The data file is traditionally in Unix-standard format: lines are ended with
39934 an ASCII newline character.
39935 However, when the &%spool_wireformat%& main option is used some -D files
39936 can have an alternate format.
39937 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
39938 The -D file lines (not including the first name-component line) are
39939 suitable for direct copying to the wire when transmitting using the
39940 ESMTP CHUNKING option, meaning lower processing overhead.
39941 Lines are terminated with an ASCII CRLF pair.
39942 There is no dot-stuffing (and no dot-termination).
39943
39944 . ////////////////////////////////////////////////////////////////////////////
39945 . ////////////////////////////////////////////////////////////////////////////
39946
39947 .chapter "DKIM, SPF and DMARC" "CHAPdkim" &&&
39948          "DKIM, SPF and DMARC Support"
39949
39950 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
39951 .cindex "DKIM"
39952
39953 DKIM is a mechanism by which messages sent by some entity can be provably
39954 linked to a domain which that entity controls.  It permits reputation to
39955 be tracked on a per-domain basis, rather than merely upon source IP address.
39956 DKIM is documented in RFC 6376.
39957
39958 As DKIM relies on the message being unchanged in transit, messages handled
39959 by a mailing-list (which traditionally adds to the message) will not match
39960 any original DKIM signature.
39961
39962 DKIM support is compiled into Exim by default if TLS support is present.
39963 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
39964
39965 Exim's DKIM implementation allows for
39966 .olist
39967 Signing outgoing messages: This function is implemented in the SMTP transport.
39968 It can co-exist with all other Exim features
39969 (including transport filters)
39970 except cutthrough delivery.
39971 .next
39972 Verifying signatures in incoming messages: This is implemented by an additional
39973 ACL (acl_smtp_dkim), which can be called several times per message, with
39974 different signature contexts.
39975 .endlist
39976
39977 In typical Exim style, the verification implementation does not include any
39978 default "policy". Instead it enables you to build your own policy using
39979 Exim's standard controls.
39980
39981 Please note that verification of DKIM signatures in incoming mail is turned
39982 on by default for logging (in the <= line) purposes.
39983
39984 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
39985 When set, for each signature in incoming email,
39986 exim will log a line displaying the most important signature details, and the
39987 signature status. Here is an example (with line-breaks added for clarity):
39988 .code
39989 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
39990     d=facebookmail.com s=q1-2009b
39991     c=relaxed/relaxed a=rsa-sha1
39992     i=@facebookmail.com t=1252484542 [verification succeeded]
39993 .endd
39994
39995 You might want to turn off DKIM verification processing entirely for internal
39996 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
39997 control modifier. This should typically be done in the RCPT ACL, at points
39998 where you accept mail from relay sources (internal hosts or authenticated
39999 senders).
40000
40001
40002 .section "Signing outgoing messages" "SECDKIMSIGN"
40003 .cindex "DKIM" "signing"
40004
40005 For signing to be usable you must have published a DKIM record in DNS.
40006 Note that RFC 8301 (which does not cover EC keys) says:
40007 .code
40008 rsa-sha1 MUST NOT be used for signing or verifying.
40009
40010 Signers MUST use RSA keys of at least 1024 bits for all keys.
40011 Signers SHOULD use RSA keys of at least 2048 bits.
40012 .endd
40013
40014 Note also that the key content (the 'p=' field)
40015 in the DNS record is different between RSA and EC keys;
40016 for the former it is the base64 of the ASN.1 for the RSA public key
40017 (equivalent to the private-key .pem with the header/trailer stripped)
40018 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
40019
40020 Signing is enabled by setting private options on the SMTP transport.
40021 These options take (expandable) strings as arguments.
40022
40023 .option dkim_domain smtp string list&!! unset
40024 The domain(s) you want to sign with.
40025 After expansion, this can be a list.
40026 Each element in turn,
40027 lowercased,
40028 is put into the &%$dkim_domain%& expansion variable
40029 while expanding the remaining signing options.
40030 If it is empty after expansion, DKIM signing is not done,
40031 and no error will result even if &%dkim_strict%& is set.
40032
40033 .option dkim_selector smtp string list&!! unset
40034 This sets the key selector string.
40035 After expansion, which can use &$dkim_domain$&, this can be a list.
40036 Each element in turn is put in the expansion
40037 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
40038 option along with &%$dkim_domain%&.
40039 If the option is empty after expansion, DKIM signing is not done for this domain,
40040 and no error will result even if &%dkim_strict%& is set.
40041
40042 .option dkim_private_key smtp string&!! unset
40043 This sets the private key to use.
40044 You can use the &%$dkim_domain%& and
40045 &%$dkim_selector%& expansion variables to determine the private key to use.
40046 The result can either
40047 .ilist
40048 be a valid RSA private key in ASCII armor (.pem file), including line breaks
40049 .next
40050 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40051 be a valid Ed25519 private key (same format as above)
40052 .next
40053 start with a slash, in which case it is treated as a file that contains
40054 the private key
40055 .next
40056 be "0", "false" or the empty string, in which case the message will not
40057 be signed. This case will not result in an error, even if &%dkim_strict%&
40058 is set.
40059 .endlist
40060
40061 To generate keys under OpenSSL:
40062 .code
40063 openssl genrsa -out dkim_rsa.private 2048
40064 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
40065 .endd
40066 Take the base-64 lines from the output of the second command, concatenated,
40067 for the DNS TXT record.
40068 See section 3.6 of RFC6376 for the record specification.
40069
40070 Under GnuTLS:
40071 .code
40072 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
40073 certtool --load-privkey=dkim_rsa.private --pubkey-info
40074 .endd
40075
40076 Note that RFC 8301 says:
40077 .code
40078 Signers MUST use RSA keys of at least 1024 bits for all keys.
40079 Signers SHOULD use RSA keys of at least 2048 bits.
40080 .endd
40081
40082 EC keys for DKIM are defined by RFC 8463.
40083 They are considerably smaller than RSA keys for equivalent protection.
40084 As they are a recent development, users should consider dual-signing
40085 (by setting a list of selectors, and an expansion for this option)
40086 for some transition period.
40087 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40088 for EC keys.
40089
40090 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
40091 .code
40092 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
40093 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
40094 .endd
40095
40096 To produce the required public key value for a DNS record:
40097 .code
40098 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
40099 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
40100 .endd
40101
40102 Exim also supports an alternate format
40103 of Ed25519 keys in DNS which was a candidate during development
40104 of the standard, but not adopted.
40105 A future release will probably drop that support.
40106
40107 .option dkim_hash smtp string&!! sha256
40108 Can be set to any one of the supported hash methods, which are:
40109 .ilist
40110 &`sha1`& &-- should not be used, is old and insecure
40111 .next
40112 &`sha256`& &-- the default
40113 .next
40114 &`sha512`& &-- possibly more secure but less well supported
40115 .endlist
40116
40117 Note that RFC 8301 says:
40118 .code
40119 rsa-sha1 MUST NOT be used for signing or verifying.
40120 .endd
40121
40122 .option dkim_identity smtp string&!! unset
40123 If set after expansion, the value is used to set an "i=" tag in
40124 the signing header.  The DKIM standards restrict the permissible
40125 syntax of this optional tag to a mail address, with possibly-empty
40126 local part, an @, and a domain identical to or subdomain of the "d="
40127 tag value.  Note that Exim does not check the value.
40128
40129 .option dkim_canon smtp string&!! unset
40130 This option sets the canonicalization method used when signing a message.
40131 The DKIM RFC currently supports two methods: "simple" and "relaxed".
40132 The option defaults to "relaxed" when unset. Note: the current implementation
40133 only supports signing with the same canonicalization method for both headers and body.
40134
40135 .option dkim_strict smtp string&!! unset
40136 This  option  defines  how  Exim  behaves  when  signing a message that
40137 should be signed fails for some reason.  When the expansion evaluates to
40138 either "1" or "true", Exim will defer. Otherwise Exim will send the message
40139 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
40140 variables here.
40141
40142 .option dkim_sign_headers smtp string&!! "see below"
40143 If set, this option must expand to a colon-separated
40144 list of header names.
40145 Headers with these names, or the absence or such a header, will be included
40146 in the message signature.
40147 When unspecified, the header names listed in RFC4871 will be used,
40148 whether or not each header is present in the message.
40149 The default list is available for the expansion in the macro
40150 "_DKIM_SIGN_HEADERS".
40151
40152 If a name is repeated, multiple headers by that name (or the absence thereof)
40153 will be signed.  The textually later headers in the headers part of the
40154 message are signed first, if there are multiples.
40155
40156 A name can be prefixed with either an '=' or a '+' character.
40157 If an '=' prefix is used, all headers that are present with this name
40158 will be signed.
40159 If a '+' prefix if used, all headers that are present with this name
40160 will be signed, and one signature added for a missing header with the
40161 name will be appended.
40162
40163 .option dkim_timestamps smtp integer&!! unset
40164 This option controls the inclusion of timestamp information in the signature.
40165 If not set, no such information will be included.
40166 Otherwise, must be an unsigned number giving an offset in seconds from the current time
40167 for the expiry tag
40168 (eg. 1209600 for two weeks);
40169 both creation (t=) and expiry (x=) tags will be included.
40170
40171 RFC 6376 lists these tags as RECOMMENDED.
40172
40173
40174 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
40175 .cindex "DKIM" "verification"
40176
40177 Verification of DKIM signatures in SMTP incoming email is done for all
40178 messages for which an ACL control &%dkim_disable_verify%& has not been set.
40179 .cindex DKIM "selecting signature algorithms"
40180 Individual classes of signature algorithm can be ignored by changing
40181 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
40182 The &%dkim_verify_minimal%& option can be set to cease verification
40183 processing for a message once the first passing signature is found.
40184
40185 .cindex authentication "expansion item"
40186 Performing verification sets up information used by the
40187 &%authresults%& expansion item.
40188
40189 For most purposes the default option settings suffice and the remainder
40190 of this section can be ignored.
40191
40192 The results of verification are made available to the
40193 &%acl_smtp_dkim%& ACL, which can examine and modify them.
40194 A missing ACL definition defaults to accept.
40195 By default, the ACL is called once for each
40196 syntactically(!) correct signature in the incoming message.
40197 If any ACL call does not accept, the message is not accepted.
40198 If a cutthrough delivery was in progress for the message, that is
40199 summarily dropped (having wasted the transmission effort).
40200
40201 To evaluate the verification result in the ACL
40202 a large number of expansion variables
40203 containing the signature status and its details are set up during the
40204 runtime of the ACL.
40205
40206 Calling the ACL only for existing signatures is not sufficient to build
40207 more advanced policies. For that reason, the main option
40208 &%dkim_verify_signers%&, and an expansion variable
40209 &%$dkim_signers%& exist.
40210
40211 The main option &%dkim_verify_signers%& can be set to a colon-separated
40212 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
40213 called. It is expanded when the message has been received. At this point,
40214 the expansion variable &%$dkim_signers%& already contains a colon-separated
40215 list of signer domains and identities for the message. When
40216 &%dkim_verify_signers%& is not specified in the main configuration,
40217 it defaults as:
40218 .code
40219 dkim_verify_signers = $dkim_signers
40220 .endd
40221 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
40222 DKIM signature in the message. Current DKIM verifiers may want to explicitly
40223 call the ACL for known domains or identities. This would be achieved as follows:
40224 .code
40225 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
40226 .endd
40227 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
40228 and "ebay.com", plus all domains and identities that have signatures in the message.
40229 You can also be more creative in constructing your policy. For example:
40230 .code
40231 dkim_verify_signers = $sender_address_domain:$dkim_signers
40232 .endd
40233
40234 If a domain or identity is listed several times in the (expanded) value of
40235 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
40236
40237 Note that if the option is set using untrustworthy data
40238 (such as the From: header)
40239 care should be taken to force lowercase for domains
40240 and for the domain part if identities.
40241 The default setting can be regarded as trustworthy in this respect.
40242
40243 If multiple signatures match a domain (or identity), the ACL is called once
40244 for each matching signature.
40245
40246
40247 Inside the DKIM ACL, the following expansion variables are
40248 available (from most to least important):
40249
40250
40251 .vlist
40252 .vitem &%$dkim_cur_signer%&
40253 The signer that is being evaluated in this ACL run. This can be a domain or
40254 an identity. This is one of the list items from the expanded main option
40255 &%dkim_verify_signers%& (see above).
40256
40257 .vitem &%$dkim_verify_status%&
40258 Within the DKIM ACL,
40259 a string describing the general status of the signature. One of
40260 .ilist
40261 &%none%&: There is no signature in the message for the current domain or
40262 identity (as reflected by &%$dkim_cur_signer%&).
40263 .next
40264 &%invalid%&: The signature could not be verified due to a processing error.
40265 More detail is available in &%$dkim_verify_reason%&.
40266 .next
40267 &%fail%&: Verification of the signature failed.  More detail is
40268 available in &%$dkim_verify_reason%&.
40269 .next
40270 &%pass%&: The signature passed verification. It is valid.
40271 .endlist
40272
40273 This variable can be overwritten using an ACL 'set' modifier.
40274 This might, for instance, be done to enforce a policy restriction on
40275 hash-method or key-size:
40276 .code
40277   warn condition       = ${if eq {$dkim_verify_status}{pass}}
40278        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
40279        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
40280                                   {< {$dkim_key_length}{1024}}}}
40281        logwrite        = NOTE: forcing DKIM verify fail (was pass)
40282        set dkim_verify_status = fail
40283        set dkim_verify_reason = hash too weak or key too short
40284 .endd
40285
40286 So long as a DKIM ACL is defined (it need do no more than accept),
40287 after all the DKIM ACL runs have completed, the value becomes a
40288 colon-separated list of the values after each run.
40289 This is maintained for the mime, prdr and data ACLs.
40290
40291 .vitem &%$dkim_verify_reason%&
40292 A string giving a little bit more detail when &%$dkim_verify_status%& is either
40293 "fail" or "invalid". One of
40294 .ilist
40295 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
40296 key for the domain could not be retrieved. This may be a temporary problem.
40297 .next
40298 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
40299 record for the domain is syntactically invalid.
40300 .next
40301 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
40302 body hash does not match the one specified in the signature header. This
40303 means that the message body was modified in transit.
40304 .next
40305 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
40306 could not be verified. This may mean that headers were modified,
40307 re-written or otherwise changed in a way which is incompatible with
40308 DKIM verification. It may of course also mean that the signature is forged.
40309 .endlist
40310
40311 This variable can be overwritten, with any value, using an ACL 'set' modifier.
40312
40313 .vitem &%$dkim_domain%&
40314 The signing domain. IMPORTANT: This variable is only populated if there is
40315 an actual signature in the message for the current domain or identity (as
40316 reflected by &%$dkim_cur_signer%&).
40317
40318 .vitem &%$dkim_identity%&
40319 The signing identity, if present. IMPORTANT: This variable is only populated
40320 if there is an actual signature in the message for the current domain or
40321 identity (as reflected by &%$dkim_cur_signer%&).
40322
40323 .vitem &%$dkim_selector%&
40324 The key record selector string.
40325
40326 .vitem &%$dkim_algo%&
40327 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
40328 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40329 may also be 'ed25519-sha256'.
40330 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40331 for EC keys.
40332
40333 Note that RFC 8301 says:
40334 .code
40335 rsa-sha1 MUST NOT be used for signing or verifying.
40336
40337 DKIM signatures identified as having been signed with historic
40338 algorithms (currently, rsa-sha1) have permanently failed evaluation
40339 .endd
40340
40341 To enforce this you must either have a DKIM ACL which checks this variable
40342 and overwrites the &$dkim_verify_status$& variable as discussed above,
40343 or have set the main option &%dkim_verify_hashes%& to exclude
40344 processing of such signatures.
40345
40346 .vitem &%$dkim_canon_body%&
40347 The body canonicalization method. One of 'relaxed' or 'simple'.
40348
40349 .vitem &%$dkim_canon_headers%&
40350 The header canonicalization method. One of 'relaxed' or 'simple'.
40351
40352 .vitem &%$dkim_copiedheaders%&
40353 A transcript of headers and their values which are included in the signature
40354 (copied from the 'z=' tag of the signature).
40355 Note that RFC6376 requires that verification fail if the From: header is
40356 not included in the signature.  Exim does not enforce this; sites wishing
40357 strict enforcement should code the check explicitly.
40358
40359 .vitem &%$dkim_bodylength%&
40360 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
40361 limit was set by the signer, "9999999999999" is returned. This makes sure
40362 that this variable always expands to an integer value.
40363 &*Note:*& The presence of the signature tag specifying a signing body length
40364 is one possible route to spoofing of valid DKIM signatures.
40365 A paranoid implementation might wish to regard signature where this variable
40366 shows less than the "no limit" return as being invalid.
40367
40368 .vitem &%$dkim_created%&
40369 UNIX timestamp reflecting the date and time when the signature was created.
40370 When this was not specified by the signer, "0" is returned.
40371
40372 .vitem &%$dkim_expires%&
40373 UNIX timestamp reflecting the date and time when the signer wants the
40374 signature to be treated as "expired". When this was not specified by the
40375 signer, "9999999999999" is returned. This makes it possible to do useful
40376 integer size comparisons against this value.
40377 Note that Exim does not check this value.
40378
40379 .vitem &%$dkim_headernames%&
40380 A colon-separated list of names of headers included in the signature.
40381
40382 .vitem &%$dkim_key_testing%&
40383 "1" if the key record has the "testing" flag set, "0" if not.
40384
40385 .vitem &%$dkim_key_nosubdomains%&
40386 "1" if the key record forbids subdomaining, "0" otherwise.
40387
40388 .vitem &%$dkim_key_srvtype%&
40389 Service type (tag s=) from the key record. Defaults to "*" if not specified
40390 in the key record.
40391
40392 .vitem &%$dkim_key_granularity%&
40393 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
40394 in the key record.
40395
40396 .vitem &%$dkim_key_notes%&
40397 Notes from the key record (tag n=).
40398
40399 .vitem &%$dkim_key_length%&
40400 Number of bits in the key.
40401
40402 Note that RFC 8301 says:
40403 .code
40404 Verifiers MUST NOT consider signatures using RSA keys of
40405 less than 1024 bits as valid signatures.
40406 .endd
40407
40408 To enforce this you must have a DKIM ACL which checks this variable
40409 and overwrites the &$dkim_verify_status$& variable as discussed above.
40410 As EC keys are much smaller, the check should only do this for RSA keys.
40411
40412 .endlist
40413
40414 In addition, two ACL conditions are provided:
40415
40416 .vlist
40417 .vitem &%dkim_signers%&
40418 ACL condition that checks a colon-separated list of domains or identities
40419 for a match against the domain or identity that the ACL is currently verifying
40420 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
40421 verb to a group of domains or identities. For example:
40422
40423 .code
40424 # Warn when Mail purportedly from GMail has no gmail signature
40425 warn log_message = GMail sender without gmail.com DKIM signature
40426      sender_domains = gmail.com
40427      dkim_signers = gmail.com
40428      dkim_status = none
40429 .endd
40430
40431 Note that the above does not check for a total lack of DKIM signing;
40432 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
40433
40434 .vitem &%dkim_status%&
40435 ACL condition that checks a colon-separated list of possible DKIM verification
40436 results against the actual result of verification. This is typically used
40437 to restrict an ACL verb to a list of verification outcomes, for example:
40438
40439 .code
40440 deny message = Mail from Paypal with invalid/missing signature
40441      sender_domains = paypal.com:paypal.de
40442      dkim_signers = paypal.com:paypal.de
40443      dkim_status = none:invalid:fail
40444 .endd
40445
40446 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
40447 see the documentation of the &%$dkim_verify_status%& expansion variable above
40448 for more information of what they mean.
40449 .endlist
40450
40451
40452
40453
40454 .section "SPF (Sender Policy Framework)" SECSPF
40455 .cindex SPF verification
40456
40457 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
40458 messages with its domain in the envelope from, documented by RFC 7208.
40459 For more information on SPF see &url(http://www.open-spf.org), a static copy of
40460 the &url(http://openspf.org).
40461 . --- 2019-10-28: still not https, open-spf.org is told to be a
40462 . --- web-archive copy of the now dead openspf.org site
40463 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
40464 . --- discussion.
40465
40466 Messages sent by a system not authorised will fail checking of such assertions.
40467 This includes retransmissions done by traditional forwarders.
40468
40469 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
40470 &_Local/Makefile_&.  The support uses the &_libspf2_& library
40471 &url(https://www.libspf2.org/).
40472 There is no Exim involvement in the transmission of messages;
40473 publishing certain DNS records is all that is required.
40474
40475 For verification, an ACL condition and an expansion lookup are provided.
40476 .cindex authentication "expansion item"
40477 Performing verification sets up information used by the
40478 &%authresults%& expansion item.
40479
40480
40481 .cindex SPF "ACL condition"
40482 .cindex ACL "spf condition"
40483 The ACL condition "spf" can be used at or after the MAIL ACL.
40484 It takes as an argument a list of strings giving the outcome of the SPF check,
40485 and will succeed for any matching outcome.
40486 Valid strings are:
40487 .vlist
40488 .vitem &%pass%&
40489 The SPF check passed, the sending host is positively verified by SPF.
40490
40491 .vitem &%fail%&
40492 The SPF check failed, the sending host is NOT allowed to send mail for the
40493 domain in the envelope-from address.
40494
40495 .vitem &%softfail%&
40496 The SPF check failed, but the queried domain can't absolutely confirm that this
40497 is a forgery.
40498
40499 .vitem &%none%&
40500 The queried domain does not publish SPF records.
40501
40502 .vitem &%neutral%&
40503 The SPF check returned a "neutral" state.  This means the queried domain has
40504 published a SPF record, but wants to allow outside servers to send mail under
40505 its domain as well.  This should be treated like "none".
40506
40507 .vitem &%permerror%&
40508 This indicates a syntax error in the SPF record of the queried domain.
40509 You may deny messages when this occurs.
40510
40511 .vitem &%temperror%&
40512 This indicates a temporary error during all processing, including Exim's
40513 SPF processing.  You may defer messages when this occurs.
40514 .endlist
40515
40516 You can prefix each string with an exclamation mark to  invert
40517 its meaning,  for example  "!fail" will  match all  results but
40518 "fail".  The  string  list is  evaluated  left-to-right,  in a
40519 short-circuit fashion.
40520
40521 Example:
40522 .code
40523 deny spf = fail
40524      message = $sender_host_address is not allowed to send mail from \
40525                ${if def:sender_address_domain \
40526                     {$sender_address_domain}{$sender_helo_name}}.  \
40527                Please see http://www.open-spf.org/Why?scope=\
40528                ${if def:sender_address_domain {mfrom}{helo}};\
40529                identity=${if def:sender_address_domain \
40530                              {$sender_address}{$sender_helo_name}};\
40531                ip=$sender_host_address
40532 .endd
40533
40534 When the spf condition has run, it sets up several expansion
40535 variables:
40536
40537 .cindex SPF "verification variables"
40538 .vlist
40539 .vitem &$spf_header_comment$&
40540 .vindex &$spf_header_comment$&
40541   This contains a human-readable string describing the outcome
40542   of the SPF check. You can add it to a custom header or use
40543   it for logging purposes.
40544
40545 .vitem &$spf_received$&
40546 .vindex &$spf_received$&
40547   This contains a complete Received-SPF: header that can be
40548   added to the message. Please note that according to the SPF
40549   draft, this header must be added at the top of the header
40550   list. Please see section 10 on how you can do this.
40551
40552   Note: in case of "Best-guess" (see below), the convention is
40553   to put this string in a header called X-SPF-Guess: instead.
40554
40555 .vitem &$spf_result$&
40556 .vindex &$spf_result$&
40557   This contains the outcome of the SPF check in string form,
40558   one of pass, fail, softfail, none, neutral, permerror or
40559   temperror.
40560
40561 .vitem &$spf_result_guessed$&
40562 .vindex &$spf_result_guessed$&
40563   This boolean is true only if a best-guess operation was used
40564   and required in order to obtain a result.
40565
40566 .vitem &$spf_smtp_comment$&
40567 .vindex &$spf_smtp_comment$&
40568   This contains a string that can be used in a SMTP response
40569   to the calling party. Useful for "fail".
40570 .endlist
40571
40572
40573 .cindex SPF "ACL condition"
40574 .cindex ACL "spf_guess condition"
40575 .cindex SPF "best guess"
40576 In addition to SPF, you can also perform checks for so-called
40577 "Best-guess".  Strictly speaking, "Best-guess" is not standard
40578 SPF, but it is supported by the same framework that enables SPF
40579 capability.
40580 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
40581 for a description of what it means.
40582 . --- 2019-10-28: still not https:
40583
40584 To access this feature, simply use the spf_guess condition in place
40585 of the spf one.  For example:
40586
40587 .code
40588 deny spf_guess = fail
40589      message = $sender_host_address doesn't look trustworthy to me
40590 .endd
40591
40592 In case you decide to reject messages based on this check, you
40593 should note that although it uses the same framework, "Best-guess"
40594 is not SPF, and therefore you should not mention SPF at all in your
40595 reject message.
40596
40597 When the spf_guess condition has run, it sets up the same expansion
40598 variables as when spf condition is run, described above.
40599
40600 Additionally, since Best-guess is not standardized, you may redefine
40601 what "Best-guess" means to you by redefining the main configuration
40602 &%spf_guess%& option.
40603 For example, the following:
40604
40605 .code
40606 spf_guess = v=spf1 a/16 mx/16 ptr ?all
40607 .endd
40608
40609 would relax host matching rules to a broader network range.
40610
40611
40612 .cindex SPF "lookup expansion"
40613 .cindex lookup spf
40614 A lookup expansion is also available. It takes an email
40615 address as the key and an IP address
40616 (v4 or v6)
40617 as the database:
40618
40619 .code
40620   ${lookup {username@domain} spf {ip.ip.ip.ip}}
40621 .endd
40622
40623 The lookup will return the same result strings as can appear in
40624 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
40625
40626
40627
40628
40629
40630 .section DMARC SECDMARC
40631 .cindex DMARC verification
40632
40633 DMARC combines feedback from SPF, DKIM, and header From: in order
40634 to attempt to provide better indicators of the authenticity of an
40635 email.  This document does not explain the fundamentals; you
40636 should read and understand how it works by visiting the website at
40637 &url(http://www.dmarc.org/).
40638
40639 If Exim is built with DMARC support,
40640 the libopendmarc library is used.
40641
40642 For building Exim yourself, obtain the library from
40643 &url(http://sourceforge.net/projects/opendmarc/)
40644 to obtain a copy, or find it in your favorite package
40645 repository.  You will need to attend to the local/Makefile feature
40646 SUPPORT_DMARC and the associated LDFLAGS addition.
40647 This description assumes
40648 that headers will be in /usr/local/include, and that the libraries
40649 are in /usr/local/lib.
40650
40651 . subsection
40652
40653 There are three main-configuration options:
40654 .cindex DMARC "configuration options"
40655
40656 The &%dmarc_tld_file%& option
40657 .oindex &%dmarc_tld_file%&
40658 defines the location of a text file of valid
40659 top level domains the opendmarc library uses
40660 during domain parsing. Maintained by Mozilla,
40661 the most current version can be downloaded
40662 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
40663 See also the util/renew-opendmarc-tlds.sh script.
40664 .new
40665 The default for the option is unset.
40666 If not set, DMARC processing is disabled.
40667 .wen
40668
40669
40670 The &%dmarc_history_file%& option, if set
40671 .oindex &%dmarc_history_file%&
40672 defines the location of a file to log results
40673 of dmarc verification on inbound emails. The
40674 contents are importable by the opendmarc tools
40675 which will manage the data, send out DMARC
40676 reports, and expire the data. Make sure the
40677 directory of this file is writable by the user
40678 exim runs as.
40679 The default is unset.
40680
40681 The &%dmarc_forensic_sender%& option
40682 .oindex &%dmarc_forensic_sender%&
40683 defines an alternate email address to use when sending a
40684 forensic report detailing alignment failures
40685 if a sender domain's dmarc record specifies it
40686 and you have configured Exim to send them.
40687 If set, this is expanded and used for the
40688 From: header line; the address is extracted
40689 from it and used for the envelope from.
40690 If not set (the default), the From: header is expanded from
40691 the dsn_from option, and <> is used for the
40692 envelope from.
40693
40694 . I wish we had subsections...
40695
40696 .cindex DMARC controls
40697 By default, the DMARC processing will run for any remote,
40698 non-authenticated user.  It makes sense to only verify DMARC
40699 status of messages coming from remote, untrusted sources.  You can
40700 use standard conditions such as hosts, senders, etc, to decide that
40701 DMARC verification should *not* be performed for them and disable
40702 DMARC with an ACL control modifier:
40703 .code
40704   control = dmarc_disable_verify
40705 .endd
40706 A DMARC record can also specify a "forensic address", which gives
40707 exim an email address to submit reports about failed alignment.
40708 Exim does not do this by default because in certain conditions it
40709 results in unintended information leakage (what lists a user might
40710 be subscribed to, etc).  You must configure exim to submit forensic
40711 reports to the owner of the domain.  If the DMARC record contains a
40712 forensic address and you specify the control statement below, then
40713 exim will send these forensic emails.  It is also advised that you
40714 configure a &%dmarc_forensic_sender%& because the default sender address
40715 construction might be inadequate.
40716 .code
40717   control = dmarc_enable_forensic
40718 .endd
40719 (AGAIN: You can choose not to send these forensic reports by simply
40720 not putting the dmarc_enable_forensic control line at any point in
40721 your exim config.  If you don't tell exim to send them, it will not
40722 send them.)
40723
40724 There are no options to either control.  Both must appear before
40725 the DATA acl.
40726
40727 . subsection
40728
40729 DMARC checks cam be run on incoming SMTP  messages by using the
40730 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
40731 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
40732 condition.  Putting this condition in the ACLs is required in order
40733 for a DMARC check to actually occur.  All of the variables are set
40734 up before the DATA ACL, but there is no actual DMARC check that
40735 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
40736
40737 The &"dmarc_status"& condition takes a list of strings on its
40738 right-hand side.  These strings describe recommended action based
40739 on the DMARC check.  To understand what the policy recommendations
40740 mean, refer to the DMARC website above.  Valid strings are:
40741 .display
40742 &'accept      '& The DMARC check passed and the library recommends accepting the email.
40743 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
40744 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
40745 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
40746 &'norecord    '& No policy section in the DMARC record for this sender domain.
40747 &'nofrom      '& Unable to determine the domain of the sender.
40748 &'temperror   '& Library error or dns error.
40749 &'off         '& The DMARC check was disabled for this email.
40750 .endd
40751 You can prefix each string with an exclamation mark to invert its
40752 meaning, for example "!accept" will match all results but
40753 "accept".  The string list is evaluated left-to-right in a
40754 short-circuit fashion.  When a string matches the outcome of the
40755 DMARC check, the condition succeeds.  If none of the listed
40756 strings matches the outcome of the DMARC check, the condition
40757 fails.
40758
40759 Of course, you can also use any other lookup method that Exim
40760 supports, including LDAP, Postgres, MySQL, etc, as long as the
40761 result is a list of colon-separated strings.
40762
40763 Performing the check sets up information used by the
40764 &%authresults%& expansion item.
40765
40766 Several expansion variables are set before the DATA ACL is
40767 processed, and you can use them in this ACL.  The following
40768 expansion variables are available:
40769
40770 .vlist
40771 .vitem &$dmarc_status$&
40772 .vindex &$dmarc_status$&
40773 .cindex DMARC result
40774 A one word status indicating what the DMARC library
40775 thinks of the email.  It is a combination of the results of
40776 DMARC record lookup and the SPF/DKIM/DMARC processing results
40777 (if a DMARC record was found).  The actual policy declared
40778 in the DMARC record is in a separate expansion variable.
40779
40780 .vitem &$dmarc_status_text$&
40781 .vindex &$dmarc_status_text$&
40782 Slightly longer, human readable status.
40783
40784 .vitem &$dmarc_used_domain$&
40785 .vindex &$dmarc_used_domain$&
40786 The domain which DMARC used to look up the DMARC policy record.
40787
40788 .vitem &$dmarc_domain_policy$&
40789 .vindex &$dmarc_domain_policy$&
40790 The policy declared in the DMARC record.  Valid values
40791 are "none", "reject" and "quarantine".  It is blank when there
40792 is any error, including no DMARC record.
40793 .endlist
40794
40795 . subsection
40796
40797 By default, Exim's DMARC configuration is intended to be
40798 non-intrusive and conservative.  To facilitate this, Exim will not
40799 create any type of logging files without explicit configuration by
40800 you, the admin.  Nor will Exim send out any emails/reports about
40801 DMARC issues without explicit configuration by you, the admin (other
40802 than typical bounce messages that may come about due to ACL
40803 processing or failure delivery issues).
40804
40805 In order to log statistics suitable to be imported by the opendmarc
40806 tools, you need to:
40807 .ilist
40808 Configure the global option &%dmarc_history_file%&
40809 .next
40810 Configure cron jobs to call the appropriate opendmarc history
40811 import scripts and truncating the dmarc_history_file
40812 .endlist
40813
40814 In order to send forensic reports, you need to:
40815 .ilist
40816 Configure the global option &%dmarc_forensic_sender%&
40817 .next
40818 Configure, somewhere before the DATA ACL, the control option to
40819 enable sending DMARC forensic reports
40820 .endlist
40821
40822 . subsection
40823
40824 Example usage:
40825 .code
40826 (RCPT ACL)
40827   warn    domains        = +local_domains
40828           hosts          = +local_hosts
40829           control        = dmarc_disable_verify
40830
40831   warn    !domains       = +screwed_up_dmarc_records
40832           control        = dmarc_enable_forensic
40833
40834   warn    condition      = (lookup if destined to mailing list)
40835           set acl_m_mailing_list = 1
40836
40837 (DATA ACL)
40838   warn    dmarc_status   = accept : none : off
40839           !authenticated = *
40840           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
40841
40842   warn    dmarc_status   = !accept
40843           !authenticated = *
40844           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
40845
40846   warn    dmarc_status   = quarantine
40847           !authenticated = *
40848           set $acl_m_quarantine = 1
40849           # Do something in a transport with this flag variable
40850
40851   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
40852           condition      = ${if eq{$acl_m_mailing_list}{1}}
40853           message        = Messages from $dmarc_used_domain break mailing lists
40854
40855   deny    dmarc_status   = reject
40856           !authenticated = *
40857           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
40858
40859   warn    add_header     = :at_start:${authresults {$primary_hostname}}
40860 .endd
40861
40862
40863
40864
40865
40866 . ////////////////////////////////////////////////////////////////////////////
40867 . ////////////////////////////////////////////////////////////////////////////
40868
40869 .chapter "Proxies" "CHAPproxies" &&&
40870          "Proxy support"
40871 .cindex "proxy support"
40872 .cindex "proxy" "access via"
40873
40874 A proxy is an intermediate system through which communication is passed.
40875 Proxies may provide a security, availability or load-distribution function.
40876
40877
40878 .section "Inbound proxies" SECTproxyInbound
40879 .cindex proxy inbound
40880 .cindex proxy "server side"
40881 .cindex proxy "Proxy protocol"
40882 .cindex "Proxy protocol" proxy
40883
40884 Exim has support for receiving inbound SMTP connections via a proxy
40885 that uses &"Proxy Protocol"& to speak to it.
40886 To include this support, include &"SUPPORT_PROXY=yes"&
40887 in Local/Makefile.
40888
40889 It was built on the HAProxy specification, found at
40890 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
40891
40892 The purpose of this facility is so that an application load balancer,
40893 such as HAProxy, can sit in front of several Exim servers
40894 to distribute load.
40895 Exim uses the local protocol communication with the proxy to obtain
40896 the remote SMTP system IP address and port information.
40897 There is no logging if a host passes or
40898 fails Proxy Protocol negotiation, but it can easily be determined and
40899 recorded in an ACL (example is below).
40900
40901 Use of a proxy is enabled by setting the &%hosts_proxy%&
40902 main configuration option to a hostlist; connections from these
40903 hosts will use Proxy Protocol.
40904 Exim supports both version 1 and version 2 of the Proxy Protocol and
40905 automatically determines which version is in use.
40906
40907 The Proxy Protocol header is the first data received on a TCP connection
40908 and is inserted before any TLS-on-connect handshake from the client; Exim
40909 negotiates TLS between Exim-as-server and the remote client, not between
40910 Exim and the proxy server.
40911
40912 The following expansion variables are usable
40913 (&"internal"& and &"external"& here refer to the interfaces
40914 of the proxy):
40915 .display
40916 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
40917 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
40918 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
40919 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
40920 &'proxy_session            '& boolean: SMTP connection via proxy
40921 .endd
40922 If &$proxy_session$& is set but &$proxy_external_address$& is empty
40923 there was a protocol error.
40924 The variables &$sender_host_address$& and &$sender_host_port$&
40925 will have values for the actual client system, not the proxy.
40926
40927 Since the real connections are all coming from the proxy, and the
40928 per host connection tracking is done before Proxy Protocol is
40929 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
40930 handle all of the parallel volume you expect per inbound proxy.
40931 With the option set so high, you lose the ability
40932 to protect your server from many connections from one IP.
40933 In order to prevent your server from overload, you
40934 need to add a per connection ratelimit to your connect ACL.
40935 A possible solution is:
40936 .display
40937   # Set max number of connections per host
40938   LIMIT   = 5
40939   # Or do some kind of IP lookup in a flat file or database
40940   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
40941
40942   defer   message        = Too many connections from this IP right now
40943           ratelimit      = LIMIT / 5s / per_conn / strict
40944 .endd
40945
40946
40947
40948 .section "Outbound proxies" SECTproxySOCKS
40949 .cindex proxy outbound
40950 .cindex proxy "client side"
40951 .cindex proxy SOCKS
40952 .cindex SOCKS proxy
40953 Exim has support for sending outbound SMTP via a proxy
40954 using a protocol called SOCKS5 (defined by RFC1928).
40955 The support can be optionally included by defining SUPPORT_SOCKS=yes in
40956 Local/Makefile.
40957
40958 Use of a proxy is enabled by setting the &%socks_proxy%& option
40959 on an smtp transport.
40960 The option value is expanded and should then be a list
40961 (colon-separated by default) of proxy specifiers.
40962 Each proxy specifier is a list
40963 (space-separated by default) where the initial element
40964 is an IP address and any subsequent elements are options.
40965
40966 Options are a string <name>=<value>.
40967 The list of options is in the following table:
40968 .display
40969 &'auth   '& authentication method
40970 &'name   '& authentication username
40971 &'pass   '& authentication password
40972 &'port   '& tcp port
40973 &'tmo    '& connection timeout
40974 &'pri    '& priority
40975 &'weight '& selection bias
40976 .endd
40977
40978 More details on each of these options follows:
40979
40980 .ilist
40981 .cindex authentication "to proxy"
40982 .cindex proxy authentication
40983 &%auth%&: Either &"none"& (default) or &"name"&.
40984 Using &"name"& selects username/password authentication per RFC 1929
40985 for access to the proxy.
40986 Default is &"none"&.
40987 .next
40988 &%name%&: sets the username for the &"name"& authentication method.
40989 Default is empty.
40990 .next
40991 &%pass%&: sets the password for the &"name"& authentication method.
40992 Default is empty.
40993 .next
40994 &%port%&: the TCP port number to use for the connection to the proxy.
40995 Default is 1080.
40996 .next
40997 &%tmo%&: sets a connection timeout in seconds for this proxy.
40998 Default is 5.
40999 .next
41000 &%pri%&: specifies a priority for the proxy within the list,
41001 higher values being tried first.
41002 The default priority is 1.
41003 .next
41004 &%weight%&: specifies a selection bias.
41005 Within a priority set servers are queried in a random fashion,
41006 weighted by this value.
41007 The default value for selection bias is 1.
41008 .endlist
41009
41010 Proxies from the list are tried according to their priority
41011 and weight settings until one responds.  The timeout for the
41012 overall connection applies to the set of proxied attempts.
41013
41014 .section Logging SECTproxyLog
41015 To log the (local) IP of a proxy in the incoming or delivery logline,
41016 add &"+proxy"& to the &%log_selector%& option.
41017 This will add a component tagged with &"PRX="& to the line.
41018
41019 . ////////////////////////////////////////////////////////////////////////////
41020 . ////////////////////////////////////////////////////////////////////////////
41021
41022 .chapter "Internationalisation" "CHAPi18n" &&&
41023          "Internationalisation""
41024 .cindex internationalisation "email address"
41025 .cindex EAI
41026 .cindex i18n
41027 .cindex utf8 "mail name handling"
41028
41029 Exim has support for Internationalised mail names.
41030 To include this it must be built with SUPPORT_I18N and the libidn library.
41031 Standards supported are RFCs 2060, 5890, 6530 and 6533.
41032
41033 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
41034 instead of it) then IDNA2008 is supported; this adds an extra library
41035 requirement, upon libidn2.
41036
41037 .section "MTA operations" SECTi18nMTA
41038 .cindex SMTPUTF8 "ESMTP option"
41039 The main configuration option &%smtputf8_advertise_hosts%& specifies
41040 a host list.  If this matches the sending host and
41041 accept_8bitmime is true (the default) then the ESMTP option
41042 SMTPUTF8 will be advertised.
41043
41044 If the sender specifies the SMTPUTF8 option on a MAIL command
41045 international handling for the message is enabled and
41046 the expansion variable &$message_smtputf8$& will have value TRUE.
41047
41048 The option &%allow_utf8_domains%& is set to true for this
41049 message. All DNS lookups are converted to a-label form
41050 whatever the setting of &%allow_utf8_domains%&
41051 when Exim is built with SUPPORT_I18N.
41052
41053 Both localparts and domain are maintained as the original
41054 UTF-8 form internally; any comparison or regular-expression use will
41055 require appropriate care.  Filenames created, eg. by
41056 the appendfile transport, will have UTF-8 names.
41057
41058 HELO names sent by the smtp transport will have any UTF-8
41059 components expanded to a-label form,
41060 and any certificate name checks will be done using the a-label
41061 form of the name.
41062
41063 .cindex log protocol
41064 .cindex SMTPUTF8 logging
41065 .cindex i18n logging
41066 Log lines and Received-by: header lines will acquire a "utf8"
41067 prefix on the protocol element, eg. utf8esmtp.
41068
41069 The following expansion operators can be used:
41070 .code
41071 ${utf8_domain_to_alabel:str}
41072 ${utf8_domain_from_alabel:str}
41073 ${utf8_localpart_to_alabel:str}
41074 ${utf8_localpart_from_alabel:str}
41075 .endd
41076
41077 .cindex utf8 "address downconversion"
41078 .cindex i18n "utf8 address downconversion"
41079 The RCPT ACL
41080 may use the following modifier:
41081 .display
41082 control = utf8_downconvert
41083 control = utf8_downconvert/<value>
41084 .endd
41085 This sets a flag requiring that addresses are converted to
41086 a-label form before smtp delivery, for use in a
41087 Message Submission Agent context.
41088 If a value is appended it may be:
41089 .display
41090 &`1  `& (default) mandatory downconversion
41091 &`0  `& no downconversion
41092 &`-1 `& if SMTPUTF8 not supported by destination host
41093 .endd
41094
41095 If mua_wrapper is set, the utf8_downconvert control
41096 is initially set to -1.
41097
41098 The smtp transport has an option &%utf8_downconvert%&.
41099 If set it must expand to one of the three values described above,
41100 and it overrides any previously set value.
41101
41102
41103 There is no explicit support for VRFY and EXPN.
41104 Configurations supporting these should inspect
41105 &$smtp_command_argument$& for an SMTPUTF8 argument.
41106
41107 There is no support for LMTP on Unix sockets.
41108 Using the "lmtp" protocol option on an smtp transport,
41109 for LMTP over TCP, should work as expected.
41110
41111 There is no support for DSN unitext handling,
41112 and no provision for converting logging from or to UTF-8.
41113
41114
41115
41116 .section "MDA operations" SECTi18nMDA
41117 To aid in constructing names suitable for IMAP folders
41118 the following expansion operator can be used:
41119 .code
41120 ${imapfolder {<string>} {<sep>} {<specials>}}
41121 .endd
41122
41123 The string is converted from the charset specified by
41124 the "headers charset" command (in a filter file)
41125 or &%headers_charset%& main configuration option (otherwise),
41126 to the
41127 modified UTF-7 encoding specified by RFC 2060,
41128 with the following exception: All occurrences of <sep>
41129 (which has to be a single character)
41130 are replaced with periods ("."), and all periods and slashes that are not
41131 <sep> and are not in the <specials> string are BASE64 encoded.
41132
41133 The third argument can be omitted, defaulting to an empty string.
41134 The second argument can be omitted, defaulting to "/".
41135
41136 This is the encoding used by Courier for Maildir names on disk, and followed
41137 by many other IMAP servers.
41138
41139 Examples:
41140 .display
41141 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
41142 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
41143 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
41144 .endd
41145
41146 Note that the source charset setting is vital, and also that characters
41147 must be representable in UTF-16.
41148
41149
41150 . ////////////////////////////////////////////////////////////////////////////
41151 . ////////////////////////////////////////////////////////////////////////////
41152
41153 .chapter "Events" "CHAPevents" &&&
41154          "Events"
41155 .cindex events
41156
41157 The events mechanism in Exim can be used to intercept processing at a number
41158 of points.  It was originally invented to give a way to do customised logging
41159 actions (for example, to a database) but can also be used to modify some
41160 processing actions.
41161
41162 Most installations will never need to use Events.
41163 The support can be left out of a build by defining DISABLE_EVENT=yes
41164 in &_Local/Makefile_&.
41165
41166 There are two major classes of events: main and transport.
41167 The main configuration option &%event_action%& controls reception events;
41168 a transport option &%event_action%& controls delivery events.
41169
41170 Both options are a string which is expanded when the event fires.
41171 An example might look like:
41172 .cindex logging custom
41173 .code
41174 event_action = ${if eq {msg:delivery}{$event_name} \
41175 {${lookup pgsql {SELECT * FROM record_Delivery( \
41176     '${quote_pgsql:$sender_address_domain}',\
41177     '${quote_pgsql:${lc:$sender_address_local_part}}', \
41178     '${quote_pgsql:$domain}', \
41179     '${quote_pgsql:${lc:$local_part}}', \
41180     '${quote_pgsql:$host_address}', \
41181     '${quote_pgsql:${lc:$host}}', \
41182     '${quote_pgsql:$message_exim_id}')}} \
41183 } {}}
41184 .endd
41185
41186 Events have names which correspond to the point in process at which they fire.
41187 The name is placed in the variable &$event_name$& and the event action
41188 expansion must check this, as it will be called for every possible event type.
41189
41190 .new
41191 The current list of events is:
41192 .wen
41193 .display
41194 &`dane:fail              after    transport  `& per connection
41195 &`msg:complete           after    main       `& per message
41196 &`msg:defer              after    transport  `& per message per delivery try
41197 &`msg:delivery           after    transport  `& per recipient
41198 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
41199 &`msg:rcpt:defer         after    transport  `& per recipient
41200 &`msg:host:defer         after    transport  `& per host per delivery try; host errors
41201 &`msg:fail:delivery      after    transport  `& per recipient
41202 &`msg:fail:internal      after    main       `& per recipient
41203 &`tcp:connect            before   transport  `& per connection
41204 &`tcp:close              after    transport  `& per connection
41205 &`tls:cert               before   both       `& per certificate in verification chain
41206 &`smtp:connect           after    transport  `& per connection
41207 &`smtp:ehlo              after    transport  `& per connection
41208 .endd
41209 New event types may be added in future.
41210
41211 The event name is a colon-separated list, defining the type of
41212 event in a tree of possibilities.  It may be used as a list
41213 or just matched on as a whole.  There will be no spaces in the name.
41214
41215 The second column in the table above describes whether the event fires
41216 before or after the action is associates with.  Those which fire before
41217 can be used to affect that action (more on this below).
41218
41219 The third column in the table above says what section of the configuration
41220 should define the event action.
41221
41222 An additional variable, &$event_data$&, is filled with information varying
41223 with the event type:
41224 .display
41225 &`dane:fail            `& failure reason
41226 &`msg:defer            `& error string
41227 &`msg:delivery         `& smtp confirmation message
41228 &`msg:fail:internal    `& failure reason
41229 &`msg:fail:delivery    `& smtp error message
41230 &`msg:host:defer       `& error string
41231 &`msg:rcpt:host:defer  `& error string
41232 &`msg:rcpt:defer       `& error string
41233 &`tls:cert             `& verification chain depth
41234 &`smtp:connect         `& smtp banner
41235 &`smtp:ehlo            `& smtp ehlo response
41236 .endd
41237
41238 The :defer events populate one extra variable: &$event_defer_errno$&.
41239
41240 For complex operations an ACL expansion can be used in &%event_action%&
41241 however due to the multiple contexts that Exim operates in during
41242 the course of its processing:
41243 .ilist
41244 variables set in transport events will not be visible outside that
41245 transport call
41246 .next
41247 acl_m variables in a server context are lost on a new connection,
41248 and after smtp helo/ehlo/mail/starttls/rset commands
41249 .endlist
41250 Using an ACL expansion with the logwrite modifier can be
41251 a useful way of writing to the main log.
41252
41253 The expansion of the event_action option should normally
41254 return an empty string.  Should it return anything else the
41255 following will be forced:
41256 .display
41257 &`tcp:connect      `&  do not connect
41258 &`tls:cert         `&  refuse verification
41259 &`smtp:connect     `&  close connection
41260 .endd
41261 All other message types ignore the result string, and
41262 no other use is made of it.
41263
41264 For a tcp:connect event, if the connection is being made to a proxy
41265 then the address and port variables will be that of the proxy and not
41266 the target system.
41267
41268 For tls:cert events, if GnuTLS is in use this will trigger only per
41269 chain element received on the connection.
41270 For OpenSSL it will trigger for every chain element including those
41271 loaded locally.
41272
41273 . ////////////////////////////////////////////////////////////////////////////
41274 . ////////////////////////////////////////////////////////////////////////////
41275
41276 .chapter "Adding new drivers or lookup types" "CHID13" &&&
41277          "Adding drivers or lookups"
41278 .cindex "adding drivers"
41279 .cindex "new drivers, adding"
41280 .cindex "drivers" "adding new"
41281 The following actions have to be taken in order to add a new router, transport,
41282 authenticator, or lookup type to Exim:
41283
41284 .olist
41285 Choose a name for the driver or lookup type that does not conflict with any
41286 existing name; I will use &"newdriver"& in what follows.
41287 .next
41288 Add to &_src/EDITME_& the line:
41289 .display
41290 <&'type'&>&`_NEWDRIVER=yes`&
41291 .endd
41292 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
41293 code is not to be included in the binary by default, comment this line out. You
41294 should also add any relevant comments about the driver or lookup type.
41295 .next
41296 Add to &_src/config.h.defaults_& the line:
41297 .code
41298 #define <type>_NEWDRIVER
41299 .endd
41300 .next
41301 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
41302 and create a table entry as is done for all the other drivers and lookup types.
41303 .next
41304 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
41305 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
41306 Add your &`NEWDRIVER`& to that list.
41307 As long as the dynamic module would be named &_newdriver.so_&, you can use the
41308 simple form that most lookups have.
41309 .next
41310 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
41311 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
41312 driver or lookup type and add it to the definition of OBJ.
41313 .next
41314 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
41315 definition of OBJ_MACRO.  Add a set of line to do the compile also.
41316 .next
41317 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
41318 &_src_&.
41319 .next
41320 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
41321 as for other drivers and lookups.
41322 .endlist
41323
41324 Then all you need to do is write the code! A good way to start is to make a
41325 proforma by copying an existing module of the same type, globally changing all
41326 occurrences of the name, and cutting out most of the code. Note that any
41327 options you create must be listed in alphabetical order, because the tables are
41328 searched using a binary chop procedure.
41329
41330 There is a &_README_& file in each of the sub-directories of &_src_& describing
41331 the interface that is expected.
41332
41333
41334
41335
41336 . ////////////////////////////////////////////////////////////////////////////
41337 . ////////////////////////////////////////////////////////////////////////////
41338
41339 . /////////////////////////////////////////////////////////////////////////////
41340 . These lines are processing instructions for the Simple DocBook Processor that
41341 . Philip Hazel has developed as a less cumbersome way of making PostScript and
41342 . PDFs than using xmlto and fop. They will be ignored by all other XML
41343 . processors.
41344 . /////////////////////////////////////////////////////////////////////////////
41345
41346 .literal xml
41347 <?sdop
41348   format="newpage"
41349   foot_right_recto="&chaptertitle;"
41350   foot_right_verso="&chaptertitle;"
41351 ?>
41352 .literal off
41353
41354 .makeindex "Options index"   "option"
41355 .makeindex "Variables index" "variable"
41356 .makeindex "Concept index"   "concept"
41357
41358
41359 . /////////////////////////////////////////////////////////////////////////////
41360 . /////////////////////////////////////////////////////////////////////////////